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

Updates installation guide #78

Merged
merged 2 commits into from
Dec 7, 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
Binary file added content/images/manual-approve-1.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/manual-approve-2.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/manual-approve-3.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/manual-approve-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
83 changes: 29 additions & 54 deletions content/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## Requirements

* An **OpenShift** cluster [v4.7 - v4.12]
* An **OpenShift** cluster [v4.8 - v4.13]

## Installing via OperatorHub UI

Expand Down Expand Up @@ -42,34 +42,6 @@

> 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`
Expand Down Expand Up @@ -107,11 +79,7 @@
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
```
Expand All @@ -134,33 +102,40 @@

![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`:

Check failure on line 109 in content/installation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/installation.md#L109

[Vale.Spelling] Did you really mean 'gui'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'gui'?", "location": {"path": "content/installation.md", "range": {"start": {"line": 109, "column": 19}}}, "severity": "ERROR"}

```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 install plan approval is set to `Manual` then you will have to manually approve the install plan for MTO console components to be installed.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
The word ‘install’ is not a noun. (A_INSTALL[1])
Suggestions: installation
Rule: https://community.languagetool.org/rule/show/A_INSTALL?lang=en-US&subId=1
Category: GRAMMAR

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
The word ‘install’ is not a noun. (A_INSTALL[1])
Suggestions: installation
Rule: https://community.languagetool.org/rule/show/A_INSTALL?lang=en-US&subId=1
Category: GRAMMAR


### 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 install plan will be approved and MTO console components will be installed.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
The word ‘install’ is not a noun. (A_INSTALL[1])
Suggestions: installation
Rule: https://community.languagetool.org/rule/show/A_INSTALL?lang=en-US&subId=1
Category: GRAMMAR

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[4])
Suggestions: , and
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=4
Category: PUNCTUATION


## Uninstall via OperatorHub UI

Expand Down
Loading