openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity
Files
6070e6474ebde1aac01b9d5bb75cbc6a45a67e71
openshift-docs/_topic_maps/_topic_map_osd.yml

763 lines
25 KiB
YAML
Raw Blame History

# 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: 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: 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: Security and compliance
Dir: security
Distros: openshift-dedicated
Topics:
- Name: Viewing 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: 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: Networking
Dir: networking
Distros: openshift-dedicated
Topics:
- 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: Configuring a cluster-wide proxy
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: 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 logging collector
File: cluster-logging-collector
- 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: Maintenance and support
File: cluster-logging-maintenance-support
- Name: Logging with the 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: Forwarding logs to third party systems
File: cluster-logging-external
- Name: Enabling JSON logging
File: cluster-logging-enabling-json-logging
- Name: Collecting and storing Kubernetes events
File: cluster-logging-eventrouter
# - Name: Forwarding logs using ConfigMaps
# File: cluster-logging-external-configmap
# Distros: openshift-dedicated
- 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: Collecting logging data for Red Hat Support
File: cluster-logging-must-gather
- 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 user-defined projects
Dir: 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: Enabling alert routing for user-defined projects
File: osd-enabling-alert-routing-for-user-defined-projects
- Name: Managing metrics
File: osd-managing-metrics
- Name: Managing alerts
File: managing-alerts
- Name: Reviewing monitoring dashboards
File: osd-reviewing-monitoring-dashboards
- Name: Troubleshooting monitoring issues
File: osd-troubleshooting-monitoring-issues
---
Name: Serverless
Dir: serverless
Distros: openshift-dedicated
Topics:
- Name: Release notes
File: serverless-release-notes
- Name: About Serverless
Dir: about
Topics:
- Name: Serverless overview
File: about-serverless
- Name: Knative Serving overview
File: about-knative-serving
- Name: Knative Eventing overview
File: about-knative-eventing
- Name: Serverless Functions overview
File: serverless-functions-about
- Name: Installing Serverless
Dir: install
Topics:
- Name: Preparing to install OpenShift Serverless
File: preparing-serverless-install
- Name: Installing the Serverless Operator
File: install-serverless-operator
- Name: Installing the Knative CLI
File: installing-kn
- Name: Installing Knative Serving
File: installing-knative-serving
- Name: Installing Knative Eventing
File: installing-knative-eventing
- Name: Configuring Serverless Functions
File: configuring-serverless-functions
- Name: Knative Serving
Dir: knative-serving
Topics:
- Name: Getting started with Knative Serving
Dir: getting-started
Topics:
- Name: Creating Serverless applications
File: serverless-applications
- Name: Verifying application deployment
File: verifying-application-deployment
- Name: Autoscaling
Dir: autoscaling
Topics:
- Name: Autoscaling overview
File: serverless-autoscaling-developer
- Name: Scale bounds
File: serverless-autoscaling-developer-scale-bounds
- Name: Concurrency
File: serverless-concurrency
- Name: Scale-to-zero
File: serverless-autoscaling-scale-to-zero
- Name: Configuring Serverless applications
Dir: config-applications
Topics:
- Name: Overriding system deployment configurations
File: overriding-config
- Name: EmptyDir volumes
File: empty-dir
- Name: Persistent Volume Claims
File: pvcs-for-serving
- Name: Init containers
File: init-containers
- Name: Resolving image tags to digests
File: resolving-image-tags-to-digests
- Name: Restrictive network policies
File: restrictive-network-policies
- Name: Traffic splitting
Dir: traffic-splitting
Topics:
- Name: Traffic splitting overview
File: traffic-splitting-overview
- Name: Traffic spec examples
File: traffic-spec-examples
- Name: Traffic splitting using the CLI
File: traffic-splitting-using-cli
- Name: CLI flags for traffic splitting
File: traffic-splitting-flags
- Name: Splitting traffic between revisions
File: traffic-splitting-revisions
- Name: Rerouting traffic using blue-green strategy
File: traffic-splitting-blue-green
- Name: External and Ingress routing
Dir: external-ingress-routing
Topics:
- Name: Routing overview
File: routing-overview
- Name: Customizing labels and annotations
File: customize-labels-annotations-routes
- Name: Configuring routes for Knative services
File: configuring-service-routes
- Name: Global HTTPS redirection
File: https-redirect-global
- Name: URL scheme for external routes
File: url-scheme-external-routes
- Name: HTTPS redirection per service
File: https-redirect-per-service
- Name: Cluster local availability
File: cluster-local-availability
- Name: Kourier Gateway service type
File: kourier-gateway-service-type
- Name: Using HTTP2 and gRPC
File: using-http2-gRPC
- Name: Configuring access to Knative services
Dir: config-access
Topics:
- Name: Configuring JSON Web Token authentication for Knative services
File: serverless-ossm-with-kourier-jwt
- Name: Using JSON Web Token authentication with Service Mesh 2.x
File: serverless-ossm-v2x-jwt
- Name: Using JSON Web Token authentication with Service Mesh 1.x
File: serverless-ossm-v1x-jwt
- Name: Configuring custom domains for Knative services
Dir: config-custom-domains
Topics:
- Name: Configuring custom domains overview
File: serverless-custom-domains
- Name: Custom domain mapping
File: create-domain-mapping
- Name: Custom domains using the Knative CLI
File: create-domain-mapping-kn
- Name: Domain mapping using the Developer perspective
File: domain-mapping-odc-developer
- Name: Domain mapping using the Administrator perspective
File: domain-mapping-odc-admin
- Name: Securing a mapped service using a TLS certificate
File: domain-mapping-custom-tls-cert
- Name: Configuring high availability for Knative services
Dir: config-ha-services
Topics:
- Name: High availability for Knative services overview
File: ha-services-overview
- Name: High availability for Knative services
File: ha-replicas-serving
# Eventing
- Name: Eventing
Dir: eventing
Topics:
- Name: Knative Eventing
File: knative-eventing
- Name: Event sources
Dir: event-sources
Topics:
- Name: Event sources overview
File: knative-event-sources
- Name: Event source in the Administrator perspective
File: event-source-admin-perspective
- Name: Creating an API server source
File: serverless-apiserversource
- Name: Creating a ping source
File: serverless-pingsource
- Name: Kafka source
File: serverless-kafka-developer-source
- Name: Custom event sources
File: serverless-custom-event-sources
- Name: Connecting an event source to a sink using the Developer perspective
File: serverless-sink-source-odc
- Name: Event sinks
Dir: event-sinks
Topics:
- Name: Event sinks overview
File: serverless-event-sinks
- Name: Kafka sink
File: serverless-kafka-developer-sink
- Name: Brokers
Dir: brokers
Topics:
- Name: Brokers overview
File: serverless-brokers
- Name: Broker types
File: serverless-broker-types
- Name: Creating brokers
File: serverless-using-brokers
- Name: Configuring the default broker backing channel
File: serverless-broker-backing-channel-default
- Name: Configuring the default broker class
File: serverless-global-config-broker-class-default
- Name: Kafka broker
File: kafka-broker
- Name: Creating a Kafka broker
File: creating-kafka-broker
- Name: Security configuration for Knative Kafka
File: serverless-kafka-admin-security
- Name: Managing brokers
File: serverless-using-brokers-managing-brokers
- Name: Event delivery
File: serverless-event-delivery
- Name: Triggers
Dir: triggers
Topics:
- Name: Triggers overview
File: serverless-triggers
- Name: Creating triggers from the web console
File: create-trigger-odc
- Name: Creating triggers from the command line
File: create-trigger-cli
- Name: Creating a trigger from the Administrator perspective
File: create-trigger-admin
- Name: List triggers from the command line
File: list-triggers-cli
- Name: Describe triggers from the command line
File: describe-triggers-cli
- Name: Connecting a trigger to a sink
File: connect-trigger-sink
- Name: Filtering triggers from the command line
File: filter-triggers-cli
- Name: Updating triggers from the command line
File: update-triggers-cli
- Name: Deleting triggers from the command line
File: delete-triggers-cli
- Name: Channels
Dir: channels
Topics:
- Name: Channels and subscriptions
File: serverless-channels
- Name: Creating channels
File: serverless-creating-channels
- Name: Default channel implementation
File: serverless-channel-default
- Name: Security configuration for Knative Kafka channels
File: serverless-kafka-admin-security-channels
- Name: Subscriptions
Dir: subscriptions
Topics:
- Name: Creating and managing subscriptions
File: serverless-subs
- Name: Event discovery
Dir: discovery
Topics:
- Name: Listing event sources and event source types
File: serverless-listing-event-sources
- Name: Listing event source types from the command line
File: list-event-source-types-cli
- Name: Listing event source types from the Developer perspective
File: list-event-source-types-odc
- Name: Listing event sources from the command line
File: list-event-sources-cli
- Name: Tuning eventing configuration
Dir: tuning
Topics:
- Name: Overriding deployment configurations
File: override-config
- Name: High availability
File: serverless-ha
- Name: kn-event plugin
Dir: kn-event-plugin
Topics:
- Name: Knative CLI plugins
File: kn-plugins-events
- 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 Quarkus functions
File: serverless-developing-quarkus-functions
- Name: Developing Node.js functions
File: serverless-developing-nodejs-functions
- Name: Developing TypeScript functions
File: serverless-developing-typescript-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
# Knative kn CLI
- Name: Knative CLI
Dir: cli_tools
Topics:
- Name: Knative Serving CLI commands
Dir: serving_cli
Topics:
- Name: kn service commands
File: kn-service
- Name: kn service commands in offline mode
File: kn-service-offline
- Name: kn container commands
File: kn-container
- Name: kn domain commands
File: kn-domain
- Name: Configuring the Knative CLI
File: advanced-kn-config
- Name: Knative CLI plugins
File: kn-plugins
- Name: Knative Eventing CLI commands
Dir: eventing_cli
Topics:
- Name: kn source commands
File: kn-source
- Name: Knative Functions CLI commands
Dir: functions_cli
Topics:
- Name: kn functions commands
File: kn-functions
- 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: Security
Dir: security
Topics:
- Name: Configuring TLS authentication
File: serverless-config-tls
- Name: Observability
Dir: observability
Topics:
- Name: Administrator metrics
Dir: admin-metrics
Topics:
- Name: Administrator metrics overview
File: serverless-admin-metrics
- Name: Controller metrics
File: serverless-controller-metrics
- Name: Webhook metrics
File: serverless-webhook-metrics
- Name: Knative Eventing metrics
File: serverless-admin-metrics-eventing
- Name: Knative Serving metrics
File: serverless-admin-metrics-serving
- Name: Developer metrics
Dir: developer-metrics
Topics:
- Name: Developer metrics overview
File: serverless-developer-metrics
- Name: Default Knative service metrics
File: serverless-monitoring-services-default-metrics
- Name: Custom Knative service metrics
File: serverless-monitoring-services-custom-metrics
- Name: Configuration for scraping custom metrics
File: serverless-monitoring-services-configuration-scraping
- Name: Examining metrics of a service
File: serverless-monitoring-services-examining-metrics
- Name: Dashboard for service metrics
File: serverless-developer-metrics-dashboard
- Name: Cluster logging
Dir: cluster-logging
Topics:
- Name: Using OpenShift Logging with Serverless
File: cluster-logging-serverless
- Name: Finding logs for Knative Serving components
File: finding-serving-logs-components
- Name: Finding logs for Knative Serving services
File: finding-serving-logs-services
- Name: Tracing
Dir: tracing
Topics:
- Name: Tracing requests
File: serverless-tracing
- Name: Using Red Hat OpenShift distributed tracing
File: serverless-tracing-open-telemetry
Distros: openshift-enterprise
- Name: Using Jaeger distributed tracing
File: serverless-tracing-jaeger
# Removing
- Name: Removing Serverless
Dir: removing
Topics:
- Name: Removing Serverless overview
File: removing-openshift-serverless
- Name: Uninstalling Knative Eventing
File: uninstalling-knative-eventing
- Name: Uninstalling Knative Serving
File: uninstalling-knative-serving
- Name: Removing Serverless Operator
File: removing-serverless-operator
- Name: Deleting Serverless CRDs
File: deleting-serverless-crds
# Support
- Name: Serverless support
File: serverless-support
---
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
View Git Blame Copy Permalink