mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
491 lines
15 KiB
YAML
491 lines
15 KiB
YAML
# 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
|
|
- Name: Support for OpenShift Dedicated
|
|
File: osd-support
|
|
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: 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: Managing administration roles and users
|
|
File: osd-admin-roles
|
|
- 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: 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: Cluster autoscaling
|
|
# File: osd-cluster-autoscaling
|
|
---
|
|
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: Managing security context constraints
|
|
File: managing-security-context-constraints
|
|
---
|
|
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: 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: 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: Logging
|
|
Dir: logging
|
|
Distros: openshift-dedicated
|
|
Topics:
|
|
- Name: Release notes
|
|
File: cluster-logging-release-notes
|
|
- Name: Support
|
|
File: cluster-logging-support
|
|
- Name: About Logging
|
|
File: cluster-logging
|
|
- Name: Installing Logging
|
|
File: cluster-logging-deploying
|
|
- Name: Accessing the service logs
|
|
File: sd-accessing-the-service-logs
|
|
- Name: Configuring your Logging deployment
|
|
Dir: config
|
|
Topics:
|
|
- Name: About the Cluster Logging custom resource
|
|
File: cluster-logging-configuring-cr
|
|
- Name: Configuring the log store
|
|
File: cluster-logging-log-store
|
|
- Name: Configuring the log visualizer
|
|
File: cluster-logging-visualizer
|
|
- Name: Configuring Logging storage
|
|
File: cluster-logging-storage-considerations
|
|
- 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 the Logging resources with node selectors
|
|
File: cluster-logging-moving-nodes
|
|
#- Name: Configuring systemd-journald and Fluentd
|
|
# File: cluster-logging-systemd
|
|
- Name: Logging using LokiStack
|
|
File: cluster-logging-loki
|
|
- Name: Viewing logs for a specific resource
|
|
File: viewing-resource-logs
|
|
- Name: Viewing cluster logs in Kibana
|
|
File: cluster-logging-visualizer
|
|
Distros: openshift-dedicated
|
|
- Name: Log collection and forwarding
|
|
Dir: log_collection_forwarding
|
|
Topics:
|
|
- Name: About log forwarding
|
|
File: log-forwarding
|
|
- Name: Enabling JSON log forwarding
|
|
File: cluster-logging-enabling-json-logging
|
|
- Name: Configuring the logging collector
|
|
File: cluster-logging-collector
|
|
- Name: Collecting and storing Kubernetes events
|
|
File: cluster-logging-eventrouter
|
|
- Name: Updating Logging
|
|
File: cluster-logging-upgrading
|
|
- Name: Viewing cluster dashboards
|
|
File: cluster-logging-dashboards
|
|
- Name: Troubleshooting Logging
|
|
Dir: troubleshooting
|
|
Topics:
|
|
- Name: Viewing Logging status
|
|
File: cluster-logging-cluster-status
|
|
- Name: Viewing the status of the log store
|
|
File: cluster-logging-log-store-status
|
|
- Name: Understanding Logging alerts
|
|
File: cluster-logging-alerts
|
|
- Name: Troubleshooting for Critical Alerts
|
|
File: cluster-logging-troubleshooting-for-critical-alerts
|
|
- Name: Uninstalling Logging
|
|
File: cluster-logging-uninstall
|
|
- Name: Exported fields
|
|
File: cluster-logging-exported-fields
|
|
---
|
|
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
|
|
---
|
|
Name: Troubleshooting
|
|
Dir: sd_support
|
|
Distros: openshift-dedicated
|
|
Topics:
|
|
- 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
|
|
- Name: Using Insights to identify issues with your cluster
|
|
File: using-insights-to-identify-issues-with-your-cluster
|
|
- Name: Summarizing cluster specifications
|
|
File: osd-summarizing-cluster-specifications
|
|
Distros: openshift-dedicated
|
|
- Name: OpenShift Dedicated managed resources
|
|
File: osd-managed-resources
|
|
Distros: openshift-dedicated
|