diff --git a/content/images/manual-approve-1.png b/content/images/manual-approve-1.png new file mode 100644 index 000000000..c1e014ee2 Binary files /dev/null and b/content/images/manual-approve-1.png differ diff --git a/content/images/manual-approve-2.png b/content/images/manual-approve-2.png new file mode 100644 index 000000000..14a128918 Binary files /dev/null and b/content/images/manual-approve-2.png differ diff --git a/content/images/manual-approve-3.png b/content/images/manual-approve-3.png new file mode 100644 index 000000000..84c480d87 Binary files /dev/null and b/content/images/manual-approve-3.png differ diff --git a/content/images/manual-approve-4.png b/content/images/manual-approve-4.png new file mode 100644 index 000000000..f5c4b2715 Binary files /dev/null and b/content/images/manual-approve-4.png differ diff --git a/content/installation.md b/content/installation.md index 75f16c15f..295c154d9 100644 --- a/content/installation.md +++ b/content/installation.md @@ -6,11 +6,13 @@ This document contains instructions on installing, uninstalling and configuring 1. [CLI/GitOps](#installing-via-cli-or-gitops) +1. [Enabling Console](#enabling-console) + 1. [Uninstall](#uninstall-via-operatorhub-ui) ## Requirements -* An **OpenShift** cluster [v4.7 - v4.12] +* An **OpenShift** cluster [v4.8 - v4.13] ## Installing via OperatorHub UI @@ -42,34 +44,6 @@ This document contains instructions on installing, uninstalling and configuring > Note: MTO will be installed in `multi-tenant-operator` namespace. -### Configuring IntegrationConfig - -IntegrationConfig is required to configure the settings of multi-tenancy for MTO. - -* We recommend using the following IntegrationConfig as a starting point - -```yaml -apiVersion: tenantoperator.stakater.com/v1alpha1 -kind: IntegrationConfig -metadata: - name: tenant-operator-config - namespace: multi-tenant-operator -spec: - openshift: - privilegedNamespaces: - - default - - ^openshift-* - - ^kube-* - - ^redhat-* - privilegedServiceAccounts: - - ^system:serviceaccount:default-* - - ^system:serviceaccount:openshift-* - - ^system:serviceaccount:kube-* - - ^system:serviceaccount:redhat-* -``` - -For more details and configurations check out [IntegrationConfig](./integration-config.md). - ## Installing via CLI OR GitOps * Create namespace `multi-tenant-operator` @@ -107,11 +81,7 @@ spec: name: tenant-operator source: certified-operators sourceNamespace: openshift-marketplace - startingCSV: tenant-operator.v0.9.1 - config: - env: - - name: ENABLE_CONSOLE - value: 'true' + startingCSV: tenant-operator.v0.10.0 EOF subscription.operators.coreos.com/tenant-operator created ``` @@ -134,33 +104,40 @@ subscription.operators.coreos.com/tenant-operator created ![image](./images/to_installed_successful_pod.png) -### Configuring IntegrationConfig +For more details and configurations check out [IntegrationConfig](./integration-config.md). -IntegrationConfig is required to configure the settings of multi-tenancy for MTO. +## Enabling Console -* We recommend using the following IntegrationConfig as a starting point: +To enable console GUI for MTO, go to `Search` -> `IntegrationConfig` -> `tenant-operator-config` and make sure the following fields are set to `true`: ```yaml -apiVersion: tenantoperator.stakater.com/v1alpha1 -kind: IntegrationConfig -metadata: - name: tenant-operator-config - namespace: multi-tenant-operator spec: - openshift: - privilegedNamespaces: - - default - - ^openshift-* - - ^kube-* - - ^redhat-* - privilegedServiceAccounts: - - ^system:serviceaccount:default-* - - ^system:serviceaccount:openshift-* - - ^system:serviceaccount:kube-* - - ^system:serviceaccount:redhat-* + provision: + console: true + showback: true ``` -For more details and configurations check out [IntegrationConfig](./integration-config.md). +> Note: If your `InstallPlan` approval is set to `Manual` then you will have to manually approve the `InstallPlan` for MTO console components to be installed. + +### Manual Approval + +* Open OpenShift console and click on `Operators`, followed by `Installed Operators` from the side menu. + +![image](./images/manual-approve-1.png) + +* Now click on `Upgrade available` in front of `mto-opencost` or `mto-prometheus`. + +![image](./images/manual-approve-2.png) + +* Now click on `Preview InstallPlan` on top. + +![image](./images/manual-approve-3.png) + +* Now click on `Approve` button. + +![image](./images/manual-approve-4.png) + +* Now the `InstallPlan` will be approved, and MTO console components will be installed. ## Uninstall via OperatorHub UI