Skip to content

Commit a8cd53b

Browse files
Merge pull request #806 from marcoderama/doco
documentation: Fix a few typos.
2 parents eb2561c + 9480e38 commit a8cd53b

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

Documentation/design/building-your-csv.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ The Lifecycle Manager will check against the available CRDs and Operators in the
147147
description: Represents a cluster of etcd nodes.
148148
```
149149
## CRD Templates
150-
Users of your Operator will need to be aware of which options are required vs optional. You can provide templates for each of our CRDs with a minimum set of configuration as an annotation named `alm-examples`. Compatible UIs will pre-enter this template for users to further customize.
150+
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`. Compatible UIs will pre-enter this template for users to further customize.
151151

152152
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`:
153153

@@ -238,7 +238,7 @@ The metadata section contains general metadata around the name, version and othe
238238

239239
**Selectors** (optional): A label selector to identify related resources. Set this to select on current labels applied to this CSV object (if applicable).
240240

241-
**InstallModes**: A set of `InstallMode`s that tell OLM which `OperatorGroup`s an Operator can belong to. Belonging to an `OperatorGroup` means that OLM provides the set of targetted namespaces as an annotation on the Operator's CSV and any deployments defined therin. These deployments can then untilize [the Downward API](https://kubernetes.io/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/#the-downward-api) to inject the list of namespaces into its container(s). An `InstallMode` consists of an `InstallModeType` field and a boolean `Supported` field. There are four `InstallModeTypes`:
241+
**InstallModes**: A set of `InstallMode`s that tell OLM which `OperatorGroup`s an Operator can belong to. Belonging to an `OperatorGroup` means that OLM provides the set of targeted namespaces as an annotation on the Operator's CSV and any deployments defined therein. These deployments can then utilize [the Downward API](https://kubernetes.io/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/#the-downward-api) to inject the list of namespaces into their container(s). An `InstallMode` consists of an `InstallModeType` field and a boolean `Supported` field. There are four `InstallModeTypes`:
242242
* `OwnNamespace`: If supported, the operator can be a member of an `OperatorGroup` that selects its own namespace
243243
* `SingleNamespace`: If supported, the operator can be a member of an `OperatorGroup` that selects one namespace
244244
* `MultiNamespace`: If supported, the operator can be a member of an `OperatorGroup` that selects more than one namespace

Documentation/design/debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Debugging a ClusterServiceVersion
22

3-
We have a ClusterServiceVersion that is failing to report as avialable.
3+
We have a ClusterServiceVersion that is failing to report as available.
44

55
```sh
66
$ kubectl -n ci-olm-pr-188-gc-csvs get clusterserviceversions etcdoperator.v0.8.1 -o yaml

Documentation/design/operatorgroups.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ An `OperatorGroup` is an OLM resource that provides rudimentary multitenant conf
55
## OperatorGroup Overview
66

77
* An `OperatorGroup` selects a set of target namespaces in which to generate required RBAC access for its member operators.
8-
* The set of target namespaces is provided via a comma-delimited string stored in the `olm.targetNamespaces` annotation. This annotation is applied to member operator's `ClusterServiceVersion` (CSV) instances and is projected into their deployments. It accessible to operator containers using [The Downward API](https://kubernetes.io/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/#the-downward-api)
8+
* The set of target namespaces is provided via a comma-delimited string stored in the `olm.targetNamespaces` annotation. This annotation is applied to member operator's `ClusterServiceVersion` (CSV) instances and is projected into their deployments. It is accessible to operator containers using [The Downward API](https://kubernetes.io/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/#the-downward-api)
99
* An operator is said to be a [member of an `OperatorGroup`](#operatorgroup-membership) if its CSV exists in the same namespace as the `OperatorGroup` and its CSV's [`InstallModes` support the set of namespaces targetted by the `OperatorGroup`](#installmodes-and-supported-operatorgroups)
1010
* In order to transition, a CSV must be an active member of an `OperatorGroup` that has no [provided API conflicts with intersecting `OperatorGroups`](#operatorgroup-intersection)
1111

@@ -128,7 +128,7 @@ When an `OperatorGroup` is created, 3 ClusterRoles each containing a single Aggr
128128
* `<operatorgroup-name>-edit`
129129
* ClusterRoleSelector set to match the `olm.opgroup.permissions/aggregate-to-edit: <operatorgroup-name>` label
130130

131-
* `<oepratorgroup-name>-view`
131+
* `<operatorgroup-name>-view`
132132
* ClusterRoleSelector set to match the `olm.opgroup.permissions/aggregate-to-view: <operatorgroup-name>` label
133133

134134
When a CSV becomes an active member of an `OperatorGroup` and is not in a failed state with reason InterOperatorGroupOwnerConflict, the following RBAC resources are generated:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ There is no way to express a dependency on a particular version of an operator (
8383
## Discovery, Catalogs, and Automated Upgrades
8484
OLM has the concept of catalogs, which are repositories of application definitions and CRDs.
8585

86-
Catalogs contain a set of Packages, which map “channels” to a particular application definition. Channels allow package authors write different upgrade paths for different users (e.g. alpha vs. stable).
86+
Catalogs contain a set of Packages, which map “channels” to a particular application definition. Channels allow package authors to write different upgrade paths for different users (e.g. alpha vs. stable).
8787

8888
Example: [etcd package](https://github.com/operator-framework/community-operators/blob/master/community-operators/etcd/etcd.package.yaml)
8989

0 commit comments

Comments
 (0)