Operator Lifecycle Manager

Difficulty: beginner

Estimated Time: 30 minutes

The Operator Lifecycle Manager project is a component of the Operator Framework, an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way.

OLM extends Kubernetes to provide a declarative way to install, manage, and upgrade operators and their dependencies in a cluster.

It also enforces some constraints on the components it manages in order to ensure a good user experience.

OLM enables users to do the following:

Define applications as a single Kubernetes resource that encapsulates requirements and metadata.
Install applications automatically with dependency resolution or manually with nothing but kubectl.
Upgrade applications automatically with different approval policies.

For more information, check out the links below:

Git Hub

Operator-Framework: https://github.com/operator-framework
Operator Lifecycle Manager: https://github.com/operator-framework/operator-lifecycle-manager/

Chat

Kubernetes Slack Chat (upstream): #kubernetes-operators at https://kubernetes.slack.com/
Operator-Framework on Google Groups: https://groups.google.com/forum/#!forum/operator-framework
OpenShift Operators Special Interest Group (SIG): https://commons.openshift.org/sig/OpenshiftOperators.html

Your environment is currently being packaged as a Docker container and the download will begin shortly. To run the image locally, once Docker has been installed, use the commands

cat scrapbook_openshift/operatorframework_operator-lifecycle-manager-311_container.tar | docker load

docker run -it /openshift/operatorframework_operator-lifecycle-manager-311:20210725

Restart Scenario

Next Scenario

Step 1 of 5

Setting Up OLM

The Operator Lifecycle Manager is not installed in our current Katacoda OpenShift environment. We will now install it from scratch by deploying the following objects:

CustomResourceDefinitions:
- Subscription, InstallPlan, CatalogSource, ClusterServiceVersion
Namespace:
- openshift-operator-lifecycle-manager
Service Account:
- olm-operator-serviceaccount
ClusterRole:
- system:controller:operator-lifecycle-manager
ClusterRoleBinding:
- olm-operator-binding-openshift-operator-lifecycle-manager
CatalogSource:
- rh-operators
ConfigMap:
- rh-operators
Deployments:
- olm-operator, catalog-operator, package-server

Note: The initial setup of the Operator Lifecycle Manager (OLM) is a one-time task and is reserved for Kubernetes administrators with cluster-admin privileges. Once OLM is properly setup, Kubernetes administrators can then delegate Operator install privileges to non-admin Kubernetes users.

Let's get started by cloning the official OLM repository:

git clone https://github.com/operator-framework/operator-lifecycle-manager

Create the dedicated openshift-operator-lifecycle-manager Namespace:

oc create -f operator-lifecycle-manager/deploy/ocp/manifests/0.7.2/0000_30_00-namespace.yaml

Verify the Namespace was successfully created:

oc get namespaces openshift-operator-lifecycle-manager

Create the olm-operator-serviceaccount Service Account, system:controller:operator-lifecycle-manager ClusterRole, and olm-operator-binding-openshift-operator-lifecycle-manager ClusterRoleBinding:

oc create -f operator-lifecycle-manager/deploy/ocp/manifests/0.7.2/0000_30_01-olm-operator.serviceaccount.yaml

Verify the Service Account, ClusterRole, and ClusterRoleBinding were successfully created:

oc -n openshift-operator-lifecycle-manager get serviceaccount olm-operator-serviceaccount

oc get clusterrole system:controller:operator-lifecycle-manager

oc get clusterrolebinding olm-operator-binding-openshift-operator-lifecycle-manager

Create the OLM Custom Resource Definitions (Subscription, InstallPlan, CatalogSource, ClusterServiceVersion):

for num in {02..05}; do oc create -f operator-lifecycle-manager/deploy/ocp/manifests/0.7.2/0000_30_$num*; done

Verify all four OLM CRDs are present:

oc get crds

Create the internal rh-operators CatalogSource and rh-operators ConfigMap which contains manifests for some popular Operators:

for num in {06,09}; do oc create -f operator-lifecycle-manager/deploy/ocp/manifests/0.7.2/0000_30_$num*; done

Verify the CatalogSource and ConfigMap were successfully created:

oc -n openshift-operator-lifecycle-manager get catalogsource rh-operators

oc -n openshift-operator-lifecycle-manager get configmap rh-operators

Create the remaining OLM objects including OLM, Catalog, and Package Deployments:

for num in {10..13}; do oc create -f operator-lifecycle-manager/deploy/ocp/manifests/0.7.2/0000_30_$num*; done

Verify all three OLM deployments were successfully created:

oc -n openshift-operator-lifecycle-manager get deployments

We have successfully setup the Operator Lifecycle Manager in our OpenShift cluster.

Setting up the UI

To access the Operator Lifecycle Manager via the UI, we will run a local copy of the UI found in the container image quay.io/openshift/origin-console:latest.

The local console proxy utilizes the system:serviceaccount:kube-system:default Service Account to access all resources.

We will first grant this Service Account cluster-admin access. DO NOT DO THIS IN PRODUCTION.

oc adm policy add-cluster-role-to-user cluster-admin system:serviceaccount:kube-system:default

Replace the Operator-centric Origin console container image latest tag with v3.11.0.

sed -i 's|latest|v3.11.0|g' ./operator-lifecycle-manager/scripts/run_console_local.sh

Serve up the Operator-centric Origin console locally.

./operator-lifecycle-manager/scripts/run_console_local.sh

To access the UI, visit https://[[HOST_SUBDOMAIN]]-9000-[[KATACODA_HOST]].environments.katacoda.com

Creating the Subscription

Let's begin my creating a new project called myproject.

oc new-project myproject

Create a Subscription manifest for the Etcd Operator. Ensure the Approval is set to Manual.

cat > etcd-alpha-subscription.yaml <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: etcd
  namespace: myproject 
spec:
  channel: alpha
  name: etcd
  source: rh-operators
  installPlanApproval: Manual
EOF

Create the Subscription.

oc create -f etcd-alpha-subscription.yaml

Verify the Subscription and InstallPlan have been created.

oc get subscription
oc get installplan

Approving the InstallPlan

Modify the InstallPlan and set approved to true.

oc edit InstallPlan

Once the InstallPlan is set to true, you will see the newly provisioned ClusterServiceVersion, ClusterResourceDefinition, Role and RoleBindings, Service Accounts, and etcd-operator Deployment.

oc get clusterserviceversion
oc get crd
oc get sa
oc get roles
oc get rolebindings
oc get deployments

Creating the Custom Resource

Create the etcdCluster manifest.

cat > etcd-cluster.yaml <<EOF
apiVersion: etcd.database.coreos.com/v1beta2
kind: EtcdCluster
metadata:
  name: example-etcd-cluster
spec:
  size: 3
EOF

Create the etcd-cluster.

oc create -f etcd-cluster.yaml

Confirm the cluster has been created:

oc get etcdcluster
oc get pods

Terminal

Dashboard

cd <directory>	Change directory
ls	List directory
echo 'contents' > <file>	Write contents to a file
cat <file>	Output contents of file

i	In Command Mode	Change into Insert Mode, you can now insert and edit text in the file
esc	In Insert Mode	Change into Command Mode, you can now execute commands
:wq	In Command Mode	Save and Exit

Welcome!

Operator Lifecycle Manager

Congratulations!

You've completed the scenario!

Scenario Rating

Git Hub

Chat

Steps