openshift-docs/_topic_maps/_topic_map_osd.yml

# This configuration file dictates the organization of the topic groups and
# topics on the main page of the doc site for this branch. Each record
# consists of the following:
#
# ---                                  <= Record delimiter
# Name: Origin of the Species          <= Display name of topic group
# Dir:  origin_of_the_species          <= Directory name of topic group
# Topics:
#   - Name: The Majestic Marmoset      <= Topic name
#     File: the_majestic_marmoset      <= Topic file under group dir +/-
#   - Name: The Curious Crocodile      <= Topic 2 name
#     File: the_curious_crocodile      <= Topic 2 file
#   - Name: The Numerous Nematodes     <= Sub-topic group name
#     Dir: the_numerous_nematodes      <= Sub-topic group dir
#     Topics:
#       - Name: The Wily Worm          <= Sub-topic name
#         File: the_wily_worm          <= Sub-topic file under <group dir>/<subtopic dir>
#       - Name: The Acrobatic Ascarid  <= Sub-topic 2 name
#         File: the_acrobatic_ascarid  <= Sub-topic 2 file under <group dir>/<subtopic dir>
#
# The ordering of the records in this document determines the ordering of the
# topic groups and topics on the main page.

---
Name: About
Dir: welcome
Distros: openshift-dedicated
Topics:
- Name: Welcome
  File: index
- Name: Legal notice
  File: legal-notice
  Distros: openshift-dedicated
---
Name: Introduction to OpenShift Dedicated
Dir: osd_architecture
Distros: openshift-dedicated
Topics:
- Name: Understanding OpenShift Dedicated
  File: osd-understanding
- Name: Architecture concepts
  File: osd-architecture
- Name: Policies and service definition
  Dir: osd_policy
  Distros: openshift-dedicated
  Topics:
  - Name: OpenShift Dedicated service definition
    File: osd-service-definition
  - Name: Responsibility assignment matrix
    File: policy-responsibility-matrix
  - Name: Understanding process and security for OpenShift Dedicated
    File: policy-process-security
  - Name: SRE and service account access
    File: osd-sre-access
  - Name: About availability for OpenShift Dedicated
    File: policy-understand-availability
  - Name: Update life cycle
    File: osd-life-cycle
# Created a new assembly in ROSA/OSD. In OCP, the assembly is in a book that is not in ROSA/OSD
- Name: About admission plugins
  File: osd-admission-plug-ins
  Distros: openshift-dedicated
---
#Name: Tutorials
#Dir: cloud_experts_tutorials
#Distros: openshift-dedicated
#Topics:
#---
Name: Red Hat OpenShift Cluster Manager
Dir: ocm
Distros: openshift-dedicated
Topics:
- Name: Red Hat OpenShift Cluster Manager
  File: ocm-overview
---
Name: Planning your environment
Dir: osd_planning
Distros: openshift-dedicated
Topics:
- Name: Limits and scalability
  File: osd-limits-scalability
- Name: Customer Cloud Subscriptions on AWS
  File: aws-ccs
- Name: Customer Cloud Subscriptions on GCP
  File: gcp-ccs
---
Name: Getting started
Dir: osd_getting_started
Distros: openshift-dedicated
Topics:
- Name: Understanding your cloud deployment options
  File: osd-understanding-your-cloud-deployment-options
- Name: Getting started with OpenShift Dedicated
  File: osd-getting-started
---
Name: Installing, accessing, and deleting OpenShift Dedicated clusters
Dir: osd_install_access_delete_cluster
Distros: openshift-dedicated
Topics:
- Name: Creating a cluster on AWS
  File: creating-an-aws-cluster
- Name: Creating a cluster on GCP
  File: creating-a-gcp-cluster
- Name: Configuring your identity providers
  File: config-identity-providers
- Name: Revoking privileges and access to an OpenShift Dedicated cluster
  File: osd-revoking-cluster-privileges
- Name: Deleting an OpenShift Dedicated cluster
  File: osd-deleting-a-cluster
---
Name: Support
Dir: support
Distros: openshift-dedicated
Topics:
- Name: Support overview
  File: index
- Name: Managing your cluster resources
  File: managing-cluster-resources
- Name: Getting support
  File: getting-support
  Distros: openshift-dedicated
- Name: Remote health monitoring with connected clusters
  Dir: remote_health_monitoring
  Distros: openshift-dedicated
  Topics:
  - Name: About remote health monitoring
    File: about-remote-health-monitoring
  - Name: Showing data collected by remote health monitoring
    File: showing-data-collected-by-remote-health-monitoring
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
#  - Name: Opting out of remote health reporting
#    File: opting-out-of-remote-health-reporting
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
#  - Name: Enabling remote health reporting
#    File: enabling-remote-health-reporting
  - Name: Using Insights to identify issues with your cluster
    File: using-insights-to-identify-issues-with-your-cluster
  - Name: Using Insights Operator
    File: using-insights-operator
# Not supported per Michael McNeill
# - Name: Using remote health reporting in a restricted network
#   File: remote-health-reporting-from-restricted-network
# cannot list resource "secrets" in API group "" in the namespace "openshift-config"
#  - Name: Importing simple content access entitlements with Insights Operator
#    File: insights-operator-simple-access
# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
# - Name: Gathering data about your cluster
#   File: gathering-cluster-data
#   Distros: openshift-dedicated
- Name: Summarizing cluster specifications
  File: summarizing-cluster-specifications
  Distros: openshift-dedicated
