Skip to content

Commit b6eaaa2

Browse files
bhardestybhardesty
committed
OSDOCS-3991: Port Operators book to OSD/ROSA
1 parent f39867b commit b6eaaa2

File tree

96 files changed

+1246
-158
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+1246
-158
lines changed

‎_topic_maps/_topic_map_osd.yml‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,175 @@ Topics:
309309
# - Name: Exposing the registry
310310
# File: securing-exposing-registry
311311
---
312+
Name: Operators
313+
Dir: operators
314+
Distros: openshift-dedicated
315+
Topics:
316+
- Name: Operators overview
317+
File: index
318+
- Name: Understanding Operators
319+
Dir: understanding
320+
Topics:
321+
- Name: What are Operators?
322+
File: olm-what-operators-are
323+
- Name: Packaging format
324+
File: olm-packaging-format
325+
- Name: Common terms
326+
File: olm-common-terms
327+
- Name: Operator Lifecycle Manager (OLM)
328+
Dir: olm
329+
Topics:
330+
- Name: Concepts and resources
331+
File: olm-understanding-olm
332+
- Name: Architecture
333+
File: olm-arch
334+
- Name: Workflow
335+
File: olm-workflow
336+
- Name: Dependency resolution
337+
File: olm-understanding-dependency-resolution
338+
- Name: Operator groups
339+
File: olm-understanding-operatorgroups
340+
- Name: Multitenancy and Operator colocation
341+
File: olm-colocation
342+
- Name: Operator conditions
343+
File: olm-operatorconditions
344+
- Name: Metrics
345+
File: olm-understanding-metrics
346+
- Name: Webhooks
347+
File: olm-webhooks
348+
- Name: OperatorHub
349+
File: olm-understanding-operatorhub
350+
- Name: Red Hat-provided Operator catalogs
351+
File: olm-rh-catalogs
352+
- Name: Operators in multitenant clusters
353+
File: olm-multitenancy
354+
- Name: CRDs
355+
Dir: crds
356+
Topics:
357+
- Name: Managing resources from CRDs
358+
File: crd-managing-resources-from-crds
359+
- Name: User tasks
360+
Dir: user
361+
Topics:
362+
- Name: Creating applications from installed Operators
363+
File: olm-creating-apps-from-installed-operators
364+
- Name: Administrator tasks
365+
Dir: admin
366+
Topics:
367+
- Name: Adding Operators to a cluster
368+
File: olm-adding-operators-to-cluster
369+
- Name: Updating installed Operators
370+
File: olm-upgrading-operators
371+
- Name: Deleting Operators from a cluster
372+
File: olm-deleting-operators-from-cluster
373+
- Name: Configuring proxy support
374+
File: olm-configuring-proxy-support
375+
- Name: Viewing Operator status
376+
File: olm-status
377+
- Name: Managing Operator conditions
378+
File: olm-managing-operatorconditions
379+
- Name: Managing custom catalogs
380+
File: olm-managing-custom-catalogs
381+
- Name: Catalog source pod scheduling
382+
File: olm-cs-podsched
383+
# - Name: Managing platform Operators <= Tech Preview
384+
# File: olm-managing-po
385+
- Name: Developing Operators
386+
Dir: operator_sdk
387+
Topics:
388+
- Name: About the Operator SDK
389+
File: osdk-about
390+
- Name: Installing the Operator SDK CLI
391+
File: osdk-installing-cli
392+
- Name: Go-based Operators
393+
Dir: golang
394+
Topics:
395+
# Quick start excluded, because it requires cluster-admin permissions.
396+
# - Name: Getting started
397+
# File: osdk-golang-quickstart
398+
- Name: Tutorial
399+
File: osdk-golang-tutorial
400+
- Name: Project layout
401+
File: osdk-golang-project-layout
402+
- Name: Updating Go-based projects
403+
File: osdk-golang-updating-projects
404+
- Name: Ansible-based Operators
405+
Dir: ansible
406+
Topics:
407+
# Quick start excluded, because it requires cluster-admin permissions.
408+
# - Name: Getting started
409+
# File: osdk-ansible-quickstart
410+
- Name: Tutorial
411+
File: osdk-ansible-tutorial
412+
- Name: Project layout
413+
File: osdk-ansible-project-layout
414+
- Name: Updating Ansible-based projects
415+
File: osdk-ansible-updating-projects
416+
- Name: Ansible support
417+
File: osdk-ansible-support
418+
- Name: Kubernetes Collection for Ansible
419+
File: osdk-ansible-k8s-collection
420+
- Name: Using Ansible inside an Operator
421+
File: osdk-ansible-inside-operator
422+
- Name: Custom resource status management
423+
File: osdk-ansible-cr-status
424+
- Name: Helm-based Operators
425+
Dir: helm
426+
Topics:
427+
# Quick start excluded, because it requires cluster-admin permissions.
428+
# - Name: Getting started
429+
# File: osdk-helm-quickstart
430+
- Name: Tutorial
431+
File: osdk-helm-tutorial
432+
- Name: Project layout
433+
File: osdk-helm-project-layout
434+
- Name: Updating Helm-based projects
435+
File: osdk-helm-updating-projects
436+
- Name: Helm support
437+
File: osdk-helm-support
438+
# - Name: Hybrid Helm Operator <= Tech Preview
439+
# File: osdk-hybrid-helm
440+
# - Name: Updating Hybrid Helm-based projects <= Tech Preview
441+
# File: osdk-hybrid-helm-updating-projects
442+
# - Name: Java-based Operators <= Tech Preview
443+
# Dir: java
444+
# Topics:
445+
# - Name: Getting started
446+
# File: osdk-java-quickstart
447+
# - Name: Tutorial
448+
# File: osdk-java-tutorial
449+
# - Name: Project layout
450+
# File: osdk-java-project-layout
451+
# - Name: Updating Java-based projects
452+
# File: osdk-java-updating-projects
453+
- Name: Defining cluster service versions (CSVs)
454+
File: osdk-generating-csvs
455+
- Name: Working with bundle images
456+
File: osdk-working-bundle-images
457+
- Name: Complying with pod security admission
458+
File: osdk-complying-with-psa
459+
- Name: Validating Operators using the scorecard
460+
File: osdk-scorecard
461+
- Name: Validating Operator bundles
462+
File: osdk-bundle-validate
463+
- Name: High-availability or single-node cluster detection and support
464+
File: osdk-ha-sno
465+
- Name: Configuring built-in monitoring with Prometheus
466+
File: osdk-monitoring-prometheus
467+
- Name: Configuring leader election
468+
File: osdk-leader-election
469+
- Name: Object pruning utility
470+
File: osdk-pruning-utility
471+
- Name: Migrating package manifest projects to bundle format
472+
File: osdk-pkgman-to-bundle
473+
- Name: Operator SDK CLI reference
474+
File: osdk-cli-ref
475+
- Name: Migrating to Operator SDK v0.1.0
476+
File: osdk-migrating-to-v0-1-0
477+
# ROSA customers can't configure/edit the cluster Operators
478+
# - Name: Cluster Operators reference
479+
# File: operator-reference
480+
---
312481
Name: Networking
313482
Dir: networking
314483
Distros: openshift-dedicated

