mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
368 lines
11 KiB
YAML
368 lines
11 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: 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: 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: 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: 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: Monitoring user-defined projects
|
|
Dir: osd_monitoring
|
|
Distros: openshift-dedicated
|
|
Topics:
|
|
- Name: Understanding the monitoring stack
|
|
File: osd-understanding-the-monitoring-stack
|
|
- Name: Accessing monitoring for user-defined projects
|
|
File: osd-accessing-monitoring-for-user-defined-projects
|
|
- Name: Configuring the monitoring stack
|
|
File: osd-configuring-the-monitoring-stack
|
|
- Name: Managing metrics
|
|
File: osd-managing-metrics
|
|
- Name: Managing alerts
|
|
File: osd-managing-alerts
|
|
- Name: Reviewing monitoring dashboards
|
|
File: osd-reviewing-monitoring-dashboards
|
|
- Name: Troubleshooting monitoring issues
|
|
File: osd-troubleshooting-monitoring-issues
|
|
---
|
|
Name: Cluster security
|
|
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: 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: Persistent storage
|
|
Dir: persistent_storage
|
|
Distros: openshift-dedicated
|
|
Topics:
|
|
- Name: Persistent storage using AWS EFS
|
|
File: osd-persistent-storage-aws
|
|
---
|
|
Name: Networking
|
|
Dir: networking
|
|
Distros: openshift-dedicated
|
|
Topics:
|
|
- Name: OpenShift SDN default CNI network provider
|
|
Dir: openshift_sdn
|
|
Topics:
|
|
- Name: Enabling multicast for a project
|
|
File: enabling-multicast
|
|
- Name: Configuring a cluster-wide proxy during installation
|
|
File: configuring-cluster-wide-proxy
|
|
- Name: CIDR range definitions
|
|
File: cidr-range-definitions
|
|
---
|
|
Name: Applications
|
|
Dir: applications
|
|
Distros: openshift-dedicated
|
|
Topics:
|
|
- Name: Deployments
|
|
Dir: deployments
|
|
Distros: openshift-dedicated
|
|
Topics:
|
|
- Name: Configuring custom domains for applications
|
|
File: osd-config-custom-domains-applications
|
|
---
|
|
Name: Serverless
|
|
Dir: serverless
|
|
Distros: openshift-dedicated
|
|
Topics:
|
|
- Name: Release notes
|
|
File: serverless-release-notes
|
|
- Name: Discover
|
|
Dir: discover
|
|
Topics:
|
|
- Name: About OpenShift Serverless
|
|
File: about-serverless
|
|
- Name: About OpenShift Serverless Functions
|
|
File: serverless-functions-about
|
|
- Name: Event sources
|
|
File: knative-event-sources
|
|
- Name: Channels and subscriptions
|
|
File: serverless-channels
|
|
- Name: Install
|
|
Dir: install
|
|
Topics:
|
|
- Name: Installing the OpenShift Serverless Operator
|
|
File: install-serverless-operator
|
|
- Name: Installing Knative Serving
|
|
File: installing-knative-serving
|
|
- Name: Installing Knative Eventing
|
|
File: installing-knative-eventing
|
|
- Name: Removing OpenShift Serverless
|
|
File: removing-openshift-serverless
|
|
- Name: Knative CLI
|
|
Dir: cli_tools
|
|
Topics:
|
|
- Name: Installing the Knative CLI
|
|
File: installing-kn
|
|
- Name: Configuring the Knative CLI
|
|
File: advanced-kn-config
|
|
- Name: Knative Serving CLI commands
|
|
File: kn-serving-ref
|
|
- Name: Knative Eventing CLI commands
|
|
File: kn-eventing-ref
|
|
- Name: Functions commands
|
|
File: kn-func-ref
|
|
- Name: Develop
|
|
Dir: develop
|
|
Topics:
|
|
- Name: Serverless applications
|
|
File: serverless-applications
|
|
- Name: Autoscaling
|
|
File: serverless-autoscaling-developer
|
|
- Name: Traffic management
|
|
File: serverless-traffic-management
|
|
- Name: Routing
|
|
File: serverless-configuring-routes
|
|
- Name: Event sinks
|
|
File: serverless-event-sinks
|
|
- Name: Event delivery
|
|
File: serverless-event-delivery
|
|
- Name: Listing event sources and event source types
|
|
File: serverless-listing-event-sources
|
|
- Name: Creating an API server source
|
|
File: serverless-apiserversource
|
|
- Name: Creating a ping source
|
|
File: serverless-pingsource
|
|
- File: serverless-custom-event-sources
|
|
Name: Custom event sources
|
|
- Name: Creating channels
|
|
File: serverless-creating-channels
|
|
- Name: Creating and managing subscriptions
|
|
File: serverless-subs
|
|
- Name: Brokers
|
|
File: serverless-using-brokers
|
|
- Name: Triggers
|
|
File: serverless-triggers
|
|
- Name: Using Knative Kafka
|
|
File: serverless-kafka-developer
|
|
- Name: Administer
|
|
Dir: admin_guide
|
|
Topics:
|
|
- Name: Global configuration
|
|
File: serverless-configuration
|
|
- Name: Configuring Knative Kafka
|
|
File: serverless-kafka-admin
|
|
- Name: Serverless components in the Administrator perspective
|
|
File: serverless-admin-perspective
|
|
- Name: Integrating Service Mesh with OpenShift Serverless
|
|
File: serverless-ossm-setup
|
|
- Name: Serverless administrator metrics
|
|
File: serverless-admin-metrics
|
|
- Name: High availability
|
|
File: serverless-ha
|
|
- Name: Monitor
|
|
Dir: monitor
|
|
Topics:
|
|
- Name: Cluster logging with OpenShift Serverless
|
|
File: cluster-logging-serverless
|
|
- Name: Serverless developer metrics
|
|
File: serverless-developer-metrics
|
|
# Tracing
|
|
- Name: Tracing
|
|
File: serverless-tracing
|
|
- Name: Support
|
|
File: serverless-support
|
|
- Name: Security
|
|
Dir: security
|
|
Topics:
|
|
- Name: Configuring JSON Web Token authentication for Knative services
|
|
File: serverless-ossm-with-kourier-jwt
|
|
- Name: Configuring a custom domain for a Knative service
|
|
File: serverless-custom-domains
|
|
- Name: Functions
|
|
Dir: functions
|
|
Topics:
|
|
- Name: Setting up OpenShift Serverless Functions
|
|
File: serverless-functions-setup
|
|
- Name: Getting started with functions
|
|
File: serverless-functions-getting-started
|
|
- Name: Developing Node.js functions
|
|
File: serverless-developing-nodejs-functions
|
|
- Name: Developing TypeScript functions
|
|
File: serverless-developing-typescript-functions
|
|
- Name: Developing Go functions
|
|
File: serverless-developing-go-functions
|
|
- Name: Developing Python functions
|
|
File: serverless-developing-python-functions
|
|
- Name: Developing Quarkus functions
|
|
File: serverless-developing-quarkus-functions
|
|
- Name: Using functions with Knative Eventing
|
|
File: serverless-functions-eventing
|
|
- Name: Function project configuration in func.yaml
|
|
File: serverless-functions-yaml
|
|
- Name: Accessing secrets and config maps from functions
|
|
File: serverless-functions-accessing-secrets-configmaps
|
|
- Name: Adding annotations to functions
|
|
File: serverless-functions-annotations
|
|
- Name: Functions development reference guide
|
|
File: serverless-functions-reference-guide
|
|
---
|
|
Name: Troubleshooting
|
|
Dir: osd_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: Opting out of remote health reporting
|
|
File: opting-out-of-remote-health-reporting
|
|
- 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
|