- Name: Troubleshooting
  Dir: troubleshooting
  Distros: openshift-dedicated
  Topics:
#  - Name: Troubleshooting installations
#    File: troubleshooting-installations
  - Name: Verifying node health
    File: verifying-node-health
#  cannot create resource "namespaces", cannot patch resource "nodes"
#  - Name: Troubleshooting CRI-O container runtime issues
#    File: troubleshooting-crio-issues
# requires ostree, butane, and other plug-ins
#  - Name: Troubleshooting operating system issues
#    File: troubleshooting-operating-system-issues
#    Distros: openshift-dedicated
# cannot patch resource "nodes", "nodes/proxy", "namespaces"
#  - Name: Troubleshooting network issues
#    File: troubleshooting-network-issues
#    Distros: openshift-dedicated
  - Name: Troubleshooting Operator issues
    File: troubleshooting-operator-issues
  - Name: Investigating pod issues
    File: investigating-pod-issues
# Hiding from ROSA and OSD until it is decided who should port the Build book
#  - Name: Troubleshooting the Source-to-Image process
#    File: troubleshooting-s2i
  - Name: Troubleshooting storage issues
    File: troubleshooting-storage-issues
# Not supported per WINC team
#  - Name: Troubleshooting Windows container workload issues
#    File: troubleshooting-windows-container-workload-issues
  - Name: Investigating monitoring issues
    File: investigating-monitoring-issues
  - Name: Diagnosing OpenShift CLI (oc) issues
    File: diagnosing-oc-issues
  - Name: OpenShift Dedicated managed resources
    File: osd-managed-resources
    Distros: openshift-dedicated
---
Name: Web console
Dir: web_console
Distros: openshift-dedicated
Topics:
- Name: Web console overview
  File: web-console-overview
- Name: Accessing the web console
  File: web-console
- Name: Viewing cluster information
  File: using-dashboard-to-get-cluster-information
- Name: Adding user preferences
  File: adding-user-preferences
  Distros: openshift-enterprise,openshift-origin
# cannot patch resource "consoles", insufficient permissions to read any Cluster configuration
#- Name: Configuring the web console
#  File: configuring-web-console
#  Distros: openshift-rosa
- Name: Customizing the web console
  File: customizing-the-web-console
  Distros: openshift-dedicated
- Name: Dynamic plugins
  Dir: dynamic-plugin
  Distros: openshift-dedicated
  Topics:
  - Name: Overview of dynamic plugins
    File: overview-dynamic-plugin
  - Name: Getting started with dynamic plugins
    File: dynamic-plugins-get-started
  - Name: Deploy your plugin on a cluster
    File: deploy-plugin-cluster
  - Name: Dynamic plugin example
    File: dynamic-plugin-example
  - Name: Dynamic plugin reference
    File: dynamic-plugins-reference
- Name: Web terminal
  Dir: web_terminal
  Distros: openshift-dedicated
  Topics:
  - Name: Installing the web terminal
    File: installing-web-terminal
  # Do not have sufficient permissions to read any cluster configuration.
  #  - Name: Configuring the web terminal
  #    File: configuring-web-terminal
  - Name: Using the web terminal
    File: odc-using-web-terminal
  - Name: Troubleshooting the web terminal
    File: troubleshooting-web-terminal
  - Name: Uninstalling the web terminal
    File: uninstalling-web-terminal
- Name: Disabling the web console
  File: disabling-web-console
  Distros: openshift-dedicated
- Name: About quick start tutorials
  File: creating-quick-start-tutorials
  Distros: openshift-dedicated
---
Name: CLI tools
Dir: cli_reference
Distros: openshift-dedicated
Topics:
- Name: CLI tools overview
  File: index
- Name: OpenShift CLI (oc)
  Dir: openshift_cli
  Topics:
  - Name: Getting started with the OpenShift CLI
    File: getting-started-cli
  - Name: Configuring the OpenShift CLI
    File: configuring-cli
  - Name: Usage of oc and kubectl commands
    File: usage-oc-kubectl
  - Name: Managing CLI profiles
    File: managing-cli-profiles
  - Name: Extending the OpenShift CLI with plugins
    File: extending-cli-plugins
  # - Name: Managing CLI plugins with Krew
  # File: managing-cli-plugins-krew
  #  Distros: openshift-dedicated
  - Name: OpenShift CLI developer command reference
    File: developer-cli-commands
  - Name: OpenShift CLI administrator command reference
    File: administrator-cli-commands
    Distros: openshift-dedicated
- Name: Developer CLI (odo)
  File: odo-important-update
  # Dir: developer_cli_odo
  Distros: openshift-dedicated
  # Topics:
  # - Name: odo release notes
  #  File: odo-release-notes
  # - Name: Understanding odo
  #  File: understanding-odo
  # - Name: Installing odo
  #  File: installing-odo
  # - Name: Configuring the odo CLI
  #  File: configuring-the-odo-cli
  # - Name: odo CLI reference
  #  File: odo-cli-reference
- Name: Knative CLI (kn) for use with OpenShift Serverless
  File: kn-cli-tools
  Distros: openshift-dedicated
