diff --git a/content/en/docs/Installation/installation-guide/creating-updating-ossmconsole-cr.md b/content/en/docs/Installation/installation-guide/creating-updating-ossmconsole-cr.md new file mode 100644 index 000000000..943553aec --- /dev/null +++ b/content/en/docs/Installation/installation-guide/creating-updating-ossmconsole-cr.md @@ -0,0 +1,81 @@ +--- +title: "The OSSMConsole CR" +description: "Creating and updating the OSSMConsole CR." +weight: 45 +--- + +OpenShift ServiceMesh Console (aka OSSMC) provides a Kiali integration with the OpenShift Console; in other words it provides Kiali functionality within the context of the OpenShift Console. OSSMC is applicable only within OpenShift environments. + +The main component of OSSMC is a plugin that gets installed inside the OpenShift Console. Prior to installing this plugin, you are required to have already installed the Kiali Operator and Kiali Server in your OpenShift environment. Please the [Installation Guide](/docs/installation/installation-guide/) for details. + +{{% alert color="warning" %}} +There are no helm charts available to install OSSMC. You must utilize the Kiali Operator to install it. Installing the Kiali Operator on OpenShift is very easy due to the Operator Lifecycle Manager (OLM) functionality that comes with OpenShift out-of-box. Simply elect to install the Kiali Operator from the Red Hat or Community Catalog from the OperatorHub page in OpenShift Console. +{{% /alert %}} + +The Kiali Operator watches the _OSSMConsole Custom Resource_ ([OSSMConsole CR](/docs/configuration/ossmconsole.kiali.io)), a custom resource that contains the OSSMC deployment configuration. Creating, updating, or removing a OSSMConsole CR will trigger the Kiali Operator to install, update, or remove OSSMC. + +{{% alert color="warning" %}} +*Never* manually edit resources created by the Kiali Operator, only edit the OSSMConsole CR. +{{% /alert %}} + +## Creating the OSSMConsole CR to Install the OSSMC Plugin + +With the Kiali Operator and Kial Server installed and running, you can install the OSSMC plugin in one of two ways - either via the OpenShift Console or via the "oc" CLI. Both methods are described below. You choose the method you want to use. + +### Installing via OpenShift Console + +From the Kiali Operator details page in the OpenShift Console, create an instance of the "OpenShift Service Mesh Console" resource. Accept the defaults on the installation form and press "Create". + +![Install Plugin](/images/documentation/installation/installation-guide/01-ui-install-cr.png) + +### Installing via "oc" CLI + +To instruct the Kiali Operator to install the plugin, simply create a small OSSMConsole CR. A minimal CR can be created like this: + +```bash +cat < -n -p '{"metadata":{"finalizers": []}}' --type=merge ` +{{% /alert %}} + +### Uninstalling via OpenShift Console + +Remove the OSSMConsole CR by navigating to the operator details page in the OpenShift Console UI. From the operator details page, select the _OpenShift Service Mesh Console_ tab and then select the Delete option in the kebab menu. + +![Uninstall Plugin](/images/documentation/installation/installation-guide/04-ui-uninstall-cr.png) + +### Uninstalling via "oc" CLI + +Remove the OSSMConsole CR via `oc delete ossmconsoles -n `. To make sure any and all CRs are deleted from any and all namespaces, you can run this command: + +```sh +for r in $(oc get ossmconsoles --ignore-not-found=true --all-namespaces -o custom-columns=NS:.metadata.namespace,N:.metadata.name --no-headers | sed 's/ */:/g'); do oc delete ossmconsoles -n $(echo $r|cut -d: -f1) $(echo $r|cut -d: -f2); done +``` diff --git a/static/images/documentation/installation/installation-guide/01-ui-install-cr.png b/static/images/documentation/installation/installation-guide/01-ui-install-cr.png new file mode 100644 index 000000000..ce59620e9 Binary files /dev/null and b/static/images/documentation/installation/installation-guide/01-ui-install-cr.png differ diff --git a/static/images/documentation/installation/installation-guide/02-ui-installed-cr.png b/static/images/documentation/installation/installation-guide/02-ui-installed-cr.png new file mode 100644 index 000000000..1a041faec Binary files /dev/null and b/static/images/documentation/installation/installation-guide/02-ui-installed-cr.png differ diff --git a/static/images/documentation/installation/installation-guide/03-ui-installed-cr-plugin-ready.png b/static/images/documentation/installation/installation-guide/03-ui-installed-cr-plugin-ready.png new file mode 100644 index 000000000..3160eb06b Binary files /dev/null and b/static/images/documentation/installation/installation-guide/03-ui-installed-cr-plugin-ready.png differ diff --git a/static/images/documentation/installation/installation-guide/04-ui-uninstall-cr.png b/static/images/documentation/installation/installation-guide/04-ui-uninstall-cr.png new file mode 100644 index 000000000..11b2981ae Binary files /dev/null and b/static/images/documentation/installation/installation-guide/04-ui-uninstall-cr.png differ