_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: About
Dir: welcome
Distros: openshift-*
Topics:
  - Name: Welcome
    File: index
  - Name: All Revision History
    File: revhistory_all
    Distros: openshift-enterprise,openshift-dedicated

---
Name: Release Notes
Dir: release_notes
Distros: openshift-enterprise,openshift-dedicated
Topics:
  - Name: Overview
    File: index
  - Name: OpenShift Container Platform 3.3 Release Notes
    File: ocp_3_3_release_notes
    Distros: openshift-enterprise
  - Name: Latest Product Updates
    File: osd_latest_product_updates
    Distros: openshift-dedicated
  - Name: Developer Preview Release Notes
    File: online_release_notes
    Distros: openshift-online
  - Name: xPaaS Release Notes
    File: xpaas_release_notes
    Distros: openshift-enterprise
  - Name: Comparing with OpenShift Enterprise 2
    File: v2_vs_v3
    Distros: openshift-enterprise,openshift-dedicated,openshift-online
  - Name: Revision History
    File: revhistory_release_notes

---
Name: What's New?
Dir: whats_new
Distros: openshift-origin
Topics:
  - Name: Overview
    File: index
  - Name: Release Notes
    File: ose_3_0_release_notes
    Distros: openshift-enterprise
  - Name: Applications
    File: applications
  - Name: Cartridges vs Images
    File: carts_vs_images
  - Name: Terminology
    File: terminology

---
Name: Getting Started
Dir: getting_started
Distros: openshift-*
Topics:
  - Name: Overview
    File: index
  - Name: Basic Walkthrough
    File: basic_walkthrough
    Distros: openshift-online
  - Name: Beyond the Basics
    File: beyond_the_basics
    Distros: openshift-online
  - Name: Web Console Walkthrough
    File: developers_console
    Distros: openshift-enterprise,openshift-dedicated,openshift-origin
  - Name: Command-Line Walkthrough
    File: developers_cli
    Distros: openshift-enterprise,openshift-dedicated,openshift-origin
  - Name: Setting Up a Cluster
    File: administrators
    Distros: openshift-origin,openshift-enterprise
  - Name: Administering a Cluster
    File: dedicated_administrators
    Distros: openshift-dedicated
  - Name: Developer Preview FAQ
    File: devpreview_faq
    Distros: openshift-online
  - Name: Comparing OpenShift 2 and 3
    File: online_v2_vs_v3
    Distros: openshift-online
  - Name: Revision History
    File: revhistory_getting_started
    Distros: openshift-enterprise,openshift-dedicated
---
Name: Quickstart
Dir: registry_quickstart
Distros: atomic-registry
Topics:
  - Name: Overview
    File: index
  - Name: Developers
    File: developers
  - Name: Administrators
    Dir: administrators
    Topics:
      - Name: Overview
        File: index
      - Name: System Configuration
        File: system_configuration
      - Name: Uninstall
        File: uninstall

---
Name: Architecture
Dir: architecture
Topics:
  - Name: Overview
    File: index
  - Name: Infrastructure Components
    Dir: infrastructure_components
    Topics:
      - Name: Kubernetes Infrastructure
        File: kubernetes_infrastructure
      - Name: Image Registry
        File: image_registry
      - Name: Web Console
        File: web_console
  - Name: Core Concepts
    Dir: core_concepts
    Topics:
      - Name: Overview
        File: index
        Distros: openshift-*
      - Name: Containers and Images
        File: containers_and_images
        Distros: openshift-*
      - Name: Images
        File: containers_and_images
        Distros: atomic-*
      - Name: Pods and Services
        File: pods_and_services
        Distros: openshift-*
      - Name: Projects and Users
        File: projects_and_users
      - Name: Builds and Image Streams
        File: builds_and_image_streams
        Distros: openshift-*
      - Name: Image Streams
        File: builds_and_image_streams
        Distros: atomic-*
      - Name: Deployments
        File: deployments
        Distros: openshift-*
      - Name: Routes
        File: routes
        Distros: openshift-*
      - Name: Templates
        File: templates
        Distros: openshift-*
  - Name: Additional Concepts
    Dir: additional_concepts
    Topics:
      - Name: Networking
        File: networking
        Distros: openshift-*
      - Name: OpenShift SDN
        File: sdn
        Distros: openshift-*
      - Name: Nuage SDN
        File: nuagesdn
        Distros: openshift-enterprise,openshift-origin
      - Name: Authentication
        File: authentication
      - Name: Authorization
        File: authorization
      - Name: Persistent Storage
        File: storage
        Distros: openshift-*
      - Name: Remote Commands
        File: remote_commands
        Distros: openshift-*
      - Name: Port Forwarding
        File: port_forwarding
        Distros: openshift-*
      - Name: Source Control Management
        File: scm
        Distros: openshift-*
      - Name: Admission Controllers
        File: admission_controllers
        Distros: openshift-enterprise,openshift-origin,openshift-dedicated
      - Name: Other API Objects
        File: other_api_objects
  - Name: Revision History
    File: revhistory_architecture
    Distros: openshift-enterprise,openshift-dedicated