- Name: Pipelines CLI (tkn)
  Dir: tkn_cli
  Distros: openshift-dedicated
  Topics:
  - Name: Installing tkn
    File: installing-tkn
  - Name: Configuring tkn
    File: op-configuring-tkn
  - Name: Basic tkn commands
    File: op-tkn-reference
- Name: opm CLI
  Dir: opm
  Distros: openshift-dedicated
  Topics:
  - Name: Installing the opm CLI
    File: cli-opm-install
  - Name: opm CLI reference
    File: cli-opm-ref
- Name: Operator SDK
  Dir: osdk
  Distros: openshift-dedicated
  Topics:
  - Name: Installing the Operator SDK CLI
    File: cli-osdk-install
  - Name: Operator SDK CLI reference
    File: cli-osdk-ref
---
Name: Cluster administration
Dir: osd_cluster_admin
Distros: openshift-dedicated
Topics:
- Name: Configuring private connections
  Dir: osd_private_connections
  Distros: openshift-dedicated
  Topics:
  - Name: Configuring private connections for AWS
    File: aws-private-connections
  - Name: Configuring a private cluster
    File: private-cluster
- Name: Cluster autoscaling
  File: osd-cluster-autoscaling
- Name: Nodes
  Dir: osd_nodes
  Distros: openshift-dedicated
  Topics:
  - Name: About machine pools
    File: osd-nodes-machinepools-about
  - Name: Managing compute nodes
    File: osd-managing-worker-nodes
  - Name: About autoscaling nodes on a cluster
    File: osd-nodes-about-autoscaling-nodes
- Name: Logging
  Dir: osd_logging
  Distros: openshift-dedicated
  Topics:
  - Name: Accessing the service logs
    File: osd-accessing-the-service-logs
---
Name: Security and compliance
Dir: security
Distros: openshift-dedicated
Topics:
- Name: Audit logs
  File: audit-log-view
---
Name: Authentication and authorization
Dir: authentication
Distros: openshift-dedicated
Topics:
- Name: Authentication and authorization overview
  File: index
- Name: Understanding authentication
  File: understanding-authentication
# - Name: Configuring the internal OAuth server
#   File: configuring-internal-oauth
# - Name: Configuring OAuth clients
#   File: configuring-oauth-clients
- Name: Managing user-owned OAuth access tokens
  File: managing-oauth-access-tokens
# - Name: Understanding identity provider configuration
#   File: understanding-identity-provider
- Name: Configuring identity providers
  File: sd-configuring-identity-providers
# - Name: Configuring identity providers
#   Dir: identity_providers
#   Topics:
#   - Name: Configuring an htpasswd identity provider
#     File: configuring-htpasswd-identity-provider
#   - Name: Configuring a Keystone identity provider
#     File: configuring-keystone-identity-provider
#   - Name: Configuring an LDAP identity provider
#     File: configuring-ldap-identity-provider
#   - Name: Configuring a basic authentication identity provider
#     File: configuring-basic-authentication-identity-provider
#   - Name: Configuring a request header identity provider
#     File: configuring-request-header-identity-provider
#   - Name: Configuring a GitHub or GitHub Enterprise identity provider
#     File: configuring-github-identity-provider
#   - Name: Configuring a GitLab identity provider
#     File: configuring-gitlab-identity-provider
#   - Name: Configuring a Google identity provider
#     File: configuring-google-identity-provider
#   - Name: Configuring an OpenID Connect identity provider
#     File: configuring-oidc-identity-provider
- Name: Managing administration roles and users
  File: osd-admin-roles
- Name: Using RBAC to define and apply permissions
  File: using-rbac
# - Name: Removing the kubeadmin user
#   File: remove-kubeadmin
#- Name: Configuring LDAP failover
#  File: configuring-ldap-failover
- Name: Understanding and creating service accounts
  File: understanding-and-creating-service-accounts
- Name: Using service accounts in applications
  File: using-service-accounts-in-applications
- Name: Using a service account as an OAuth client
  File: using-service-accounts-as-oauth-client
- Name: Scoping tokens
  File: tokens-scoping
- Name: Using bound service account tokens
  File: bound-service-account-tokens
- Name: Managing security context constraints
  File: managing-security-context-constraints
- Name: Understanding and managing pod security admission
  File: understanding-and-managing-pod-security-admission
# - Name: Impersonating the system:admin user
#   File: impersonating-system-admin
- Name: Syncing LDAP groups
  File: ldap-syncing
# - Name: Managing cloud provider credentials
#   Dir: managing_cloud_provider_credentials
#   Topics:
#   - Name: About the Cloud Credential Operator
#     File: about-cloud-credential-operator
#   - Name: Mint mode
#     File: cco-mode-mint
#   - Name: Passthrough mode
#     File: cco-mode-passthrough
#   - Name: Manual mode with long-term credentials for components
#     File: cco-mode-manual
#   - Name: Manual mode with short-term credentials for components
#     File: cco-short-term-creds
---
Name: Upgrading
Dir: upgrading
Distros: openshift-dedicated
Topics:
- Name: Preparing to upgrade OpenShift Dedicated to 4.9
  File: osd-upgrading-cluster-prepare
  Distros: openshift-dedicated
