openshift-docs/_topic_map.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 +/- .adoc
#   - 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: Welcome
Dir: welcome
Distros: openshift-*
Topics:
- Name: Welcome
  File: index
#---
#Name: Release notes
#Dir: release_notes
#Distros: openshift-enterprise
#Topics:
#- Name: Comparing OpenShift Container Platform 3 and 4
#  File: comparing_3_4
---
Name: Architecture
Dir: architecture
Distros: openshift-*
Topics:
- Name: OpenShift Container Platform architecture
  File: architecture
- Name: Abstraction layers and topology
  File: architecture-topology
- Name: Installation and update
  File: architecture-installation
- Name: Operators in OpenShift Container Platform
  File: architecture-operators
- Name: Machine API Overview
  File: architecture-machine-api-overview


- Name: Available cluster customizations
  File: customizations
---
Name: Web console
Dir: web-console
Distros: openshift-*
Topics:
- Name: Accessing the web console
  File: web-console
- Name: Working with projects
  File: working-with-projects
---
Name: Installing
Dir: installing
Distros: openshift-origin, openshift-enterprise
Topics:
- Name: Installing on AWS
  Dir: installing_aws
  Topics:
  - Name: Configuring an AWS account
    File: installing-aws-account
  - Name: Installing a cluster quickly on AWS
    File: installing-aws-default
  - Name: Installing a cluster on AWS with customizations
    File: installing-aws-customizations
  - Name: Uninstalling a cluster on AWS
    File: uninstalling-cluster-aws
- Name: Installing on bare metal
  Dir: installing_bare_metal
  Topics:
  - Name: Installing a cluster on bare metal
    File: installing-bare-metal
---
Name: Updating clusters
Dir: updating
Distros: openshift-origin, openshift-enterprise
Topics:
- Name: Updating a cluster
  File: updating-cluster
---
Name: Applications
Dir: applications
Distros: openshift-*
Topics:
- Name: Operators
  Dir: operators
  Topics:
  - Name: What Operators are
    File: olm-what-operators-are
  - Name: Adding Operators to a cluster
    File: olm-adding-operators-to-cluster
    Distros: openshift-enterprise,openshift-origin
  - Name: Deleting Operators from a cluster
    File: olm-deleting-operators-from-cluster
    Distros: openshift-enterprise,openshift-origin
  - Name: Creating applications from installed Operators
    File: olm-creating-apps-from-installed-operators
- Name: Service brokers
  Dir: service_brokers
  Distros: openshift-enterprise,openshift-origin,openshift-dedicated
  Topics:
  - Name: Installing the service catalog
    File: installing-service-catalog
  - Name: Installing the Template service Broker
    File: installing-template-service-broker
  - Name: Provisioning template applications
    File: provisioning-template-application
  - Name: Uninstalling the Template Service Broker
    File: uninstalling-template-service-broker
  - Name: Installing the OpenShift Ansible Broker
    File: installing-ansible-service-broker
  - Name: Configuring the OpenShift Ansible Broker
    File: configuring-ansible-service-broker
  - Name: Provisioning service bundles
    File: provisioning-service-bundle
  - Name: Uninstalling the OpenShift Ansible Broker
    File: uninstalling-ansible-service-broker
- Name: Deployments
  Dir: deployments
  Topics:
  - Name: What Deployments and DeploymentConfigs are
    File: what-deployments-are
  - Name: Managing deployment processes
    File: managing-deployment-processes
  - Name: Using DeploymentConfig strategies
    File: deployment-strategies
  - Name: Using route-based deployment strategies
    File: route-based-deployment-strategies
- Name: CRDs
  Dir: crds
  Topics:
  - Name: Extending the Kubernetes API with CRDs
    File: crd-extending-api-with-crds
    Distros: openshift-origin,openshift-enterprise
  - Name: Managing resources from CRDs
    File: crd-managing-resources-from-crds
- Name: Quotas
  Dir: quotas
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Resource quotas per project
    File: quotas-setting-per-project
  - Name: Resource quotas across multiple projects
    File: quotas-setting-across-multiple-projects
- Name: Working with quotas
  File: working-with-quotas
  Distros: openshift-online,openshift-dedicated
- Name: Idling applications
  File: idling-applications
  Distros: openshift-origin,openshift-enterprise
- Name: Pruning objects to reclaim resources
  File: pruning-objects
  Distros: openshift-origin,openshift-enterprise
- Name: Operator SDK
  Dir: operator_sdk
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Getting started with the Operator SDK
    File: osdk-getting-started
  - Name: Creating Ansible-based Operators
    File: osdk-ansible
  - Name: Creating Helm-based Operators
    File: osdk-helm
  - Name: Generating a ClusterServiceVersion (CSV)
    File: osdk-generating-csvs
  - Name: Configuring built-in monitoring with Prometheus
    File: osdk-monitoring-prometheus
  - Name: Operator SDK CLI reference
    File: osdk-cli-reference
  - Name: Migrating to Operator SDK v0.1.0
    File: osdk-migrating-to-v0-1-0
    Distros: openshift-origin
  - Name: Appendices
    File: osdk-appendices
