Merge pull request #80 from stakater/integration-config-update

Adds provision in Integration config docs
stakater · Dec 8, 2023 · 3abe756 · 3abe756
2 parents 5c5b5b5 + 3c6ea74
commit 3abe756
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/content/how-to-guides/offboarding/uninstalling.md b/content/how-to-guides/offboarding/uninstalling.md
@@ -4,6 +4,10 @@ You can uninstall MTO by following these steps:
 
 * Decide on whether you want to retain tenant namespaces and ArgoCD AppProjects or not. If yes, please set `spec.onDelete.cleanNamespaces` to `false` for all those tenants whose namespaces you want to retain, and `spec.onDelete.cleanAppProject` to `false` for all those tenants whose AppProject you want to retain. For more details check out [onDelete](../../tutorials/tenant/deleting-tenant.md#retaining-tenant-namespaces-and-appproject-when-a-tenant-is-being-deleted)
 
+* In case you have enabled console, you will have to disable it first by navigating to `Search` -> `IntegrationConfig` -> `tenant-operator-config` and set `spec.provision.console` and `spec.provision.showback` to `false`.
+
+* Remove IntegrationConfig CR from the cluster by navigating to `Search` -> `IntegrationConfig` -> `tenant-operator-config` and select `Delete` from actions dropdown.
+
 * After making the required changes open OpenShift console and click on `Operators`, followed by `Installed Operators` from the side menu
 
 ![image](../../images/installed-operators.png)

diff --git a/content/integration-config.md b/content/integration-config.md
@@ -95,6 +95,9 @@ spec:
     sso:
       clientName: vault
       accessorID: <ACCESSOR_ID_TOKEN>
+  provision:
+    console: true
+    showback: true
 ```
 
 Following are the different components that can be used to configure multi-tenancy in a cluster via Multi Tenant Operator.
@@ -371,3 +374,24 @@ If enabled, than admins have to provide secret, URL and SSO accessorID of Vault.
 - `sso.clientName:` Will contain the client name.
 
 For more details please refer [use-cases](./usecases/integrationconfig.md)
+
+## Provision
+
+```yaml
+provision:
+  console: true
+  showback: true
+```
+
+`provision.console:` Can be used to enable/disable console GUI for MTO.
+`provision.showback:` Can be used to enable/disable showback feature on the console.
+
+Integration config will be managing the following resources required for console GUI:
+
+- `Showback` cronjob.
+- `Keycloak` deployment.
+- `MTO-OpenCost` operator.
+- `MTO-Prometheus` operator.
+- `MTO-Postgresql` stateful set.
+
+Details on console GUI and showback can be found [here](explanation/console.md)