Merge pull request #76 from stakater/SA-5031-Docs-0.10.0

SA-5031-Docs-0.10.0

content/faq.md

@@ -42,3 +42,7 @@ The fix is to create namespaces with `kubectl create` instead.
 ## Q. InvalidSpecError: application repo \<repo\> is not permitted in project \<project\>
 
 **Answer.** The above error can occur if the ArgoCD Application is syncing from a source that is not allowed the referenced AppProject. To solve this, verify that you have referred to the correct project in the given ArgoCD Application, and that the repoURL used for the Application's source is valid. If the error still appears, you can add the URL to the relevant Tenant's `spec.argocd.sourceRepos` array.
+
+## Q. Why are there `mto-showback-*` pods failing in my cluster?
+
+**Answer.** The `mto-showback-*` pods are used to calculate the cost of the resources used by each tenant. These pods are created by the Multi-Tenant Operator and are scheduled to run every 10 minutes. If the pods are failing, it is likely that the operator's necessary to calculate cost are not present in the cluster. To solve this, you can navigate to `Operators` -> `Installed Operators` in the OpenShift console and check if the MTO-OpenCost and MTO-Prometheus operators are installed. If they are in a pending state, you can manually approve them to install them in the cluster.

content/features.md

@@ -86,3 +86,19 @@ With Multi Tenant Operator teams can share a single cluster with multiple teams,
 ## Native Experience
 
 Multi Tenant Operator provides multi-tenancy with a native Kubernetes experience without introducing additional management layers, plugins, or customized binaries.
+
+## Custom Metrics Support
+
+Multi Tenant Operator now supports custom metrics for templates, template instances and template group instances.
+
+Exposed metrics contain, number of resources deployed, number of resources failed, total number of resources deployed for template instances and template group instances. These metrics can be used to monitor the usage of templates and template instances in the cluster.
+
+Additionally, this allows us to expose other performance metrics listed [here](https://book.kubebuilder.io/reference/metrics-reference.html).
+
+More details on [Enabling Custom Metrics](./reference-guides/custom-metrics.md)
+
+## Graph Visualization for Tenants
+
+Multi Tenant Operator now supports graph visualization for tenants on the MTO Console. Effortlessly associate tenants with their respective resources using the enhanced graph feature on the MTO Console. This dynamic graph illustrates the relationships between tenants and the resources they create, encompassing both MTO's proprietary resources and native Kubernetes/OpenShift elements.
+
+More details on [Graph Visualization](./reference-guides/graph-visualization.md)

content/reference-guides/custom-metrics.md

@@ -0,0 +1,11 @@
+# Custom Metrics Support
+
+Multi Tenant Operator now supports custom metrics for templates, template instances and template group instances. This feature allows users to monitor the usage of templates and template instances in their cluster.
+
+To enable custom metrics and view them in your OpenShift cluster, you need to follow the steps below:
+
+- Ensure that cluster monitoring is enabled in your cluster. You can check this by going to `Observe` -> `Metrics` in the OpenShift console.
+- Navigate to `Administration` -> `Namespaces` in the OpenShift console. Select the namespace where you have installed Multi Tenant Operator.
+- Add the following label to the namespace: `openshift.io/cluster-monitoring=true`. This will enable cluster monitoring for the namespace.
+- To ensure that the metrics are being scraped for the namespace, navigate to `Observe` -> `Targets` in the OpenShift console. You should see the namespace in the list of targets.
+- To view the custom metrics, navigate to `Observe` -> `Metrics` in the OpenShift console. You should see the custom metrics for templates, template instances and template group instances in the list of metrics.

content/reference-guides/graph-visualization.md

@@ -0,0 +1,30 @@
+# Graph Visualization on MTO Console
+
+Effortlessly associate tenants with their respective resources using the enhanced graph feature on the MTO Console. This dynamic graph illustrates the relationships between tenants and the resources they create, encompassing both MTO's proprietary resources and native Kubernetes/OpenShift elements.
+
+Example Graph:
+
+```mermaid
+  graph LR;
+      A(alpha)-->B(dev);
+      A-->C(prod);
+      B-->D(limitrange);
+      B-->E(owner-rolebinding);
+      B-->F(editor-rolebinding);
+      B-->G(viewer-rolebinding);
+      C-->H(limitrange);
+      C-->I(owner-rolebinding);
+      C-->J(editor-rolebinding);
+      C-->K(viewer-rolebinding);
+```
+
+Explore with an intuitive graph that showcases the relationships between tenants and their resources. The MTO Console's graph feature simplifies the understanding of complex structures, providing you with a visual representation of your tenant's organization.
+
+To view the graph of your tenant, follow the steps below:
+
+- Navigate to `Tenants` page on the MTO Console using the left navigation bar.
+![Tenants](../images/graph-1.png)
+- Click on `View` of the tenant for which you want to view the graph.
+![Tenant View](../images/graph-2.png)
+- Click on `Graph` tab on the tenant details page.
+![Tenant Graph](../images/graph-3.png)