Skip to content

Commit a05f966

Browse files
authored
WIP (#5135)
Signed-off-by: Jonathan Berkhahn <[email protected]>
1 parent c72eaca commit a05f966

File tree

12 files changed

+343
-276
lines changed

12 files changed

+343
-276
lines changed

website/content/en/docs/building-operators/ansible/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,5 +106,5 @@ Read the [full tutorial][tutorial] for an in-depth walkthough of building a Ansi
106106
[ansible-link]:https://www.ansible.com/
107107
[install-guide]:/docs/building-operators/ansible/installation
108108
[image-reg-config]:/docs/olm-integration/cli-overview#private-bundle-and-catalog-image-registries
109-
[doc-olm]:/docs/olm-integration/quickstart-bundle/#enabling-olm
109+
[doc-olm]:/docs/olm-integration/tutorial-bundle/#enabling-olm
110110
[tutorial]:/docs/building-operators/ansible/tutorial/

website/content/en/docs/building-operators/ansible/tutorial.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ There are three ways to run the operator:
164164

165165
- As Go program outside a cluster
166166
- As a Deployment inside a Kubernetes cluster
167-
- Managed by the [Operator Lifecycle Manager (OLM)][doc-olm] in [bundle][quickstart-bundle] format
167+
- Managed by the [Operator Lifecycle Manager (OLM)][doc-olm] in [bundle][tutorial-bundle] format
168168

169169
### 1. Run locally outside the cluster
170170

@@ -215,7 +215,7 @@ has a custom CA, these [configuration steps][image-reg-config] must be complete.
215215
operator-sdk run bundle example.com/memcached-operator-bundle:v0.0.1
216216
```
217217

218-
Check out the [docs][quickstart-bundle] for a deep dive into `operator-sdk`'s OLM integration.
218+
Check out the [docs][tutorial-bundle] for a deep dive into `operator-sdk`'s OLM integration.
219219

220220

221221
## Create a Memcached CR
@@ -346,7 +346,7 @@ todo(camilamacedo86): Create an Ansible operator scope document.
346346
https://github.com/operator-framework/operator-sdk/issues/3447
347347
-->
348348

349-
OLM will manage creation of most if not all resources required to run your operator, using a bit of setup from other operator-sdk commands. Check out the [OLM integration guide][quickstart-bundle].
349+
OLM will manage creation of most if not all resources required to run your operator, using a bit of setup from other operator-sdk commands. Check out the [OLM integration guide][tutorial-bundle].
350350

351351
[legacy-quickstart-doc]:https://v0-19-x.sdk.operatorframework.io/docs/ansible/quickstart/
352352
[migration-guide]:/docs/building-operators/ansible/migration
@@ -357,5 +357,5 @@ OLM will manage creation of most if not all resources required to run your opera
357357
[custom-resources]:https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
358358
[layout-doc]:/docs/building-operators/ansible/reference/scaffolding
359359
[doc-bundle]:https://github.com/operator-framework/operator-registry/blob/v1.16.1/docs/design/operator-bundle.md#operator-bundle
360-
[quickstart-bundle]:/docs/olm-integration/quickstart-bundle
361-
[doc-olm]:/docs/olm-integration/quickstart-bundle/#enabling-olm
360+
[tutorial-bundle]:/docs/olm-integration/tutorial-bundle
361+
[doc-olm]:/docs/olm-integration/tutorial-bundle/#enabling-olm

website/content/en/docs/building-operators/golang/operator-scope.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ if strings.Contains(watchNamespace, ",") {
268268
If your operator is [integrated with OLM][olm-integration], you will want to update your [CSV base's][csv-base]
269269
`spec.installModes` list to support the desired namespacing requirements. Support for multiple types of namespacing
270270
is allowed, so supporting multiple install modes in a CSV is permitted. After doing so, update your
271-
[bundle][bundle-quickstart] or [package manifests][packagemanifests-quickstart] by following the linked guides.
271+
[bundle][bundle-quickstart] or [package manifests][packagemanifests-tutorial] by following the linked guides.
272272

273273
### Watching resources in all Namespaces (default)
274274

@@ -311,4 +311,4 @@ If the operator can watch multiple namespaces, set the following in your `spec.i
311311
[olm-integration]: /docs/olm-integration
312312
[csv-base]: /docs/olm-integration/generation/#kustomize-files
313313
[bundle-quickstart]: /docs/olm-integration/quickstart-bundle
314-
[packagemanifests-quickstart]: /docs/olm-integration/quickstart-package-manifests
314+
[packagemanifests-tutorial]: /docs/olm-integration/tutorial-package-manifests

website/content/en/docs/building-operators/golang/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,5 +105,5 @@ Read the [full tutorial][tutorial] for an in-depth walkthough of building a Go o
105105

106106
[install-guide]:/docs/building-operators/golang/installation
107107
[image-reg-config]:/docs/olm-integration/cli-overview#private-bundle-and-catalog-image-registries
108-
[doc-olm]:/docs/olm-integration/quickstart-bundle/#enabling-olm
108+
[doc-olm]:/docs/olm-integration/tutorial-bundle/#enabling-olm
109109
[tutorial]:/docs/building-operators/golang/tutorial/

website/content/en/docs/building-operators/golang/tutorial.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ has a custom CA, these [configuration steps][image-reg-config] must be complete.
345345
operator-sdk run bundle example.com/memcached-operator-bundle:v0.0.1
346346
```
347347

348-
Check out the [docs][quickstart-bundle] for a deep dive into `operator-sdk`'s OLM integration.
348+
Check out the [docs][tutorial-bundle] for a deep dive into `operator-sdk`'s OLM integration.
349349

350350

351351
## Create a Memcached CR
@@ -478,8 +478,9 @@ Next, check out the following:
478478
[role-based-access-control]: https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control#iam-rolebinding-bootstrap
479479
[multigroup-kubebuilder-doc]: https://book.kubebuilder.io/migration/multi-group.html
480480
[doc-bundle]:https://github.com/operator-framework/operator-registry/blob/v1.16.1/docs/design/operator-bundle.md#operator-bundle
481+
[tutorial-bundle]:/docs/olm-integration/tutorial-bundle
481482
[quickstart-bundle]:/docs/olm-integration/quickstart-bundle
482-
[doc-olm]:/docs/olm-integration/quickstart-bundle/#enabling-olm
483+
[doc-olm]:/docs/olm-integration/tutorial-bundle/#enabling-olm
483484
[conditionals]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
484485
[kubernetes-extend-api]: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/
485486
[reconcile-godoc]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/reconcile

website/content/en/docs/building-operators/helm/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,5 +106,5 @@ Read the [full tutorial][tutorial] for an in-depth walkthough of building a Helm
106106
[helm-official]:https://helm.sh/docs/
107107
[install-guide]:/docs/building-operators/helm/installation
108108
[image-reg-config]:/docs/olm-integration/cli-overview#private-bundle-and-catalog-image-registries
109-
[doc-olm]:/docs/olm-integration/quickstart-bundle/#enabling-olm
109+
[doc-olm]:/docs/olm-integration/tutorial-bundle/#enabling-olm
110110
[tutorial]:/docs/building-operators/helm/tutorial/

website/content/en/docs/building-operators/helm/tutorial.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ There are three ways to run the operator:
197197

198198
- As Go program outside a cluster
199199
- As a Deployment inside a Kubernetes cluster
200-
- Managed by the [Operator Lifecycle Manager (OLM)][doc-olm] in [bundle][quickstart-bundle] format
200+
- Managed by the [Operator Lifecycle Manager (OLM)][doc-olm] in [bundle][tutorial-bundle] format
201201

202202
### 1. Run locally outside the cluster
203203

@@ -248,7 +248,7 @@ has a custom CA, these [configuration steps][image-reg-config] must be complete.
248248
operator-sdk run bundle example.com/nginx-operator-bundle:v0.0.1
249249
```
250250

251-
Check out the [docs][quickstart-bundle] for a deep dive into `operator-sdk`'s OLM integration.
251+
Check out the [docs][tutorial-bundle] for a deep dive into `operator-sdk`'s OLM integration.
252252

253253

254254
## Create a Nginx CR
@@ -366,7 +366,7 @@ Next, check out the following:
366366
[helm-charts]:https://helm.sh/docs/topics/charts/
367367
[helm-values]:https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing
368368
[helm-official]:https://helm.sh/docs/
369-
[quickstart-bundle]:/docs/olm-integration/quickstart-bundle
370-
[doc-olm]:/docs/olm-integration/quickstart-bundle/#enabling-olm
369+
[tutorial-bundle]:/docs/olm-integration/tutorial-bundle
370+
[doc-olm]:/docs/olm-integration/tutorial-bundle/#enabling-olm
371371
[olm-integration]:/docs/olm-integration
372372
[advanced-features]:/docs/building-operators/helm/reference/advanced_features

0 commit comments

Comments
 (0)