---
Name: Installation and Configuration
Dir: install_config
Distros: openshift-origin,openshift-enterprise,atomic-*
Topics:
  - Name: Overview
    File: index
    Distros: openshift-origin,openshift-enterprise
  - Name: Installing a Cluster
    Dir: install
    Distros: openshift-origin,openshift-enterprise
    Topics:
      - Name: Planning
        File: planning
      - Name: Prerequisites
        File: prerequisites
      - Name: Host Preparation
        File: host_preparation
      - Name: Containerized Components
        File: rpm_vs_containerized
      - Name: Quick Installation
        File: quick_install
      - Name: Advanced Installation
        File: advanced_install
      - Name: Disconnected Installation
        File: disconnected_install
        Distros: openshift-enterprise
      - Name: Installing a Stand-alone Registry
        File: stand_alone_registry
  - Name: Setting up the Registry
    Dir: registry
    Distros: openshift-origin,openshift-enterprise
    Topics:
      - Name: Registry Overview
        File: index
      - Name: Deploying a Registry on Existing Clusters
        File: deploy_registry_existing_clusters
      - Name: Accessing the Registry
        File: accessing_registry
      - Name: Securing and Exposing the Registry
        File: securing_and_exposing_registry
      - Name: Extended Registry Configuration
        File: extended_registry_configuration
      - Name: Known Issues
        File: registry_known_issues
  - Name: Setting up a Router
    Dir: router
    Distros: openshift-origin,openshift-enterprise
    Topics:
      - Name: Router Overview
        File: index
      - Name: Using the Default HAProxy Router
        File: default_haproxy_router
      - Name: Deploying a Customized HAProxy Router
        File: customized_haproxy_router
      - Name: Using the F5 Router Plug-in
        File: f5_router
  - Name: Upgrading a Cluster
    Dir: upgrading
    Distros: openshift-origin,openshift-enterprise
    Topics:
      - Name: Overview
        File: index
      - Name: Automated In-place Upgrades
        File: automated_upgrades
      - Name: Manual In-place Upgrades
        File: manual_upgrades
      - Name: Blue-Green Deployments
        File: blue_green_deployments
      - Name: Operating System Updates and Upgrades
        File: os_upgrades
  - Name: Downgrading
    File: downgrade
    Distros: openshift-enterprise
  - Name: Master and Node Configuration
    File: master_node_configuration
    Distros: openshift-origin,openshift-enterprise
  - Name: Adding Hosts to an Existing Cluster
    File: adding_hosts_to_existing_cluster
  - Name: Loading the Default Image Streams and Templates
    File: imagestreams_templates
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring Custom Certificates
    File: certificate_customization
  - Name: Redeploying Certificates
    File: redeploying_certificates
  - Name: Configuring Authentication and User Agent
    File: configuring_authentication
  - Name: Syncing Groups With LDAP
    File: syncing_groups_with_ldap
  - Name: Advanced LDAP Configuration
    Dir: advanced_ldap_configuration
    Distros: openshift-origin,openshift-enterprise,atomic-registry
    Topics:
      - Name: Overview
        File: index
      - Name: Setting up SSSD for LDAP Failover
        File: sssd_for_ldap_failover
      - Name: Configuring Form-Based Authentication
        File: configuring_form_based_authentication
      - Name: Configuring Extended LDAP Attributes
        File: configuring_extended_ldap_attributes
  - Name: Configuring the SDN
    File: configuring_sdn
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring Nuage SDN
    File: configuring_nuagesdn
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring for AWS
    File: configuring_aws
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring for OpenStack
    File: configuring_openstack
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring for GCE
    File: configuring_gce
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring for Azure
    File: configuring_azure
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring Persistent Storage
    Dir: persistent_storage
    Distros: openshift-origin,openshift-enterprise
    Topics:
      - Name: Overview
        File: index
      - Name: Using NFS
        File: persistent_storage_nfs
      - Name: Using GlusterFS
        File: persistent_storage_glusterfs
      - Name: Using OpenStack Cinder
        File: persistent_storage_cinder
      - Name: Using Ceph RBD
        File: persistent_storage_ceph_rbd
      - Name: Using AWS Elastic Block Store
        File: persistent_storage_aws
      - Name: Using GCE Persistent Disk
        File: persistent_storage_gce
      - Name: Using iSCSI
        File: persistent_storage_iscsi
      - Name: Using Fibre Channel
        File: persistent_storage_fibre_channel
      - Name: Dynamic Provisioning and Creating Storage Classes
        File: dynamically_provisioning_pvs
      - Name: Using Azure Disk
        File: persistent_storage_azure
      - Name: Volume Security
        File: pod_security_context
      - Name: Selector-Label Volume Binding
        File: selector_label_binding
  - Name: Persistent Storage Examples
    Dir: storage_examples
    Distros: openshift-origin,openshift-enterprise
    Topics:
      - Name: Overview
        File: index
      - Name: Sharing an NFS PV Across Two Pods
        File: shared_storage
      - Name: Complete Example Using Ceph RBD
        File: ceph_example
      - Name: Complete Example Using GlusterFS
        File: gluster_example
      - Name: Mounting Volumes To Privileged Pods
        File: privileged_pod_storage
      - Name: Backing Docker Registry with GlusterFS Storage
        File: gluster_backed_registry
      - Name: Binding Persistent Volumes by Label
        File: binding_pv_by_label
      - Name: Using StorageClasses for Dynamic Provisioning
        File: storage_classes_dynamic_provisioning
      - Name: Using StorageClasses for Existing Legacy Storage
        File: storage_classes_legacy
  - Name: Working with HTTP Proxies
    File: http_proxies
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring Global Build Defaults and Overrides
    File: build_defaults_overrides
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring Build Pipeline Execution
    File: configuring_pipeline_execution
    Distros: openshift-origin,openshift-enterprise
  - Name: Configuring Routing
    File: configuring_routing
    Distros: openshift-origin,openshift-enterprise
  - Name: Routing from Edge Load Balancers
    File: routing_from_edge_lb
    Distros: openshift-origin,openshift-enterprise
  - Name: Aggregating Container Logs
    File: aggregate_logging
    Distros: openshift-origin,openshift-enterprise
  - Name: Aggregate Logging Sizing Guidelines
    File: aggregate_logging_sizing
    Distros: openshift-origin,openshift-enterprise
  - Name: Enabling Cluster Metrics
    File: cluster_metrics
    Distros: openshift-origin,openshift-enterprise
  - Name: Customizing the Web Console
    File: web_console_customization
    Distros: openshift-origin,openshift-enterprise,atomic-*
  - Name: Revision History
    File: revhistory_install_config
    Distros: openshift-enterprise

