Create Custom Resource in Kubernetes Service

The NCache Operator utilizes a declarative model to manage the lifecycle of your cache clusters. By defining a Custom Resource (CR) file, you establish the Desired State of your NCache deployment within the Kubernetes ecosystem. The Operator continuously monitors this resource to automate provisioning, scaling, and licensing. To grant the Operator the necessary instructions, you must create and deploy a YAML manifest that specifies cluster parameters, resource limits, and environment-specific configurations.

Create Manifest File for Custom Resources

The ncache_custom_resource.yaml file lists the desired state of your Kubernetes service cluster under the spec section.

Note

The parameters required to create this YAML file, ready to be deployed, are explained in the Properties section.

kind: NCache
apiVersion: alachisoft.ncache/v1
metadata:a
  name: ncache
spec:
  # Add fields here
  clusterSize: 1
  image: enterprise-server-5.2-linux   # NCache container image
  nodeSelector:
    kubernetes.io/os: linux
  podRequests:
    memory: "512Mi"
    cpu: 1
  podLimits:
    memory: "512Mi"
    cpu: 1
  debug:
    enable: false
  parameters:
    '{"registrationInfo": {"email": "john_smith@yourcompany.com","firstName": "John","lastName": "Smith","company": "Your Company","environment": "Production","clientLicenses": "8", "licenseKey": "xxxxxxx-xxxxxxx-xxxxxxx"}}'
Note

You can provide Evaluation Key instead of License Key in the parameters section to activate NCache in evaluation mode. "evaluationKey": "xxxxxxxxxxxxxxxxxxxxxxxxxx"

Deploy Custom Resources Using Kubernetes Service

To deploy the desired state specified in the ncache_custom_resource.yaml, you need to execute the following command in the cloud shell:

kubectl create -f [dir]/ncache_custom_resource.yaml

On execution of this command, Operator will activate your NCache Kuberenetes Service cluster using the registration information provided in the custom resource file.

For verification, run the following command:

kubectl get pods -w

Properties

The properties required to create and deploy a custom resource in your kubernetes service cluster are explained below:

Parameter Description
-kind Specifies the kind of the custom resource to deploy. In this case, it is NCache.
-apiVersion Specifies the version of the custom resource that is to be deployed in Kubernetes.
-name Specifies the name of the deployment.
-clusterSize Specifies the number of servers of NCache cluster.
-image Specifies the path of the container image of NCache.
-nodeSelector Specifies the node on which the underlying container needs to be hosted.
-podRequests Specifies the limits on requests required at the time of scheduling.
-podLimits Specifies the limits on pods. If this is not provided, the pod will use the maximum memory and CPU limit.
-parameters Specifies the registration information to install NCache in the container.

See Also

Create Service Account
Create Role Binding
Create Role Definition
Create NCache Operator