- Name: Upgrading OpenShift Dedicated
  File: osd-upgrades
  Distros: openshift-dedicated
---
Name: CI/CD
Dir: cicd
Distros: openshift-dedicated
Topics:
- Name: Builds
  Dir: builds
  Distros: openshift-dedicated
  Topics:
  - Name: Setting up additional trusted certificate authorities for builds
    File: setting-up-trusted-ca
    Distros: openshift-dedicated
---
Name: Images
Dir: openshift_images
Distros: openshift-dedicated
Topics:
- Name: Overview of images
  File: index
# replaced Configuring the Cluster Samples Operator name, cannot configure the operator
- Name: Overview of the Cluster Samples Operator
  File: configuring-samples-operator
  Distros: openshift-dedicated
- Name: Using the Cluster Samples Operator with an alternate registry
  File: samples-operator-alt-registry
  Distros: openshift-dedicated
- Name: Creating images
  File: create-images
- Name: Managing images
  Dir: managing_images
  Topics:
  - Name: Managing images overview
    File: managing-images-overview
  - Name: Tagging images
    File: tagging-images
  - Name: Image pull policy
    File: image-pull-policy
  - Name: Using image pull secrets
    File: using-image-pull-secrets
- Name: Managing image streams
  File: image-streams-manage
  Distros: openshift-dedicated
- Name: Using image streams with Kubernetes resources
  File: using-imagestreams-with-kube-resources
  Distros: openshift-dedicated
- Name: Triggering updates on image stream changes
  File: triggering-updates-on-imagestream-changes
  Distros: openshift-dedicated
- Name: Image configuration resources
  File: image-configuration
  Distros: openshift-dedicated
- Name: Using templates
  File: using-templates
- Name: Using Ruby on Rails
  File: templates-using-ruby-on-rails
- Name: Using images
  Dir: using_images
  Distros: openshift-dedicated
  Topics:
  - Name: Using images overview
    File: using-images-overview
  - Name: Source-to-image
    File: using-s21-images
  - Name: Customizing source-to-image images
    File: customizing-s2i-images
---
Name: Add-on services
Dir: adding_service_cluster
Distros: openshift-dedicated
Topics:
- Name: Adding services to a cluster
  File: adding-service
- Name: Available services
  File: available-services
  Distros: openshift-dedicated
---
Name: Storage
Dir: storage
Distros: openshift-dedicated
Topics:
- Name: Storage overview
  File: index
- Name: Understanding ephemeral storage
  File: understanding-ephemeral-storage
- Name: Understanding persistent storage
  File: understanding-persistent-storage
- Name: Configuring persistent storage
  Dir: persistent_storage
  Topics:
  - Name: Persistent storage using AWS Elastic Block Store
    File: persistent-storage-aws
  - Name: Persistent storage using GCE Persistent Disk
    File: persistent-storage-gce
- Name: Using Container Storage Interface (CSI)
  Dir: container_storage_interface
  Topics:
  - Name: Configuring CSI volumes
    File: persistent-storage-csi
  - Name: Managing the default storage class
    File: persistent-storage-csi-sc-manage
  - Name: AWS Elastic Block Store CSI Driver Operator
    File: persistent-storage-csi-ebs
  - Name: AWS Elastic File Service CSI Driver Operator
    File: osd-persistent-storage-aws-efs-csi
  - Name: GCP PD CSI Driver Operator
    File: persistent-storage-csi-gcp-pd
  #- Name: GCP Filestore CSI Driver Operator
  #  File: persistent-storage-csi-google-cloud-file
- Name: Generic ephemeral volumes
  File: generic-ephemeral-vols
- Name: Dynamic provisioning
  File: dynamic-provisioning
---
Name: Registry
Dir: registry
Distros: openshift-dedicated
Topics:
- Name: Registry overview
  File: index
- Name: Image Registry Operator in OpenShift Dedicated
  File: configuring-registry-operator
- Name: Accessing the registry
  File: accessing-the-registry
# - Name: Exposing the registry
#   File: securing-exposing-registry
---
Name: Operators
Dir: operators
Distros: openshift-dedicated
Topics:
- Name: Operators overview
  File: index
- Name: Understanding Operators
  Dir: understanding
  Topics:
  - Name: What are Operators?
    File: olm-what-operators-are
  - Name: Packaging format
    File: olm-packaging-format
  - Name: Common terms
    File: olm-common-terms
  - Name: Operator Lifecycle Manager (OLM)
    Dir: olm
    Topics:
    - Name: Concepts and resources
      File: olm-understanding-olm
    - Name: Architecture
      File: olm-arch
    - Name: Workflow
      File: olm-workflow
    - Name: Dependency resolution
      File: olm-understanding-dependency-resolution
    - Name: Operator groups
      File: olm-understanding-operatorgroups
    - Name: Multitenancy and Operator colocation
      File: olm-colocation
    - Name: Operator conditions
      File: olm-operatorconditions
    - Name: Metrics
      File: olm-understanding-metrics
    - Name: Webhooks
      File: olm-webhooks
  - Name: OperatorHub
    File: olm-understanding-operatorhub
  - Name: Red Hat-provided Operator catalogs
    File: olm-rh-catalogs
  - Name: Operators in multitenant clusters
    File: olm-multitenancy
  - Name: CRDs
    Dir: crds
    Topics:
    - Name: Managing resources from CRDs
      File: crd-managing-resources-from-crds