‎_topic_maps/_topic_map_rosa.yml‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,175 @@ Topics:
437437
# - Name: Exposing the registry
438438
# File: securing-exposing-registry
439439
---
440+
Name: Operators
441+
Dir: operators
442+
Distros: openshift-rosa
443+
Topics:
444+
- Name: Operators overview
445+
File: index
446+
- Name: Understanding Operators
447+
Dir: understanding
448+
Topics:
449+
- Name: What are Operators?
450+
File: olm-what-operators-are
451+
- Name: Packaging format
452+
File: olm-packaging-format
453+
- Name: Common terms
454+
File: olm-common-terms
455+
- Name: Operator Lifecycle Manager (OLM)
456+
Dir: olm
457+
Topics:
458+
- Name: Concepts and resources
459+
File: olm-understanding-olm
460+
- Name: Architecture
461+
File: olm-arch
462+
- Name: Workflow
463+
File: olm-workflow
464+
- Name: Dependency resolution
465+
File: olm-understanding-dependency-resolution
466+
- Name: Operator groups
467+
File: olm-understanding-operatorgroups
468+
- Name: Multitenancy and Operator colocation
469+
File: olm-colocation
470+
- Name: Operator conditions
471+
File: olm-operatorconditions
472+
- Name: Metrics
473+
File: olm-understanding-metrics
474+
- Name: Webhooks
475+
File: olm-webhooks
476+
- Name: OperatorHub
477+
File: olm-understanding-operatorhub
478+
- Name: Red Hat-provided Operator catalogs
479+
File: olm-rh-catalogs
480+
- Name: Operators in multitenant clusters
481+
File: olm-multitenancy
482+
- Name: CRDs
483+
Dir: crds
484+
Topics:
485+
- Name: Managing resources from CRDs
486+
File: crd-managing-resources-from-crds
487+
- Name: User tasks
488+
Dir: user
489+
Topics:
490+
- Name: Creating applications from installed Operators
491+
File: olm-creating-apps-from-installed-operators
492+
- Name: Administrator tasks
493+
Dir: admin
494+
Topics:
495+
- Name: Adding Operators to a cluster
496+
File: olm-adding-operators-to-cluster
497+
- Name: Updating installed Operators
498+
File: olm-upgrading-operators
499+
- Name: Deleting Operators from a cluster
500+
File: olm-deleting-operators-from-cluster
501+
- Name: Configuring proxy support
502+
File: olm-configuring-proxy-support
503+
- Name: Viewing Operator status
504+
File: olm-status
505+
- Name: Managing Operator conditions
506+
File: olm-managing-operatorconditions
507+
- Name: Managing custom catalogs
508+
File: olm-managing-custom-catalogs
509+
- Name: Catalog source pod scheduling
510+
File: olm-cs-podsched
511+
# - Name: Managing platform Operators <= Tech Preview
512+
# File: olm-managing-po
513+
- Name: Developing Operators
514+
Dir: operator_sdk
515+
Topics:
516+
- Name: About the Operator SDK
517+
File: osdk-about
518+
- Name: Installing the Operator SDK CLI
519+
File: osdk-installing-cli
520+
- Name: Go-based Operators
521+
Dir: golang
522+
Topics:
523+
# Quick start excluded, because it requires cluster-admin permissions.
524+
# - Name: Getting started
525+
# File: osdk-golang-quickstart
526+
- Name: Tutorial
527+
File: osdk-golang-tutorial
528+
- Name: Project layout
529+
File: osdk-golang-project-layout
530+
- Name: Updating Go-based projects
531+
File: osdk-golang-updating-projects
532+
- Name: Ansible-based Operators
533+
Dir: ansible
534+
Topics:
535+
# Quick start excluded, because it requires cluster-admin permissions.
536+
# - Name: Getting started
537+
# File: osdk-ansible-quickstart
538+
- Name: Tutorial
539+
File: osdk-ansible-tutorial
540+
- Name: Project layout
541+
File: osdk-ansible-project-layout
542+
- Name: Updating Ansible-based projects
543+
File: osdk-ansible-updating-projects
544+
- Name: Ansible support
545+
File: osdk-ansible-support
546+
- Name: Kubernetes Collection for Ansible
547+
File: osdk-ansible-k8s-collection
548+
- Name: Using Ansible inside an Operator
549+
File: osdk-ansible-inside-operator
550+
- Name: Custom resource status management
551+
File: osdk-ansible-cr-status
552+
- Name: Helm-based Operators
553+
Dir: helm
554+
Topics:
555+
# Quick start excluded, because it requires cluster-admin permissions.
556+
# - Name: Getting started
557+
# File: osdk-helm-quickstart
558+
- Name: Tutorial
559+
File: osdk-helm-tutorial
560+
- Name: Project layout
561+
File: osdk-helm-project-layout
562+
- Name: Updating Helm-based projects
563+
File: osdk-helm-updating-projects
564+
- Name: Helm support
565+
File: osdk-helm-support
566+
# - Name: Hybrid Helm Operator <= Tech Preview
567+
# File: osdk-hybrid-helm
568+
# - Name: Updating Hybrid Helm-based projects <= Tech Preview
569+
# File: osdk-hybrid-helm-updating-projects
570+
# - Name: Java-based Operators <= Tech Preview
571+
# Dir: java
572+
# Topics:
573+
# - Name: Getting started
574+
# File: osdk-java-quickstart
575+
# - Name: Tutorial
576+
# File: osdk-java-tutorial
577+
# - Name: Project layout
578+
# File: osdk-java-project-layout
579+
# - Name: Updating Java-based projects
580+
# File: osdk-java-updating-projects
581+
- Name: Defining cluster service versions (CSVs)
582+
File: osdk-generating-csvs
583+
- Name: Working with bundle images
584+
File: osdk-working-bundle-images
585+
- Name: Complying with pod security admission
586+
File: osdk-complying-with-psa
587+
- Name: Validating Operators using the scorecard
588+
File: osdk-scorecard
589+
- Name: Validating Operator bundles
590+
File: osdk-bundle-validate
591+
- Name: High-availability or single-node cluster detection and support
592+
File: osdk-ha-sno
593+
- Name: Configuring built-in monitoring with Prometheus
594+
File: osdk-monitoring-prometheus
595+
- Name: Configuring leader election
596+
File: osdk-leader-election
597+
- Name: Object pruning utility
598+
File: osdk-pruning-utility
599+
- Name: Migrating package manifest projects to bundle format
600+
File: osdk-pkgman-to-bundle
601+
- Name: Operator SDK CLI reference
602+
File: osdk-cli-ref
603+
- Name: Migrating to Operator SDK v0.1.0
604+
File: osdk-migrating-to-v0-1-0
605+
# ROSA customers can't configure/edit the cluster Operators
606+
# - Name: Cluster Operators reference
607+
# File: operator-reference
608+
---
440609
Name: Networking
441610
Dir: networking
442611
Distros: openshift-rosa

