The following are definition files that will be used by the Operator to create your cluster. Create new definition files and copy and paste the contents of each code block into those files.

deployment.yaml

Create a deployment definition file using the template below.

For --cluster-id, enter the name of your cluster. This will be the name used in the memsql-cluster.yaml file as per:

metadata:
name: memsql-cluster

apiVersion: apps/v1
kind: Deployment
metadata:
  name: memsql-operator
spec:
  replicas: 1
  selector:
    matchLabels:
      name: memsql-operator
  template:
    metadata:
      labels:
        name: memsql-operator
    spec:
      serviceAccountName: memsql-operator
      containers:
        - name: memsql-operator
          image: "OPERATOR_IMAGE"
          imagePullPolicy: Always
          args: [
            # Cause the operator to merge rather than replace annotations on services
            "--merge-service-annotations",
            # Allow the process inside the container to have read/write access to the `/var/lib/memsql` volume.
            "--fs-group-id", "5555",
            "--cluster-id", "<<--- ENTER NAME OF CLUSTER--->>"
          ]
          env:
            - name: WATCH_NAMESPACE
              valueFrom:
                fieldRef:
                  fieldPath: metadata.namespace
            - name: POD_NAME
              valueFrom:
                fieldRef:
                  fieldPath: metadata.name
            - name: OPERATOR_NAME
              value: "memsql-operator"

You must edit this file and replace OPERATOR_IMAGE with the either the local memsql/operator Docker image you pulled down (such as "memsql-operator"), or add in an imagePullSecrets section under the spec section and reference a Kubernetes Secret that you can create via kubectl apply.

Refer to the Kubernetes documentation for more information on imagePullPolicy and creating Secrets.

rbac.yaml

Copy the following to create a ServiceAccount definition file that will be used by the Operator.

apiVersion: v1
kind: ServiceAccount
metadata:
  name: memsql-operator
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: memsql-operator
rules:
- apiGroups:
  - ""
  resources:
  - pods
  - services
  - endpoints
  - persistentvolumeclaims
  - events
  - configmaps
  - secrets
  verbs:
  - '*'
- apiGroups:
  - policy
  resources:
  - poddisruptionbudgets
  verbs:
  - '*'
- apiGroups:
  - batch
  resources:
  - cronjobs
  verbs:
  - '*'
- apiGroups:
  - ""
  resources:
  - namespaces
  verbs:
  - get
- apiGroups:
  - apps
  - extensions
  resources:
  - deployments
  - daemonsets
  - replicasets
  - statefulsets
  - statefulsets/status
  verbs:
  - '*'
- apiGroups:
  - memsql.com
  resources:
  - '*'
  verbs:
  - '*'
- apiGroups:
  - networking.k8s.io
  resources:
  - networkpolicies
  verbs:
  - '*'
- apiGroups:
  - coordination.k8s.io
  resources:
  - leases
  verbs:
  - get
  - list
  - watch
  - create
  - update
  - patch
  - delete
---
kind: RoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: memsql-operator
subjects:
- kind: ServiceAccount
  name: memsql-operator
roleRef:
  kind: Role
  name: memsql-operator
  apiGroup: rbac.authorization.k8s.io

memsql-cluster-crd.yaml

Create a CustomResourceDefinition file to define the MemSQLCluster resource type.

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: memsqlclusters.memsql.com
spec:
  group: memsql.com
  names:
    kind: MemsqlCluster
    listKind: MemsqlClusterList
    plural: memsqlclusters
    singular: memsqlcluster
    shortNames:
      - memsql
  scope: Namespaced
  versions:
  - name: v1alpha1
    served: true
    storage: true
    schema:
      openAPIV3Schema:
        description: Schema for the SingleStore Cluster
        properties:
          apiVersion:
            description: 'APIVersion defines the versioned schema of this representation
              of an object. Servers should convert recognized schemas to the latest
              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
            type: string
          kind:
            description: 'Kind is a string value representing the REST resource this
              object represents. Servers may infer this from the endpoint the client
              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
            type: string
          metadata:
            type: object
          spec:
            description: Spec defines the desired state of Cluster
            type: object
            x-kubernetes-preserve-unknown-fields: true
          status:
            description: Status defines the observed state of Cluster
            type: object
            x-kubernetes-preserve-unknown-fields: true
        type: object
    subresources:
      status: {}
    additionalPrinterColumns:
    - name: Aggregators
      type: integer
      description: Number of MemSQL Aggregators
      jsonPath: .status.expectedAggregators
    - name: Leaves
      type: integer
      description: Number of MemSQL Leaves (per availability group)
      jsonPath: .status.expectedLeaves
    - name: Redundancy Level
      type: integer
      description: Redundancy level of MemSQL Cluster
      jsonPath: .spec.redundancyLevel
    - name: Age
      type: date
      jsonPath: .metadata.creationTimestamp