---
Name: Administrator Solutions
Dir: admin_solutions
Distros: openshift-enterprise
Topics:
  - Name: Overview
    File: index
  - Name: Master and Node Configuration
    File: master_node_config
  - Name: User and Role Management
    File: user_role_mgmt
  - Name: Authentication
    File: authentication

---
Name: Cluster Administration
Dir: admin_guide
Distros: openshift-origin,openshift-enterprise,openshift-dedicated,atomic-*
Topics:
  - Name: Overview
    File: index
  - Name: Managing Nodes
    File: manage_nodes
    Distros: openshift-origin,openshift-enterprise
  - Name: Managing Users
    File: manage_users
    Distros: openshift-origin,openshift-enterprise,atomic-*
  - Name: Managing Projects
    File: managing_projects
  - Name: Managing Pods
    File: managing_pods
  - Name: Configuring Service Accounts
    File: service_accounts
  - Name: Managing Authorization Policies
    File: manage_authorization_policy
  - Name: Image Policy
    File: image_policy
  - Name: Scoped Tokens
    File: scoped_tokens
  - Name: Monitoring Images
    File: monitoring_images
    Distros: openshift-origin,openshift-enterprise
  - Name: Managing the Default Image Streams and Templates
    File: osd_imagestreams_templates
    Distros: openshift-dedicated
  - Name: Managing Security Context Constraints
    File: manage_scc
    Distros: openshift-*
  - Name: Setting Quotas
    File: quota
  - Name: Setting Multi-Project Quotas
    File: multiproject_quota
  - Name: Setting Limit Ranges
    File: limits
  - Name: Pruning Objects
    File: pruning_resources
    Distros: openshift-*
  - Name: Garbage Collection
    File: garbage_collection
    Distros: openshift-*
  - Name: Scheduler
    File: scheduler
    Distros: openshift-origin,openshift-enterprise,openshift-dedicated
  - Name: Configuring Global Build Defaults and Overrides
    File: osd_build_defaults_overrides
    Distros: openshift-dedicated
  - Name: Configuring Build Pipeline Execution
    File: osd_configuring_pipeline_execution
    Distros: openshift-dedicated
  - Name: Allocating Node Resources
    File: allocating_node_resources
    Distros: openshift-origin,openshift-enterprise,atomic-*
  - Name: Overcommitting
    File: overcommit
    Distros: openshift-origin,openshift-enterprise
  - Name: Assigning Unique External IPs for Ingress Traffic
    File: tcp_ingress_external_ports
  - Name: Out of Resource Handling
    File: out_of_resource_handling
    Distros: openshift-origin,openshift-enterprise
  - Name: Monitoring Routers
    File: router
    Distros: openshift-origin,openshift-enterprise
  - Name: High Availability
    File: high_availability
    Distros: openshift-origin,openshift-enterprise
  - Name: IPtables
    File: iptables
    Distros: openshift-origin,openshift-enterprise
  - Name: Securing Builds by Strategy
    File: securing_builds
    Distros: openshift-origin,openshift-enterprise
  - Name: Restricting Application Capabilities Using Seccomp
    File: seccomp
  - Name: Sysctls
    File: sysctls
    Distros: openshift-origin,openshift-enterprise
  - Name: Building Dependency Trees
    File: building_dependency_trees
    Distros: openshift-origin,openshift-enterprise
  - Name: Backup and Restore
    File: backup_restore
  - Name: Troubleshooting Networking
    File: sdn_troubleshooting
    Distros: openshift-origin,openshift-enterprise
  - Name: Diagnostics Tool
    File: diagnostics_tool
    Distros: openshift-origin,openshift-enterprise
  - Name: Idling Applications
    File: idling_applications.adoc
  - Name: Revision History
    File: revhistory_admin_guide
    Distros: openshift-enterprise,openshift-dedicated

