Chapter 41. Installing the Operator Framework (Technology Preview)

Procedure

1. In the inventory file used to install and manage your OpenShift Container Platform cluster, add the openshift_additional_registry_credentials variable in the [OSEv3:vars] section, setting credentials required to pull the Operator containers:

   openshift_additional_registry_credentials=[{'host':'registry.connect.redhat.com','user':'<your_user_name>','password':'<your_password>','test_image':'mongodb/enterprise-operator:0.3.2'}]

   Set user and password to the credentials that you use to log in to the Red Hat Customer Portal at https://access.redhat.com.

   The test_image represents an image that will be used to test the credentials you provided.

2. Change to the playbook directory and run the registry authorization playbook using your inventory file to authorize your nodes using your credentials from the previous step:

   $ cd /usr/share/ansible/openshift-ansible
   $ ansible-playbook -i <inventory_file> \
      playbooks/updates/registry_auth.yml

3. Change to the playbook directory and run the OLM installation playbook using your inventory file:

   $ cd /usr/share/ansible/openshift-ansible
   $ ansible-playbook -i <inventory_file> \
      playbooks/olm/config.yml

4. Navigate to the cluster’s web console using a browser. A new section should now be available in the navigation on the left side of the page:

   Figure 41.2. New Operators navigation section

   

   This is where you can install Operators, grant projects access to them, and then launch instances for all of your environments.

Procedure

1. As a cluster administrator (a user with the cluster-admin role), create a new project in the OpenShift Container Platform web console for this procedure. This example uses a project called couchbase-test.

2. Installing an Operator within a project is done through a Subscription object, which the cluster administrator can create and manage across the entire cluster. To view the available Subscriptions, navigate to the Cluster Console from the drop-down menu, then to the Operators Catalog Sources screen in the left navigation.

   Note

   If you want to enable additional users to view, create, and manage Subscriptions in a project, they must have the admin and view roles for that project, as well as the view role for the operator-lifecycle-manager project. Cluster administrators can add these roles using the following commands:

   $ oc policy add-role-to-user admin <user> -n <target_project>
   $ oc policy add-role-to-user view <user> -n <target_project>
   $ oc policy add-role-to-user view <user> -n operator-lifecycle-manager

   This experience will be simplified in future releases of the OLM.

3. Subscribe the desired project to the Couchbase catalog source from either the web console or CLI.

   Choose one of the following methods:

   • For the web console method, ensure you are viewing the desired project, then click Create Subscription on an Operator from this screen to install it to the project.

   • For the CLI method, create a YAML file using the following definition:

     couchbase-subscription.yaml file

     apiVersion: operators.coreos.com/v1alpha1
     kind: Subscription
     metadata:
       generateName: couchbase-enterprise-
       namespace: couchbase-test 1
     spec:
       source: certified-operators
       name: couchbase-enterprise
       startingCSV: couchbase-operator.v1.0.0
       channel: preview

     1

     Ensure the namespace field in the metadata section is set to the desired project.

     Then, create the Subscription using the CLI:

     $ oc create -f couchbase-subscription.yaml

4. After the Subscription is created, the Operator then appears in the Cluster Service Versions screen, which is the catalog users can use to launch the software provided by the Operator. Click on the Couchbase Operator to view more details about this Operator’s features:

   Figure 41.3. Couchbase Operator overview

   

5. Before creating the Couchbase cluster, create a secret with the following definition using the web console or CLI that holds credentials for the super user account. The Operator reads this upon start up and configures the database with these details:

   Couchbase secret

   apiVersion: v1
   kind: Secret
   metadata:
     name: couchbase-admin-creds
     namespace: couchbase-test 1
   type: Opaque
   stringData:
     username: admin
     password: password

   1

   Ensure the namespace field in the metadata section is set to the desired project.

   Choose one of the following methods:

   • For the web console method, click Workloads Secrets from the left navigation, then click Create and choose Secret from YAML to enter the secret definition.

   • For the CLI method, save the secret definition to a YAML file (for example, couchbase-secret.yaml) and use the CLI to create it in the desired project:

     $ oc create -f couchbase-secret.yaml

6. Create the new Couchbase cluster.

   Note

   All users with the edit role in a given project can create, manage, and delete application instances (a Couchbase cluster, in this example) managed by Operators that have already been installed in the project, in a self-service manner, just like a cloud service. If you want to enable additional users with this ability, cluster administrators can add the role using the following command:

   $ oc policy add-role-to-user edit <user> -n <target_project>

   1. From the Cluster Service Versions section of the web console, click Create Couchbase Operator from the Operator’s Overview screen to begin creating a new CouchbaseCluster object. This object is a new type that the Operator has made available in the cluster. The object works similar to the built-in Deployment or ReplicaSet objects, but contains logic specific to managing Couchbase.

      Tip

      When clicking the Create Couchbase Operator button, you may receive a 404 error the first time. This is a known issue; as a workaround, refresh this page to continue. (BZ#1609731)

      The web console contains a minimal starting template, but you can read the Couchbase documentation for all of the features the Operator supports.

      Figure 41.4. Creating a Couchbase cluster

      

   2. Ensure that you configure the name of the secret that contains the admin credentials:

      apiVersion: couchbase.com/v1
      kind: CouchbaseCluster
      metadata:
        name: cb-example
        namespace: couchbase-test
      spec:
        authSecret: couchbase-admin-creds
        baseImage: registry.connect.redhat.com/couchbase/server
        [...]

   3. When you have finalized your object definition, click Create in the web console (or use the CLI) to create your object. This triggers the Operator to start up the pods, services, and other components of the Couchbase cluster.

7. Your project now contains a number of resources created and configured automatically by the Operator:

   Figure 41.5. Couchbase cluster details

   

   Click the Resources tab to verify that a Kubernetes service has been created that allows you to access the database from other pods in your project.

   Using the cb-example service, you can connect to the database using the credentials saved in the secret. Other application pods can mount and use this secret and communicate with the service.