---
Name: Builds
Dir: builds
Distros: openshift-*
Topics:
- Name: Understanding image builds
  File: understanding-image-builds
- Name: Understanding build configurations
  File: understanding-buildconfigs
- Name: Creating build inputs
  File: creating-build-inputs
- Name: Managing build output
  File: managing-build-output
- Name: Using build strategies
  File: build-strategies
- Name: Adding a Docker socket to custom builds with Buildah
  File: custom-builds-buildah
- Name: Performing basic builds
  File: basic-build-operations
- Name: Triggering and modifying builds
  File: triggering-builds-build-hooks
- Name: Performing advanced builds
  File: advanced-build-operations
- Name: Securing builds by strategy
  File: securing-builds-by-strategy
- Name: Troubleshooting builds
  File: troubleshooting-builds
---
Name: Images
Dir: openshift_images
Distros: openshift-*
Topics:
- Name: Configuring the Samples Operator
  File: configuring-samples-operator
- Name: Understanding containers, images, and imagestreams
  File: images-understand
- Name: Creating images
  File: create-images
- Name: Managing imagestreams
  File: image-streams-manage
- Name: Using templates
  File: using-templates
- Name: Using Ruby on Rails
  File: templates-using-ruby-on-rails
---
Name: Authentication
Dir: authentication
Distros: openshift-*
Topics:
- Name: Understanding authentication
  File: understanding-authentication
- Name: Configuring the internal OAuth server
  File: configuring-internal-oauth
- Name: Understanding identity provider configuration
  File: understanding-identity-provider
- 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: 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: Configuring the user agent
  File: configuring-user-agent
- 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: Managing Security Context Constraints
  File: managing-security-context-constraints
- Name: Impersonating the system:admin user
  File: impersonating-system-admin
  Distros: openshift-enterprise,openshift-origin
- Name: Creating a project as another user
  File: creating-project-other-user
  Distros: openshift-enterprise,openshift-origin
---
Name: Machine management
Dir: machine_management
Distros: openshift-origin, openshift-enterprise
Topics:
- Name: Deploying machine health checks
  File: deploying-machine-health-checks
- Name: Applying autoscaling to a cluster
  File: applying-autoscaling
- Name: Manually scaling a MachineSet
  File: manually-scaling-machineset
- Name: Creating a MachineSet
  File: creating-machineset
- Name: Creating infrastructure MachineSets
  File: creating-infrastructure-machinesets
---
Name: Networking
Dir: networking
Distros: openshift-*
Topics:
- Name: Understanding networking
  File: understanding-networking
- Name: Multiple networks
  File: managing_multinetworking
- Name: Ingress controller configuration
  File: ingress-controller-configuration
---
Name: Registry
Dir: registry
Distros: openshift-*
Topics:
- Name: Overview
  File: architecture-component-imageregistry
- Name: Registry options
  File: registry-options
- Name: Accessing the registry
  File: accessing-the-registry
- Name: Securing and exposing the registry
  File: securing-exposing-registry
---
Name: Scalability and performance
Dir: scalability_and_performance
Distros: openshift-origin, openshift-enterprise
Topics:
- Name: Recommended host practices
  File: recommended-host-practices
- Name: Using the Node Tuning Operator
  File: using-node-tuning-operator
- Name: Using Cluster Loader
  File: using-cluster-loader
- Name: Scaling the Cluster Monitoring Operator
  File: scaling-cluster-monitoring-operator
- Name: Planning your environment according to object limits
  File: planning-your-environment-according-to-object-limits
- Name: Optimizing compute resources
  File: optimizing-compute-resources
- Name: Optimizing networking
  File: network-optimization
- Name: Optimizing storage
  File: optimizing-storage
- Name: Optimizing routing
  File: routing-optimization
---
Name: Storage
Dir: storage
Distros: openshift-*
Topics:
- 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 iSCSI
    File: persistent-storage-iscsi
  - Name: Persistent storage using Container Storage Interface (CSI)
    File: persistent-storage-csi
  - Name: Persistent storage using OpenStack Manila
    File: persistent-storage-manila
- Name: Expanding persistent volumes
  File: expanding-persistent-volumes
- Name: Dynamic provisioning
  File: dynamic-provisioning
---
Name: Nodes
Dir: nodes
Distros: openshift-*
Topics:
- 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
  - Name: Providing sensitive data to Pods
    File: nodes-pods-secrets
  - Name: Using Device Manager to make devices available to nodes
    File: nodes-pods-plugins
  - Name: Including pod priority in Pod scheduling decisions
    File: nodes-pods-priority
