Support specifying an initialize sql file on TiDB' s first bootstrap (#…

…4862)

docs/api-references/docs.md

@@ -16587,6 +16587,21 @@ TiDBInitializer
 <p>Initializer is the init configurations of TiDB</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>bootstrapSQLConfigMapName</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>BootstrapSQLConfigMapName is the name of the ConfigMap which contains the bootstrap SQL file with the key <code>bootstrap-sql</code>,
+which will only be executed when a TiDB cluster bootstrap on the first time.
+The field should be set ONLY when create a TC, since it only take effect on the first time bootstrap.
+Only v6.6.0+ supports this feature.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="tidbstatus">TiDBStatus</h3>

manifests/crd.yaml

@@ -24698,6 +24698,8 @@ spec:
                     type: string
                   binlogEnabled:
                     type: boolean
+                  bootstrapSQLConfigMapName:
+                    type: string
                   config:
                     x-kubernetes-preserve-unknown-fields: true
                   configUpdateStrategy:

manifests/crd/v1/pingcap.com_tidbclusters.yaml

@@ -11443,6 +11443,8 @@ spec:
                     type: string
                   binlogEnabled:
                     type: boolean
+                  bootstrapSQLConfigMapName:
+                    type: string
                   config:
                     x-kubernetes-preserve-unknown-fields: true
                   configUpdateStrategy:

manifests/crd/v1beta1/pingcap.com_tidbclusters.yaml

@@ -11428,6 +11428,8 @@ spec:
                   type: string
                 binlogEnabled:
                   type: boolean
+                bootstrapSQLConfigMapName:
+                  type: string
                 config:
                   x-kubernetes-preserve-unknown-fields: true
                 configUpdateStrategy:

manifests/crd_v1beta1.yaml

@@ -24678,6 +24678,8 @@ spec:
                   type: string
                 binlogEnabled:
                   type: boolean
+                bootstrapSQLConfigMapName:
+                  type: string
                 config:
                   x-kubernetes-preserve-unknown-fields: true
                 configUpdateStrategy:

pkg/apis/pingcap/v1alpha1/tidbcluster.go

@@ -975,6 +975,14 @@ func (tc *TidbCluster) IsTiDBBinlogEnabled() bool {
 	return *binlogEnabled
 }
 
+func (tidb *TiDBSpec) IsBootstrapSQLEnabled() bool {
+	if tidb.BootstrapSQLConfigMapName != nil && *tidb.BootstrapSQLConfigMapName != "" {
+		return true
+	}
+
+	return false
+}
+
 func (tidb *TiDBSpec) IsTLSClientEnabled() bool {
 	return tidb.TLSClient != nil && tidb.TLSClient.Enabled
 }

pkg/apis/pingcap/v1alpha1/types.go

@@ -914,6 +914,13 @@ type TiDBSpec struct {
 	//
 	// +optional
 	Initializer *TiDBInitializer `json:"initializer,omitempty"`
+
+	// BootstrapSQLConfigMapName is the name of the ConfigMap which contains the bootstrap SQL file with the key `bootstrap-sql`,
+	// which will only be executed when a TiDB cluster bootstrap on the first time.
+	// The field should be set ONLY when create a TC, since it only take effect on the first time bootstrap.
+	// Only v6.6.0+ supports this feature.
+	// +optional
+	BootstrapSQLConfigMapName *string `json:"bootstrapSQLConfigMapName,omitempty"`
 }
 
 type TiDBInitializer struct {

pkg/apis/pingcap/v1alpha1/validation/validation.go

@@ -536,6 +536,7 @@ func ValidateUpdateTidbCluster(old, tc *v1alpha1.TidbCluster) field.ErrorList {
 			"The instance must not be mutate or set value other than the cluster name"))
 	}
 	allErrs = append(allErrs, validateUpdatePDConfig(old.Spec.PD, tc.Spec.PD, field.NewPath("spec.pd.config"))...)
+	allErrs = append(allErrs, disallowMutateBootstrapSQLConfigMapName(old.Spec.TiDB, tc.Spec.TiDB, field.NewPath("spec.tidb.bootstrapSQLConfigMapName"))...)
 	allErrs = append(allErrs, disallowUsingLegacyAPIInNewCluster(old, tc)...)
 
 	return allErrs
@@ -643,6 +644,23 @@ func validateUpdatePDConfig(oldPdSpec, pdSpec *v1alpha1.PDSpec, path *field.Path
 	return allErrs
 }
 