---
Name: User Guide
Dir: dev_guide
Distros: atomic-*
Topics:
  - Name: Overview
    File: index
  - Name: Authentication
    File: authentication
  - Name: Managing Images
    File: managing_images
  - Name: Service Accounts
    File: service_accounts

---
Name: CLI Reference
Dir: cli_reference
Distros: openshift-*,atomic-*
Topics:
  - Name: Overview
    File: index
  - Name: Get Started with the CLI
    File: get_started_cli
  - Name: Managing CLI Profiles
    File: manage_cli_profiles
  - Name: Developer CLI Operations
    File: basic_cli_operations
    Distros: openshift-*
  - Name: Administrator CLI Operations
    File: admin_cli_operations
    Distros: openshift-enterprise,openshift-dedicated,openshift-origin
  - Name: Revision History
    File: revhistory_cli_reference
    Distros: openshift-enterprise,openshift-dedicated

---
Name: Developer Guide
Dir: dev_guide
Distros: openshift-*
Topics:
  - Name: Overview
    File: index
  - Name: Application Life Cycle Management
    Dir: application_lifecycle
    Topics:
      - Name: Planning Your Development Process
        File: development_process
      - Name: Creating New Applications
        File: new_app
      - Name: Promoting Applications Across Environments
        File: promoting_applications
  - Name: Authentication
    File: authentication
  - Name: Projects
    File: projects
  - Name: Migrating Applications
    Dir: migrating_applications
    Topics:
      - Name: Overview
        File: index
      - Name: Database Applications
        File: database_applications
      - Name: Web Framework Applications
        File: web_framework_applications
      - Name: QuickStart Examples
        File: quickstart_examples
      - Name: Continuous Integration and Deployment
        File: continuous_integration_and_deployment
      - Name: Webhooks and Action Hooks
        File: web_hooks_action_hooks
      - Name: S2I Tool
        File: S2I_tool
      - Name: Support Guide
        File: support_guide
  - Name: Application Tutorials
    Dir: app_tutorials
    Topics:
      - Name: Overview
        File: index
      - Name: Quickstart Templates
        File: quickstarts
      - Name: Ruby on Rails
        File: ruby_on_rails
      - Name: Setting Up a Nexus Mirror
        File: maven_tutorial
  - Name: Opening a Remote Shell to Containers
    File: ssh_environment
  - Name: Templates
    File: templates
  - Name: Service Accounts
    File: service_accounts
  - Name: Builds
    File: builds
  - Name: Managing Images
    File: managing_images
  - Name: Quotas and Limit Ranges
    File: compute_resources
  - Name: Deployments
    Dir: deployments
    Topics:
      - Name: How Deployments Work
        File: how_deployments_work
      - Name: Basic Deployment Operations
        File: basic_deployment_operations
      - Name: Deployment Strategies
        File: deployment_strategies
      - Name: Advanced Deployment Strategies
        File: advanced_deployment_strategies
      - Name: Kubernetes Deployments Support
        File: kubernetes_deployments
        Distros: openshift-enterprise,openshift-origin
  - Name: Getting Traffic Into The Cluster
    File: getting_traffic_into_cluster
  - Name: Routes
    File: routes
  - Name: Integrating External Services
    File: integrating_external_services
  - Name: Secrets
    File: secrets
  - Name: ConfigMaps
    File: configmaps
  - Name: Using Daemonsets
    File: daemonsets
  - Name: Pod Autoscaling
    File: pod_autoscaling
  - Name: Pod Disruption Budget
    File: pod_disruption_budget
  - Name: Managing Volumes
    File: volumes
  - Name: Using Persistent Volumes
    File: persistent_volumes
  - Name: Executing Remote Commands
    File: executing_remote_commands
  - Name: Copying Files
    File: copy_files_to_container
  - Name: Port Forwarding
    File: port_forwarding
  - Name: Shared Memory
    File: shared_memory
  - Name: Application Health
    File: application_health
  - Name: Events
    File: events
  - Name: Downward API
    File: downward_api
  - Name: Managing Environment Variables
    File: environment_variables
  - Name: Jobs
    File: jobs
  - Name: Scheduled Jobs
    File: scheduled_jobs
  - Name: Revision History
    File: revhistory_dev_guide
    Distros: openshift-enterprise,openshift-dedicated

