This repository was archived by the owner on May 28, 2021. It is now read-only.

Support MySQL Enterprise #226

Merged

owainlewis merged 9 commits into master from bcb/SupportEnterpriseMYSQL

Oct 12, 2018

bencurrerburgess commented Sep 27, 2018 •

edited

Loading

These changes introduce the ability for users to use the enterprise edition of the MySQL server.

Added Image pull request field to the config for MySQL Clusters.
Added tutorial for creating an enterprise MySQL Cluster in the docs.

This allows for pulling of any valid MySQL image as long as the correct credentials are provided as a Kubernetes secret.

Images are now specified on a per-cluster basis allowing for one operator to handle creation of various MySQL Clusters.

bencurrerburgess requested review from prydie, templecloud and MadalinaPatrichi

September 28, 2018 08:09

prydie suggested changes

View reviewed changes

prydie left a comment

Great start 👍

pkg/options/operator/options.go Outdated

-              	MySQLAgentImage  string `yaml:"mysqlAgent"`
+              	MySQLServerImage string                   `yaml:"mysqlServer"`
+              	MySQLAgentImage  string                   `yaml:"mysqlAgent"`
+              	ImagePullSecret  *v1.LocalObjectReference `yaml:"imagePullSecret"`

prydie Sep 28, 2018

This should be configured on the MySQLCluster CRD IMO 🙂

examples/example-enterprise-deployment.yaml Outdated

+              data:
+                mysql-operator-config.yaml: |
+                  images:
+                    mysqlServer: store/oracle/mysql-enterprise-server #Enterprise sql image

prydie Sep 28, 2018

We should add an Image field to the Cluster CRD to let users choose enterprise on a per MySQL cluster basis.

Member

owainlewis Oct 1, 2018

This is a good idea here as it brings the benefit of having a per cluster MySQL and also having patched custom MySQL images. It's almost a separate PR and feature in it's own right.

Member

owainlewis Oct 1, 2018

When going down this route we'll need to double check and make sure we update documentation and check existing code doesn't reference two sources of the image.

examples/example-enterprise-deployment.yaml Outdated

		@@ -0,0 +1,287 @@
		# 01 - Custom resources

prydie Sep 28, 2018

We don't want to need to maintain another set of manifests. We should add an option to the helm chart for setting the default image that the operator uses and then get users to install via helm.

bcurrerb added 4 commits

October 2, 2018 12:22


          Added support and documentation for MYSQL Enterprise

7e444b5


          formatting fix

e0a5ded


          Moved custom mysql server image from operator spec to cluster spec

ce721f9


          Added unit tests for ensuring server image default

d5d2694

bencurrerburgess force-pushed the bcb/SupportEnterpriseMYSQL branch from 7c4372a to d5d2694 Compare

October 2, 2018 11:23

owainlewis added enhancement feature labels

owainlewis reviewed

View reviewed changes

pkg/resources/statefulsets/statefulset_test.go Outdated


		func TestClusterWithOnlyMysqlServerResourceRequirements(t *testing.T) {

Member

owainlewis Oct 4, 2018

Did you mean to delete these tests?

owainlewis reviewed

View reviewed changes

pkg/resources/statefulsets/statefulset_test.go Outdated

@@ @@ -223,67 +224,34 @@ func TestClusterWithTolerations(t *testing.T) { @@
               	}
               }
-              func TestClusterWithResourceRequirements(t *testing.T) {

Member

owainlewis Oct 4, 2018

Did you mean to delete these tests?

owainlewis reviewed

View reviewed changes

docs/enterprise-edition-example.md Outdated

		@@ -0,0 +1,54 @@
		# Enterprise edition tutorial
		This tutorial will explain how to create a mysqlcluster that runs the enterprise version of mysql.

Member

owainlewis Oct 4, 2018

mysqlcluster => MySQL cluster (?)
mysql => MySQL

owainlewis reviewed

View reviewed changes

docs/enterprise-edition-example.md Outdated

+              ## Prerequisites
+              - The mysql-operator repository checked out locally.
+              - Access to a Docker registry that contains the enterprise version of mysql.

Member

owainlewis Oct 4, 2018

mysql => MySQL

owainlewis reviewed

View reviewed changes

docs/enterprise-edition-example.md Outdated

+              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.

Member

owainlewis Oct 4, 2018 •

edited

Loading

mysql enterprise edition => MySQL Enterprise Edition
docker => Docker

owainlewis reviewed

View reviewed changes

docs/enterprise-edition-example.md Outdated

+              - 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.

Member

owainlewis Oct 4, 2018

mysql enterprise => MySQL Enterprise

owainlewis reviewed

View reviewed changes

docs/enterprise-edition-example.md Outdated

+              - 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.
+              >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).

Member

owainlewis Oct 4, 2018

Typo: secretes => secrets

owainlewis reviewed

View reviewed changes

docs/enterprise-edition-example.md Outdated


		>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).

		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.

Member

owainlewis Oct 4, 2018

. add the => Add the ...

owainlewis reviewed

View reviewed changes

docs/enterprise-edition-example.md Outdated

+              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.

Member

owainlewis Oct 4, 2018