- Name: Controlling pod placement onto nodes (scheduling)
  Dir: scheduling
  Topics:
  - Name: About pod placement using the scheduler
    File: nodes-scheduler-about
  - Name: Placing pods onto nodes with the default scheduler
    File: nodes-scheduler-default
  - Name: Placing pods relative to other pods using pod affinity/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 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: Placing pods onto overcommited nodes
    File: nodes-scheduler-overcommit
  - Name: Controlling pod placement using node taints
    File: nodes-scheduler-taints-tolerations
  - Name: Constraining pod placement using node selectors
    File: nodes-scheduler-node-selectors
#  - Name: Keeping your cluster balanced using the descheduler
#    File: nodes-scheduler-descheduler
- Name: Using Jobs and DaemonSets
  Dir: jobs
  Topics:
  - Name: Running background tasks on nodes automatically with daemonsets
    File: nodes-pods-daemonsets
  - Name: Running tasks in pods using jobs
    File: nodes-nodes-jobs
- Name: Working with nodes
  Dir: nodes
  Topics:
  - Name: Viewing and listing the nodes in your cluster
    File: nodes-nodes-viewing
  - Name: Working with nodes
    File: nodes-nodes-working
  - Name: Managing Nodes
    File: nodes-nodes-managing
  - 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: Understanding node rebooting
    File: nodes-nodes-rebooting
  - Name: Freeing node resources using garbage collection
    File: nodes-nodes-garbage-collection
  - Name: Allocating resources for nodes
    File: nodes-nodes-resources-configuring
  - Name: Advertising hidden resources for nodes
    File: nodes-nodes-opaque-resources
#  - Name: Monitoring for problems in your nodes
#    File: nodes-nodes-problem-detector
- Name: Working with containers
  Dir: containers
  Topics:
  - Name: Using containers
    File: nodes-containers-using
  - Name: Using Init Containers to perform tasks before a pod is deployed
    File: nodes-containers-init
    Distros: openshift-enterprise,openshift-origin
  - 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
  - Name: Monitoring container health
    File: nodes-containers-health
- 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
  - Name: Configuring cluster memory to meet container memory and risk requirements
    File: nodes-cluster-resource-configure
  - Name: Configuring your cluster to place pods on overcommited nodes
    File: nodes-cluster-overcommit
  - Name: Disabling features using feature gates
    File: nodes-cluster-disabling-features
---
Name: Logging
Dir: logging
Distros: openshift-*
Topics:
- Name: About cluster logging
  File: efk-logging
- Name: About deploying cluster logging
  File: efk-logging-deploying-about
- Name: Deploying cluster logging
  File: efk-logging-deploying
- Name: Deploying and Configuring the Event Router
  File: efk-logging-eventrouter
- Name: Configuring your cluster logging deployment
  Dir: config
  Topics:
  - Name: About configuring cluster logging
    File: efk-logging-configuring-about
  - Name: Changing cluster logging management state
    File: efk-logging-management
  - Name: Configuring cluster logging
    File: efk-logging-configuring
  - Name: Configuring Elasticsearch
    File: efk-logging-elasticsearch
  - Name: Configuring Kibana
    File: efk-logging-kibana
  - Name: Configuring Curator
    File: efk-logging-curator
  - Name: Configuring Fluentd
    File: efk-logging-fluentd
  - Name: Configuring systemd-journald
    File: efk-logging-systemd
  - Name: Sending logs to external devices
    File: efk-logging-external
- Name: Viewing Elasticsearch status
  File: efk-logging-elasticsearch-status
- Name: Manually rolling out Elasticsearch
  File: efk-logging-manual-rollout
- Name: Troubleshooting Kibana
  File: efk-logging-troubleshooting
- Name: Exported fields
  File: efk-logging-exported-fields
- Name: Uninstalling cluster logging
  File: efk-logging-uninstall
---
Name: Monitoring
Dir: monitoring
Distros: openshift-*
Topics:
- Name: Cluster monitoring
  Dir: cluster-monitoring
  Topics:
  - Name: About cluster monitoring
    File: about-cluster-monitoring
  - Name: Configuring the monitoring stack
    File: configuring-the-monitoring-stack
  - Name: Managing alerts using Alertmanager UI
    File: managing-alerts-using-alertmanager-ui
  - Name: Accessing Prometheus, Alertmanager, and Grafana
    File: prometheus-alertmanager-and-grafana
- Name: Application monitoring
  File: application-monitoring
---
Name: CLI reference
Dir: cli_reference
Distros: openshift-*
Topics:
- Name: Getting started with the CLI
  File: getting-started-cli
- Name: Configuring the CLI
  File: configuring-cli
- Name: Extending the CLI with plug-ins
  File: extending-cli-plugins
  Distros: openshift-enterprise,openshift-origin
- Name: Developer CLI commands
  File: developer-cli-commands
- Name: Administrator CLI commands
  File: administrator-cli-commands
  Distros: openshift-enterprise,openshift-origin,openshift-dedicated