- Name: User tasks
  Dir: user
  Topics:
  - Name: Creating applications from installed Operators
    File: olm-creating-apps-from-installed-operators
- Name: Administrator tasks
  Dir: admin
  Topics:
  - Name: Adding Operators to a cluster
    File: olm-adding-operators-to-cluster
  - Name: Updating installed Operators
    File: olm-upgrading-operators
  - Name: Deleting Operators from a cluster
    File: olm-deleting-operators-from-cluster
  - Name: Configuring proxy support
    File: olm-configuring-proxy-support
  - Name: Viewing Operator status
    File: olm-status
  - Name: Managing Operator conditions
    File: olm-managing-operatorconditions
  - Name: Managing custom catalogs
    File: olm-managing-custom-catalogs
  - Name: Catalog source pod scheduling
    File: olm-cs-podsched
# - Name: Managing platform Operators  <= Tech Preview
#   File: olm-managing-po
  - Name: Troubleshooting Operator issues
    File: olm-troubleshooting-operator-issues
- Name: Developing Operators
  Dir: operator_sdk
  Topics:
  - Name: About the Operator SDK
    File: osdk-about
  - Name: Installing the Operator SDK CLI
    File: osdk-installing-cli
  - Name: Go-based Operators
    Dir: golang
    Topics:
# Quick start excluded, because it requires cluster-admin permissions.
#   - Name: Getting started
#     File: osdk-golang-quickstart
    - Name: Tutorial
      File: osdk-golang-tutorial
    - Name: Project layout
      File: osdk-golang-project-layout
    - Name: Updating Go-based projects
      File: osdk-golang-updating-projects
  - Name: Ansible-based Operators
    Dir: ansible
    Topics:
# Quick start excluded, because it requires cluster-admin permissions.
#   - Name: Getting started
#     File: osdk-ansible-quickstart
    - Name: Tutorial
      File: osdk-ansible-tutorial
    - Name: Project layout
      File: osdk-ansible-project-layout
    - Name: Updating Ansible-based projects
      File: osdk-ansible-updating-projects
    - Name: Ansible support
      File: osdk-ansible-support
    - Name: Kubernetes Collection for Ansible
      File: osdk-ansible-k8s-collection
    - Name: Using Ansible inside an Operator
      File: osdk-ansible-inside-operator
    - Name: Custom resource status management
      File: osdk-ansible-cr-status
  - Name: Helm-based Operators
    Dir: helm
    Topics:
# Quick start excluded, because it requires cluster-admin permissions.
#   - Name: Getting started
#     File: osdk-helm-quickstart
    - Name: Tutorial
      File: osdk-helm-tutorial
    - Name: Project layout
      File: osdk-helm-project-layout
    - Name: Updating Helm-based projects
      File: osdk-helm-updating-projects
    - Name: Helm support
      File: osdk-helm-support
#   - Name: Hybrid Helm Operator  <= Tech Preview
#     File: osdk-hybrid-helm
#   - Name: Updating Hybrid Helm-based projects  <= Tech Preview
#     File: osdk-hybrid-helm-updating-projects
# - Name: Java-based Operators  <= Tech Preview
#   Dir: java
#   Topics:
#   - Name: Getting started
#     File: osdk-java-quickstart
#   - Name: Tutorial
#     File: osdk-java-tutorial
#   - Name: Project layout
#     File: osdk-java-project-layout
#   - Name: Updating Java-based projects
#     File: osdk-java-updating-projects
  - Name: Defining cluster service versions (CSVs)
    File: osdk-generating-csvs
  - Name: Working with bundle images
    File: osdk-working-bundle-images
  - Name: Complying with pod security admission
    File: osdk-complying-with-psa
  - Name: Validating Operators using the scorecard
    File: osdk-scorecard
  - Name: Validating Operator bundles
    File: osdk-bundle-validate
  - Name: High-availability or single-node cluster detection and support
    File: osdk-ha-sno
  - Name: Configuring built-in monitoring with Prometheus
    File: osdk-monitoring-prometheus
  - Name: Configuring leader election
    File: osdk-leader-election
  - Name: Object pruning utility
    File: osdk-pruning-utility
  - Name: Migrating package manifest projects to bundle format
    File: osdk-pkgman-to-bundle
  - Name: Operator SDK CLI reference
    File: osdk-cli-ref
  - Name: Migrating to Operator SDK v0.1.0
    File: osdk-migrating-to-v0-1-0
# ROSA customers can't configure/edit the cluster Operators
# - Name: Cluster Operators reference
#   File: operator-reference
---
Name: Networking
Dir: networking
Distros: openshift-dedicated
Topics:
- Name: Understanding the DNS Operator
  File: dns-operator
- Name: Understanding the Ingress Operator
  File: ingress-operator
- Name: OpenShift SDN default CNI network provider
  Dir: openshift_sdn
  Topics:
  - Name: Enabling multicast for a project
    File: enabling-multicast
- Name: Network verification
  File: network-verification
- Name: Configuring a cluster-wide proxy during installation
  File: configuring-cluster-wide-proxy
- Name: CIDR range definitions
  File: cidr-range-definitions
