Allow MySQL server image default to be specified in operator config

Author: bcurrerb

docs/enterprise-edition-example.md

@@ -1,10 +1,10 @@
 # Enterprise edition tutorial
-This tutorial will explain how to create a mysqlcluster that runs the enterprise version of mysql.
+This tutorial will explain how to create a MySQL cluster that runs the enterprise version of MySQL.
 
 ## Prerequisites
 
-- The mysql-operator repository checked out locally.
-- Access to a Docker registry that contains the enterprise version of mysql.
+- The MySQL operator repository checked out locally.
+- Access to a Docker registry that contains the enterprise version of MySQL.
 
 ## 01 - Create the Operator
 You will need to create the following:
@@ -14,18 +14,17 @@ You will need to create the following:
 3. The Operator 
 4. The Agent ServiceAccount & RoleBinding
 
-The creation of these resources can be achieved by following the [introductory tutorial][1]; return here before creating a MySQL Cluster.
+The creation of these resources can be achieved by following the [introductory tutorial][1]; return here before creating a MySQL cluster.
 
 ## 02 - Create a secret with registry credentials
-To be able to pull the mysql enterprise edition from docker it is necessary to provide credentials, these credentials must be supplied in the form of a Kubernetes secret.
+To be able to pull the MySQL Enterprise Edition from Docker it is necessary to provide credentials, these credentials must be supplied in the form of a Kubernetes secret.
 
-- The name of the secret `myregistrykey` must match the name in the `imagepullsecrets` which we will specify in the cluster config in step 03.
-- The secret must be created in the same namespace as the MySQL Cluster which we will make in step 03. It must also be in the same namespace as the RBAC permissions created in step 01.
-- If you are pulling the mysql enterprise image from a different registry then the secret must contain the relevant credentials for that registry.
+- Remember the name of the secret *myregistrykey* as this will need to be used in step 03 when creating the cluster. 
+- If you are pulling the MySQL Enterprise image from a different registry than the one in the example then the secret must contain the relevant credentials for that registry.
 
