Skip to content

Commit dd06812

Browse files
authored
Update installation/uninstallation docs (#2784)
* Fix spelling error Changes "exmaple" to "example" Signed-off-by: Noah Sapse <[email protected]> * Updates Installation/Uninstallation Documents - Closes #2662 - Updates installation document to include `operator-sdk olm install` as an install method - Updates installation document to include `operator-sdk olm uninstall` as an uninstall method Signed-off-by: Noah Sapse <[email protected]>
1 parent cbb6c3d commit dd06812

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

doc/design/building-your-csv.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ The Lifecycle Manager will check against the available CRDs and Operators in the
169169
description: Represents a cluster of etcd nodes.
170170
```
171171
## CRD Templates
172-
Users of your Operator will need to be aware of which options are required vs optional. You can provide templates for each of your CRDs with a minimum set of configuration as an annotation named `alm-examples`. Metadata for each template, for exmaple an expanded description, can be included in an annotation named `alm-examples-metadata`, which should be a hash indexed with the `metadata.name` of the example in the `alm-examples` list. Compatible UIs will pre-enter the `alm-examples` template for users to further customize, and use the `alm-examples-metadata` to help users decide which template to select.
172+
Users of your Operator will need to be aware of which options are required vs optional. You can provide templates for each of your CRDs with a minimum set of configuration as an annotation named `alm-examples`. Metadata for each template, for example an expanded description, can be included in an annotation named `alm-examples-metadata`, which should be a hash indexed with the `metadata.name` of the example in the `alm-examples` list. Compatible UIs will pre-enter the `alm-examples` template for users to further customize, and use the `alm-examples-metadata` to help users decide which template to select.
173173

174174
The annotation consists of a list of the `kind`, eg. the CRD name, and the corresponding `metadata` and `spec` of the Kubernetes object. Here’s a full example that provides templates for `EtcdCluster`, `EtcdBackup` and `EtcdRestore`:
175175

doc/install/install.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ You can verify that the OLM components have been successfully deployed by runnin
3333

3434
**IMPORTANT:** OLM is installed by default in OpenShift 4.0 and above.
3535

36+
## Install with `operator-sdk olm install`
37+
38+
OLM can be installed with the operator-sdk command `operator-sdk olm install` more information is available in the [operator-sdk documentation.](https://sdk.operatorframework.io/docs/cli/operator-sdk_olm_install/)
39+
3640
## Customizing OLM installation
3741

3842
Deployments of OLM can be stamped out with different configurations by writing a `values.yaml` file and running commands to generate resources.
@@ -130,6 +134,4 @@ spec:
130134

131135
# Uninstall
132136

133-
Run the command `make uninstall`.
134-
135-
**NOTE** Valid just for local/manual installs.
137+
OLM can be uninstalled with the `operator-sdk olm uninstall` command. More information is available in the [operator-sdk documentation](https://sdk.operatorframework.io/docs/cli/operator-sdk_olm_uninstall/)

0 commit comments

Comments
 (0)