Skip to content

Commit 73393db

Browse files
adellapeadellape
authored
Merge pull request #65818 from bhardesty/osdocs-3991-operators-port-main
2 parents 9f383b7 + b6eaaa2 commit 73393db

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