- Name: Network policy
  Dir: network_policy
  Topics:
  - Name: About network policy
    File: about-network-policy
  - Name: Creating a network policy
    File: creating-network-policy
  - Name: Viewing a network policy
    File: viewing-network-policy
  - Name: Deleting a network policy
    File: deleting-network-policy
  - Name: Configuring multitenant isolation with network policy
    File: multitenant-network-policy
- Name: Configuring Routes
  Dir: routes
  Topics:
  - Name: Route configuration
    File: route-configuration
  - Name: Secured routes
    File: secured-routes
---
Name: Applications
Dir: applications
Distros: openshift-dedicated
Topics:
- Name: Deployments
  Dir: deployments
  Distros: openshift-dedicated
  Topics:
  - Name: Custom domains for applications
    File: osd-config-custom-domains-applications
---
Name: Nodes
Dir: nodes
Distros: openshift-dedicated
Topics:
- Name: Overview of nodes
  File: index
- Name: Working with pods
  Dir: pods
  Topics:
  - Name: About pods
    File: nodes-pods-using
  - Name: Viewing pods
    File: nodes-pods-viewing
  - Name: Configuring a cluster for pods
    File: nodes-pods-configuring
    Distros: openshift-dedicated
# Cannot create namespace to install VPA; revisit after Operator book converted
#  - Name: Automatically adjust pod resource levels with the vertical pod autoscaler
#   File: nodes-pods-vertical-autoscaler
  - Name: Providing sensitive data to pods
    File: nodes-pods-secrets
  - Name: Creating and using config maps
    File: nodes-pods-configmaps
# Cannot create required "kubeletconfigs"
# - Name: Using Device Manager to make devices available to nodes
#   File: nodes-pods-plugins
#    Distros: openshift-dedicated
  - Name: Including pod priority in pod scheduling decisions
    File: nodes-pods-priority
    Distros: openshift-dedicated
  - Name: Placing pods on specific nodes using node selectors
    File: nodes-pods-node-selectors
    Distros: openshift-dedicated
# Cannot create namespace to install Run Once; revisit after Operator book converted
#  - Name: Run Once Duration Override Operator
#    Dir: run_once_duration_override
#    Distros: openshift-dedicated
#    Topics:
#    - Name: Run Once Duration Override Operator overview
#      File: index
#    - Name: Run Once Duration Override Operator release notes
#      File: run-once-duration-override-release-notes
#    - Name: Overriding the active deadline for run-once pods
#      File: run-once-duration-override-install
#    - Name: Uninstalling the Run Once Duration Override Operator
#      File: run-once-duration-override-uninstall
- Name: Automatically scaling pods with the Custom Metrics Autoscaler Operator
  Dir: cma
  Distros: openshift-dedicated
  Topics:
  - Name: Custom Metrics Autoscaler Operator overview
    File: nodes-cma-autoscaling-custom
  - Name: Custom Metrics Autoscaler Operator release notes
    File: nodes-cma-autoscaling-custom-rn
  - Name: Installing the custom metrics autoscaler
    File: nodes-cma-autoscaling-custom-install
  - Name: Understanding the custom metrics autoscaler triggers
    File: nodes-cma-autoscaling-custom-trigger
  - Name: Understanding the custom metrics autoscaler trigger authentications
    File: nodes-cma-autoscaling-custom-trigger-auth
  - Name: Pausing the custom metrics autoscaler
    File: nodes-cma-autoscaling-custom-pausing
  - Name: Gathering audit logs
    File: nodes-cma-autoscaling-custom-audit-log
  - Name: Gathering debugging data
    File: nodes-cma-autoscaling-custom-debugging
  - Name: Viewing Operator metrics
    File: nodes-cma-autoscaling-custom-metrics
  - Name: Understanding how to add custom metrics autoscalers
    File: nodes-cma-autoscaling-custom-adding
  - Name: Removing the Custom Metrics Autoscaler Operator
    File: nodes-cma-autoscaling-custom-removing
- Name: Controlling pod placement onto nodes (scheduling)
  Dir: scheduling
  Distros: openshift-dedicated
  Topics:
  - Name: About pod placement using the scheduler
    File: nodes-scheduler-about
  - Name: Placing pods relative to other pods using pod affinity and anti-affinity rules
    File: nodes-scheduler-pod-affinity
  - Name: Controlling pod placement on nodes using node affinity rules
    File: nodes-scheduler-node-affinity
  - Name: Placing pods onto overcommited nodes
    File: nodes-scheduler-overcommit
  - Name: Controlling pod placement using node taints
    File: nodes-scheduler-taints-tolerations
  - Name: Placing pods on specific nodes using node selectors
    File: nodes-scheduler-node-selectors
  - Name: Controlling pod placement using pod topology spread constraints
    File: nodes-scheduler-pod-topology-spread-constraints
