Skip to content
This repository was archived by the owner on Aug 2, 2021. It is now read-only.
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 06a8d68

Browse files
committedDec 2, 2019
fix broken links
Signed-off-by: dmesser <[email protected]>
1 parent 1149a32 commit 06a8d68

5 files changed

+9
-9
lines changed
 

‎docs/discover-operator-presence.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Checking the presence of custom installed operators in the cluster is simply a m
66
associated with it that that contains all the details of the operator. Running `kubectl get csvs -A`
77
would return all CSVs across all namespaces and provide a high-level view of all custom installed operators.
88

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](troubleshooting.md) to debug your installation.
1010

1111
## Finding available operators
1212
Operators are available from a variety of sources, or catalogs. Some catalogs are bundled in the default installation of

‎docs/how-do-i-install-my-operator-with-olm.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How do I install my operator with OLM?
22

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](packaging-an-operator.md) 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.
44

55
## Install with automatic updates enabled
66

@@ -121,7 +121,7 @@ NAME READY UP-TO-DATE AVAILABLE AGE
121121
my-operator 1/1 1 1 9m48s
122122
```
123123

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](troubleshooting.md) to debug your installation.
125125

126126
## Install with manual updates
127127

‎docs/operator-scoping.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ spec:
147147

148148
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).
149149

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](./).
151151

152152
### Configuring the End User Experience
153153

‎docs/packaging-an-operator.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ These manifests consist of:
2727

2828
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.
2929

30-
#### Basic Metadata [Optional]
30+
#### Basic Metadata \[Optional\]
3131

3232
Let's start with a CSV that only contains some descriptive metadata:
3333

@@ -55,7 +55,7 @@ spec:
5555
5656
Most of these fields are optional, but they provide an opportunity to describe your operator to potential or current users.
5757
58-
#### Installation Metadata [Required]
58+
#### Installation Metadata \[Required\]
5959
6060
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.
6161
@@ -139,7 +139,7 @@ If you have an existing CSV `csv.yaml` (refer to the example from Basic Metadata
139139
$ faq -f yaml -o yaml --slurp '.[0].spec.install = {strategy: "deployment", spec:{ deployments: [{name: .[1].metadata.name, template: .[1].spec }], permissions: [{serviceAccountName: .[3].metadata.name, rules: .[2].rules }]}} | .[0]' csv.yaml operator.yaml role.yaml service_account.yaml
140140
```
141141

142-
#### Defining APIs [Required]
142+
#### Defining APIs \[Required\]
143143

144144
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.
145145

@@ -204,7 +204,7 @@ spec:
204204
kind: Memcached
205205
```
206206

207-
##### NativeAPIs [recommended]
207+
##### NativeAPIs \[recommended\]
208208

209209
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.
210210

‎docs/troubleshooting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ If the OLM operator encounters an unrecoverable error when attempting to install
8888

8989
>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.
9090
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.
9292

9393
If the `Status` block does not provide enough information, check the [OLM operator's logs](#how-to-view-the-olm-operator-logs).
9494

0 commit comments

Comments
 (0)
This repository has been archived.