ako-operator

README

AKO Operator

AKO operator takes care of deploying, managing and removing AKO from Openshift clusters. It takes the AKO installation/deployment configuration from a CRD called AKOConfig.

Installing the operator

Install on Openshift cluster from OperatorHub using Openshift Container Platform Web Console

Step 1: Login to the Openshift Container Platform web console of your Openshift cluster.

Step 2: Navigate in the web console to the Operators → OperatorHub page.

Step 3: Find AKO Operator provided by VMware.

Step 4: Click install and select the 1.10.1 version. The operator will be installed in avi-system namespace. The namespace will be created if it doesn't exist.

Step 5: Verify installation by checking the pods in avi-system namespace.

Note: Refer akoconfig to start the AKO controller

AKOConfig Custom Resource

AKO Operator manages the AKO Controller. To deploy and manage the controller, it takes in a custom resource object called AKOConfig. Please go through the description to understand the different fields of this object.

Create a secret with Avi Controller details

Create a secret named avi-secret in the avi-system namespace. Edit secret.yaml with the credentials of Avi Controller in base64 encoding.

kubectl apply -f config/secrets/secret.yaml

Or, if using the Openshift client, use

oc apply -f config/secrets/secret.yaml

Deploying the AKO Controller

If the AKO operator was installed on Openshift cluster from OperatorHub, then to install the AKO controller, add an AKOConfig object to the avi-system namespace.

A sample of akoconfig is present here. Edit this file according to your setup.

kubectl create -f config/samples/ako_v1alpha1_akoconfig.yaml

Or, if using the Openshift client, use

oc create -f config/samples/ako_v1alpha1_akoconfig.yaml

AKO Controller can also be deployed on Openshift cluster, with AKOConfig custom resource using Openshift Container Platform Web Console.

Prerequisite

AKO Operator should already be installed on Openshift cluster. Once this prerequisite is met, following steps need to be followed.

Step 1: Login to the Openshift Container Platform web console of your Openshift cluster.

Step 2: Navigate in the web console to the Operators → Installed Operators page. AKO Operator, if already installed, should be listed.

Step 3: In the Provided APIs section click on AKOConfig, and then click on Create AKOConfig button.

Step 4: You will be provided two configuration options, Form view and YAML view. Please select the preferred option and populate the fields as required. The AKOConfig custom resource description and sample yaml manifest file can be referred for assistance.

Step 5: Once the fields are populated, click on Create button.

Step 6: Verify installation by checking the pods in avi-system namespace.

Tweaking/Manage the AKO Controller

If the user needs to change any properties of the AKO Controller, they can change the AKOConfig object and the changes will take effect once it is saved.

kubectl edit akoconfig -n avi-system ako-config

Or, if using the Openshift client, use

oc edit akoconfig -n avi-system ako-config

Note that if the user edits the AKO controller's configmap/statefulset out-of-band, the changes will be overwritten by the AKO operator.

Removing the AKO Controller

To remove the AKO Controller, simply delete the AKOConfig object:

kubectl delete akoconfig -n avi-system ako-config

Or, if using the Openshift client, use

oc delete akoconfig -n avi-system ako-config

Troubleshooting: If the Operator isn't running when akoconfig is deleted, the akoconfig will be stuck in terminating state.
If this happens edit akoconfig using kubectl edit akoconfig -n avi-system ako-config and remove the finalizers section.

Versioning

Operator version	Supported AKO Version
1.9.3	1.9.3
1.10.1	1.10.1