---
Name: Creating Images
Dir: creating_images
Distros: openshift-*
Topics:
  - Name: Overview
    File: index
  - Name: Guidelines
    File: guidelines
  - Name: Image Metadata
    File: metadata
  - Name: S2I Requirements
    File: s2i
  - Name: Testing S2I Images
    File: s2i_testing
  - Name: Custom Builder
    File: custom
  - Name: Revision History
    File: revhistory_creating_images
    Distros: openshift-enterprise,openshift-dedicated

---
Name: Using Images
Dir: using_images
Distros: openshift-*
Topics:
  - Name: Overview
    File: index
    Distros: openshift-online,openshift-enterprise,openshift-dedicated
  - Name: Source-to-Image (S2I)
    Dir: s2i_images
    Topics:
      - Name: Overview
        File: index
      - Name: Customizing S2I images
        File: customizing_s2i_images
      - Name: Java
        File: java
        Distros: openshift-origin,openshift-online
      - Name: .NET Core
        File: dot_net_core
        Distros: openshift-online,openshift-enterprise,openshift-dedicated
      - Name: Node.js
        File: nodejs
      - Name: Perl
        File: perl
      - Name: PHP
        File: php
      - Name: Python
        File: python
      - Name: Ruby
        File: ruby
  - Name: Database Images
    Dir: db_images
    Topics:
      - Name: Overview
        File: index
      - Name: MySQL
        File: mysql
      - Name: PostgreSQL
        File: postgresql
      - Name: MongoDB
        File: mongodb
  - Name: Docker Images
    Dir: docker_images
    Topics:
      - Name: Overview
        File: index
  - Name: Other Images
    Dir: other_images
    Topics:
      - Name: Overview
        File: index
      - Name: Jenkins
        File: jenkins
  - Name: xPaaS Middleware Images
    Dir: xpaas_images
    Distros: openshift-online,openshift-enterprise,openshift-dedicated
    Topics:
      - Name: Overview
        File: index
  - Name: Revision History
    File: revhistory_using_images
    Distros: openshift-enterprise,openshift-dedicated


---
Name: REST API Reference
Dir: rest_api
Topics:
  - Name: Overview
    File: index
  - Name: OpenShift v1
    File: openshift_v1
  - Name: Kubernetes v1
    File: kubernetes_v1
  - Name: Revision History
    File: revhistory_rest_api
    Distros: openshift-enterprise,openshift-dedicated