->For alternative ways to create Kubernetes secretes see their documentation on [creating secrets from docker configs](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) or [creating secrets manually](https://kubernetes.io/docs/concepts/containers/images/#creating-a-secret-with-a-docker-config).
+>For alternative ways to create Kubernetes secrets see their documentation on [creating secrets from Docker configs](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) or [creating secrets manually](https://kubernetes.io/docs/concepts/containers/images/#creating-a-secret-with-a-docker-config).
 
-Enter your credentials into the following command and execute it to create a Kubernetes secret that will enable pulling images from the Docker store. add  the `-n` flag to specify a namespace if you do not want to use the default namespace. 
+Enter your credentials into the following command and execute it to create a Kubernetes secret that will enable pulling images from the Docker store. Add  the `-n` flag to specify a namespace if you do not want to use the default namespace. 
 ```
 kubectl create secret docker-registry myregistrykey \
 --docker-server=https://index.docker.io/v1/ \
@@ -36,10 +35,10 @@ kubectl create secret docker-registry myregistrykey \
 ## 03 - Create your MySQL Cluster
 Finally, create your MySQL Cluster with the required specifications entered under `spec:` 
 
-- The mysqlServer field should be the path to a registry containing the enterprise edition of MySQL.
-- The imagePullSecret: name: Should be the name of a Kubernetes secret in the same namespace that contains your credentials for the docker registry.
-- The version to be used must be specified, without this, a default version is used which is **not** guaranteed to match an available image of MySQL Enterprise.
-- The namespace of the cluster  must match the namespace of the secret we created in step 02.
+- The `repository:` field should be the path to a Docker registry containing the enterprise edition of MySQL. If this is ommited, the default is taken from the MySQL operator field `defaultMysqlServer:` which you can also specify.
+- The `imagePullSecrets`: field allows you to specify a list of Kubernetes secret names. These secret(s) should contains your credentials for the Docker registry.
+- The version to be used should be specified, without this, a default version is used which is **not** guaranteed to match an available image of MySQL Enterprise.
+- The namespace of the cluster  must match the namespace of the RBAC permissions created in step 01.
 ```
 kubectl apply -f examples/cluster/cluster-enterprise-version.yaml
 ```

examples/cluster/cluster-enterprise-version.yaml

@@ -1,10 +1,9 @@
 apiVersion: mysql.oracle.com/v1alpha1
 kind: Cluster
 metadata:
-  name: mysql
-  namespace: default
+  name: mysql-enterprise
 spec:
   version: "8.0.11"
-  mysqlServer: store/oracle/mysql-enterprise-server
-  imagePullSecret: 
-    name: myregistrykey
+  repository: store/oracle/mysql-enterprise-server
+  imagePullSecrets: 
+    - name: myregistrykey

pkg/apis/mysql/v1alpha1/helpers.go

@@ -54,8 +54,8 @@ func getOperatorVersionLabel(labelMap map[string]string) string {
 
 // EnsureDefaults will ensure that if a user omits any fields in the
 // spec that are required, we set some sensible defaults.
-// For example a user can choose to omit the version
-// and number of members.
+// For example a user can choose to omit the version and number of
+// members. MySQL server image default is defined through operator spec.
 func (c *Cluster) EnsureDefaults() *Cluster {
 	if c.Spec.Members == 0 {
 		c.Spec.Members = defaultMembers
@@ -69,10 +69,6 @@ func (c *Cluster) EnsureDefaults() *Cluster {
 		c.Spec.Version = DefaultVersion
 	}
 
-	if c.Spec.MySQLServerImage == "" {
-		c.Spec.MySQLServerImage = MysqlServer
-	}
-
 	return c
 }
 

pkg/apis/mysql/v1alpha1/types.go

@@ -28,11 +28,11 @@ const MinimumMySQLVersion = "8.0.11"
 type ClusterSpec struct {
 	// Version defines the MySQL Docker image version.
 	Version string `json:"version"`
-	// MySQLServerImage defines the image to be pulled for the mysqlServer.
-	MySQLServerImage string `json:"mysqlServer"`
+	// Repository defines the image to be pulled for the MySQL server.
+	Repository string `json:"repository"`
 	// ImagePullSecret defines the name of the secret that contains the
-	// required credentials for pulling the MySQLServerImage.
-	ImagePullSecret *v1.LocalObjectReference `json:"imagePullSecret"`
+	// required credentials for pulling from the specified Repository.
+	ImagePullSecrets []v1.LocalObjectReference `json:"imagePullSecret"`
 	// Members defines the number of MySQL instances in a cluster
 	Members int32 `json:"members,omitempty"`
 	// BaseServerID defines the base number used to create unique server_id

pkg/options/operator/options.go

@@ -29,13 +29,16 @@ import (
 )
 
 const (
-	mysqlAgent = "iad.ocir.io/oracle/mysql-agent"
+	mysqlAgent  = "iad.ocir.io/oracle/mysql-agent"
+	mysqlServer = "mysql/mysql-server"
 )
 
 // Images is the configuration of required MySQLOperator images. Remember to configure the appropriate
-// credentials for the target repositories. Image for mysqlServer is specified in ClusterSpec
+// credentials for the target repositories. The DefaultMySQLServerImage can be overridden on a per-cluster
+// basis by setting the Repository field.
 type Images struct {
-	MySQLAgentImage string `yaml:"mysqlAgent"`
+	MySQLAgentImage         string `yaml:"mysqlAgent"`
+	DefaultMySQLServerImage string `yaml:"defaultMysqlServer"`
 }
 
 // MySQLOperatorOpts holds the options for the MySQLOperator.
@@ -107,6 +110,9 @@ func (s *MySQLOperatorOpts) EnsureDefaults() {
 	if s.Images.MySQLAgentImage == "" {
 		s.Images.MySQLAgentImage = mysqlAgent
 	}
+	if s.Images.DefaultMySQLServerImage == "" {
+		s.Images.DefaultMySQLServerImage = mysqlServer
+	}
 	if s.MinResyncPeriod.Duration <= 0 {
 		s.MinResyncPeriod = metav1.Duration{Duration: 12 * time.Hour}
 	}
@@ -117,6 +123,7 @@ func (s *MySQLOperatorOpts) AddFlags(fs *pflag.FlagSet) *pflag.FlagSet {
 	fs.StringVar(&s.KubeConfig, "kubeconfig", s.KubeConfig, "Path to Kubeconfig file with authorization and master location information.")
 	fs.StringVar(&s.Master, "master", s.Master, "The address of the Kubernetes API server (overrides any value in kubeconfig).")
 	fs.StringVar(&s.Namespace, "namespace", metav1.NamespaceAll, "The namespace for which the MySQL operator manages MySQL clusters. Defaults to all.")
+	fs.StringVar(&s.Images.DefaultMySQLServerImage, "mysql-server-image", mysqlServer, "The name of the default target for the 'mysql-server' image (can be overridden on a per-cluster basis). Defaults to: "+mysqlServer+".")
 	fs.StringVar(&s.Images.MySQLAgentImage, "mysql-agent-image", s.Images.MySQLAgentImage, "The name of the target 'mysql-agent' image. Defaults to: iad.ocir.io/oracle/mysql-agent.")
 	fs.DurationVar(&s.MinResyncPeriod.Duration, "min-resync-period", s.MinResyncPeriod.Duration, "The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.")
 	return fs

pkg/resources/statefulsets/statefulset.go

@@ -344,8 +344,15 @@ func NewForCluster(cluster *v1alpha1.Cluster, images operatoropts.Images, servic
 		})
 	}
 
+	var serverImage string
+	if cluster.Spec.Repository != "" {
+		serverImage = cluster.Spec.Repository
+	} else {
+		serverImage = images.DefaultMySQLServerImage
+	}
+
 	containers := []v1.Container{
-		mysqlServerContainer(cluster, cluster.Spec.MySQLServerImage, rootPassword, members, baseServerID),
+		mysqlServerContainer(cluster, serverImage, rootPassword, members, baseServerID),
 		mysqlAgentContainer(cluster, images.MySQLAgentImage, rootPassword, members)}
 
 	podLabels := map[string]string{
@@ -399,8 +406,8 @@ func NewForCluster(cluster *v1alpha1.Cluster, images operatoropts.Images, servic
 		},
 	}
 
-	if cluster.Spec.ImagePullSecret != nil {
-		ss.Spec.Template.Spec.ImagePullSecrets = append(ss.Spec.Template.Spec.ImagePullSecrets, *cluster.Spec.ImagePullSecret)
+	if cluster.Spec.ImagePullSecrets != nil {
+		ss.Spec.Template.Spec.ImagePullSecrets = append(ss.Spec.Template.Spec.ImagePullSecrets, cluster.Spec.ImagePullSecrets...)
 	}
 	if cluster.Spec.VolumeClaimTemplate != nil {
 		ss.Spec.VolumeClaimTemplates = append(ss.Spec.VolumeClaimTemplates, *cluster.Spec.VolumeClaimTemplate)

pkg/resources/statefulsets/statefulset_test.go

@@ -292,10 +292,10 @@ func TestClusterWithOnlyMysqlServerResourceRequirements(t *testing.T) {
 func TestClusterEnterpriseImage(t *testing.T) {
 	cluster := &v1alpha1.Cluster{
 		Spec: v1alpha1.ClusterSpec{
-			MySQLServerImage: "some/image/path",
-			ImagePullSecret: &corev1.LocalObjectReference{
+			Repository: "some/image/path",
+			ImagePullSecrets: []corev1.LocalObjectReference{{
 				Name: "someSecretName",
-			},
+			}},
 		},
 	}
 	cluster.EnsureDefaults()
@@ -320,3 +320,30 @@ func TestClusterNoImage(t *testing.T) {
 
 	assert.Equal(t, v1alpha1.MysqlServer+":"+v1alpha1.DefaultVersion, si)
 }
+
+func TestClusterNoImageOperatorDefault(t *testing.T) {
+	cluster := &v1alpha1.Cluster{}
+	cluster.EnsureDefaults()
+
+	operatorConf := mockOperatorConfig()
+	operatorConf.Images.DefaultMySQLServerImage = "newDefaultImage"
+	statefulSet := NewForCluster(cluster, operatorConf.Images, "mycluster")
+
+	si := statefulSet.Spec.Template.Spec.Containers[0].Image
+
+	assert.Equal(t, "newDefaultImage:"+v1alpha1.DefaultVersion, si)
+}
+
+func TestClusterDefaultOverride(t *testing.T) {
+	cluster := &v1alpha1.Cluster{}
+	cluster.EnsureDefaults()
+	cluster.Spec.Repository = "OverrideDefaultImage"
+
+	operatorConf := mockOperatorConfig()
+	operatorConf.Images.DefaultMySQLServerImage = "newDefaultImage"
+	statefulSet := NewForCluster(cluster, operatorConf.Images, "mycluster")
+
+	si := statefulSet.Spec.Template.Spec.Containers[0].Image
+
+	assert.Equal(t, "OverrideDefaultImage:"+v1alpha1.DefaultVersion, si)
+}