Skip to content

Commit 4197455

Browse files
committed
Documentation: Fix a few typos
1 parent 41821c7 commit 4197455

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

Documentation/design/building-your-csv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ It’s recommended to only list out the objects that are important to a human, n
190190
Essentially the same as for owned CRDs.
191191

192192
### APIService Resource Creation
193-
The Lifecycle Manage is responsible for creating or replacing the Service and APIService resources for each unique owned APIService.
193+
The Lifecycle Manager is responsible for creating or replacing the Service and APIService resources for each unique owned APIService.
194194
* Service pod selectors are copied from the CSV deployment matching the APIServiceDescription's DeploymentName.
195195
* A new CA key/cert pair is generated for for each installation and the base64 encoded CA bundle is embedded in the respective APIService resource.
196196

Documentation/design/developing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ kubectl apply -f ./custom-olm
5555
* do not overwrite the old one
5656
* Add any new CRDs to `deploy/chart/catalog_resources/<catalog>`
5757
* run `make update-catalog` to regen the catalog configmap
58-
* either apply the new configmap on it's own and restart catalog or, easier, just run:
58+
* either apply the new configmap on its own and restart the catalog or, easier, just run:
5959

6060
```sh
6161
./scripts/package_release.sh 1.0.0-custom custom-olm ./Documentation/install/example-values.yaml

Documentation/design/operatorgroups.md

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

77
* An `OperatorGroup` selects a set of target namespaces in which to generate required RBAC access for its member operators.
88
* 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)
9-
* 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)
9+
* 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 targeted 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

1212
## OperatorGroup Membership
@@ -27,15 +27,15 @@ An `InstallMode` consists of an `InstallModeType` field and a boolean `Supported
2727
* `MultiNamespace`: If supported, the operator can be a member of an `OperatorGroup` that selects more than one namespace
2828
* `AllNamespaces`: If supported, the operator can be a member of an `OperatorGroup` that selects all namespaces (target namespace set is the empty string "")
2929

30-
> Note: If a CSV's spec omit's an entry of `InstallModeType`, that type is considered unsupported unless support can be inferred by an existing entry that implicitly supports it.
30+
> Note: If a CSV's spec omits an entry of `InstallModeType`, that type is considered unsupported unless support can be inferred by an existing entry that implicitly supports it.
3131
3232
### UnsupportedOperatorGroup
3333

3434
If a CSV's `InstallMode`s do not support the target namespace selection of the `OperatorGroup` in its namespace, the CSV will transition to a failure state with reason `UnsupportedOperatorGroup`. CSVs in a failed state for this reason will transition to pending once either the `OperatorGroups`'s target namespace selection changes to a supported configuration, or the CSV's `InstallMode`s are modified to support the `OperatorGroup`'s target namespace selection.
3535

3636
## Target Namespace Selection
3737

38-
Selection of the set of namespaces by specifying a label selector with the `spec.selector` field:
38+
Select the set of namespaces by specifying a label selector with the `spec.selector` field:
3939

4040
```yaml
4141
apiVersion: operators.coreos.com/v1alpha2

Documentation/design/philosophy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,11 +160,11 @@ We have two major components that handle the resources described above
160160

161161
**What if I want lifecycle/packaging/discovery for kubernetes, but don't want to write an operator?**
162162

163-
If you don't want to write an operator, the thing you want to package probably fits one of the standard shapes of software that can be deployed on a cluster. You can take advantage of OLM by writing a package the binds your application to one of our standard operators, like [helm-app-operator-kit](https://github.com/coreos/helm-app-operator-kit).
163+
If you don't want to write an operator, the thing you want to package probably fits one of the standard shapes of software that can be deployed on a cluster. You can take advantage of OLM by writing a package that binds your application to one of our standard operators, like [helm-app-operator-kit](https://github.com/coreos/helm-app-operator-kit).
164164

165165
If your use-case doesn't fit one of our standard operators, that means you have domain-specific operational knowledge you need to encode into an operator, and you can take advantage of our Operator SDK for common operator tasks.
166166

167-
**Why are dependencies between operators are expressed as a dependency on a CRD?**
167+
**Why are dependencies between operators expressed as a dependency on a CRD?**
168168

169169
This decouples the actual dependency from the operation of the dependency. For example, Vault requires an EtcdCluster, but we should be able to update the etcd operator out of step with the vault operator.
170170

0 commit comments

Comments
 (0)