‎modules/arch-cluster-operators.adoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,11 @@
77

88
In {product-title}, all cluster functions are divided into a series of default _cluster Operators_. Cluster Operators manage a particular area of cluster functionality, such as cluster-wide application logging, management of the Kubernetes control plane, or the machine provisioning system.
99

10-
Cluster Operators are represented by a `ClusterOperator` object, which cluster administrators can view in the {product-title} web console from the *Administration* -> *Cluster Settings* page. Each cluster Operator provides a simple API for determining cluster functionality. The Operator hides the details of managing the lifecycle of that component. Operators can manage a single component or tens of components, but the end goal is always to reduce operational burden by automating common actions.
10+
Cluster Operators are represented by a `ClusterOperator` object, which
11+
ifndef::openshift-dedicated,openshift-rosa[]
12+
cluster administrators
13+
endif::openshift-dedicated,openshift-rosa[]
14+
ifdef::openshift-dedicated,openshift-rosa[]
15+
administrators with the `dedicated-admin` role
16+
endif::openshift-dedicated,openshift-rosa[]
17+
can view in the {product-title} web console from the *Administration* -> *Cluster Settings* page. Each cluster Operator provides a simple API for determining cluster functionality. The Operator hides the details of managing the lifecycle of that component. Operators can manage a single component or tens of components, but the end goal is always to reduce operational burden by automating common actions.