memsql-cluster.yaml

Create a MemSQLCluster definition file to specify the configuration settings for your cluster.

apiVersion: memsql.com/v1alpha1
kind: MemsqlCluster
metadata:
  name: memsql-cluster
spec:
  license: LICENSE_KEY
  adminHashedPassword: "HASHED_PASSWORD"
  nodeImage:
    repository: memsql/node
    tag: centos-6.8.24-8e110b7bed

  redundancyLevel: 1

  serviceSpec:
    objectMetaOverrides:
      labels:
        custom: label
      annotations:
        custom: annotations

  aggregatorSpec:
    count: 3
    height: 0.5
    storageGB: 256
    storageClass: standard

    objectMetaOverrides:
      annotations:
        optional: annotation
      labels:
        optional: label

  leafSpec:
    count: 1
    height: 1
    storageGB: 1024
    storageClass: standard

    objectMetaOverrides:
      annotations:
        optional: annotation
      labels:
        optional: label

You must edit the following placeholders in this file to properly set up your cluster:

• Change the name value to the cluster name of your choice.

• Specify your license key and a hashed version of a secure password for the admin database user on the cluster. The admin user is the default user you can use when logging into your cluster. The account is created by the Operator during cluster deployment and has an explicit set of grants (defined at the end of this step) to reduce the scope of this user.

  Note that, as of SingleStore DB 7.1.4, license checks are now cgroup-aware and respect container resource boundaries for containerized deployments. While this does not change how license checks are performed, nor does it change how capacity is allocated, it does change how the resources allocated to the container are checked.

  To include the license key and hashed password, you have the following two options:

  • Replace LICENSE_KEY with your license key from the SingleStore Customer Portal and change HASHED_PASSWORD to a hashed version of a secure password for the admin database user on the cluster. The following Python script shows how to create a hashed password. Note that the asterisk (*) must be included in the final password.

    from hashlib import sha1
    print("*" + sha1(sha1('secretpass'.encode('utf-8')).digest()).hexdigest().upper())
    

  • Use Kubernetes secrets to pass in the license key and hashed passwords. You will need one or two secrets (they can be separate or the same secret) with the keys set to the correct values. Note: The password still needs to be hashed inside the secret. It cannot be a bare password.

    licenseSecret:
      name: "my-secret"
      key: "license"
    adminHashedPasswordSecret:
      name: "my-secret"
      key: "password"
    

• Under nodeImage, tag specifies the version of memsql/node that will be deployed in your cluster. This value aligns with the version number of the MemSQL/SingleStore DB database engine that is running in the container (e.g. centos-6.8.24-8e110b7bed contains the 6.8.24 version of MemSQL).

  You can use different versions of the engine by going to the Docker Hub page for memsql/node and selecting a different tag. Because of recent updates to the memsql/node container, you should select a tag that is 6.8.9-24b9cbd386 or newer. Also, running different versions of the MemSQL/SingleStore DB engine in one cluster is not supported, so you must ensure that each node in your Kubernetes cluster has the same tag value.

• Change redundancyLevel to 2 if you want to enable high availability. It is highly recommended you set this value to 2 for production deployments. Note: You must have an even number of leaf nodes to enable high availability. Refer to Managing High Availability for more information.

• The objectMetaOverrides sections are optional. By including these sections, you can override the metadata annotations and labels at either the node or service layer (objectMetaOverrides).

• Change count to alter the number of aggregator or leaf nodes in your cluster.

• The height value specifies the vCPU and RAM size of an aggregator or leaf node where a height of 1 equals 8 vCPU cores and 32 GB of RAM. The smallest value you can set is 0.5 (4 vCPU cores, 16 GB of RAM).

• The storageGB value corresponds to the amount of storage each aggregator or leaf should request for their persistent data volume.

• The storageClass value specifies which storage class to use for the PersistedVolume in the Kubernetes cluster. You should change this value to align with the default (or custom) storage class available to your cluster.

• Users may declare an envVariables section. This is an optional section that allows environment variables to be specified. The currently supported environment variables include:

  • MALLOC_ARENA_MAX

  envVariables:
    MALLOC_ARENA_MAX: 4
  

Once you have finished creating your definition files, you can deploy your cluster.

Was this Article Helpful?

Thanks For Your Feedback!