mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
364 lines
12 KiB
YAML
364 lines
12 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 +/- .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: Applications and projects
|
|
Dir: applications_and_projects
|
|
Distros: openshift-*
|
|
Topics:
|
|
- Name: Managing resources from CRDs
|
|
File: crd-managing-resources-from-crds
|
|
---
|
|
Name: Builds
|
|
Dir: builds
|
|
Distros: openshift-*
|
|
Topics:
|
|
- Name: Understanding builds
|
|
File: understanding-builds
|
|
- Name: Creating build inputs
|
|
File: creating-build-inputs
|
|
- Name: Managing build output
|
|
File: managing-build-output
|
|
- Name: Using build strategies
|
|
File: build-strategies
|
|
- 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: Troubleshooting builds
|
|
File: troubleshooting-builds
|
|
---
|
|
Name: Images
|
|
Dir: openshift_images
|
|
Distros: openshift-*
|
|
Topics:
|
|
- Name: Using templates
|
|
File: using-templates
|
|
- Name: Using Ruby on Rails
|
|
File: templates-using-ruby-on-rails
|
|
---
|
|
Name: OpenShift CCS modular docs guide
|
|
Dir: mod_docs_guide
|
|
Distros: openshift-*
|
|
Topics:
|
|
- Name: Getting started with modular docs on OpenShift
|
|
File: getting-started-modular-docs-ocp
|
|
- Name: OpenShift CCS modular docs conventions
|
|
File: mod-docs-conventions-ocp
|
|
---
|
|
Name: Release notes
|
|
Dir: release_notes
|
|
Distros: openshift-enterprise
|
|
Topics:
|
|
- Name: Comparing OpenShift Container Platform v3 and v4
|
|
File: comparing_v3_v4
|
|
---
|
|
Name: Architecture
|
|
Dir: architecture
|
|
Distros: openshift-*
|
|
Topics:
|
|
- Name: Architecture
|
|
File: architecture
|
|
---
|
|
Name: Installing clusters on AWS
|
|
Dir: installing-aws
|
|
Distros: openshift-origin, openshift-enterprise
|
|
Topics:
|
|
- Name: Configuring an AWS account
|
|
File: installing-aws-account
|
|
- Name: Installing a cluster quickly on AWS
|
|
File: installing-quickly-cloud
|
|
- Name: Installing a cluster on AWS with customizations
|
|
File: installing-customizations-cloud
|
|
- Name: Uninstalling a cluster on AWS
|
|
File: uninstalling-cluster-aws
|
|
---
|
|
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 allow all identity provider
|
|
File: configuring-allow-all-identity-provider
|
|
- Name: Configuring a deny all identity provider
|
|
File: configuring-deny-all-identity-provider
|
|
- 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: 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: Users and roles
|
|
Dir: users_and_roles
|
|
Distros: openshift-*
|
|
Topics:
|
|
- 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: Masters
|
|
Dir: masters
|
|
Distros: openshift-origin, openshift-enterprise
|
|
Topics:
|
|
- Name: Setting resource quotas per project
|
|
File: quotas-setting-per-project
|
|
- Name: Setting resource quotas across multiple projects
|
|
File: quotas-setting-across-multiple-projects
|
|
- Name: Idling applications
|
|
File: idling-applications
|
|
- Name: Extending the Kubernetes API with CRDs
|
|
File: crd-extending-api-with-crds
|
|
- Name: Pruning objects
|
|
File: pruning-objects
|
|
---
|
|
Name: Networking
|
|
Dir: networking
|
|
Distros: openshift-*
|
|
Topics:
|
|
- Name: Understanding networking
|
|
File: understanding-networking
|
|
- Name: Using cookies to keep route statefulness
|
|
File: using-cookies-to-keep-route-statefulness
|
|
---
|
|
Name: Registry
|
|
Dir: registry
|
|
Distros: openshift-*
|
|
Topics:
|
|
- 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: 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: Storage
|
|
Dir: storage
|
|
Distros: openshift-*
|
|
Topics:
|
|
- Name: Optimizing storage
|
|
File: optimizing-storage
|
|
---
|
|
Name: Operators
|
|
Dir: operators
|
|
Distros: openshift-*
|
|
Topics:
|
|
- Name: What are Operators?
|
|
File: olm-what-are-operators
|
|
- Name: Adding Operators to a cluster
|
|
File: olm-adding-operators-to-cluster
|
|
Distros: openshift-enterprise,openshift-origin
|
|
- Name: Creating applications from installed Operators
|
|
File: olm-creating-apps-from-installed-operators
|
|
- Name: Getting started with the Operator SDK
|
|
File: osdk-getting-started
|
|
- Name: Operators based on Helm charts
|
|
File: osdk-helm
|
|
- Name: Operator SDK CLI reference
|
|
File: osdk-cli-reference
|
|
- Name: Migrating to Operator SDK v0.1.0
|
|
File: migrating-to-osdk-v0-1-0
|
|
- Name: Appendices
|
|
File: operators-appendices
|
|
---
|
|
Name: Nodes
|
|
Dir: nodes
|
|
Distros: openshift-*
|
|
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: Automatically scaling Pods
|
|
File: nodes-pods-autoscaling
|
|
- Name: Running background tasks on nodes automatically with daemonsets
|
|
File: nodes-pods-daemonsets
|
|
- Name: Disabling features using feature gates
|
|
File: nodes-pods-disabling-features
|
|
- 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: 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 on nodes using node affinity rules
|
|
File: nodes-scheduler-node-affinity
|
|
- 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: Viewing and listing the nodes in your cluster
|
|
File: nodes-nodes-viewing
|
|
- Name: Working with nodes
|
|
File: nodes-nodes-working
|
|
- 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: Running tasks in pods using jobs
|
|
File: nodes-nodes-jobs
|
|
- 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 cluster
|
|
File: nodes-containers-port-forwarding
|
|
- 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: Logging
|
|
Dir: logging
|
|
Distros: openshift-*
|
|
Topics:
|
|
- Name: About cluster logging
|
|
File: efk-logging
|
|
- Name: Deploying EFK stack
|
|
File: efk-logging-deploy
|
|
- Name: Uninstalling the EFK stack
|
|
File: efk-logging-uninstall
|
|
- Name: Working with Elasticsearch
|
|
File: efk-logging-elasticsearch
|
|
- Name: Working with Fluentd
|
|
File: efk-logging-fluentd
|
|
- Name: Working with Kibana
|
|
File: efk-logging-kibana
|
|
- Name: Working with Curator
|
|
File: efk-logging-curator
|
|
- Name: Sending logs to external devices
|
|
File: efk-logging-external
|
|
- Name: Setting the cluster logging driver
|
|
File: efk-logging-driver
|
|
- Name: Manually rolling out Elasticsearch
|
|
File: efk-logging-manual-rollout
|
|
- Name: Configuring systemd-journald and rsyslog
|
|
File: efk-logging-systemd
|
|
- Name: Troubleshooting Kubernetes
|
|
File: efk-logging-troubleshooting
|
|
- Name: Exported fields
|
|
File: efk-logging-exported-fields
|