cbopcfg
cbopcfg
is a command-line tool that is provided in the Couchbase Autonomous Operator package.
It is used to generate resource configuration to quickly configure and run the Operator.
The cbopcfg
is not intended to allow configuration of every aspect of the Operator.
We provide Helm charts to allow more complex deployment scenarios.
Installation
Make sure that you have downloaded the Operator package and unpacked it.
After you unpack the download, the resulting directory will be titled something like couchbase-autonomous-operator-kubernetes_x.x.x-linux_x86_64
.
-
Open a Terminal window and go to the directory where the
cbopcfg
binary is located:$ cd couchbase-autonomous-operator-kubernetes_x.x.x-macos_x86_64/bin/
-
Make the
cbopcfg
binary executable:$ chmod +x ./cbopcfg
-
Move the binary into your PATH:
$ sudo mv ./cbopcfg /usr/local/bin/cbopcfg
-
Open a command prompt and go to the directory where the
cbopcfg
binary is located:$ cd couchbase-autonomous-operator-kubernetes_x.x.x-linux_x86_64/bin/
-
Make the
cbopcfg
binary executable:$ chmod +x ./cbopcfg
-
Move the binary into your PATH:
$ sudo mv ./cbopcfg /usr/local/bin/cbopcfg
-
Open a command prompt and go to the directory where the
cbopcfg
binary is located:$ cd couchbase-autonomous-operator-kubernetes_x.x.x-windows_x86_64\bin\
-
Add the
cbopcfg
binary into your PATH.
Options
- --namespace <string>
-
If specified this will override the default namespace
default
. Specifying the namespace is especially important when installing the dynamic admission controller as this flag affects TLS certificate generation. - --operator-image <string>
-
If specified this will override the default operator image
couchbase/operator:2.0.3
. - --dynamic-admission-controller-image <string>
-
If specified this will override the default admission controller image
couchbase/admission-controller:2.0.3
. - --image-pull-secret <string>
-
If specified this will add the image pull secret name to all deployments. This is required when pulling images from private container repositories such as the Red Hat container registry.
- --no-operator
-
If specified the command will not emit operator configuration.
- --no-admission
-
If specified the command will not emit admission controller configuration.
- --file
-
If specified individual YAML files are created rather than all output going to the console.
Examples
To create configuration to run the operator in the default
namespace.
$ cbopcfg | kubectl create -f -
To create a configuration file:
$ cbopcfg > operator.yaml
To create configuration to run on Red Hat Openshift:
$ cbopcfg --namespace myproject --image-pull-secret my-redhat-docker-credentials > operator.yaml