Skip to content

Commit fe981bd

Browse files
committed
content: Add newline between text and [links, code blocks]. Add trailing newlines. Remove unneeded newlines.
1 parent 16efa9a commit fe981bd

27 files changed

+53
-53
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,5 @@ Any changes will be included in real time.
9191
9292
## Useful resources
9393
94-
* [Docsy user guide](wherever it goes): All about Docsy, including how it manages navigation, look and feel, and multi-language support.
95-
* [Hugo documentation](https://gohugo.io/documentation/): Comprehensive reference for Hugo.
94+
* [Docsy user guide](https://www.docsy.dev/docs/): All about Docsy, including how it manages navigation, look and feel, and multi-language support.
95+
* [Hugo documentation](https://gohugo.io/documentation/): Comprehensive reference for Hugo.

content/en/docs/Concepts/crds/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,3 @@ weight: 2
44
description: >
55
A list of [CustomResourceDefinitions](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/) defined by OLM.
66
---
7-

content/en/docs/Concepts/crds/clusterserviceversion.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,3 @@ spec:
104104
version: v1alpha1
105105
kind: Other
106106
```
107-

content/en/docs/Concepts/crds/operatorgroup.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ An OperatorGroup is an OLM resource that provides rudimentary multitenant config
1515
## Membership
1616

1717
An operator defined by CSV `csv-a` is said to be a _member_ of `OperatorGroup` `op-a` in namespace `ns-a` if both of the following hold:
18+
1819
* `op-a` is the only `OperatorGroup` in `ns-a`
1920
* `csv-a`'s `InstallMode`s support `op-a`'s target namespace set
2021

@@ -25,6 +26,7 @@ If there exists more than one `OperatorGroup` in a single namespace, any CSV cre
2526
### InstallModes and Supported OperatorGroups
2627

2728
An `InstallMode` consists of an `InstallModeType` field and a boolean `Supported` field. A CSV's spec can contain a set of `InstallModes` of four distinct `InstallModeTypes`:
29+
2830
* `OwnNamespace`: If supported, the operator can be a member of an `OperatorGroup` that selects its own namespace
2931
* `SingleNamespace`: If supported, the operator can be a member of an `OperatorGroup` that selects one namespace
3032
* `MultiNamespace`: If supported, the operator can be a member of an `OperatorGroup` that selects more than one namespace
@@ -85,6 +87,7 @@ The resolved set of selected namespaces is surfaced in an `OperatorGroup`'s `sta
8587
## OperatorGroup CSV Annotations
8688

8789
Member CSVs of an `OperatorGroup` get the following annotations:
90+
8891
* `olm.operatorGroup=<group-name>`
8992
* Contains the name of the `OperatorGroup`
9093
* `olm.operatorGroupNamespace=<group-namespace>`
@@ -125,6 +128,7 @@ status:
125128
## RBAC
126129

127130
When an `OperatorGroup` is created, 3 ClusterRoles each containing a single AggregationRule are generated:
131+
128132
* `<operatorgroup-name>-admin`
129133
* ClusterRoleSelector set to match the `olm.opgroup.permissions/aggregate-to-admin: <operatorgroup-name>` label
130134

@@ -135,6 +139,7 @@ When an `OperatorGroup` is created, 3 ClusterRoles each containing a single Aggr
135139
* ClusterRoleSelector set to match the `olm.opgroup.permissions/aggregate-to-view: <operatorgroup-name>` label
136140

137141
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:
142+
138143
* For each provided API resource from a CRD:
139144
* A `<kind.group-version-admin>` ClusterRole is generated with the `*` verb on `<group>` `<kind>` with aggregation labels `rbac.authorization.k8s.io/aggregate-to-admin: true` and `olm.opgroup.permissions/aggregate-to-admin: <operatorgroup-name>`
140145
* A `<kind.group-version-edit>` ClusterRole is generated with the `create, update, patch, release` verbs on `<group>` `<kind>` with aggregation labels `rbac.authorization.k8s.io/aggregate-to-edit: true` and `olm.opgroup.permissions/aggregate-to-edit: <operatorgroup-name>`
@@ -190,6 +195,7 @@ spec:
190195
### Rules for Intersection
191196

192197
Each time an active member CSV syncs, OLM queries the cluster for the set of _intersecting provided APIs_ between the CSV's `OperatorGroup` and all others. OLM then checks if that set __is the empty set__:
198+
193199
* If __true__ and the CSV's provided APIs __are a subset__ of the `OperatorGroup`'s:
194200
* Continue transitioning
195201
* If __true__ and the CSV's provided APIs __are not a subset__ of the `OperatorGroup`'s:
@@ -209,10 +215,10 @@ Each time an active member CSV syncs, OLM queries the cluster for the set of _in
209215
* Replace the `OperatorGroup`'s `olm.providedAPIs` annotation with the difference between itself and the CSV's provided APIs
210216

211217
> Note: Failure states caused by `OperatorGroup`s are non-terminal.
212-
213218
> Note: When checking intersection rules, an `OperatorGroup`'s namespace is always included as part of its selected target namespaces.
214219

215220
Each time an `OperatorGroup` syncs:
221+
216222
* The set of provided APIs from active member CSV's is calculated from the cluster (ignoring [copied CSVs](#copied-csvs))
217223
* The cluster set is compared to `olm.providedAPIs`:
218224
* If `olm.providedAPIs` contains any extraneous provided APIs:

content/en/docs/Concepts/olm-architecture/_index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Each of these Operators are responsible for managing the CRDs that are the basis
1414

1515
**_Table 1. CRDs managed by OLM and Catalog Operators_**
1616

17-
1817
| Resource | Short Name | Owner | Description |
1918
|-----------------------|-------------|---------|---------------------------------------|
2019
| ClusterServiceVersion | **csv** | OLM | Application metadata: name, version, icon, required resources, installation, etc. |
@@ -72,9 +71,8 @@ Users can also create an InstallPlan resource directly, containing the names of
7271
* Watches for resolved InstallPlans and creates all of the discovered resources for it (if approved by a user or automatically).
7372
* Watches for CatalogSources and Subscriptions and creates InstallPlans based on them.
7473

75-
7674
## Catalog Registry
7775

7876
The Catalog Registry stores CSVs and CRDs for creation in a cluster and stores metadata about packages and channels.
7977

80-
A _package manifest_ is an entry in the Catalog Registry that associates a package identity with sets of CSVs. Within a package, channels point to a particular CSV. Because CSVs explicitly reference the CSV that they replace, a package manifest provides the Catalog Operator all of the information that is required to update a CSV to the latest version in a channel, stepping through each intermediate version.
78+
A _package manifest_ is an entry in the Catalog Registry that associates a package identity with sets of CSVs. Within a package, channels point to a particular CSV. Because CSVs explicitly reference the CSV that they replace, a package manifest provides the Catalog Operator all of the information that is required to update a CSV to the latest version in a channel, stepping through each intermediate version.

content/en/docs/Concepts/olm-architecture/dependency-resolution/_index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ graph TD;
1515
v(BarOperator) --> |Provides|vs(Kind: Bar<br/>apiVersion: bargroup.io/bar/v1alpha1);
1616
s(BazOperator) --> |Provides|ss(Kind: Baz<br />apiVersion: bazgroup.io/baz/v1alpha1)
1717
v--> |Requires|ec;
18-
18+
1919
classDef foo fill:#8addf2,stroke:#333,stroke-width:4px;
2020
classDef bar fill:#ffcc26,stroke:#333,stroke-width:4px;
2121
classDef baz fill:#ff7452,stroke:#333,stroke-width:4px;
2222

2323
class e,ec foo;
2424
class v,vs bar;
2525
class s,ss baz;
26-
26+
2727
linkStyle default fill:none,stroke-width:2px;
2828
{{</mermaid>}}
2929

@@ -104,26 +104,26 @@ spec:
104104
priority: 100
105105
```
106106

107-
`CatalogSource` has a `priority` field, which is used by the resolver to know how to prefer options for a dependency.
107+
`CatalogSource` has a `priority` field, which is used by the resolver to know how to prefer options for a dependency.
108108

109109
There are two rules that govern catalog preference:
110110

111-
- Options in higher-priority catalogs are preferred to options in lower-priority catalogs
112-
- Options in the same catalog as the depender are preferred to any other catalogs.
111+
- Options in higher-priority catalogs are preferred to options in lower-priority catalogs
112+
- Options in the same catalog as the depender are preferred to any other catalogs.
113113

114114
#### Example - Same catalog preferred to all others
115115

116116
{{<mermaid>}}
117117
graph TD
118118
subgraph Catalog A - Priority 0
119-
e(FooOperator<br /><br />Provides: Foo)
119+
e(FooOperator<br /><br />Provides: Foo)
120120
v(BarOperator<br /><br />Provides: Bar<br />Requires: Foo)
121121
end
122-
122+
123123
subgraph Catalog B - Priority 50
124-
e2(FooOperatorAlt<br /><br />Provides: Foo)
124+
e2(FooOperatorAlt<br /><br />Provides: Foo)
125125
end
126-
126+
127127
classDef foo fill:#8addf2,stroke:#333,stroke-width:4px;
128128
classDef fooSelected fill:#8addf2,stroke:green,stroke-width:4px;
129129
classDef bar fill:#ffcc26,stroke:#333,stroke-width:4px;
@@ -132,7 +132,7 @@ graph TD
132132
class e fooSelected;
133133
class e2 foo;
134134
class v,vs bar;
135-
135+
136136
linkStyle default fill:none,stroke-width:2px;
137137
{{</mermaid>}}
138138

@@ -163,7 +163,7 @@ graph TD
163163
class e3 fooSelected;
164164
class e2 foo;
165165
class v,vs bar;
166-
166+
167167
linkStyle default fill:none,stroke-width:2px;
168168
{{</mermaid>}}
169169

content/en/docs/Concepts/olm-architecture/operator-registry/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
21
---
32
title: "Operator Registry"
43
weight: 3
54
---
65

76
## What is Operator-Registry?
8-
7+
98
[Operator Registry](https://github.com/operator-framework/operator-registry) runs in a Kubernetes cluster to provide operator catalog data to [Operator Lifecycle Manager](https://github.com/operator-framework/operator-lifecycle-manager).
109

1110
<pre></pre>
@@ -26,7 +25,8 @@ And libraries:
2625
* `pkg/containertools` - providing an interface to interact with and shell out to common container tooling binaries (if installed on the environment)
2726

2827
## Why do I want Operator Registry?
29-
Operator registry allows you to package your operator in a defined format and make it available for OLM so that it can install your operator in a
28+
29+
Operator registry allows you to package your operator in a defined format and make it available for OLM so that it can install your operator in a
3030
kubernetes cluster.
3131
<pre></pre>
3232
You can find all the releases of operator-registry in the [github release page](https://github.com/operator-framework/operator-registry/releases)

content/en/docs/Concepts/olm-architecture/operator-registry/building-a-catalog.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,8 @@ opm index add --bundles quay.io/my-container-registry-namespace/my-manifest-bund
7878
<pre></pre>
7979
For more detail on using `opm` to generate index images, take a look at the [documentation](https://github.com/operator-framework/operator-registry/blob/master/docs/design/opm-tooling.md).
8080
<pre></pre>
81+
8182
## Where should I go next?
8283

8384
* [Use the catalog of operators locally](/docs/concepts/olm-architecture/operator-registry/using-a-catalog-locally): Test your catalog locally
8485
* [Using a Catalog with OLM](/docs/concepts/olm-architecture/operator-registry/using-catalog-with-olm): Make your operator available for OLM in a cluster
85-
86-

content/en/docs/Concepts/olm-architecture/operator-registry/using-a-catalog-locally.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Once you have a database file, eg sqlite.db, you can serve the database locally
1818
```bash
1919
./bin/registry-server -d sqlite.db -p <port number to serve on (default "50051")>
2020
```
21+
2122
[grpcurl](https://github.com/fullstorydev/grpcurl) is a useful tool for interacting with the example catalog server.
2223

2324
```sh
@@ -36,6 +37,7 @@ ListPackages
3637
```sh
3738
grpcurl -plaintext localhost:50051 api.Registry/ListPackages
3839
```
40+
3941
```json
4042
{
4143
"name": "etcd"
@@ -48,6 +50,7 @@ grpcurl -plaintext localhost:50051 api.Registry/ListPackages
4850
```sh
4951
grpcurl -plaintext -d '{"name":"etcd"}' localhost:50051 api.Registry/GetPackage
5052
```
53+
5154
```json
5255
{
5356
"name": "etcd",
@@ -65,6 +68,7 @@ grpcurl -plaintext -d '{"name":"etcd"}' localhost:50051 api.Registry/GetPackage
6568
$ grpcurl localhost:50051 describe api.Registry.GetBundleForChannel
6669
api.Registry.GetBundleForChannel is a method:
6770
```
71+
6872
```json
6973
{
7074
"name": "GetBundleForChannel",
@@ -79,6 +83,7 @@ api.Registry.GetBundleForChannel is a method:
7983
$ grpcurl localhost:50051 describe api.GetBundleInChannelRequest
8084
api.GetBundleInChannelRequest is a message:
8185
```
86+
8287
```json
8388
{
8489
"name": "GetBundleInChannelRequest",
@@ -113,6 +118,7 @@ api.GetBundleInChannelRequest is a message:
113118
```sh
114119
grpcurl -plaintext -d '{"pkgName":"etcd","channelName":"alpha"}' localhost:50051 api.Registry/GetBundleForChannel
115120
```
121+
116122
```json
117123
{
118124
"csvName": "etcdoperator.v0.9.2",
@@ -124,4 +130,4 @@ grpcurl -plaintext -d '{"pkgName":"etcd","channelName":"alpha"}' localhost:50051
124130
"{\"apiVersion\":\"apiextensions.k8s.io/v1beta1\",\"kind\":\"CustomResourceDefinition\",\"metadata\":{\"name\":\"etcdrestores.etcd.database.coreos.com\"},\"spec\":{\"group\":\"etcd.database.coreos.com\",\"names\":{\"kind\":\"EtcdRestore\",\"listKind\":\"EtcdRestoreList\",\"plural\":\"etcdrestores\",\"singular\":\"etcdrestore\"},\"scope\":\"Namespaced\",\"version\":\"v1beta2\"}}"
125131
]
126132
}
127-
```
133+
```

content/en/docs/Concepts/olm-architecture/operator-registry/using-catalog-with-olm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ spec:
6262
name: etcd
6363
source: example-manifests
6464
sourceNamespace: default
65-
```
65+
```

0 commit comments

Comments
 (0)