‎modules/arch-olm-operators.adoc‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,30 @@
77

88
Operator Lifecycle Manager (OLM) and OperatorHub are default components in {product-title} that help manage Kubernetes-native applications as Operators. Together they provide the system for discovering, installing, and managing the optional add-on Operators available on the cluster.
99

10-
Using OperatorHub in the {product-title} web console, cluster administrators and authorized users can select Operators to install from catalogs of Operators. After installing an Operator from OperatorHub, it can be made available globally or in specific namespaces to run in user applications.
10+
Using OperatorHub in the {product-title} web console,
11+
ifndef::openshift-dedicated,openshift-rosa[]
12+
cluster administrators
13+
endif::openshift-dedicated,openshift-rosa[]
14+
ifdef::openshift-dedicated,openshift-rosa[]
15+
administrators with the `dedicated-admin` role
16+
endif::openshift-dedicated,openshift-rosa[]
17+
and authorized users can select Operators to install from catalogs of Operators. After installing an Operator from OperatorHub, it can be made available globally or in specific namespaces to run in user applications.
1118

12-
Default catalog sources are available that include Red Hat Operators, certified Operators, and community Operators. Cluster administrators can also add their own custom catalog sources, which can contain a custom set of Operators.
19+
Default catalog sources are available that include Red Hat Operators, certified Operators, and community Operators.
20+
ifndef::openshift-dedicated,openshift-rosa[]
21+
Cluster administrators
22+
endif::openshift-dedicated,openshift-rosa[]
23+
ifdef::openshift-dedicated,openshift-rosa[]
24+
Administrators with the `dedicated-admin` role
25+
endif::openshift-dedicated,openshift-rosa[]
26+
can also add their own custom catalog sources, which can contain a custom set of Operators.
27+
28+
ifdef::openshift-dedicated,openshift-rosa[]
29+
[NOTE]
30+
====
31+
All Operators listed in the Operator Hub marketplace should be available for installation. These Operators are considered customer workloads, and are not monitored by Red Hat Site Reliability Engineering (SRE).
32+
====
33+
endif::openshift-dedicated,openshift-rosa[]
1334

1435
Developers can use the Operator SDK to help author custom Operators that take advantage of OLM features, as well. Their Operator can then be bundled and added to a custom catalog source, which can be added to a cluster and made available to users.
1536

0 commit comments

Comments
 (0)