Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added MTO Console Documentation #75

Merged
merged 7 commits into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions content/how-to-guides/console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# MTO Console

## Introduction

The Multi Tenant Operator (MTO) Console is a comprehensive user interface designed for both administrators and tenant users to manage multi-tenant environments. The MTO Console simplifies the complexity involved in handling various aspects of tenants and their related resources.

## Dashboard Overview

Check failure on line 7 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / doc_qa / markdown_lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Dashboard Overview"]
The dashboard serves as a centralized monitoring hub, offering insights into the current state of tenants, namespaces, templates and quotas. It is designed to provide a quick summary/snapshot of MTO's status and facilitates easier interaction with various resources such as tenants, namespaces, templates, and quotas.

![image](../images/dashboard.png)

### Tenants

Check failure on line 12 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / doc_qa / markdown_lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Tenants"]
Here, admins have a bird's-eye view of all tenants, with the ability to delve into each one for detailed examination and management. This section is pivotal for observing the distribution and organization of tenants within the system. The Tenants section also provides a graph view that showcases the resources deployed under a tenant.

![image](../images/tenants.png)
![image](../images/tenant-graph.png)

### Namespaces

Check failure on line 18 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / doc_qa / markdown_lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Namespaces"]
bnallapeta marked this conversation as resolved.
Show resolved Hide resolved
Namespaces are organized under their respective tenants for easy tracking and oversight. This section allows for a clear view of what namespaces are accessible to you as a tenant member, with options for detailed exploration.

![image](../images/namespaces.png)

### Quotas

Check failure on line 23 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / doc_qa / markdown_lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Quotas"]
bnallapeta marked this conversation as resolved.
Show resolved Hide resolved
Quotas are crucial for managing resource allocation. In this section, administrators can assess the quotas assigned to each tenant, ensuring a balanced distribution of resources in line with operational requirements.

![image](../images/quotas.png)

### Templates

Check failure on line 28 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / doc_qa / markdown_lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Templates"]
The Templates section acts as a repository for standardized resource deployment patterns, which can be utilized to maintain consistency and reliability across tenant environments. Few examples include provisioning specific k8s manifests, helm charts, secrets or configmaps across a set of namespaces.

![image](../images/templates.png)
![image](../images/templateGroupInstances.png)

### Showback

Check failure on line 34 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / doc_qa / markdown_lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Showback"]

Check failure on line 34 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/how-to-guides/console.md#L34

[Vale.Spelling] Did you really mean 'Showback'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Showback'?", "location": {"path": "content/how-to-guides/console.md", "range": {"start": {"line": 34, "column": 5}}}, "severity": "ERROR"}
The Showback feature is an essential financial governance tool, providing detailed insights into the cost implications of resource usage by tenant or namespace or other filters. This facilitates a transparent cost management and internal chargeback or showback process, enabling informed decision-making regarding resource consumption and budgeting.

Check failure on line 35 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/how-to-guides/console.md#L35

[Vale.Spelling] Did you really mean 'Showback'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Showback'?", "location": {"path": "content/how-to-guides/console.md", "range": {"start": {"line": 35, "column": 5}}}, "severity": "ERROR"}

Check failure on line 35 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/how-to-guides/console.md#L35

[Vale.Spelling] Did you really mean 'showback'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'showback'?", "location": {"path": "content/how-to-guides/console.md", "range": {"start": {"line": 35, "column": 253}}}, "severity": "ERROR"}

![image](../images/showback.png)

## User Roles and Permissions

Check failure on line 39 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / doc_qa / markdown_lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## User Roles and Permissions"]
### Administrators:

Check failure on line 40 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / doc_qa / markdown_lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "### Administrators:"]
Administrators have overarching access to the console, including the ability to view all namespaces and tenants. They have exclusive access to the IntegrationConfig, allowing them to define and manage system-wide settings and integrations.

![image](../images/integrationConfig.png)

### Tenant Users:
Regular tenant users can monitor and manage their allocated resources. However, they do not have access to the IntegrationConfig and cannot view resources across different tenants, ensuring data privacy and operational integrity.

## Live YAML Configuration and Graph View

In the MTO Console, each resource section is equipped with a "View" button, revealing the live YAML configuration for complete information on the resource. For Tenant resources, a supplementary "Graph" option is available, illustrating the relationships and dependencies of all resources under a Tenant. This dual-view approach empowers users with both the detailed control of YAML and the holistic oversight of the graph view.

![image](../images/tenants_graph.png)

## Conclusion
The MTO Console is engineered to simplify complex multi-tenant management. The current iteration focuses on providing comprehensive visibility. Future updates could include direct CUD (Create/Update/Delete) capabilities from the dashboard, enhancing the console’s functionality. The Showback feature remains a standout, offering critical cost tracking and analysis. The delineation of roles between administrators and tenant users ensures a secure and organized operational framework.

Check failure on line 55 in content/how-to-guides/console.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/how-to-guides/console.md#L55

[Vale.Spelling] Did you really mean 'Showback'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Showback'?", "location": {"path": "content/how-to-guides/console.md", "range": {"start": {"line": 55, "column": 284}}}, "severity": "ERROR"}
Binary file added content/images/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/integrationConfig.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/namespaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/quotas.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/showback.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/templateGroupInstances.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/templates.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/tenants.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/tenantsAdmin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/tenants_graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/tenants_yaml.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading