{"id":6914,"date":"2019-05-14T21:16:37","date_gmt":"2019-05-15T04:16:37","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=6914"},"modified":"2025-06-13T21:33:43","modified_gmt":"2025-06-14T04:33:43","slug":"quick-start-with-helm","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/quick-start-with-helm\/","title":{"rendered":"Quick Start: Deploy Couchbase Autonomous Operator With Helm"},"content":{"rendered":"

What\u2019s Helm?<\/span><\/h2>\n

Helm is a tool that streamlines the installation and management of applications on Kubernetes platforms. The Couchbase Autonomous Operator helm chart allows users to combine Kubernetes definitions for resources like Services, Roles, and Deployments into a single customizable package. \u00a0Since Helm is essentially a package manager for Kubernetes applications, all installed resources can be managed and updated as a single unit using an all-or-nothing approach which ensures every dependency needed for each release is successfully installed when upgrading.\u00a0This blog describes how to use Helm for installing the Couchbase Autonomous Operator along with a Couchbase Cluster into your Kubernetes environment.<\/span><\/p>\n

 <\/p>\n

Installing Helm<\/span><\/h2>\n

Assuming you have a kubernetes cluster running on at least version 1.11, then you\u2019re all set to get started with helm for deploying a Couchbase Cluster. \u00a0The first step is to install the Helm command line client. The following commands will download and unpack the helm binary to an executable path for linux (for a different OS see <\/span>releases<\/span><\/a>)<\/span><\/p>\n

# Install helm\r\nwget https:\/\/storage.googleapis.com\/kubernetes-helm\/helm-v2.13.1-linux-amd64.tar.gz\r\ntar -zxvf helm-v2.13.1-linux-amd64.tar.gz\r\nsudo mv linux-amd64\/helm \/usr\/local\/bin\/helm\r\n\r\n<\/pre>\n
Now let’s install Helms templating service which is called `tiller`<\/strong><\/em>. Tiller does all the work of interacting directly with the Kubernetes API for creating resources like Services, Secrets, and Pods. \u00a0As with every good quick-start guide, we\u2019re going to be a bit loose with security for the sake of brevity, which means giving the `tiller` service the ability to create resources within any Kubernetes namespace. \u00a0<\/span>Run the following command to create the RBAC rules and ServiceAccount needed for the Tiller service:<\/span><\/p>\n
echo \"apiVersion: v1\r\nkind: ServiceAccount\r\nmetadata:\r\n  name: tiller\r\n  namespace: kube-system\r\n---\r\napiVersion: rbac.authorization.k8s.io\/v1\r\nkind: ClusterRoleBinding\r\nmetadata:\r\n  name: tiller\r\nroleRef:\r\n  apiGroup: rbac.authorization.k8s.io\r\n  kind: ClusterRole\r\n  name: cluster-admin\r\nsubjects:\r\n  - kind: ServiceAccount\r\n    name: tiller\r\n    namespace: kube-system\" | kubectl create -f -\r\n<\/pre>\n
Finally install the tiller service into the kubernetes cluster:<\/span><\/p>\n
helm init --service-account tiller<\/pre>\n
Time to start helming!<\/p>\n
Installing Charts<\/span><\/h2>\n
Install the Operator Chart<\/span><\/h2>\n
The Couchbase Operator Chart deploys the dynamic admission controller, the Operator itself, and every resource needed to run them within your cluster. \u00a0This is the power\/magic of helm, as it functions very similar to a package manager by representing a group of resources as a single installable, and upgradeable unit.<\/span><\/p>\n
To install the charts you will need to point the helm client to our partner repository with the following command:<\/span><\/p>\n
helm repo add couchbase https:\/\/couchbase-partners.github.io\/helm-charts\/<\/pre>\n
And now let\u2019s install the operator chart:<\/span><\/p>\n
helm install --name op-example couchbase\/couchbase-operator<\/pre>\n
The install returns a list of commands to run for checking logs of the operator. \u00a0<\/span><\/p>\n
NOTES: \r\n\r\n1. couchbase-operator deployed. Check the couchbase-operator logs\r\nkubectl logs -f deployment\/op-example-couchbase-operator --namespace default \r\n\r\n2. admission-controller deployed. Check the admission-controller logs\r\nkubectl logs -f deployment\/op-example-couchbase-admission-controller --namespace default<\/pre>\n
Copy the first command to ensure that the operator has started successfully:<\/span><\/p>\n
kubectl logs -f deployment\/op-example-couchbase-operator --namespace default<\/pre>\n
And you should see that the operator is listening for events, which means that it’s waiting for a cluster to manage:<\/p>\n
time=\"2019-05-02T23:42:12Z\" level=info msg=\"couchbase-operator v1.2.0 (release)\" module=main\r\n...\r\ntime=\"2019-05-02T23:42:28Z\" level=info msg=\"CRD initialized, listening for events...<\/pre>\n
 <\/p>\n
Install the Couchbase Cluster Chart<\/span><\/h2>\n
The couchbase cluster chart provides a templated version of the couchbase cluster type. \u00a0By default, this chart will install a 3 node cluster. If you\u2019re curious about the details of this chart you can view the default values with the following command:<\/span><\/p>\n
helm inspect couchbase\/couchbase-cluster<\/pre>\n
Now let\u2019s get a cluster running by installing the cluster chart with the following command:<\/span><\/p>\n
helm install --name cb-example couchbase\/couchbase-cluster<\/pre>\n
The install returns steps to get status of the cluster along with a quick way to view the Admin console.\u00a0<\/span><\/p>\n
NOTES: \r\n1. Get couchbase cluster status \u00a0\r\nkubectl describe --namespace default couchbasecluster cb-example-couchbase-cluster \r\n\r\n2. Connect to Admin console \u00a0\r\nkubectl port-forward --namespace default cb-example-couchbase-cluster-0000 8091:8091 \u00a0# open https:\/\/localhost:8091<\/pre>\n
\u00a0Let\u2019s run the 2nd command to view the console:<\/span><\/p>\n
kubectl port-forward --namespace default cb-example-couchbase-cluster-0000 8091:8091\r\n<\/pre>\n
This command will create a proxy of the Admin console to your localhost at port 8091. Navigate to <\/span>https:\/\/localhost:8091<\/span><\/a> to view the cluster. \u00a0If you do not yet see the cluster, run kubectl describe po cb-example-couchbase-cluster-0000<\/span>\u00a0 to get status of the Pod being forwarded because it may be that images are still being created, which is often the case when running on a brand new cluster.<\/span><\/p>\n
Managing Charts<\/span><\/h2>\n
At this point you should have at least two charts installed, one for the operator and another for the cluster. \u00a0To view the list of installed charts run helm list<\/code>:<\/p>\n
~$ helm list\r\n\r\nNAME      \tREVISION\tUPDATED                 \tSTATUS  \tCHART                   \tAPP VERSION\tNAMESPACE\r\ncb-example\t1       \tThu May  9 23:44:31 2019\tDEPLOYED\tcouchbase-cluster-0.1.2 \t1.2        \tdefault  \r\nop-example\t1       \tThu May  9 23:40:36 2019\tDEPLOYED\tcouchbase-operator-0.1.2\t1.2        \tdefault<\/pre>\n
When a chart is installed it is referred to by Helm as a\u00a0release<\/code>. You can install multiple releases from a single chart. When a release is deleted using helm delete<\/code>, all of it’s packaged resources (Pods, Services, Secrets) are also deleted. \u00a0For more information about customizing the operator and cluster chart, refer to the Couchbase Operator documentation on Updating a Release<\/a>.<\/p>\n
Installing with TLS and Persistent Volumes<\/span><\/h2>\n
To create a cluster with TLS and Persistent Volumes we\u2019ll use helm\u2019s template overriding to provide customizations of the cluster chart.<\/span><\/p>\n
Create a file named myvalues.yaml<\/code> with the following values:<\/span><\/p>\n
echo \"couchbaseCluster:\r\n  servers:\r\n    all_services:\r\n      pod:\r\n        volumeMounts:\r\n          default: couchbase\r\n          data:  couchbase\r\n  securityContext:\r\n    fsGroup: 1000\r\n  volumeClaimTemplates:\r\n    - metadata:\r\n        name: couchbase\r\n      spec:\r\n        storageClassName: default\r\n        resources:\r\n          requests:\r\n            storage: 1Gi\r\ncouchbaseTLS:\r\n  create: true\" > myvalues.yaml\r\n<\/pre>\n
The above values assume you have a storage class named `default`, if this is not the case then change it to the appropriate value for your environment. \u00a0Now install the cluster chart with the value overrides:<\/span><\/p>\n
helm install \u00a0--name cbs-example -f myvalues.yaml couchbase\/couchbase-cluster<\/pre>\n
Notice helm auto-generated the CA cert used by the operator and clients along with the server cert and key.<\/span><\/p>\n
RESOURCES:\r\n==> v1\/Secret\r\nNAME \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0AGE\r\ncbs-example-couchbase-cluster \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a01s\r\ncbs-example-couchbase-cluster-server-tls \u00a0\u00a0\u00a01s\r\ncbs-example-couchbase-cluster-operator-tls \u00a01s<\/pre>\n
To view the Admin console, run the port forward command from the TLS enabled admin port (18091) of a pod to your localhost with the following command:<\/span><\/p>\n
kubectl port-forward --namespace default cbs-example-couchbase-cluster-0000 18091:18091<\/pre>\n
Navigate to <\/span>https:\/\/localhost:18091<\/span><\/a> to view the cluster.<\/span><\/p>\n
Moving on<\/span><\/h2>\n
If you\u2019re thinking, \u201cthat was too easy,\u201d you\u2019re probably right. \u00a0If you\u2019re thinking, \u201cI want to know more\u201d, then have a look at the Setup Guide<\/a> for best practices on taking your environment in to production!<\/p>\n
More Couchbase Autonomous Operator Resources<\/h4>\n