# - Name: Placing a pod on a specific node by name
#   File: nodes-scheduler-node-names
# - Name: Placing a pod in a specific project
#   File: nodes-scheduler-node-projects
# - Name: Keeping your cluster balanced using the descheduler
#   File: nodes-scheduler-descheduler
  - Name: Descheduler
    Dir: descheduler
    Topics:
    - Name: Descheduler overview
      File: index
    - Name: Descheduler release notes
      File: nodes-descheduler-release-notes
    - Name: Evicting pods using the descheduler
      File: nodes-descheduler-configuring
    - Name: Uninstalling the descheduler
      File: nodes-descheduler-uninstalling
  - Name: Secondary scheduler
    Dir: secondary_scheduler
    Distros: openshift-enterprise
    Topics:
    - Name: Secondary scheduler overview
      File: index
    - Name: Secondary Scheduler Operator release notes
      File: nodes-secondary-scheduler-release-notes
    - Name: Scheduling pods using a secondary scheduler
      File: nodes-secondary-scheduler-configuring
    - Name: Uninstalling the Secondary Scheduler Operator
      File: nodes-secondary-scheduler-uninstalling
- Name: Using Jobs and DaemonSets
  Dir: jobs
  Topics:
  - Name: Running background tasks on nodes automatically with daemonsets
    File: nodes-pods-daemonsets
    Distros: openshift-dedicated
  - Name: Running tasks in pods using jobs
    File: nodes-nodes-jobs
- Name: Working with nodes
  Dir: nodes
  Distros: openshift-dedicated
  Topics:
  - Name: Viewing and listing the nodes in your cluster
    File: nodes-nodes-viewing
# cannot use oc adm cordon; cannot patch resource "machinesets"; cannot patch resource "nodes"
#  - Name: Working with nodes
#    File: nodes-nodes-working
# cannot create resource "kubeletconfigs", "schedulers", "machineconfigs", "kubeletconfigs"
#  - Name: Managing nodes
#    File: nodes-nodes-managing
# cannot create resource "kubeletconfigs"
#  - Name: Managing graceful node shutdown
#    File: nodes-nodes-graceful-shutdown
# cannot create resource "kubeletconfigs"
#  - Name: Managing the maximum number of pods per node
#    File: nodes-nodes-managing-max-pods
  - Name: Using the Node Tuning Operator
    File: nodes-node-tuning-operator
  - Name: Remediating, fencing, and maintaining nodes
    File: nodes-remediating-fencing-maintaining-rhwa
# Cannot create namespace needed to oc debug and reboot; revisit after Operator book converted
#  - Name: Understanding node rebooting
#    File: nodes-nodes-rebooting
# cannot create resource "kubeletconfigs"
#  - Name: Freeing node resources using garbage collection
#    File: nodes-nodes-garbage-collection
# cannot create resource "kubeletconfigs"
#  - Name: Allocating resources for nodes
#    File: nodes-nodes-resources-configuring
# cannot create resource "kubeletconfigs"
#  - Name: Allocating specific CPUs for nodes in a cluster
#    File: nodes-nodes-resources-cpus
# cannot create resource "kubeletconfigs"
#  - Name: Configuring the TLS security profile for the kubelet
#    File: nodes-nodes-tls
#    Distros: openshift-dedicated
#  - Name: Monitoring for problems in your nodes
#    File: nodes-nodes-problem-detector
  - Name: Machine Config Daemon metrics
    File: nodes-nodes-machine-config-daemon-metrics
# cannot patch resource "nodes"
#  - Name: Creating infrastructure nodes
#    File: nodes-nodes-creating-infrastructure-nodes
- Name: Working with containers
  Dir: containers
  Topics:
  - Name: Understanding containers
    File: nodes-containers-using
  - Name: Using Init Containers to perform tasks before a pod is deployed
    File: nodes-containers-init
    Distros: openshift-dedicated
  - Name: Using volumes to persist container data
    File: nodes-containers-volumes
  - Name: Mapping volumes using projected volumes
    File: nodes-containers-projected-volumes
  - Name: Allowing containers to consume API objects
    File: nodes-containers-downward-api
  - Name: Copying files to or from a container
    File: nodes-containers-copying-files
  - Name: Executing remote commands in a container
    File: nodes-containers-remote-commands
  - Name: Using port forwarding to access applications in a container
    File: nodes-containers-port-forwarding
# cannot patch resource "configmaps"
#  - Name: Using sysctls in containers
#    File: nodes-containers-sysctls
- Name: Working with clusters
  Dir: clusters
  Topics:
  - Name: Viewing system event information in a cluster
    File: nodes-containers-events
  - Name: Analyzing cluster resource levels
    File: nodes-cluster-resource-levels
    Distros: openshift-dedicated
  - Name: Setting limit ranges
    File: nodes-cluster-limit-ranges
  - Name: Configuring cluster memory to meet container memory and risk requirements
    File: nodes-cluster-resource-configure
    Distros: openshift-dedicated
  - Name: Configuring your cluster to place pods on overcommited nodes
    File: nodes-cluster-overcommit
    Distros: openshift-dedicated
  - Name: Configuring the Linux cgroup version on your nodes
    File: nodes-cluster-cgroups-2
    Distros: openshift-enterprise
  - Name: Configuring the Linux cgroup version on your nodes
    File: nodes-cluster-cgroups-okd
    Distros: openshift-origin