docker registry => Docker registry

owainlewis reviewed

View reviewed changes

docs/enterprise-edition-example.md Outdated

+              kubectl apply -f examples/cluster/cluster-enterprise-version.yaml
+              ```
+              ### Check that it is running
+              You can now run the following command to access the sql prompt in your MySQL Cluster, just replace `<NAMESPACE>` with the namespace you created your cluster in.

Member

owainlewis Oct 4, 2018

sql => SQL

owainlewis suggested changes

View reviewed changes

Member

owainlewis left a comment

I like the design around setting the pull secret and image as part of the cluster spec. Some minor comments but overall looking great.

prydie suggested changes

View reviewed changes

prydie left a comment

Looking good 👍

pkg/apis/mysql/v1alpha1/types.go Outdated

@@ @@ -27,6 +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"`

prydie Oct 4, 2018

I suggest we call this field Repository

pkg/options/operator/options.go Show resolved Hide resolved

pkg/apis/mysql/v1alpha1/types.go Outdated

+              	MySQLServerImage string `json:"mysqlServer"`
+              	// ImagePullSecret defines the name of the secret that contains the
+              	// required credentials for pulling the MySQLServerImage.
+              	ImagePullSecret *v1.LocalObjectReference `json:"imagePullSecret"`

prydie Oct 4, 2018

I suggest we implement as []v1.LocalObjectReference as in the core.

From v1.PodSpec:

// ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
// If specified, these secrets will be passed to individual puller implementations for them to use. For example,
// in the case of docker, only DockerConfig type secrets are honored.
// More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
// +optional
// +patchMergeKey=name
// +patchStrategy=merge
ImagePullSecrets []LocalObjectReference `json:"imagePullSecrets,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,15,rep,name=imagePullSecrets"`

bcurrerb added 3 commits

October 4, 2018 11:02


          Fixed rebase

83c4da0


          Allow MySQL server image default to be specified in operator config

e8328a6


          Fixed formating and test

eb5daf6

bencurrerburgess force-pushed the bcb/SupportEnterpriseMYSQL branch from 6576170 to eb5daf6 Compare

October 4, 2018 13:28

prydie suggested changes

View reviewed changes

prydie left a comment

Nearly there 😄

pkg/apis/mysql/v1alpha1/types.go Outdated

@@ @@ -15,6 +15,7 @@ @@
               package v1alpha1
               import (
+              	"k8s.io/api/core/v1"

prydie Oct 4, 2018

Already imported as corev1 below

pkg/apis/mysql/v1alpha1/types.go Outdated

@@ @@ -27,6 +28,11 @@ const MinimumMySQLVersion = "8.0.11" @@
               type ClusterSpec struct {
               	// Version defines the MySQL Docker image version.
               	Version string `json:"version"`
+              	// Repository defines the image to be pulled for the MySQL server.

prydie Oct 4, 2018

s/image/image repository/

pkg/options/operator/options.go Outdated

		mysqlAgent = "iad.ocir.io/oracle/mysql-agent"
		mysqlServer = "mysql/mysql-server"

prydie Oct 4, 2018

Instead of redefining this here use the value from the v1alpha1 pkg.

pkg/apis/mysql/v1alpha1/helpers.go Show resolved Hide resolved

pkg/resources/statefulsets/statefulset.go Outdated

               		})
               	}
+              	var serverImage string
+              	if cluster.Spec.Repository != "" {

prydie Oct 4, 2018

This defaulting will be redundant if we can manage to default in Cluster.EnsureDefaults()

pkg/options/operator/options.go Outdated

    
            @@ -122,7 +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.MySQLServerImage, "mysql-server-image", s.Images.MySQLServerImage, "The name of the target 'mysql-server' image. Defaults to: mysql/mysql-server.")

              	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+".")

prydie Oct 4, 2018

s/mysqlServer/s.Images.DefaultMySQLServerImage/

bcurrerb added 2 commits

October 9, 2018 15:37


          Fixed test and defaulting

eefb0cc


          Merge branch 'bcb/SupportEnterpriseMYSQL' of github.com:oracle/mysql-…

d68b5a7

…operator into bcb/SupportEnterpriseMYSQL

prydie approved these changes

View reviewed changes

prydie left a comment

One tiny nit pick but once that's cleaned up go ahead and merge - awesome work 🎉

Another thought: Should we include an E2E test or two for enterprise?

pkg/apis/mysql/v1alpha1/helpers.go

               	defaultMembers      = 3
               	defaultBaseServerID = 1000
               	// maxBaseServerID is the maximum safe value for BaseServerID calculated
               	// as max MySQL server_id value - max Replication Group size.
               	maxBaseServerID uint32 = 4294967295 - 9
+              	// MysqlServer is the image to use if no image is specified explicitly by the user.
+              	MysqlServer = "mysql/mysql-server"

prydie Oct 9, 2018

s/MysqlServer/DefaultRepository/

owainlewis approved these changes

View reviewed changes

owainlewis removed request for templecloud and MadalinaPatrichi

October 12, 2018 13:50

owainlewis self-assigned this

owainlewis merged commit c0ef271 into master

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

enhancement feature