+// disallowMutateBootstrapSQLConfigMapName checks if user mutate the bootstrapSQLConfigMapName field.
+// Only allow to update bootstrapSQLConfigMapName from non-nil to nil.
+func disallowMutateBootstrapSQLConfigMapName(old, new *v1alpha1.TiDBSpec, p *field.Path) field.ErrorList {
+	allErrs := field.ErrorList{}
+	if old == nil || new == nil {
+		return allErrs
+	}
+
+	bootstrapSQLSpecified := old.BootstrapSQLConfigMapName != nil && new.BootstrapSQLConfigMapName != nil
+	if (bootstrapSQLSpecified && *old.BootstrapSQLConfigMapName != *new.BootstrapSQLConfigMapName) ||
+		(!bootstrapSQLSpecified && new.BootstrapSQLConfigMapName != nil) {
+		return append(allErrs, field.Invalid(p, new.BootstrapSQLConfigMapName, "bootstrapSQLConfigMapName is immutable"))
+	}
+
+	return allErrs
+}
+
 func validateDeleteSlots(annotations map[string]string, key string, fldPath *field.Path) field.ErrorList {
 	allErrs := field.ErrorList{}
 	if annotations != nil {

pkg/apis/pingcap/v1alpha1/validation/validation_test.go

@@ -749,3 +749,74 @@ func TestValidatePDSpec(t *testing.T) {
 		})
 	}
 }
+
+func Test_disallowMutateBootstrapSQLConfigMapName(t *testing.T) {
+	g := NewGomegaWithT(t)
+	tests := []struct {
+		name      string
+		old       *v1alpha1.TiDBSpec
+		new       *v1alpha1.TiDBSpec
+		wantError bool
+	}{
+		{
+			name: "no change, both nil",
+			old: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: nil,
+			},
+			new: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: nil,
+			},
+			wantError: false,
+		},
+		{
+			name: "no change, both non-nil",
+			old: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: pointer.StringPtr("old"),
+			},
+			new: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: pointer.StringPtr("old"),
+			},
+			wantError: false,
+		},
+		{
+			name: "mutate from non-nil to nil",
+			old: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: pointer.StringPtr("old"),
+			},
+			new: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: nil,
+			},
+			wantError: false,
+		},
+		{
+			name: "mutate from nil to non-nil",
+			old: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: nil,
+			},
+			new: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: pointer.StringPtr("new"),
+			},
+			wantError: true,
+		},
+		{
+			name: "mutate from non-nil to non-nil",
+			old: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: pointer.StringPtr("old"),
+			},
+			new: &v1alpha1.TiDBSpec{
+				BootstrapSQLConfigMapName: pointer.StringPtr("new"),
+			},
+			wantError: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			errs := disallowMutateBootstrapSQLConfigMapName(tt.old, tt.new, field.NewPath("spec.tidb.bootstrapSQLConfigMapName"))
+			if tt.wantError {
+				g.Expect(len(errs)).NotTo(Equal(0))
+			} else {
+				g.Expect(len(errs)).To(Equal(0))
+			}
+		})
+	}
+}

pkg/manager/member/startscript/v1/render_script.go

@@ -83,7 +83,6 @@ func RenderTiDBStartScript(tc *v1alpha1.TidbCluster) (string, error) {
 		PluginDirectory: "/plugins",
 		PluginList:      strings.Join(plugins, ","),
 	}
-
 	model.Path = "${CLUSTER_NAME}-pd:2379"
 	if tc.AcrossK8s() {
 		model.Path = "${CLUSTER_NAME}-pd:2379" // get pd addr from discovery in startup script

pkg/manager/member/tidb_member_manager.go

@@ -73,6 +73,9 @@ const (
 
 	// tidb DC label Name
 	tidbDCLabel = "zone"
+
+	bootstrapSQLFilePath = "/etc/tidb-bootstrap"
+	bootstrapSQLFileName = "bootstrap.sql"
 )
 
 var (
@@ -579,6 +582,9 @@ func getTiDBConfigMap(tc *v1alpha1.TidbCluster) (*corev1.ConfigMap, error) {
 		config.Set("security.ssl-cert", path.Join(serverCertPath, corev1.TLSCertKey))
 		config.Set("security.ssl-key", path.Join(serverCertPath, corev1.TLSPrivateKeyKey))
 	}
+	if tc.Spec.TiDB.IsBootstrapSQLEnabled() {
+		config.Set("initialize-sql-file", path.Join(bootstrapSQLFilePath, bootstrapSQLFileName))
+	}
 	confText, err := config.MarshalTOML()
 	if err != nil {
 		return nil, err
@@ -767,6 +773,22 @@ func getNewTiDBSetForTidbCluster(tc *v1alpha1.TidbCluster, cm *corev1.ConfigMap)
 			},
 		})
 	}
+	if tc.Spec.TiDB != nil && tc.Spec.TiDB.IsBootstrapSQLEnabled() {
+		volMounts = append(volMounts, corev1.VolumeMount{
+			Name: "tidb-bootstrap-sql", ReadOnly: true, MountPath: bootstrapSQLFilePath,
+		})
+
+		vols = append(vols, corev1.Volume{
+			Name: "tidb-bootstrap-sql", VolumeSource: corev1.VolumeSource{
+				ConfigMap: &corev1.ConfigMapVolumeSource{
+					LocalObjectReference: corev1.LocalObjectReference{
+						Name: *tc.Spec.TiDB.BootstrapSQLConfigMapName,
+					},
+					Items: []corev1.KeyToPath{{Key: "bootstrap-sql", Path: bootstrapSQLFileName}},
+				},
+			},
+		})
+	}
 	if tc.IsTLSClusterEnabled() {
 		vols = append(vols, corev1.Volume{
 			Name: "tidb-tls", VolumeSource: corev1.VolumeSource{