#  The TechPreviewNoUpgrade Feature Gate is not allowed
#  - Name: Enabling features using FeatureGates
#    File: nodes-cluster-enabling-features
#    Distros: openshift-rosa
# Error: nodes.config.openshift.io "cluster" could not be patched
#  - Name: Improving cluster stability in high latency environments using worker latency profiles
#    File: nodes-cluster-worker-latency-profiles
# Not supported per Michael McNeill
#- Name: Remote worker nodes on the network edge
#  Dir: edge
#  Topics:
#  - Name: Using remote worker node at the network edge
#    File: nodes-edge-remote-workers
# Not supported per Michael McNeill
#- Name: Worker nodes for single-node OpenShift clusters
#  Dir: nodes
#  Topics:
#  - Name: Adding worker nodes to single-node OpenShift clusters
#    File: nodes-sno-worker-nodes
---
Name: Logging
Dir: logging
Distros: openshift-dedicated
Topics:
- Name: Release notes
  Dir: logging_release_notes
  Topics:
  - Name: Logging 5.8
    File: logging-5-8-release-notes
  - Name: Logging 5.7
    File: logging-5-7-release-notes
- Name: Support
  File: cluster-logging-support
- Name: Troubleshooting logging
  Dir: troubleshooting
  Topics:
  - Name: Viewing Logging status
    File: cluster-logging-cluster-status
  - Name: Troubleshooting log forwarding
    File: log-forwarding-troubleshooting
  - Name: Troubleshooting logging alerts
    File: troubleshooting-logging-alerts
  - Name: Viewing the status of the Elasticsearch log store
    File: cluster-logging-log-store-status
- Name: About Logging
  File: cluster-logging
- Name: Installing Logging
  File: cluster-logging-deploying
- Name: Updating Logging
  File: cluster-logging-upgrading
- Name: Visualizing logs
  Dir: log_visualization
  Topics:
  - Name: About log visualization
    File: log-visualization
  - Name: Log visualization with the web console
    File: log-visualization-ocp-console
  - Name: Viewing cluster dashboards
    File: cluster-logging-dashboards
  - Name: Log visualization with Kibana
    File: logging-kibana
- Name: Accessing the service logs
  File: sd-accessing-the-service-logs
- Name: Configuring your Logging deployment
  Dir: config
  Topics:
  - Name: Configuring CPU and memory limits for Logging components
    File: cluster-logging-memory
  - Name: Using tolerations to control Logging pod placement
    File: cluster-logging-tolerations
  - Name: Moving logging subsystem resources with node selectors
    File: cluster-logging-moving-nodes
  #- Name: Configuring systemd-journald and Fluentd
  #  File: cluster-logging-systemd
- Name: Log collection and forwarding
  Dir: log_collection_forwarding
  Topics:
  - Name: About log collection and forwarding
    File: log-forwarding
  - Name: Log output types
    File: logging-output-types
  - Name: Enabling JSON log forwarding
    File: cluster-logging-enabling-json-logging
  - Name: Configuring log forwarding
    File: configuring-log-forwarding
  - Name: Configuring the logging collector
    File: cluster-logging-collector
  - Name: Collecting and storing Kubernetes events
    File: cluster-logging-eventrouter
- Name: Log storage
  Dir: log_storage
  Topics:
  - Name: About log storage
    File: about-log-storage
  - Name: Installing log storage
    File: installing-log-storage
  - Name: Configuring the LokiStack log store
    File: cluster-logging-loki
  - Name: Configuring the Elasticsearch log store
    File: logging-config-es-store
- Name: Logging alerts
  Dir: logging_alerts
  Topics:
  - Name: Default logging alerts
    File: default-logging-alerts
  - Name: Custom logging alerts
    File: custom-logging-alerts
- Name: Performance and reliability tuning
  Dir: performance_reliability
  Topics:
  - Name: Flow control mechanisms
    File: logging-flow-control-mechanisms
- Name: Uninstalling Logging
  File: cluster-logging-uninstall
- Name: Exported fields
  File: cluster-logging-exported-fields
- Name: API reference
  Dir: api_reference
  Topics:
#  - Name: 5.8 Logging API reference
#    File: logging-5-8-reference
#  - Name: 5.7 Logging API reference
#    File: logging-5-7-reference
  - Name: 5.6 Logging API reference
    File: logging-5-6-reference
- Name: Glossary
  File: logging-common-terms
---
Name: Monitoring
Dir: monitoring
Distros: openshift-dedicated
Topics:
- Name: Monitoring overview
  File: monitoring-overview
- Name: Accessing monitoring for user-defined projects
  File: sd-accessing-monitoring-for-user-defined-projects
- Name: Configuring the monitoring stack
  File: configuring-the-monitoring-stack
- Name: Disabling monitoring for user-defined projects
  File: sd-disabling-monitoring-for-user-defined-projects
- Name: Enabling alert routing for user-defined projects
  File: enabling-alert-routing-for-user-defined-projects
- Name: Managing metrics
  File: managing-metrics
- Name: Managing alerts
  File: managing-alerts
- Name: Reviewing monitoring dashboards
  File: reviewing-monitoring-dashboards
- Name: Accessing third-party monitoring APIs
  File: accessing-third-party-monitoring-apis
- Name: Troubleshooting monitoring issues
  File: troubleshooting-monitoring-issues
- Name: Config map reference for the Cluster Monitoring Operator
  File: config-map-reference-for-the-cluster-monitoring-operator
---
Name: Serverless
Dir: serverless
Distros: openshift-dedicated
Topics:
- Name: About Serverless
  Dir: about
  Topics:
  - Name: Serverless overview
    File: about-serverless