# 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 / # - Name: The Acrobatic Ascarid <= Sub-topic 2 name # File: the_acrobatic_ascarid <= Sub-topic 2 file under / # # 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-enterprise,openshift-origin,openshift-dedicated Topics: - Name: Welcome File: index - Name: About OpenShift Container Engine File: oce_about Distros: openshift-enterprise - Name: Accessing your services File: accessing-your-services Distros: openshift-dedicated - Name: Legal notice File: legal-notice --- Name: Release notes Dir: release_notes Distros: openshift-enterprise Topics: - Name: OpenShift Container Platform 4.1 release notes File: ocp-4-1-release-notes - Name: Versioning policy File: versioning-policy --- Name: Architecture Dir: architecture Distros: openshift-enterprise,openshift-origin,openshift-dedicated Topics: - Name: Product architecture File: architecture - Name: Installation and update File: architecture-installation - Name: The control plane File: control-plane Distros: openshift-enterprise,openshift-origin,openshift-dedicated - Name: Understanding OpenShift development File: understanding-development - Name: Red Hat Enterprise Linux CoreOS File: architecture-rhcos --- Name: Administering a cluster Dir: administering_a_cluster Distros: openshift-dedicated Topics: - Name: The dedicated-admin role File: dedicated-admin-role --- Name: Installing Dir: installing Distros: openshift-origin,openshift-enterprise Topics: - Name: Installing on AWS Dir: installing_aws Topics: - Name: Configuring an AWS account File: installing-aws-account - Name: Installing a cluster quickly on AWS File: installing-aws-default - Name: Installing a cluster on AWS with customizations File: installing-aws-customizations - Name: Installing a cluster on AWS with network customizations File: installing-aws-network-customizations - Name: Uninstalling a cluster on AWS File: uninstalling-cluster-aws - Name: Installing on user-provisioned AWS Dir: installing_aws_user_infra Topics: - Name: Installing a cluster on AWS using CloudFormation templates File: installing-aws-user-infra #- Name: Installing on Azure # Dir: installing_azure # Topics: # - Name: Configuring an Azure account # File: installing-azure-account # - Name: Installing a cluster quickly on Azure # File: installing-azure-default # - Name: Installing a cluster on Azure with customizations # File: installing-azure-customizations # - Name: Uninstalling a cluster on Azure # File: uninstalling-cluster-azure #- Name: Installing on GCP # Dir: installing_gcp # Topics: # - Name: Configuring an GCP account # File: installing-gcp-account # - Name: Installing a cluster quickly on GCP # File: installing-gcp-default # - Name: Installing a cluster on GCP with customizations # File: installing-gcp-customizations # - Name: Uninstalling a cluster on GCP # File: uninstalling-cluster-gcp #- Name: Installing in a disconnected environment # Dir: installing_disconnected # Topics: # - Name: Preparing for a disconnected installation # File: installing-disconnected-preparations # - Name: Installing in a disconnected environment # File: installing-disconnected - Name: Installing on bare metal Dir: installing_bare_metal Topics: - Name: Installing a cluster on bare metal File: installing-bare-metal - Name: Installing on vSphere Dir: installing_vsphere Topics: - Name: Installing a cluster on vSphere File: installing-vsphere - Name: Gathering installation logs File: installing-gather-logs - Name: Installation configuration Dir: install_config Topics: - Name: Available cluster customizations File: customizations Distros: openshift-enterprise,openshift-origin - Name: Configuring your firewall File: configuring-firewall # - Name: Configuring a custom certificate authority # File: configuring-custom-ca --- Name: Updating clusters Dir: updating Distros: openshift-origin,openshift-enterprise Topics: - Name: Updating a cluster to a minor version from the web console File: updating-cluster - Name: Updating a cluster to a minor version by using the CLI File: updating-cluster-cli - Name: Updating a cluster that includes RHEL compute machines File: updating-cluster-rhel-compute #- Name: Updating a disconnected cluster # File: updating-disconnected-cluster # - Name: Troubleshooting an update # File: updating-troubleshooting --- Name: Web console Dir: web-console Distros: openshift-enterprise,openshift-origin,openshift-dedicated Topics: - Name: Accessing the web console File: web-console - Name: Configuring the web console File: configuring-web-console - Name: Disabling the web console File: disabling-web-console --- Name: Authentication Dir: authentication Distros: openshift-enterprise,openshift-origin Topics: - Name: Understanding authentication File: understanding-authentication Distros: openshift-enterprise,openshift-origin - Name: Configuring the internal OAuth server File: configuring-internal-oauth Distros: openshift-enterprise,openshift-origin - Name: Understanding identity provider configuration File: understanding-identity-provider Distros: openshift-enterprise,openshift-origin - Name: Configuring identity providers Dir: identity_providers Distros: openshift-enterprise,openshift-origin Topics: - 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: Configuring certificates Dir: certificates Topics: - Name: Replacing the default ingress certificate File: replacing-default-ingress-certificate - Name: Adding API server certificates File: api-server - Name: Securing service traffic using service serving certificates File: service-serving-certificate - Name: Using RBAC to define and apply permissions File: using-rbac Distros: openshift-enterprise,openshift-origin - Name: Removing the kubeadmin user File: remove-kubeadmin Distros: openshift-enterprise,openshift-origin #- Name: Configuring LDAP failover # File: configuring-ldap-failover Distros: openshift-enterprise,openshift-origin - Name: Configuring the user agent File: configuring-user-agent Distros: openshift-enterprise,openshift-origin - Name: Understanding and creating service accounts File: understanding-and-creating-service-accounts Distros: openshift-enterprise,openshift-origin - Name: Using service accounts in applications File: using-service-accounts-in-applications Distros: openshift-enterprise,openshift-origin - Name: Using a service account as an OAuth client File: using-service-accounts-as-oauth-client Distros: openshift-enterprise,openshift-origin - Name: Scoping tokens File: tokens-scoping - Name: Managing Security Context Constraints File: managing-security-context-constraints Distros: openshift-enterprise,openshift-origin - Name: Impersonating the system:admin user File: impersonating-system-admin Distros: openshift-enterprise,openshift-origin - Name: Syncing LDAP groups File: ldap-syncing Distros: openshift-enterprise,openshift-origin - Name: Allowing JavaScript-based access to the API server from additional hosts File: allowing-javascript-access-api-server Distros: openshift-enterprise,openshift-origin --- Name: Networking Dir: networking Distros: openshift-enterprise,openshift-origin Topics: - Name: Understanding networking File: understanding-networking - Name: Understanding the Cluster Network Operator (CNO) File: cluster-network-operator - Name: Understanding the DNS Operator File: dns-operator - Name: Understanding the Ingress Operator File: ingress-operator - Name: Multiple networks File: managing-multinetworking Distros: openshift-enterprise,openshift-origin - Name: Configuring network policy File: configuring-networkpolicy Distros: openshift-origin,openshift-enterprise - Name: OpenShift SDN Dir: openshift-sdn Topics: - Name: About OpenShift SDN File: about-openshift-sdn - Name: Enabling egress IPs for a project File: assigning-egress-ips Distros: openshift-origin,openshift-enterprise - Name: Using multicast File: using-multicast Distros: openshift-origin,openshift-enterprise - Name: Configuring multitenant isolation File: multitenant-isolation Distros: openshift-origin,openshift-enterprise - Name: Configuring kube-proxy File: configuring-kube-proxy Distros: openshift-enterprise,openshift-origin - Name: Configuring Routes Dir: routes Topics: - Name: Route configuration File: route-configuration - Name: Secured routes File: secured-routes - Name: Configuring ingress cluster traffic Dir: configuring-ingress-cluster-traffic Topics: - Name: Overview File: overview-traffic - Name: Configuring ingress cluster traffic using an Ingress Controller File: configuring-ingress-cluster-traffic-ingress-controller - Name: Configuring ingress cluster traffic using a load balancer File: configuring-ingress-cluster-traffic-load-balancer - Name: Configuring ingress cluster traffic using a service external IP File: configuring-ingress-cluster-traffic-service-external-ip - Name: Configuring ingress cluster traffic using a NodePort File: configuring-ingress-cluster-traffic-nodeport --- Name: Storage Dir: storage Distros: openshift-enterprise,openshift-origin,openshift-dedicated Topics: - Name: Understanding persistent storage File: understanding-persistent-storage Distros: openshift-enterprise,openshift-origin,openshift-dedicated - Name: Configuring persistent storage Dir: persistent-storage Distros: openshift-enterprise,openshift-origin Topics: - Name: Persistent storage using AWS Elastic Block Store File: persistent-storage-aws - Name: Persistent storage using NFS File: persistent-storage-nfs - Name: Persistent Storage using iSCSI File: persistent-storage-iscsi - Name: Persistent storage using Container Storage Interface (CSI) File: persistent-storage-csi # - Name: Persistent storage using OpenStack Manila # File: persistent-storage-manila - Name: Expanding persistent volumes File: expanding-persistent-volumes Distros: openshift-enterprise,openshift-origin - Name: Dynamic provisioning File: dynamic-provisioning Distros: openshift-enterprise,openshift-origin --- Name: Registry Dir: registry Distros: openshift-enterprise,openshift-origin,openshift-dedicated Topics: - Name: Overview File: architecture-component-imageregistry - Name: Image Registry Operator in Openshift Container Platform File: configuring-registry-operator Distros: openshift-enterprise,openshift-origin - Name: Registry options File: registry-options Distros: openshift-enterprise,openshift-origin - Name: Accessing the registry File: accessing-the-registry Distros: openshift-enterprise,openshift-origin - Name: Exposing the registry File: securing-exposing-registry Distros: openshift-enterprise,openshift-origin --- Name: Builds Dir: builds Distros: openshift-enterprise,openshift-origin,openshift-dedicated Topics: - Name: Understanding image builds File: understanding-image-builds - Name: Understanding build configurations File: understanding-buildconfigs - Name: Creating build inputs File: creating-build-inputs - Name: Managing build output File: managing-build-output - Name: Using build strategies File: build-strategies #- Name: OpenShift Pipelines # Dir: openshift_piplines # Distros: openshift-enterprise,openshift-origin - Name: Custom image builds with Buildah File: custom-builds-buildah Distros: openshift-enterprise,openshift-origin - Name: Performing basic builds File: basic-build-operations Distros: openshift-enterprise,openshift-origin - Name: Triggering and modifying builds File: triggering-builds-build-hooks Distros: openshift-enterprise,openshift-origin - Name: Performing advanced builds File: advanced-build-operations Distros: openshift-enterprise,openshift-origin - Name: Running entitled builds File: running-entitled-builds Distros: openshift-enterprise,openshift-origin - Name: Securing builds by strategy File: securing-builds-by-strategy Distros: openshift-enterprise,openshift-origin - Name: Build configuration resources File: build-configuration Distros: openshift-enterprise,openshift-origin - Name: Troubleshooting builds File: troubleshooting-builds Distros: openshift-enterprise,openshift-origin - Name: Setting up additional trusted certifying authorities for builds File: setting-up-trusted-ca --- Name: Images Dir: openshift_images Distros: openshift-enterprise,openshift-origin,openshift-dedicated Topics: - Name: Configuring the Samples Operator File: configuring-samples-operator - Name: Understanding containers, images, and imagestreams File: images-understand - Name: Creating images File: create-images - Name: Managing imagestreams File: image-streams-manage - Name: Image configuration resources File: image-configuration Distros: openshift-enterprise,openshift-origin - Name: Using templates File: using-templates - Name: Using Ruby on Rails File: templates-using-ruby-on-rails - Name: Using images Dir: using_images Distros: openshift-enterprise,openshift-origin Topics: - Name: Using images overview File: using-images-overview - Name: Configuring Jenkins images File: images-other-jenkins - Name: Jenkins agent File: images-other-jenkins-agent --- Name: Applications Dir: applications Distros: openshift-* Topics: - Name: Projects Dir: projects Topics: - Name: Working with projects File: working-with-projects - Name: Creating a project as another user File: creating-project-other-user Distros: openshift-enterprise,openshift-origin - Name: Configuring project creation File: configuring-project-creation Distros: openshift-enterprise,openshift-origin - Name: Operators Dir: operators Topics: - Name: Understanding Operators File: olm-what-operators-are - Name: Understanding the Operator Lifecycle Manager (OLM) File: olm-understanding-olm - Name: Understanding the OperatorHub File: olm-understanding-operatorhub - Name: Adding Operators to a cluster File: olm-adding-operators-to-cluster Distros: openshift-enterprise,openshift-origin,openshift-dedicated - Name: Deleting Operators from a cluster File: olm-deleting-operators-from-cluster Distros: openshift-enterprise,openshift-origin,openshift-dedicated - Name: Creating applications from installed Operators File: olm-creating-apps-from-installed-operators - Name: Service brokers Dir: service_brokers Distros: openshift-enterprise,openshift-origin Topics: - Name: Installing the service catalog File: installing-service-catalog - Name: Installing the Template service Broker File: installing-template-service-broker - Name: Provisioning template applications File: provisioning-template-application - Name: Uninstalling the Template Service Broker File: uninstalling-template-service-broker - Name: Installing the OpenShift Ansible Broker File: installing-ansible-service-broker - Name: Configuring the OpenShift Ansible Broker File: configuring-ansible-service-broker - Name: Provisioning service bundles File: provisioning-service-bundle - Name: Uninstalling the OpenShift Ansible Broker File: uninstalling-ansible-service-broker - Name: Deployments Dir: deployments Topics: - Name: Understanding Deployments and DeploymentConfigs File: what-deployments-are - Name: Managing deployment processes File: managing-deployment-processes - Name: Using DeploymentConfig strategies File: deployment-strategies - Name: Using route-based deployment strategies File: route-based-deployment-strategies - Name: CRDs Dir: crds Topics: - Name: Extending the Kubernetes API with CRDs File: crd-extending-api-with-crds Distros: openshift-origin,openshift-enterprise - Name: Managing resources from CRDs File: crd-managing-resources-from-crds - Name: Quotas Dir: quotas Distros: openshift-origin,openshift-enterprise,openshift-dedicated Topics: - Name: Resource quotas per project File: quotas-setting-per-project - Name: Resource quotas across multiple projects File: quotas-setting-across-multiple-projects - Name: Working with quotas File: working-with-quotas Distros: openshift-online,openshift-dedicated - Name: Idling applications File: idling-applications Distros: openshift-origin,openshift-enterprise - Name: Pruning objects to reclaim resources File: pruning-objects Distros: openshift-origin,openshift-enterprise - Name: Operator SDK Dir: operator_sdk Distros: openshift-origin,openshift-enterprise Topics: - Name: Getting started with the Operator SDK File: osdk-getting-started - Name: Creating Ansible-based Operators File: osdk-ansible - Name: Creating Helm-based Operators File: osdk-helm - Name: Generating a ClusterServiceVersion (CSV) File: osdk-generating-csvs - Name: Configuring built-in monitoring with Prometheus File: osdk-monitoring-prometheus - Name: Configuring leader election File: osdk-leader-election - Name: Operator SDK CLI reference File: osdk-cli-reference - Name: Migrating to Operator SDK v0.1.0 File: osdk-migrating-to-v0-1-0 Distros: openshift-origin - Name: Appendices File: osdk-appendices - Name: Application life cycle management Dir: application-life-cycle-management Topics: - Name: Creating applications File: creating-new-applications --- Name: Machine management Dir: machine_management Distros: openshift-origin,openshift-enterprise Topics: - Name: Creating a MachineSet File: creating-machineset - Name: Manually scaling a MachineSet File: manually-scaling-machineset - Name: Applying autoscaling to a cluster File: applying-autoscaling - Name: Creating infrastructure MachineSets File: creating-infrastructure-machinesets - Name: Adding a RHEL compute machine File: adding-rhel-compute - Name: Adding more RHEL compute machines File: more-rhel-compute - Name: Deploying machine health checks File: deploying-machine-health-checks --- Name: Nodes Dir: nodes Distros: openshift-* Topics: - Name: Working with pods Dir: pods 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 Distros: openshift-enterprise,openshift-origin - Name: Automatically scaling pods File: nodes-pods-autoscaling - Name: Providing sensitive data to Pods File: nodes-pods-secrets - Name: Using Device Manager to make devices available to nodes File: nodes-pods-plugins Distros: openshift-enterprise,openshift-origin - Name: Including pod priority in Pod scheduling decisions File: nodes-pods-priority Distros: openshift-enterprise,openshift-origin - Name: Placing pods on specific nodes using node selectors File: nodes-pods-node-selectors Distros: openshift-enterprise,openshift-origin - Name: Controlling pod placement onto nodes (scheduling) Dir: scheduling Distros: openshift-enterprise,openshift-origin Topics: - Name: About pod placement using the scheduler File: nodes-scheduler-about - Name: Configuring the default scheduler to control pod placement File: nodes-scheduler-default - Name: Placing pods relative to other pods using pod affinity and anti-affinity rules File: nodes-scheduler-pod-affinity - Name: Controlling pod placement on nodes using node affinity rules File: nodes-scheduler-node-affinity - Name: Placing pods onto overcommited nodes File: nodes-scheduler-overcommit - Name: Controlling pod placement using node taints File: nodes-scheduler-taints-tolerations - Name: Placing pods on specific nodes using node selectors File: nodes-scheduler-node-selectors # - 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: Keeping your cluster balanced using the descheduler # File: nodes-scheduler-descheduler - Name: Using Jobs and DaemonSets Dir: jobs Topics: - Name: Running background tasks on nodes automatically with daemonsets File: nodes-pods-daemonsets Distros: openshift-enterprise,openshift-origin - Name: Running tasks in pods using jobs File: nodes-nodes-jobs - Name: Working with nodes Dir: nodes Distros: openshift-enterprise,openshift-origin Topics: - Name: Viewing and listing the nodes in your cluster File: nodes-nodes-viewing - Name: Working with nodes File: nodes-nodes-working - Name: Managing Nodes File: nodes-nodes-managing - Name: Managing the maximum number of Pods per Node File: nodes-nodes-managing-max-pods - Name: Using the Node Tuning Operator File: nodes-node-tuning-operator - 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: Viewing node audit logs File: nodes-nodes-audit-log - Name: Working with containers Dir: containers Topics: - 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 container File: nodes-containers-port-forwarding - Name: Monitoring container health File: nodes-containers-health - Name: Working with clusters Dir: clusters Topics: - Name: Viewing system event information in a cluster File: nodes-containers-events - Name: Analyzing cluster resource levels File: nodes-cluster-resource-levels Distros: openshift-enterprise,openshift-origin - Name: Configuring cluster memory to meet container memory and risk requirements File: nodes-cluster-resource-configure Distros: openshift-enterprise,openshift-origin - Name: Configuring your cluster to place pods on overcommited nodes File: nodes-cluster-overcommit Distros: openshift-enterprise,openshift-origin - Name: Enabling features using FeatureGates File: nodes-cluster-enabling-features Distros: openshift-enterprise,openshift-origin --- Name: Logging Dir: logging Distros: openshift-enterprise,openshift-origin,openshift-dedicated Topics: - Name: About cluster logging File: efk-logging - Name: About deploying cluster logging File: efk-logging-deploying-about Distros: openshift-enterprise,openshift-origin - Name: Deploying cluster logging File: efk-logging-deploying Distros: openshift-enterprise,openshift-origin Name: Deloying cluster Logging File: dedicated-efk-deploying Distros: openshift-dedicated - Name: Configuring cluster logging File: dedicated-efk-logging Distros: openshift-dedicated - Name: Deploying and Configuring the Event Router File: efk-logging-eventrouter Distros: openshift-enterprise,openshift-origin - Name: Configuring your cluster logging deployment Dir: config Distros: openshift-enterprise,openshift-origin Topics: - Name: About configuring cluster logging File: efk-logging-configuring-about - Name: Changing cluster logging management state File: efk-logging-management - Name: Configuring cluster logging File: efk-logging-configuring - Name: Configuring Elasticsearch File: efk-logging-elasticsearch - Name: Configuring Kibana File: efk-logging-kibana - Name: Configuring Curator File: efk-logging-curator - Name: Configuring Fluentd File: efk-logging-fluentd - Name: Configuring systemd-journald File: efk-logging-systemd - Name: Sending logs to external devices File: efk-logging-external - Name: Viewing Elasticsearch status File: efk-logging-elasticsearch-status Distros: openshift-enterprise,openshift-origin - Name: Manually rolling out Elasticsearch File: efk-logging-manual-rollout Distros: openshift-enterprise,openshift-origin - Name: Troubleshooting Kibana File: efk-logging-troubleshooting Distros: openshift-enterprise,openshift-origin - Name: Exported fields File: efk-logging-exported-fields Distros: openshift-enterprise,openshift-origin - Name: Uninstalling cluster logging File: efk-logging-uninstall --- Name: Monitoring Dir: monitoring Distros: openshift-enterprise,openshift-origin Topics: - Name: Cluster monitoring Dir: cluster-monitoring Topics: - Name: About cluster monitoring File: about-cluster-monitoring - Name: Configuring the monitoring stack File: configuring-the-monitoring-stack - Name: Managing cluster alerts File: managing-cluster-alerts - Name: Accessing Prometheus, Alertmanager, and Grafana File: prometheus-alertmanager-and-grafana - Name: Exposing custom application metrics for autoscaling File: exposing-custom-application-metrics-for-autoscaling --- Name: Telemetry Dir: telemetry Distros: openshift-enterprise,openshift-origin Topics: - Name: About Telemetry File: about-telemetry - Name: Showing data collected by Telemetry File: showing-data-collected-by-telemetry - Name: Opting out of Telemetry File: opting-out-of-telemetry --- Name: Scalability and performance Dir: scalability_and_performance Distros: openshift-origin,openshift-enterprise Topics: - Name: Recommended host practices File: recommended-host-practices - Name: Using the Node Tuning Operator File: using-node-tuning-operator - Name: Using Cluster Loader File: using-cluster-loader - Name: Using CPU Manager File: using-cpu-manager - 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 storage File: optimizing-storage - Name: Optimizing routing File: routing-optimization - Name: What huge pages do and how they are consumed by apps File: what-huge-pages-do-and-how-they-are-consumed-by-apps --- Name: Disaster recovery Dir: disaster_recovery Distros: openshift-origin,openshift-enterprise Topics: - Name: Backing up etcd data File: backing-up-etcd - Name: Recovering from lost master hosts File: scenario-1-infra-recovery - Name: Restoring back to a previous cluster state File: scenario-2-restoring-cluster-state - Name: Recovering from expired control plane certificates File: scenario-3-expired-certs --- Name: CLI reference Dir: cli_reference Distros: openshift-enterprise,openshift-origin,openshift-dedicated Topics: - Name: Getting started with the CLI File: getting-started-cli - Name: Configuring the CLI File: configuring-cli - Name: Extending the CLI with plug-ins File: extending-cli-plugins Distros: openshift-enterprise,openshift-origin - Name: Developer CLI commands File: developer-cli-commands - Name: Administrator CLI commands File: administrator-cli-commands Distros: openshift-enterprise,openshift-origin --- Name: Service Mesh Dir: service_mesh Distros: openshift-enterprise Topics: - Name: Service Mesh Installation Dir: service_mesh_install Topics: - Name: Understanding service mesh File: understanding-ossm - Name: Preparing to install service mesh File: preparing-ossm-installation - Name: Installing service mesh File: installing-ossm - Name: Installing a multi-tenant service mesh File: installing-mt-ossm - Name: Deploying applications on service mesh File: prepare-to-deploy-applications-ossm - Name: Example application File: ossm-example-bookinfo - Name: Kiali tutorial File: ossm-tutorial-kiali - Name: Distributed tracing tutorial File: ossm-tutorial-jaeger-tracing - Name: Grafana tutorial File: ossm-tutorial-grafana - Name: Prometheus tutorial File: ossm-tutorial-prometheus - Name: Removing service mesh File: removing-ossm - Name: 3scale adapter Dir: threescale_adapter Topics: - Name: Using the 3scale Istio adapter File: threescale-adapter - Name: Service Mesh Release Notes File: servicemesh-release-notes --- Name: Container-native Virtualization Dir: cnv Distros: openshift-enterprise Topics: - Name: Container-native Virtualization installation Dir: cnv_install Topics: - Name: About Container-native Virtualization File: cnv-about-cnv - Name: Preparing your OpenShift cluster for Container-native Virtualization File: preparing-cluster-for-cnv - Name: Installing Container-native Virtualization File: installing-container-native-virtualization - Name: Installing the `virtctl` client File: cnv-installing-virtctl - Name: Uninstalling Container-native Virtualization File: uninstalling-container-native-virtualization - Name: Container-native Virtualization user's guide Dir: cnv_users_guide Topics: ### VIRTUAL MACHINE CHESS SALAD (silly name to highlight that the commented out assemblies need to be checked against merged filenams) - Name: Creating virtual machines File: cnv-create-vms ### Importing virtual machines - Name: Importing a VMware virtual machine or template with the virtual machine wizard File: cnv-importing-vmware-vm - Name: Importing virtual machine images with DataVolumes File: cnv-importing-virtual-machine-images-datavolumes ### VM CHESS SALAD cont'd - Name: Editing virtual machines File: cnv-edit-vms - Name: Deleting virtual machines File: cnv-delete-vms - Name: Controlling virtual machines states File: cnv-controlling-vm-states - Name: Accessing virtual machine consoles File: cnv-accessing-vm-consoles - Name: Using the CLI tools File: cnv-using-the-cli-tools ### Virtual machine networking - Name: Using the default Pod network with Container-native Virtualization File: cnv-using-the-default-pod-network-with-cnv - Name: Attaching a virtual machine to multiple networks File: cnv-attaching-vm-multiple-networks - Name: Installing the QEMU guest agent on virtual machines File: cnv-installing-qemu-guest-agent - Name: Viewing the IP address of vNICs on a virtual machine File: cnv-viewing-ip-of-vm-vnic ### Advanced virtual machine configuration - Name: Configuring PXE booting for virtual machines File: cnv-configuring-pxe-booting - Name: Managing guest memory File: cnv-managing-guest-memory ### Templates - Name: Creating virtual machine templates File: cnv-creating-vm-template - Name: Editing a virtual machine template File: cnv-editing-vm-template - Name: Deleting a virtual machine template File: cnv-deleting-vm-template ### Cloning virtual machines - Name: Cloning a virtual machine disk into a new DataVolume File: cnv-cloning-vm-disk-into-new-datavolume - Name: Cloning a virtual machine by using a DataVolumeTemplate File: cnv-cloning-vm-using-datavolumetemplate ### A BETTER NAME THAN 'STORAGE 4 U' - Name: Uploading local disk images by using the virtctl tool File: cnv-uploading-local-disk-images-virtctl - Name: Expanding virtual storage by adding blank disk images File: cnv-expanding-virtual-storage-with-blank-disk-images ### Virtual machine live migration - Name: Virtual machine live migration File: cnv-live-migration - Name: Live migration limits and timeouts File: cnv-live-migration-limits - Name: Migrating a virtual machine instance to another node File: cnv-migrate-vmi - Name: Monitoring live migration of a virtual machine instance File: cnv-monitor-vmi-migration - Name: Cancelling the live migration of a virtual machine instance File: cnv-cancel-vmi-migration ### Node maintenance mode - Name: Node maintenance mode File: cnv-node-maintenance - Name: Configuring virtual machine eviction strategy File: cnv-configuring-vmi-eviction-strategy - Name: Setting a node to maintenance mode File: cnv-setting-node-maintenance - Name: Resuming a node from maintenance mode File: cnv-resuming-node ### Installing VirtIO drivers on Windows virtual machines - Name: Installing VirtIO driver on an existing Windows virtual machine File: cnv-installing-virtio-drivers-on-existing-windows-vm - Name: Installing VirtIO driver on a new Windows virtual machine File: cnv-installing-virtio-drivers-on-new-windows-vm ### Logging, events, and monitoring - Name: Viewing logs File: cnv-logs - Name: Viewing events File: cnv-events - Name: OpenShift cluster monitoring File: cnv-openshift-cluster-monitoring - Name: Container-native Virtualization 2.0 release notes Dir: cnv_release_notes Topics: - Name: Container-native Virtualization 2.0 release notes File: cnv-release-notes #--- #Name: Serverless applications #Dir: serverless #Distros: openshift-enterprise #Topics: #- Name: Understanding Serverless # File: understanding-serverless #- Name: Serverless product architecture # File: serverless-architecture #- Name: Getting started with Knative services # File: getting-started-knative-services #- Name: Configuring Knative services # File: configuring-knative-services