New certificate layout for tiproxy (#5825)

pingcap · Nov 8, 2024 · 699ac5d · 699ac5d
1 parent cb47ac5
commit 699ac5d
Show file tree

Hide file tree

Showing 5 changed files with 273 additions and 97 deletions.
diff --git a/docs/api-references/docs.md b/docs/api-references/docs.md
@@ -23522,6 +23522,13 @@ int32
 </tr>
 </tbody>
 </table>
+<h3 id="tiproxycertlayout">TiProxyCertLayout</h3>
+<p>
+(<em>Appears on:</em>
+<a href="#tiproxyspec">TiProxySpec</a>)
+</p>
+<p>
+</p>
 <h3 id="tiproxyconfigwraper">TiProxyConfigWraper</h3>
 <p>
 (<em>Appears on:</em>
@@ -23710,6 +23717,21 @@ used by TiProxy to check health status.</p>
 </tr>
 <tr>
 <td>
+<code>certLayout</code></br>
+<em>
+<a href="#tiproxycertlayout">
+TiProxyCertLayout
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>TiProxyCertLayout is the certificate layout of TiProxy that determines how tidb-operator mount cert secrets
+and how configure TLS configurations for tiproxy.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>baseImage</code></br>
 <em>
 string

diff --git a/manifests/crd/v1/pingcap.com_tidbclusters.yaml b/manifests/crd/v1/pingcap.com_tidbclusters.yaml
@@ -24312,6 +24312,8 @@ spec:
                   baseImage:
                     default: pingcap/tiproxy
                     type: string
+                  certLayout:
+                    type: string
                   claims:
                     items:
                       properties:

diff --git a/pkg/apis/pingcap/v1alpha1/openapi_generated.go b/pkg/apis/pingcap/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/pingcap/v1alpha1/types.go b/pkg/apis/pingcap/v1alpha1/types.go
@@ -161,6 +161,14 @@ const (
 	StartScriptV2FeatureFlagPreferPDAddressesOverDiscovery = "PreferPDAddressesOverDiscovery"
 )
 
+type TiProxyCertLayout string
+
+const (
+	TiProxyCertLayoutLegacy TiProxyCertLayout = ""
+	// TiProxyCertLayoutV1 is a refined version of legacy layout. It's more intuitive and more flexible.
+	TiProxyCertLayoutV1 TiProxyCertLayout = "v1"
+)
+
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
@@ -932,6 +940,11 @@ type TiProxySpec struct {
 	// +optional
 	TLSClientSecretName *string `json:"tlsClientSecretName,omitempty"`
 
+	// TiProxyCertLayout is the certificate layout of TiProxy that determines how tidb-operator mount cert secrets
+	// and how configure TLS configurations for tiproxy.
+	// +optional
+	CertLayout TiProxyCertLayout `json:"certLayout,omitempty"`
+
 	// Base image of the component, image tag is now allowed during validation
 	// +kubebuilder:default=pingcap/tiproxy
 	// +optional