You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 2, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: docs/discover-operator-presence.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Checking the presence of custom installed operators in the cluster is simply a m
6
6
associated with it that that contains all the details of the operator. Running `kubectl get csvs -A`
7
7
would return all CSVs across all namespaces and provide a high-level view of all custom installed operators.
8
8
9
-
If the ClusterServiceVersion fails to show up or does not reach the `Succeeded` phase, please check the [troubleshooting documentation](https://) to debug your installation.
9
+
If the ClusterServiceVersion fails to show up or does not reach the `Succeeded` phase, please check the [troubleshooting documentation](docs/) to debug your installation.
10
10
11
11
## Finding available operators
12
12
Operators are available from a variety of sources, or catalogs. Some catalogs are bundled in the default installation of
Copy file name to clipboardExpand all lines: docs/how-do-i-install-my-operator-with-olm.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# How do I install my operator with OLM?
2
2
3
-
[Once you've made your packaged operator available in a catalog](./how-do-i-package-my-operator-for-olm) it will appear in the `packagemanifest` list from which the Operators to install are selected. See [How do I list available Operators](./list-available-operators.md#information-relevant-for-installation) how to retrieve the required information from the `PackageServer` in order start an installation of an Operator.
3
+
[Once you've made your packaged operator available in a catalog](./how-do-i-package-my-operator-for-olm) it will appear in the `packagemanifest` list from which the Operators to install are selected. See [How do I list available Operators](docs/list-available-operators.md#information-relevant-for-installation) how to retrieve the required information from the `PackageServer` in order start an installation of an Operator.
4
4
5
5
## Install with automatic updates enabled
6
6
@@ -121,7 +121,7 @@ NAME READY UP-TO-DATE AVAILABLE AGE
121
121
my-operator 1/1 1 1 9m48s
122
122
```
123
123
124
-
If the ClusterServiceVersion fails to show up or does not reach the `Succeeded` phase, please check the [troubleshooting documentation](https://) to debug your installation.
124
+
If the ClusterServiceVersion fails to show up or does not reach the `Succeeded` phase, please check the [troubleshooting documentation](docs/troubleshooting.md) to debug your installation.
Copy file name to clipboardExpand all lines: docs/operator-scoping.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -147,7 +147,7 @@ spec:
147
147
148
148
Any operator tied to this `OperatorGroup` will now be confined to the permission(s) granted to the specified `ServiceAccount`. If the operator asks for permission(s) that are outside the scope of the `ServiceAccount` the install will fail with appropriate error(s).
149
149
150
-
An example of scoping an operator can be found [here]("https://operator-framework.github.io/olm-book/docs/how-do-i-scope-down-an-operator).
150
+
An example of scoping an operator can be found [here](docs/).
Copy file name to clipboardExpand all lines: docs/packaging-an-operator.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ These manifests consist of:
27
27
28
28
Building a minimal `ClusterServiceVersion` from these requires transplanting the contents of the Operator definition and the RBAC definitions into a CSV. Together, your CSV and CRDs will form the package that you give to OLM to install an operator.
29
29
30
-
#### Basic Metadata [Optional]
30
+
#### Basic Metadata \[Optional\]
31
31
32
32
Let's start with a CSV that only contains some descriptive metadata:
33
33
@@ -55,7 +55,7 @@ spec:
55
55
56
56
Most of these fields are optional, but they provide an opportunity to describe your operator to potential or current users.
57
57
58
-
#### Installation Metadata [Required]
58
+
#### Installation Metadata \[Required\]
59
59
60
60
The next section to add to the CSV is the Install Strategy - this tells OLM about the runtime components of your operator and their requirements.
61
61
@@ -139,7 +139,7 @@ If you have an existing CSV `csv.yaml` (refer to the example from Basic Metadata
By definition, operators are programs that can talk to the Kubernetes API. Often, they are also programs that *extend* the Kubernetes API, by providing an interface via `CustomResourceDefinition`s or, less frequently, `APIService`s.
145
145
@@ -204,7 +204,7 @@ spec:
204
204
kind: Memcached
205
205
```
206
206
207
-
##### NativeAPIs [recommended]
207
+
##### NativeAPIs \[recommended\]
208
208
209
209
There are often cases where you wish to depend on an API that is either provided natively by the platform (i.e. `Pod`) or sometimes by another operator that is outside the control of OLM.
Copy file name to clipboardExpand all lines: docs/troubleshooting.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,7 +88,7 @@ If the OLM operator encounters an unrecoverable error when attempting to install
88
88
89
89
>Note: It is possible that the Status is missing, which suggests that the OLM operator is encountering an issue when processing the `CSV` in a very early stage. You should respond by reviewing the logs of the OLM operator.
90
90
91
-
You should typically pay special attention to the information within the `status.reason` and `status.message` fields. Please look in the [#failed-csv-reasons]
91
+
You should typically pay special attention to the information within the `status.reason` and `status.message` fields. Please look in the [#Failed CSV reasons](#failed-csv-reasons) section.
92
92
93
93
If the `Status` block does not provide enough information, check the [OLM operator's logs](#how-to-view-the-olm-operator-logs).
0 commit comments