Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
9 changes: 9 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,12 @@ Vocab = Stakater
[*.md]

BasedOnStyles = Vale

# content/reference/api.md is machine-generated from the operator's Go types
# (via crd-ref-docs). It contains API identifiers and verbatim code comments
# (e.g. the `templates.stakater.com` group, the `LabelSelector` type, the
# `${NAMESPACE}` token), not prose, so prose style rules don't apply.
[content/reference/api.md]
BasedOnStyles =
Vale.Terms = NO
Vale.Spelling = NO
Empty file removed content/about/.gitkeep
Empty file.
Empty file removed content/architecture/.gitkeep
Empty file.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,23 @@ This document contains instructions on installing, uninstalling and configuring

* After opening OpenShift console click on `Operators`, followed by `OperatorHub` from the side menu

![OperatorHub](../images/operatorhub.png)
![OperatorHub](../../images/operatorhub.png)

* Now search for `Template Operator` and then click on `Template Operator` tile

![alt text](../images/template-operator.png)
![alt text](../../images/template-operator.png)

* Click on the `install` button

![alt text](../images/operator-details.png)
![alt text](../../images/operator-details.png)

* Keep the `Update Channel` and `Version` dropdowns at the latest versions. Select Operator recommended Namespace in `Installed Namespace` section.

![alt text](../images/install-tab.png)
![alt text](../../images/install-tab.png)

* Wait for the operator to be installed

![alt text](../images/successful-install.png)
![alt text](../../images/successful-install.png)

> Note: Template Operator will be installed in `template-operator-system` namespace.

Expand Down Expand Up @@ -84,19 +84,19 @@ This document contains instructions on installing, uninstalling and configuring

* After creating the `subscription` custom resource, open OpenShift console and click on `Operators`, followed by `Installed Operators` from the side menu and wait for the installation to complete

![alt text](../images/wait-for-installation.png)
![alt text](../../images/wait-for-installation.png)

## Uninstall via OperatorHub UI

You can uninstall Template Operator by following these steps:

* After making the required changes open OpenShift console and click on `Operators`, followed by `Installed Operators` from the side menu

![image](../images/wait-for-installation.png)
![image](../../images/wait-for-installation.png)

* Now click on uninstall and confirm uninstall.

![alt text](../images/uninstall.png)
![alt text](../../images/uninstall.png)

* Now the operator has been uninstalled.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Distributing Resources in Namespaces

Multi Tenant Operator has two Custom Resources which can cover this need using the [`Template` CR](../template.md), depending upon the conditions and preference.
Multi Tenant Operator has two Custom Resources which can cover this need using the [`Template` CR](../../concepts/templates/template.md), depending upon the conditions and preference.

1. ClusterTemplateInstance
1. TemplateInstance
Expand Down
2 changes: 1 addition & 1 deletion content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Template Operator simplifies cluster administration, enhances security, and enab

## Installation

Refer to the [installation guide](./installation/overview.md) for setting up Template Operator.
Refer to the [installation guide](./getting-started/installation/overview.md) for setting up Template Operator.
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Common use cases for namespace templates may be:
* Deploying pre-populated databases with test data
* Injecting new namespaces with optional credentials such as image pull secrets

More details on [Distributing Template Resources](../kubernetes-resources/how-to-guides/deploying-templates.md)
More details on [Distributing Template Resources](../guides/templates/deploying-templates.md)

### Cross Namespace Resource Distribution

Template Operator supports cloning of secrets and ConfigMaps from one namespace to another namespace based on label selectors. It uses templates to enable users to provide reference to secrets and ConfigMaps. It uses a Cluster Template Instance to distribute those secrets and namespaces in matching namespaces, while Template Instance copies secret and configMap to a single namespace.

More details on [Copying Secrets and ConfigMaps](../kubernetes-resources/how-to-guides/copying-resources.md)
More details on [Copying Secrets and ConfigMaps](../guides/templates/copying-resources.md)

## Operational Features

Expand Down
File renamed without changes.
Loading
Loading