From 9a18fcda83c655269649489ae9b4c3df94e40d8a Mon Sep 17 00:00:00 2001 From: Paul Needle Date: Tue, 23 Mar 2021 10:45:14 +0000 Subject: [PATCH] fix toc issue --- administering_a_cluster/cluster-admin-role.adoc | 1 + administering_a_cluster/dedicated-admin-role.adoc | 1 + .../odc-deleting-applications.adoc | 1 + .../odc-editing-applications.adoc | 1 + ...odc-viewing-application-composition-using-topology-view.adoc | 1 + ...dc-working-with-helm-charts-using-developer-perspective.adoc | 1 + ...ect-and-application-metrics-using-developer-perspective.adoc | 1 + applications/projects/creating-project-other-user.adoc | 1 + architecture/admission-plug-ins.adoc | 1 + architecture/architecture-installation.adoc | 1 + architecture/architecture-rhcos.adoc | 1 + architecture/architecture.adoc | 1 + architecture/control-plane.adoc | 1 + architecture/understanding-development.adoc | 1 + authentication/bound-service-account-tokens.adoc | 1 + authentication/configuring-internal-oauth.adoc | 1 + authentication/configuring-oauth-clients.adoc | 1 + authentication/configuring-user-agent.adoc | 1 + authentication/dedicated-understanding-authentication.adoc | 1 + .../configuring-basic-authentication-identity-provider.adoc | 1 + .../configuring-github-identity-provider.adoc | 1 + .../configuring-gitlab-identity-provider.adoc | 1 + .../configuring-google-identity-provider.adoc | 1 + .../configuring-htpasswd-identity-provider.adoc | 1 + .../configuring-keystone-identity-provider.adoc | 1 + .../identity_providers/configuring-ldap-identity-provider.adoc | 1 + .../identity_providers/configuring-oidc-identity-provider.adoc | 1 + .../configuring-request-header-identity-provider.adoc | 1 + authentication/impersonating-system-admin.adoc | 1 + authentication/ldap-syncing.adoc | 1 + authentication/managing-security-context-constraints.adoc | 1 + .../about-cloud-credential-operator.adoc | 1 + .../managing_cloud_provider_credentials/cco-mode-manual.adoc | 1 + .../managing_cloud_provider_credentials/cco-mode-mint.adoc | 1 + .../cco-mode-passthrough.adoc | 1 + .../managing_cloud_provider_credentials/cco-mode-sts.adoc | 1 + authentication/remove-kubeadmin.adoc | 1 + authentication/tokens-scoping.adoc | 1 + authentication/understanding-and-creating-service-accounts.adoc | 1 + authentication/understanding-authentication.adoc | 1 + authentication/understanding-identity-provider.adoc | 1 + authentication/using-service-accounts-as-oauth-client.adoc | 1 + authentication/using-service-accounts-in-applications.adoc | 1 + cicd/builds/advanced-build-operations.adoc | 1 + cicd/builds/basic-build-operations.adoc | 1 + cicd/builds/build-configuration.adoc | 1 + cicd/builds/build-strategies.adoc | 1 + cicd/builds/custom-builds-buildah.adoc | 1 + cicd/builds/managing-build-output.adoc | 1 + cicd/builds/running-entitled-builds.adoc | 1 + cicd/builds/securing-builds-by-strategy.adoc | 1 + cicd/builds/setting-up-trusted-ca.adoc | 1 + cicd/builds/triggering-builds-build-hooks.adoc | 1 + cicd/builds/troubleshooting-builds.adoc | 1 + cicd/builds/understanding-buildconfigs.adoc | 1 + cicd/builds/understanding-image-builds.adoc | 1 + cicd/gitops/getting-started-with-openshift-gitops.adoc | 1 + cicd/gitops/understanding-openshift-gitops.adoc | 1 + cicd/pipelines/creating-applications-with-cicd-pipelines.adoc | 1 + cicd/pipelines/understanding-openshift-pipelines.adoc | 1 + .../working-with-pipelines-using-the-developer-perspective.adoc | 1 + cli_reference/developer_cli_odo/configuring-the-odo-cli.adoc | 1 + .../creating-instances-of-services-managed-by-operators.adoc | 1 + .../creating-a-java-application-with-a-database.adoc | 1 + .../creating-a-multicomponent-application-with-odo.adoc | 1 + .../creating-a-single-component-application-with-odo.adoc | 1 + .../creating-an-application-with-a-database.adoc | 1 + .../debugging-applications-in-odo.adoc | 1 + .../deleting-applications.adoc | 1 + .../sample-applications.adoc | 1 + .../using-devfiles-in-odo.adoc | 1 + .../working-with-projects.adoc | 1 + .../working-with-storage.adoc | 1 + cli_reference/developer_cli_odo/installing-odo.adoc | 1 + .../managing-environment-variables-in-odo.adoc | 1 + cli_reference/developer_cli_odo/odo-architecture.adoc | 1 + cli_reference/developer_cli_odo/odo-cli-reference.adoc | 1 + cli_reference/developer_cli_odo/odo-release-notes.adoc | 1 + cli_reference/developer_cli_odo/understanding-odo.adoc | 1 + .../about-odo-in-a-restricted-environment.adoc | 1 + ...g-and-deploying-a-component-to-the-disconnected-cluster.adoc | 1 + ...g-the-odo-init-image-to-the-restricted-cluster-registry.adoc | 1 + cli_reference/tkn_cli/op-tkn-reference.adoc | 1 + cloud_infrastructure_access/dedicated-aws-access.adoc | 1 + cloud_infrastructure_access/dedicated-aws-dc.adoc | 1 + cloud_infrastructure_access/dedicated-aws-peering.adoc | 1 + cloud_infrastructure_access/dedicated-aws-private-cluster.adoc | 1 + cloud_infrastructure_access/dedicated-aws-vpn.adoc | 1 + cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc | 1 + installing/index.adoc | 1 + .../installing-openstack-load-balancing.adoc | 2 +- logging/troubleshooting/cluster-logging-must-gather.adoc | 1 - .../creating_machinesets/creating-machineset-osp.adoc | 2 +- machine_management/deploying-machine-health-checks.adoc | 1 + mod_docs_guide/getting-started-modular-docs-ocp.adoc | 1 + mod_docs_guide/mod-docs-conventions-ocp.adoc | 1 + modules/common-attributes.adoc | 2 -- .../k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc | 1 + .../k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc | 1 + .../k8s_nmstate/k8s-nmstate-troubleshooting-node-network.adoc | 1 + .../k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc | 1 + networking/routes/route-configuration.adoc | 1 + networking/using-cookies-to-keep-route-statefulness.adoc | 2 +- nodes/clusters/nodes-cluster-resource-configure.adoc | 1 - nodes/clusters/nodes-cluster-resource-levels.adoc | 1 - nodes/containers/nodes-containers-sysctls.adoc | 1 - nodes/containers/nodes-containers-using.adoc | 1 - nodes/nodes/nodes-nodes-garbage-collection.adoc | 1 - nodes/scheduling/nodes-scheduler-about.adoc | 1 - nodes/scheduling/nodes-scheduler-default.adoc | 1 - nodes/scheduling/nodes-scheduler-node-affinity.adoc | 1 - nodes/scheduling/nodes-scheduler-node-names.adoc | 1 - openshift_images/cnf-building-and-deploying-a-dpdk-payload.adoc | 1 + openshift_images/configuring-samples-operator.adoc | 1 + openshift_images/image-configuration.adoc | 1 + openshift_images/image-streams-manage.adoc | 1 + openshift_images/images-understand.adoc | 1 + openshift_images/samples-operator-alt-registry.adoc | 1 + openshift_images/templates-using-ruby-on-rails.adoc | 1 + openshift_images/using-imagestreams-with-kube-resources.adoc | 1 + openshift_images/using-templates.adoc | 1 + openshift_images/using_images/images-other-jenkins-agent.adoc | 1 + openshift_images/using_images/images-other-jenkins.adoc | 1 + openshift_images/using_images/using-images-overview.adoc | 1 + post_installation_configuration/cluster-tasks.adoc | 1 + .../machine-configuration-tasks.adoc | 1 + post_installation_configuration/network-configuration.adoc | 1 + post_installation_configuration/node-tasks.adoc | 1 + post_installation_configuration/preparing-for-users.adoc | 1 + post_installation_configuration/storage-configuration.adoc | 1 + registry/accessing-the-registry.adoc | 1 + registry/architecture-component-imageregistry.adoc | 1 + registry/configuring-registry-operator.adoc | 1 + .../configuring-registry-storage-aws-user-infrastructure.adoc | 1 + .../configuring-registry-storage-azure-user-infrastructure.adoc | 1 + .../configuring-registry-storage-baremetal.adoc | 1 + .../configuring-registry-storage-gcp-user-infrastructure.adoc | 1 + ...figuring-registry-storage-openstack-user-infrastructure.adoc | 1 + .../configuring-registry-storage-vsphere.adoc | 1 + registry/registry-options.adoc | 1 + registry/securing-exposing-registry.adoc | 1 + .../file-integrity-operator-advanced-usage.adoc | 1 + .../file-integrity-operator-configuring.adoc | 1 + .../file-integrity-operator-troubleshooting.adoc | 1 + .../file-integrity-operator-understanding.adoc | 1 + serverless/admin_guide/upgrading-serverless.adoc | 1 + serverless/event_sources/knative-event-sources.adoc | 1 + serverless/event_sources/serverless-kafka-source.adoc | 1 + service_mesh/v1x/customizing-installation-ossm.adoc | 1 + service_mesh/v1x/installing-ossm.adoc | 1 + service_mesh/v1x/ossm-architecture.adoc | 1 + service_mesh/v1x/ossm-custom-resources.adoc | 1 + service_mesh/v1x/preparing-ossm-installation.adoc | 1 + service_mesh/v1x/removing-ossm.adoc | 1 + service_mesh/v1x/threescale-adapter.adoc | 1 + service_mesh/v2x/customizing-installation-ossm.adoc | 1 + service_mesh/v2x/installing-ossm.adoc | 1 + service_mesh/v2x/ossm-architecture.adoc | 1 + service_mesh/v2x/ossm-custom-resources.adoc | 1 + service_mesh/v2x/ossm-traffic-manage.adoc | 2 +- service_mesh/v2x/preparing-ossm-installation.adoc | 1 + service_mesh/v2x/removing-ossm.adoc | 1 + service_mesh/v2x/threescale-adapter.adoc | 1 + service_mesh/v2x/upgrading-ossm.adoc | 1 + storage/dynamic-provisioning.adoc | 1 + storage/expanding-persistent-volumes.adoc | 1 + storage/persistent_storage/persistent-storage-azure-file.adoc | 1 + storage/persistent_storage/persistent-storage-azure.adoc | 1 + storage/persistent_storage/persistent-storage-ocs.adoc | 1 + storage/understanding-ephemeral-storage.adoc | 1 + storage/understanding-persistent-storage.adoc | 1 + .../about-remote-health-monitoring.adoc | 2 +- .../using-insights-to-identify-issues-with-your-cluster.adoc | 1 + updating/understanding-the-update-service.adoc | 1 + virt/about-virt.adoc | 1 + virt/install/installing-virt-cli.adoc | 1 + virt/install/installing-virt-web.adoc | 1 + virt/install/preparing-cluster-for-virt.adoc | 1 + virt/install/uninstalling-virt-cli.adoc | 1 + virt/install/uninstalling-virt-web.adoc | 1 + virt/install/virt-installing-virtctl.adoc | 1 + .../virt-specifying-nodes-for-virtualization-components.adoc | 1 + virt/live_migration/virt-cancel-vmi-migration.adoc | 1 + virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc | 1 + virt/live_migration/virt-live-migration-limits.adoc | 1 + virt/live_migration/virt-live-migration.adoc | 1 + virt/live_migration/virt-migrate-vmi.adoc | 1 + virt/live_migration/virt-monitor-vmi-migration.adoc | 1 + virt/logging_events_monitoring/virt-collecting-virt-data.adoc | 1 + ...virt-diagnosing-datavolumes-using-events-and-conditions.adoc | 1 + virt/logging_events_monitoring/virt-events.adoc | 1 + virt/logging_events_monitoring/virt-logs.adoc | 1 + virt/logging_events_monitoring/virt-monitoring-vm-health.adoc | 1 + .../virt-openshift-cluster-monitoring.adoc | 1 + .../virt-using-dashboard-to-get-cluster-info.adoc | 1 + .../virt-viewing-information-about-vm-workloads.adoc | 1 + virt/node_maintenance/virt-automatic-certificates.adoc | 1 + .../virt-managing-node-labeling-obsolete-cpu-models.adoc | 1 + virt/node_maintenance/virt-node-maintenance.adoc | 1 + virt/node_maintenance/virt-refresh-certificates.adoc | 1 + virt/node_maintenance/virt-resuming-node.adoc | 1 + virt/node_maintenance/virt-setting-node-maintenance.adoc | 1 + virt/node_network/virt-observing-node-network-state.adoc | 1 + virt/node_network/virt-troubleshooting-node-network.adoc | 1 + virt/node_network/virt-updating-node-network-config.adoc | 1 + virt/upgrading-virt.adoc | 1 + virt/virt-2-6-release-notes.adoc | 1 + ...-additional-security-privileges-controller-and-launcher.adoc | 1 + virt/virt-using-the-cli-tools.adoc | 1 + .../virt-automating-management-tasks.adoc | 1 + .../advanced_vm_management/virt-configuring-pxe-booting.adoc | 1 + .../advanced_vm_management/virt-dedicated-resources-vm.adoc | 1 + .../advanced_vm_management/virt-efi-mode-for-vms.adoc | 1 + .../advanced_vm_management/virt-managing-guest-memory.adoc | 1 + .../advanced_vm_management/virt-schedule-vms.adoc | 1 + .../advanced_vm_management/virt-using-huge-pages-with-vms.adoc | 1 + .../virt-cloning-vm-disk-into-new-datavolume-block.adoc | 1 + .../cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc | 1 + .../cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc | 1 + .../virt-enabling-user-permissions-to-clone-datavolumes.adoc | 1 + virt/virtual_machines/importing_vms/virt-importing-rhv-vm.adoc | 1 + ...virt-importing-virtual-machine-images-datavolumes-block.adoc | 1 + .../virt-importing-virtual-machine-images-datavolumes.adoc | 1 + .../importing_vms/virt-importing-vmware-vm.adoc | 1 + .../importing_vms/virt-tls-certificates-for-dv-imports.adoc | 1 + virt/virtual_machines/virt-accessing-vm-consoles.adoc | 1 + virt/virtual_machines/virt-controlling-vm-states.adoc | 1 + virt/virtual_machines/virt-create-vms.adoc | 1 + virt/virtual_machines/virt-delete-vms.adoc | 1 + virt/virtual_machines/virt-edit-boot-order.adoc | 1 + virt/virtual_machines/virt-edit-vms.adoc | 1 + virt/virtual_machines/virt-installing-qemu-guest-agent.adoc | 1 + .../virt-installing-virtio-drivers-on-existing-windows-vm.adoc | 1 + .../virt-installing-virtio-drivers-on-new-windows-vm.adoc | 1 + virt/virtual_machines/virt-manage-vmis.adoc | 1 + .../virt-managing-configmaps-secrets-service-accounts.adoc | 1 + .../virt-triggering-vm-failover-resolving-failed-node.adoc | 1 + virt/virtual_machines/virt-viewing-qemu-guest-agent-web.adoc | 1 + .../virt-cloning-a-datavolume-using-smart-cloning.adoc | 1 + .../virt-configuring-cdi-for-namespace-resourcequota.adoc | 1 + .../virtual_disks/virt-configuring-local-storage-for-vms.adoc | 1 + .../virtual_disks/virt-creating-and-using-boot-sources.adoc | 1 + .../virtual_disks/virt-deleting-datavolumes.adoc | 1 + .../virt-expanding-virtual-storage-with-blank-disk-images.adoc | 1 + .../virtual_disks/virt-features-for-storage.adoc | 1 + .../virtual_disks/virt-managing-offline-vm-snapshots.adoc | 1 + .../virt-moving-local-vm-disk-to-different-node.adoc | 1 + .../virtual_disks/virt-preparing-cdi-scratch-space.adoc | 1 + .../virtual_disks/virt-reserving-pvc-space-fs-overhead.adoc | 1 + .../virt-reusing-statically-provisioned-persistent-volumes.adoc | 1 + .../virtual_disks/virt-storage-defaults-for-datavolumes.adoc | 1 + .../virtual_disks/virt-uploading-local-disk-images-block.adoc | 1 + .../virtual_disks/virt-uploading-local-disk-images-virtctl.adoc | 1 + .../virtual_disks/virt-uploading-local-disk-images-web.adoc | 1 + .../virtual_disks/virt-using-container-disks-with-vms.adoc | 1 + .../virtual_disks/virt-using-preallocation-for-datavolumes.adoc | 1 + .../vm_networking/virt-attaching-vm-multiple-networks.adoc | 1 + .../vm_networking/virt-attaching-vm-to-sriov-network.adoc | 1 + .../vm_networking/virt-configuring-ip-for-vms.adoc | 1 + .../vm_networking/virt-configuring-sriov-device-for-vms.adoc | 1 + .../vm_networking/virt-defining-an-sriov-network.adoc | 1 + .../vm_networking/virt-using-mac-address-pool-for-vms.adoc | 1 + .../virt-using-the-default-pod-network-with-virt.adoc | 1 + .../vm_networking/virt-viewing-ip-of-vm-nic.adoc | 1 + virt/vm_templates/virt-creating-vm-template.adoc | 1 + virt/vm_templates/virt-dedicated-resources-vm-template.adoc | 1 + virt/vm_templates/virt-deleting-vm-template.adoc | 1 + virt/vm_templates/virt-editing-vm-template.adoc | 1 + web_console/configuring-web-console.adoc | 1 + web_console/creating-quick-start-tutorials.adoc | 1 + web_console/customizing-the-web-console.adoc | 1 + web_console/disabling-web-console.adoc | 1 + web_console/odc-about-developer-perspective.adoc | 1 + web_console/using-dashboard-to-get-cluster-information.adoc | 1 + web_console/web-console.adoc | 1 + .../creating-windows-machineset-aws.adoc | 2 +- .../creating-windows-machineset-azure.adoc | 2 +- .../creating-windows-machineset-vsphere.adoc | 2 +- windows_containers/enabling-windows-container-workloads.adoc | 2 +- 279 files changed, 268 insertions(+), 21 deletions(-) diff --git a/administering_a_cluster/cluster-admin-role.adoc b/administering_a_cluster/cluster-admin-role.adoc index 1ba125ef32..9e2d0203db 100644 --- a/administering_a_cluster/cluster-admin-role.adoc +++ b/administering_a_cluster/cluster-admin-role.adoc @@ -2,6 +2,7 @@ = The cluster-admin role include::modules/common-attributes.adoc[] :context: cluster-administrator + toc::[] As an administrator of {product-title} with Customer Cloud Subscriptions (link:https://www.openshift.com/dedicated/ccs[CCS]), you can request additional permissions and access to the *cluster-admin* role within your organization's cluster. While logged into an account with the cluster-admin role, users have increased permissions to run privileged security contexts and install additional Operators for their environment. diff --git a/administering_a_cluster/dedicated-admin-role.adoc b/administering_a_cluster/dedicated-admin-role.adoc index 34cf615c93..6d919e87a4 100644 --- a/administering_a_cluster/dedicated-admin-role.adoc +++ b/administering_a_cluster/dedicated-admin-role.adoc @@ -2,6 +2,7 @@ = The dedicated-admin role include::modules/common-attributes.adoc[] :context: dedicated-administrator + toc::[] As an administrator of an {product-title} cluster, your account has additional diff --git a/applications/application_life_cycle_management/odc-deleting-applications.adoc b/applications/application_life_cycle_management/odc-deleting-applications.adoc index 3b2c082b41..b0932bc8b9 100644 --- a/applications/application_life_cycle_management/odc-deleting-applications.adoc +++ b/applications/application_life_cycle_management/odc-deleting-applications.adoc @@ -2,6 +2,7 @@ = Deleting applications include::modules/common-attributes.adoc[] :context: odc-deleting-applications + toc::[] You can delete applications created in your project. diff --git a/applications/application_life_cycle_management/odc-editing-applications.adoc b/applications/application_life_cycle_management/odc-editing-applications.adoc index 853a01fd31..a3829fdd47 100644 --- a/applications/application_life_cycle_management/odc-editing-applications.adoc +++ b/applications/application_life_cycle_management/odc-editing-applications.adoc @@ -2,6 +2,7 @@ = Editing applications include::modules/common-attributes.adoc[] :context: odc-editing-applications + toc::[] You can edit the configuration and the source code of the application you create using the *Topology* view. diff --git a/applications/application_life_cycle_management/odc-viewing-application-composition-using-topology-view.adoc b/applications/application_life_cycle_management/odc-viewing-application-composition-using-topology-view.adoc index f167842a4f..5727f0916e 100644 --- a/applications/application_life_cycle_management/odc-viewing-application-composition-using-topology-view.adoc +++ b/applications/application_life_cycle_management/odc-viewing-application-composition-using-topology-view.adoc @@ -2,6 +2,7 @@ = Viewing application composition using the Topology view include::modules/common-attributes.adoc[] :context: viewing-application-composition-using-topology-view + toc::[] The *Topology* view in the *Developer* perspective of the web console provides a visual representation of all the applications within a project, their build status, and the components and services associated with them. diff --git a/applications/application_life_cycle_management/odc-working-with-helm-charts-using-developer-perspective.adoc b/applications/application_life_cycle_management/odc-working-with-helm-charts-using-developer-perspective.adoc index 7947806854..8474a38d02 100644 --- a/applications/application_life_cycle_management/odc-working-with-helm-charts-using-developer-perspective.adoc +++ b/applications/application_life_cycle_management/odc-working-with-helm-charts-using-developer-perspective.adoc @@ -2,6 +2,7 @@ = Working with Helm charts using the Developer perspective include::modules/common-attributes.adoc[] :context: working-with-helm-charts-using-developer-perspective + toc::[] diff --git a/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc index ae48551b5e..ab7150f767 100644 --- a/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc +++ b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc @@ -2,6 +2,7 @@ = Monitoring project and application metrics using the Developer perspective include::modules/common-attributes.adoc[] :context: monitoring-project-and-application-metrics-using-developer-perspective + toc::[] diff --git a/applications/projects/creating-project-other-user.adoc b/applications/projects/creating-project-other-user.adoc index 107404e7e0..e47a5e88d7 100644 --- a/applications/projects/creating-project-other-user.adoc +++ b/applications/projects/creating-project-other-user.adoc @@ -2,6 +2,7 @@ = Creating a project as another user include::modules/common-attributes.adoc[] :context: creating-project-other-user + toc::[] Impersonation allows you to create a project as a different user. diff --git a/architecture/admission-plug-ins.adoc b/architecture/admission-plug-ins.adoc index 9d13c11892..67bf668d81 100644 --- a/architecture/admission-plug-ins.adoc +++ b/architecture/admission-plug-ins.adoc @@ -2,6 +2,7 @@ = Admission plug-ins include::modules/common-attributes.adoc[] :context: admission-plug-ins + toc::[] // Concept modules diff --git a/architecture/architecture-installation.adoc b/architecture/architecture-installation.adoc index 8f098fae2a..596fdd77e5 100644 --- a/architecture/architecture-installation.adoc +++ b/architecture/architecture-installation.adoc @@ -2,6 +2,7 @@ = Installation and update include::modules/common-attributes.adoc[] :context: architecture-installation + toc::[] include::modules/installation-overview.adoc[leveloffset=+1] diff --git a/architecture/architecture-rhcos.adoc b/architecture/architecture-rhcos.adoc index f573456ec7..90c77e103f 100644 --- a/architecture/architecture-rhcos.adoc +++ b/architecture/architecture-rhcos.adoc @@ -2,6 +2,7 @@ = {op-system-first} include::modules/common-attributes.adoc[] :context: architecture-rhcos + toc::[] include::modules/rhcos-about.adoc[leveloffset=+1] diff --git a/architecture/architecture.adoc b/architecture/architecture.adoc index 7aa286bfa9..b30ae9e621 100644 --- a/architecture/architecture.adoc +++ b/architecture/architecture.adoc @@ -2,6 +2,7 @@ = {product-title} architecture include::modules/common-attributes.adoc[] :context: architecture + toc::[] include::modules/architecture-platform-introduction.adoc[leveloffset=+1] diff --git a/architecture/control-plane.adoc b/architecture/control-plane.adoc index 50a69f4822..e17cebaf0a 100644 --- a/architecture/control-plane.adoc +++ b/architecture/control-plane.adoc @@ -2,6 +2,7 @@ = The {product-title} control plane include::modules/common-attributes.adoc[] :context: control-plane + toc::[] include::modules/understanding-control-plane.adoc[leveloffset=+1] diff --git a/architecture/understanding-development.adoc b/architecture/understanding-development.adoc index fc76c578a7..37edbc456f 100644 --- a/architecture/understanding-development.adoc +++ b/architecture/understanding-development.adoc @@ -2,6 +2,7 @@ = Understanding {product-title} development include::modules/common-attributes.adoc[] :context: understanding-development + toc::[] To fully leverage the capability of containers when developing and running diff --git a/authentication/bound-service-account-tokens.adoc b/authentication/bound-service-account-tokens.adoc index 0fe74af216..9efe9ee83c 100644 --- a/authentication/bound-service-account-tokens.adoc +++ b/authentication/bound-service-account-tokens.adoc @@ -2,6 +2,7 @@ = Using bound service account tokens include::modules/common-attributes.adoc[] :context: bound-service-account-tokens + toc::[] You can use bound service account tokens, which improves the ability to integrate with cloud provider identity access management (IAM) services, such as AWS IAM. diff --git a/authentication/configuring-internal-oauth.adoc b/authentication/configuring-internal-oauth.adoc index e6a526eddb..20aeaf32d9 100644 --- a/authentication/configuring-internal-oauth.adoc +++ b/authentication/configuring-internal-oauth.adoc @@ -2,6 +2,7 @@ = Configuring the internal OAuth server include::modules/common-attributes.adoc[] :context: configuring-internal-oauth + toc::[] include::modules/oauth-server-overview.adoc[leveloffset=+1] diff --git a/authentication/configuring-oauth-clients.adoc b/authentication/configuring-oauth-clients.adoc index 027ba7aa5f..5138dc56a1 100644 --- a/authentication/configuring-oauth-clients.adoc +++ b/authentication/configuring-oauth-clients.adoc @@ -2,6 +2,7 @@ = Configuring OAuth clients include::modules/common-attributes.adoc[] :context: configuring-oauth-clients + toc::[] Several OAuth clients are created by default in {product-title}. You can also register and configure additional OAuth clients. diff --git a/authentication/configuring-user-agent.adoc b/authentication/configuring-user-agent.adoc index e72c4f7abf..fa81389ca9 100644 --- a/authentication/configuring-user-agent.adoc +++ b/authentication/configuring-user-agent.adoc @@ -2,6 +2,7 @@ = Configuring the user agent include::modules/common-attributes.adoc[] :context: configuring-user-agent + toc::[] include::modules/user-agent-overview.adoc[leveloffset=+1] diff --git a/authentication/dedicated-understanding-authentication.adoc b/authentication/dedicated-understanding-authentication.adoc index 57df807400..22e45b4881 100644 --- a/authentication/dedicated-understanding-authentication.adoc +++ b/authentication/dedicated-understanding-authentication.adoc @@ -2,6 +2,7 @@ = Understanding identity provider configuration include::modules/common-attributes.adoc[] :context: understanding-identity-provider + toc::[] include::modules/identity-provider-parameters.adoc[leveloffset=+1] diff --git a/authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc b/authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc index 0c2606d20b..7ba6bb5c9c 100644 --- a/authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc +++ b/authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc @@ -2,6 +2,7 @@ = Configuring a basic authentication identity provider include::modules/common-attributes.adoc[] :context: configuring-basic-authentication-identity-provider + toc::[] Configure a `basic-authentication` identity provider for users to log in to diff --git a/authentication/identity_providers/configuring-github-identity-provider.adoc b/authentication/identity_providers/configuring-github-identity-provider.adoc index 6e8db0d76f..238c15d607 100644 --- a/authentication/identity_providers/configuring-github-identity-provider.adoc +++ b/authentication/identity_providers/configuring-github-identity-provider.adoc @@ -2,6 +2,7 @@ = Configuring a GitHub or GitHub Enterprise identity provider include::modules/common-attributes.adoc[] :context: configuring-github-identity-provider + toc::[] Configure a `github` identity provider to validate user names and passwords diff --git a/authentication/identity_providers/configuring-gitlab-identity-provider.adoc b/authentication/identity_providers/configuring-gitlab-identity-provider.adoc index b1bcff7e8c..8a9c530daa 100644 --- a/authentication/identity_providers/configuring-gitlab-identity-provider.adoc +++ b/authentication/identity_providers/configuring-gitlab-identity-provider.adoc @@ -2,6 +2,7 @@ = Configuring a GitLab identity provider include::modules/common-attributes.adoc[] :context: configuring-gitlab-identity-provider + toc::[] Configure a `gitlab` identity provider to use diff --git a/authentication/identity_providers/configuring-google-identity-provider.adoc b/authentication/identity_providers/configuring-google-identity-provider.adoc index 27666fb584..a0ff89cec3 100644 --- a/authentication/identity_providers/configuring-google-identity-provider.adoc +++ b/authentication/identity_providers/configuring-google-identity-provider.adoc @@ -2,6 +2,7 @@ = Configuring a Google identity provider include::modules/common-attributes.adoc[] :context: configuring-google-identity-provider + toc::[] Configure a `google` identity provider using diff --git a/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc b/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc index a9c720654b..008735583e 100644 --- a/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc +++ b/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc @@ -2,6 +2,7 @@ = Configuring an HTPasswd identity provider include::modules/common-attributes.adoc[] :context: configuring-htpasswd-identity-provider + toc::[] [id="identity-provider-overview_{context}"] diff --git a/authentication/identity_providers/configuring-keystone-identity-provider.adoc b/authentication/identity_providers/configuring-keystone-identity-provider.adoc index 50a5481838..72cc65125b 100644 --- a/authentication/identity_providers/configuring-keystone-identity-provider.adoc +++ b/authentication/identity_providers/configuring-keystone-identity-provider.adoc @@ -2,6 +2,7 @@ = Configuring a Keystone identity provider include::modules/common-attributes.adoc[] :context: configuring-keystone-identity-provider + toc::[] Configure the `keystone` identity provider to integrate diff --git a/authentication/identity_providers/configuring-ldap-identity-provider.adoc b/authentication/identity_providers/configuring-ldap-identity-provider.adoc index bbe2e10f3e..dca4424ba9 100644 --- a/authentication/identity_providers/configuring-ldap-identity-provider.adoc +++ b/authentication/identity_providers/configuring-ldap-identity-provider.adoc @@ -2,6 +2,7 @@ = Configuring an LDAP identity provider include::modules/common-attributes.adoc[] :context: configuring-ldap-identity-provider + toc::[] Configure the `ldap` identity provider to validate user names and passwords diff --git a/authentication/identity_providers/configuring-oidc-identity-provider.adoc b/authentication/identity_providers/configuring-oidc-identity-provider.adoc index a34d2fc681..5473a20e33 100644 --- a/authentication/identity_providers/configuring-oidc-identity-provider.adoc +++ b/authentication/identity_providers/configuring-oidc-identity-provider.adoc @@ -2,6 +2,7 @@ = Configuring a OpenID Connect identity provider include::modules/common-attributes.adoc[] :context: configuring-oidc-identity-provider + toc::[] Configure an `oidc` identity provider to integrate with an OpenID Connect diff --git a/authentication/identity_providers/configuring-request-header-identity-provider.adoc b/authentication/identity_providers/configuring-request-header-identity-provider.adoc index df4628e1f1..abec4bb305 100644 --- a/authentication/identity_providers/configuring-request-header-identity-provider.adoc +++ b/authentication/identity_providers/configuring-request-header-identity-provider.adoc @@ -2,6 +2,7 @@ = Configuring a request header identity provider include::modules/common-attributes.adoc[] :context: configuring-request-header-identity-provider + toc::[] Configure a `request-header` identity provider to identify users from request diff --git a/authentication/impersonating-system-admin.adoc b/authentication/impersonating-system-admin.adoc index a63216b1fc..d71f3165f6 100644 --- a/authentication/impersonating-system-admin.adoc +++ b/authentication/impersonating-system-admin.adoc @@ -2,6 +2,7 @@ = Impersonating the `system:admin` user include::modules/common-attributes.adoc[] :context: impersonating-system-admin + toc::[] include::modules/authentication-api-impersonation.adoc[leveloffset=+1] diff --git a/authentication/ldap-syncing.adoc b/authentication/ldap-syncing.adoc index 4b7b00864d..62a4819db6 100644 --- a/authentication/ldap-syncing.adoc +++ b/authentication/ldap-syncing.adoc @@ -2,6 +2,7 @@ = Syncing LDAP groups include::modules/common-attributes.adoc[] :context: ldap-syncing-groups + toc::[] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] diff --git a/authentication/managing-security-context-constraints.adoc b/authentication/managing-security-context-constraints.adoc index 3ff20b767e..4b275ba4b2 100644 --- a/authentication/managing-security-context-constraints.adoc +++ b/authentication/managing-security-context-constraints.adoc @@ -2,6 +2,7 @@ = Managing security context constraints include::modules/common-attributes.adoc[] :context: configuring-internal-oauth + toc::[] include::modules/security-context-constraints-about.adoc[leveloffset=+1] diff --git a/authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc b/authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc index 17d2826c7d..05d96e84db 100644 --- a/authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc +++ b/authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc @@ -3,6 +3,7 @@ include::modules/common-attributes.adoc[] :context: about-cloud-credential-operator :FeatureName: Support for Amazon Web Services Secure Token Service (AWS STS) + toc::[] The Cloud Credential Operator (CCO) manages cloud provider credentials as custom resource definitions (CRDs). The CCO syncs on `CredentialsRequest` custom resources (CRs) to allow {product-title} components to request cloud provider credentials with the specific permissions that are required for the cluster to run. diff --git a/authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc b/authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc index 33575bbb3f..65dee7d67d 100644 --- a/authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc +++ b/authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc @@ -3,6 +3,7 @@ include::modules/common-attributes.adoc[] :context: cco-mode-manual :FeatureName: Support for Amazon Web Services Secure Token Service (AWS STS) + toc::[] Manual mode is supported for Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP). diff --git a/authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc b/authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc index 52bcc897e8..b9c733c9e0 100644 --- a/authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc +++ b/authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc @@ -2,6 +2,7 @@ = Using mint mode include::modules/common-attributes.adoc[] :context: cco-mode-mint + toc::[] Mint mode is supported for Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP). diff --git a/authentication/managing_cloud_provider_credentials/cco-mode-passthrough.adoc b/authentication/managing_cloud_provider_credentials/cco-mode-passthrough.adoc index 11108b1ee9..2003199dbb 100644 --- a/authentication/managing_cloud_provider_credentials/cco-mode-passthrough.adoc +++ b/authentication/managing_cloud_provider_credentials/cco-mode-passthrough.adoc @@ -2,6 +2,7 @@ = Using passthrough mode include::modules/common-attributes.adoc[] :context: cco-mode-passthrough + toc::[] Passthrough mode is supported for Amazon Web Services (AWS), Microsoft Azure, Google Cloud Platform (GCP), {rh-openstack-first}, {rh-virtualization-first}, and VMware vSphere. diff --git a/authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc b/authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc index 30cb52022d..12570b78d0 100644 --- a/authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc +++ b/authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc @@ -2,6 +2,7 @@ = Using manual mode with STS include::modules/common-attributes.adoc[] :context: cco-mode-sts + toc::[] Manual mode with STS is available as a link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] for Amazon Web Services (AWS). diff --git a/authentication/remove-kubeadmin.adoc b/authentication/remove-kubeadmin.adoc index 352f5c1a4d..9a66a0c2b8 100644 --- a/authentication/remove-kubeadmin.adoc +++ b/authentication/remove-kubeadmin.adoc @@ -2,6 +2,7 @@ = Removing the kubeadmin user include::modules/common-attributes.adoc[] :context: removing-kubeadmin + toc::[] include::modules/authentication-kubeadmin.adoc[leveloffset=+1] diff --git a/authentication/tokens-scoping.adoc b/authentication/tokens-scoping.adoc index b15fffb7e0..060ddce008 100644 --- a/authentication/tokens-scoping.adoc +++ b/authentication/tokens-scoping.adoc @@ -2,6 +2,7 @@ = Scoping tokens include::modules/common-attributes.adoc[] :context: configuring-internal-oauth + toc::[] include::modules/tokens-scoping-about.adoc[leveloffset=+1] diff --git a/authentication/understanding-and-creating-service-accounts.adoc b/authentication/understanding-and-creating-service-accounts.adoc index 976f9155d5..4ef0374388 100644 --- a/authentication/understanding-and-creating-service-accounts.adoc +++ b/authentication/understanding-and-creating-service-accounts.adoc @@ -2,6 +2,7 @@ = Understanding and creating service accounts include::modules/common-attributes.adoc[] :context: understanding-service-accounts + toc::[] include::modules/service-accounts-overview.adoc[leveloffset=+1] diff --git a/authentication/understanding-authentication.adoc b/authentication/understanding-authentication.adoc index 367ef3c755..402c049805 100644 --- a/authentication/understanding-authentication.adoc +++ b/authentication/understanding-authentication.adoc @@ -2,6 +2,7 @@ = Understanding authentication include::modules/common-attributes.adoc[] :context: understanding-authentication + toc::[] For users to interact with {product-title}, they must first authenticate diff --git a/authentication/understanding-identity-provider.adoc b/authentication/understanding-identity-provider.adoc index a1c2b73de1..956423069e 100644 --- a/authentication/understanding-identity-provider.adoc +++ b/authentication/understanding-identity-provider.adoc @@ -2,6 +2,7 @@ = Understanding identity provider configuration include::modules/common-attributes.adoc[] :context: understanding-identity-provider + toc::[] The {product-title} master includes a built-in OAuth server. Developers and diff --git a/authentication/using-service-accounts-as-oauth-client.adoc b/authentication/using-service-accounts-as-oauth-client.adoc index 66a13b3dbf..c2b0d059ac 100644 --- a/authentication/using-service-accounts-as-oauth-client.adoc +++ b/authentication/using-service-accounts-as-oauth-client.adoc @@ -2,6 +2,7 @@ = Using a service account as an OAuth client include::modules/common-attributes.adoc[] :context: using-service-accounts-as-oauth-client + toc::[] include::modules/service-accounts-as-oauth-clients.adoc[leveloffset=+1] \ No newline at end of file diff --git a/authentication/using-service-accounts-in-applications.adoc b/authentication/using-service-accounts-in-applications.adoc index 68a5155a73..231e068d64 100644 --- a/authentication/using-service-accounts-in-applications.adoc +++ b/authentication/using-service-accounts-in-applications.adoc @@ -2,6 +2,7 @@ = Using service accounts in applications include::modules/common-attributes.adoc[] :context: using-service-accounts + toc::[] include::modules/service-accounts-overview.adoc[leveloffset=+1] diff --git a/cicd/builds/advanced-build-operations.adoc b/cicd/builds/advanced-build-operations.adoc index bf1325d27b..1d49a98d65 100644 --- a/cicd/builds/advanced-build-operations.adoc +++ b/cicd/builds/advanced-build-operations.adoc @@ -2,6 +2,7 @@ = Performing advanced builds include::modules/common-attributes.adoc[] :context: advanced-build-operations + toc::[] The following sections provide instructions for advanced build operations including diff --git a/cicd/builds/basic-build-operations.adoc b/cicd/builds/basic-build-operations.adoc index b5cf6e0950..371683af22 100644 --- a/cicd/builds/basic-build-operations.adoc +++ b/cicd/builds/basic-build-operations.adoc @@ -2,6 +2,7 @@ = Performing basic builds include::modules/common-attributes.adoc[] :context: basic-build-operations + toc::[] The following sections provide instructions for basic build operations including starting and canceling builds, deleting BuildConfigs, viewing build details, and accessing build logs. diff --git a/cicd/builds/build-configuration.adoc b/cicd/builds/build-configuration.adoc index ba353d6898..67d6d8cd08 100644 --- a/cicd/builds/build-configuration.adoc +++ b/cicd/builds/build-configuration.adoc @@ -2,6 +2,7 @@ = Build configuration resources include::modules/common-attributes.adoc[] :context: build-configuration + toc::[] Use the following procedure to configure build settings. diff --git a/cicd/builds/build-strategies.adoc b/cicd/builds/build-strategies.adoc index d0711a2e7e..67772ce734 100644 --- a/cicd/builds/build-strategies.adoc +++ b/cicd/builds/build-strategies.adoc @@ -2,6 +2,7 @@ = Using build strategies include::modules/common-attributes.adoc[] :context: build-strategies + toc::[] The following sections define the primary supported build strategies, and how to diff --git a/cicd/builds/custom-builds-buildah.adoc b/cicd/builds/custom-builds-buildah.adoc index 29815a2a1c..1c781ab647 100644 --- a/cicd/builds/custom-builds-buildah.adoc +++ b/cicd/builds/custom-builds-buildah.adoc @@ -2,6 +2,7 @@ = Custom image builds with Buildah include::modules/common-attributes.adoc[] :context: custom-builds-buildah + toc::[] diff --git a/cicd/builds/managing-build-output.adoc b/cicd/builds/managing-build-output.adoc index 98b5ff3dda..0cf38282b0 100644 --- a/cicd/builds/managing-build-output.adoc +++ b/cicd/builds/managing-build-output.adoc @@ -2,6 +2,7 @@ = Managing build output include::modules/common-attributes.adoc[] :context: managing-build-output + toc::[] diff --git a/cicd/builds/running-entitled-builds.adoc b/cicd/builds/running-entitled-builds.adoc index 65f9cb3cca..29f9d4bded 100644 --- a/cicd/builds/running-entitled-builds.adoc +++ b/cicd/builds/running-entitled-builds.adoc @@ -2,6 +2,7 @@ = Using Red Hat subscriptions in builds include::modules/common-attributes.adoc[] :context: running-entitled-builds + toc::[] Use the following sections to run entitled builds on {product-title}. diff --git a/cicd/builds/securing-builds-by-strategy.adoc b/cicd/builds/securing-builds-by-strategy.adoc index 97c3eeb50a..dd42c3367c 100644 --- a/cicd/builds/securing-builds-by-strategy.adoc +++ b/cicd/builds/securing-builds-by-strategy.adoc @@ -2,6 +2,7 @@ = Securing builds by strategy include::modules/common-attributes.adoc[] :context: securing-builds-by-strategy + toc::[] Builds in {product-title} are run in privileged containers. Depending on the build strategy used, if you have privileges, you can run builds to escalate their permissions on the cluster and host nodes. And as a security measure, it limits who can run builds and the strategy that is used for those builds. Custom builds are inherently less safe than source builds, because they can execute any code within a privileged container, and are disabled by default. Grant docker build permissions with caution, because a vulnerability in the Dockerfile processing logic could result in a privileges being granted on the host node. diff --git a/cicd/builds/setting-up-trusted-ca.adoc b/cicd/builds/setting-up-trusted-ca.adoc index 61dd74616e..d93c52ed7f 100644 --- a/cicd/builds/setting-up-trusted-ca.adoc +++ b/cicd/builds/setting-up-trusted-ca.adoc @@ -2,6 +2,7 @@ = Setting up additional trusted certificate authorities for builds include::modules/common-attributes.adoc[] :context: setting-up-trusted-ca + toc::[] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] diff --git a/cicd/builds/triggering-builds-build-hooks.adoc b/cicd/builds/triggering-builds-build-hooks.adoc index 303512e58d..85171adeaa 100644 --- a/cicd/builds/triggering-builds-build-hooks.adoc +++ b/cicd/builds/triggering-builds-build-hooks.adoc @@ -2,6 +2,7 @@ = Triggering and modifying builds include::modules/common-attributes.adoc[] :context: triggering-builds-build-hooks + toc::[] The following sections outline how to trigger builds and modify builds using build hooks. diff --git a/cicd/builds/troubleshooting-builds.adoc b/cicd/builds/troubleshooting-builds.adoc index 8236a29952..a09c425d91 100644 --- a/cicd/builds/troubleshooting-builds.adoc +++ b/cicd/builds/troubleshooting-builds.adoc @@ -2,6 +2,7 @@ [id="troubleshooting-builds_{context}"] = Troubleshooting builds include::modules/common-attributes.adoc[] + toc::[] Use the following to troubleshoot build issues. diff --git a/cicd/builds/understanding-buildconfigs.adoc b/cicd/builds/understanding-buildconfigs.adoc index 6413a66ad3..ac16a8327d 100644 --- a/cicd/builds/understanding-buildconfigs.adoc +++ b/cicd/builds/understanding-buildconfigs.adoc @@ -2,6 +2,7 @@ = Understanding build configurations include::modules/common-attributes.adoc[] :context: understanding-builds + toc::[] The following sections define the concept of a build, build configuration, and outline the primary build strategies available. diff --git a/cicd/builds/understanding-image-builds.adoc b/cicd/builds/understanding-image-builds.adoc index bc23e8e29c..f15c8c5755 100644 --- a/cicd/builds/understanding-image-builds.adoc +++ b/cicd/builds/understanding-image-builds.adoc @@ -2,6 +2,7 @@ = Understanding image builds include::modules/common-attributes.adoc[] :context: understanding-image-builds + toc::[] include::modules/builds-about.adoc[leveloffset=+1] diff --git a/cicd/gitops/getting-started-with-openshift-gitops.adoc b/cicd/gitops/getting-started-with-openshift-gitops.adoc index 3ac2f16343..be276a31d2 100644 --- a/cicd/gitops/getting-started-with-openshift-gitops.adoc +++ b/cicd/gitops/getting-started-with-openshift-gitops.adoc @@ -2,6 +2,7 @@ = Getting started with OpenShift GitOps include::modules/common-attributes.adoc[] :context: getting-started-with-openshift-gitops + toc::[] Red Hat OpenShift GitOps uses Argo CD as the core declarative tool and adds other tooling to enable teams to implement GitOps workflows across clusters. diff --git a/cicd/gitops/understanding-openshift-gitops.adoc b/cicd/gitops/understanding-openshift-gitops.adoc index 5fef5c28da..0f2cc39165 100644 --- a/cicd/gitops/understanding-openshift-gitops.adoc +++ b/cicd/gitops/understanding-openshift-gitops.adoc @@ -3,6 +3,7 @@ include::modules/common-attributes.adoc[] include::modules/gitops-document-attributes.adoc[] :context: understanding-openshift-gitops + toc::[] //Concept Module diff --git a/cicd/pipelines/creating-applications-with-cicd-pipelines.adoc b/cicd/pipelines/creating-applications-with-cicd-pipelines.adoc index 5ce10b2564..b569822c45 100644 --- a/cicd/pipelines/creating-applications-with-cicd-pipelines.adoc +++ b/cicd/pipelines/creating-applications-with-cicd-pipelines.adoc @@ -3,6 +3,7 @@ include::modules/common-attributes.adoc[] include::modules/pipelines-document-attributes.adoc[] :context: creating-applications-with-cicd-pipelines + toc::[] With {pipelines-title}, you can create a customized CI/CD solution to build, test, and deploy your application. diff --git a/cicd/pipelines/understanding-openshift-pipelines.adoc b/cicd/pipelines/understanding-openshift-pipelines.adoc index c3d7cc4b3f..482c6363bf 100644 --- a/cicd/pipelines/understanding-openshift-pipelines.adoc +++ b/cicd/pipelines/understanding-openshift-pipelines.adoc @@ -3,6 +3,7 @@ include::modules/common-attributes.adoc[] include::modules/pipelines-document-attributes.adoc[] :context: understanding-openshift-pipelines + toc::[] :FeatureName: OpenShift Pipelines diff --git a/cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc b/cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc index 6e0227d17e..e5030cf6a4 100644 --- a/cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc +++ b/cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc @@ -5,6 +5,7 @@ include::modules/pipelines-document-attributes.adoc[] :context: working-with-pipelines-using-the-developer-perspective + toc::[] You can use the *Developer* perspective of the {product-title} web console to create CI/CD Pipelines for your software delivery process. diff --git a/cli_reference/developer_cli_odo/configuring-the-odo-cli.adoc b/cli_reference/developer_cli_odo/configuring-the-odo-cli.adoc index 096cb45efc..df1221a047 100644 --- a/cli_reference/developer_cli_odo/configuring-the-odo-cli.adoc +++ b/cli_reference/developer_cli_odo/configuring-the-odo-cli.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: configuring-the-odo-cli + toc::[] include::modules/developer-cli-odo-using-command-completion.adoc[leveloffset=+1] diff --git a/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc b/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc index 87654718e5..7329406a0c 100644 --- a/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc +++ b/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: creating-instances-of-services-managed-by-operators + toc::[] Operators are a method of packaging, deploying, and managing Kubernetes services. With `{odo-title}`, you can create instances of services from the custom resource definitions (CRDs) provided by the Operators. You can then use these instances in your projects and link them to your components. diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-java-application-with-a-database.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-java-application-with-a-database.adoc index a749ab79b6..b6b1fe51d1 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-java-application-with-a-database.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-java-application-with-a-database.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: creating-a-java-application-with-a-database + toc::[] This example describes how to deploy a Java application by using devfile and connect it to a database service. diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc index 360c259a0f..f478042a53 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: creating-a-multicomponent-application-with-odo + toc::[] `{odo-title}` allows you to create a multicomponent application, modify it, and link its components in an easy and automated way. diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc index aed03c387c..6add327b80 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: creating-a-single-component-application-with-odo + toc::[] With `{odo-title}`, you can create and deploy applications on clusters. diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc index ccba6d0739..9ae14e7e0c 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: creating-an-application-with-a-database + toc::[] This example describes how to deploy and connect a database to a front-end application. diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc index 583c3e9b8e..f56d8c1dce 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: debugging-applications-in-odo + toc::[] With `{odo-title}`, you can attach a debugger to remotely debug your application. This feature is only supported for NodeJS and Java components. diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/deleting-applications.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/deleting-applications.adoc index 595e1dce11..ac0d5bbbc7 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/deleting-applications.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/deleting-applications.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: deleting-applications + toc::[] You can delete applications and all components associated with the application in your project. diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/sample-applications.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/sample-applications.adoc index 60a1618f40..b702a201c8 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/sample-applications.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/sample-applications.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: using-sample-applications + toc::[] `{odo-title}` offers partial compatibility with any language or runtime listed within the OpenShift catalog of component types. For example: diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc index 96600334cc..9e3a6e8a1d 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: creating-applications-by-using-devfiles + toc::[] include::modules/developer-cli-odo-about-devfiles-in-odo.adoc[leveloffset=+1] diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-projects.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-projects.adoc index e5d50dff82..68dbbee3a2 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-projects.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-projects.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: working-with-projects + toc::[] Project keeps your source code, tests, and libraries organized in a separate single unit. diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-storage.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-storage.adoc index 5bbfdbb5ac..fe6bd2f3d9 100644 --- a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-storage.adoc +++ b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-storage.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: working-with-storage + toc::[] Persistent storage keeps data available between restarts of `{odo-title}`. diff --git a/cli_reference/developer_cli_odo/installing-odo.adoc b/cli_reference/developer_cli_odo/installing-odo.adoc index 4a3be03cd9..35cd184ba0 100644 --- a/cli_reference/developer_cli_odo/installing-odo.adoc +++ b/cli_reference/developer_cli_odo/installing-odo.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: installing-odo + toc::[] The following section describes how to install `{odo-title}` on different platforms using the CLI or the Visual Studio Code (VS Code) IDE. diff --git a/cli_reference/developer_cli_odo/managing-environment-variables-in-odo.adoc b/cli_reference/developer_cli_odo/managing-environment-variables-in-odo.adoc index 8c932cf4fc..4829d83b22 100644 --- a/cli_reference/developer_cli_odo/managing-environment-variables-in-odo.adoc +++ b/cli_reference/developer_cli_odo/managing-environment-variables-in-odo.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: managing-environment-variables + toc::[] `{odo-title}` stores component-specific configurations and environment variables in the `config` file. You can use the `odo config` command to set, unset, and list environment variables for components without the need to modify the `config` file. diff --git a/cli_reference/developer_cli_odo/odo-architecture.adoc b/cli_reference/developer_cli_odo/odo-architecture.adoc index c6bce90a14..abe36a126c 100644 --- a/cli_reference/developer_cli_odo/odo-architecture.adoc +++ b/cli_reference/developer_cli_odo/odo-architecture.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: odo-architecture + toc::[] This section describes `{odo-title}` architecture and how `{odo-title}` manages resources on a cluster. diff --git a/cli_reference/developer_cli_odo/odo-cli-reference.adoc b/cli_reference/developer_cli_odo/odo-cli-reference.adoc index 8fc08d8afe..a155f753f1 100644 --- a/cli_reference/developer_cli_odo/odo-cli-reference.adoc +++ b/cli_reference/developer_cli_odo/odo-cli-reference.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: odo-cli-reference + toc::[] include::modules/developer-cli-odo-basic-odo-cli-commands.adoc[leveloffset=+1] diff --git a/cli_reference/developer_cli_odo/odo-release-notes.adoc b/cli_reference/developer_cli_odo/odo-release-notes.adoc index c5a18f1833..9a640280fb 100644 --- a/cli_reference/developer_cli_odo/odo-release-notes.adoc +++ b/cli_reference/developer_cli_odo/odo-release-notes.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: odo-release-notes + toc::[] [id="odo-notable-improvements_{context}"] diff --git a/cli_reference/developer_cli_odo/understanding-odo.adoc b/cli_reference/developer_cli_odo/understanding-odo.adoc index dc930db880..37786b9af1 100644 --- a/cli_reference/developer_cli_odo/understanding-odo.adoc +++ b/cli_reference/developer_cli_odo/understanding-odo.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: understanding-odo + toc::[] `{odo-title}` is a CLI tool for creating applications on {product-title} and Kubernetes. With `{odo-title}`, you can write, build, and debug applications on a cluster without the need to administer the cluster itself. diff --git a/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/about-odo-in-a-restricted-environment.adoc b/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/about-odo-in-a-restricted-environment.adoc index f75c9d03c2..8cf47ff11f 100644 --- a/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/about-odo-in-a-restricted-environment.adoc +++ b/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/about-odo-in-a-restricted-environment.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: about-odo-in-a-restricted-environment + toc::[] diff --git a/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc b/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc index 530f1e0ec0..e9fd7242c6 100644 --- a/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc +++ b/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: creating-and-deploying-a-component-to-the-disconnected-cluster + toc::[] After you push the `init` image to a cluster with a mirrored registry, you must mirror a supported builder image for your application with the `oc` tool, overwrite the mirror registry using the environment variable, and then create your component. diff --git a/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/pushing-the-odo-init-image-to-the-restricted-cluster-registry.adoc b/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/pushing-the-odo-init-image-to-the-restricted-cluster-registry.adoc index 00fe28f314..d35c93c54e 100644 --- a/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/pushing-the-odo-init-image-to-the-restricted-cluster-registry.adoc +++ b/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/pushing-the-odo-init-image-to-the-restricted-cluster-registry.adoc @@ -3,6 +3,7 @@ include::modules/developer-cli-odo-attributes.adoc[] include::modules/common-attributes.adoc[] :context: pushing-the-odo-init-image-to-the-restricted-cluster-registry + toc::[] Depending on the configuration of your cluster and your operating system you can either push the `odo` init image to a mirror registry or directly to an internal registry. diff --git a/cli_reference/tkn_cli/op-tkn-reference.adoc b/cli_reference/tkn_cli/op-tkn-reference.adoc index d4e46bd93d..ca6b68df39 100644 --- a/cli_reference/tkn_cli/op-tkn-reference.adoc +++ b/cli_reference/tkn_cli/op-tkn-reference.adoc @@ -3,6 +3,7 @@ include::modules/common-attributes.adoc[] include::modules/pipelines-document-attributes.adoc[] :context: op-tkn-reference + toc::[] diff --git a/cloud_infrastructure_access/dedicated-aws-access.adoc b/cloud_infrastructure_access/dedicated-aws-access.adoc index d33ef1823c..cd73316ff5 100644 --- a/cloud_infrastructure_access/dedicated-aws-access.adoc +++ b/cloud_infrastructure_access/dedicated-aws-access.adoc @@ -2,6 +2,7 @@ = Accessing AWS infrastructure include::modules/common-attributes.adoc[] :context: dedicated-aws-access + toc::[] Amazon Web Services (AWS) infrastructure access allows diff --git a/cloud_infrastructure_access/dedicated-aws-dc.adoc b/cloud_infrastructure_access/dedicated-aws-dc.adoc index f209b6e46c..c2d832df0d 100644 --- a/cloud_infrastructure_access/dedicated-aws-dc.adoc +++ b/cloud_infrastructure_access/dedicated-aws-dc.adoc @@ -2,6 +2,7 @@ = Configuring AWS Direct Connect include::modules/common-attributes.adoc[] :context: dedicated-aws-direct-connect + toc::[] This process describes accepting an AWS Direct Connect virtual interface with diff --git a/cloud_infrastructure_access/dedicated-aws-peering.adoc b/cloud_infrastructure_access/dedicated-aws-peering.adoc index b6c1cca249..4210a1654e 100644 --- a/cloud_infrastructure_access/dedicated-aws-peering.adoc +++ b/cloud_infrastructure_access/dedicated-aws-peering.adoc @@ -2,6 +2,7 @@ = Configuring AWS VPC peering include::modules/common-attributes.adoc[] :context: dedicated-aws-peering + toc::[] This sample process configures an Amazon Web Services (AWS) VPC containing an diff --git a/cloud_infrastructure_access/dedicated-aws-private-cluster.adoc b/cloud_infrastructure_access/dedicated-aws-private-cluster.adoc index d185779523..b32b5dca66 100644 --- a/cloud_infrastructure_access/dedicated-aws-private-cluster.adoc +++ b/cloud_infrastructure_access/dedicated-aws-private-cluster.adoc @@ -2,6 +2,7 @@ = Configuring a private cluster include::modules/common-attributes.adoc[] :context: dedicated-private-cluster + toc::[] An {product-title} cluster can be made private so that internal applications can be hosted inside a corporate network. In addition, private clusters can be configured to have only internal API endpoints for increased security. diff --git a/cloud_infrastructure_access/dedicated-aws-vpn.adoc b/cloud_infrastructure_access/dedicated-aws-vpn.adoc index f2477178a8..061d2d6371 100644 --- a/cloud_infrastructure_access/dedicated-aws-vpn.adoc +++ b/cloud_infrastructure_access/dedicated-aws-vpn.adoc @@ -2,6 +2,7 @@ = Configuring AWS VPN include::modules/common-attributes.adoc[] :context: dedicated-aws-vpn + toc::[] This sample process configures an Amazon Web Services (AWS) {product-title} diff --git a/cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc b/cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc index a9f35ff5ce..b541f24607 100644 --- a/cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +++ b/cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc @@ -2,6 +2,7 @@ = Accessing virtual machine consoles include::modules/cnv-document-attributes.adoc[] :context: cnv-accessing-vm-consoles + toc::[] {CNVProductNameStart} provides different virtual machine consoles that you can diff --git a/installing/index.adoc b/installing/index.adoc index 4b451ea6d1..042b30e2c9 100644 --- a/installing/index.adoc +++ b/installing/index.adoc @@ -2,6 +2,7 @@ = {product-title} installation overview include::modules/common-attributes.adoc[] :context: ocp-installation-overview + toc::[] include::modules/installation-overview.adoc[leveloffset=+1] diff --git a/installing/installing_openstack/installing-openstack-load-balancing.adoc b/installing/installing_openstack/installing-openstack-load-balancing.adoc index 2498f5692f..ecae49e5b9 100644 --- a/installing/installing_openstack/installing-openstack-load-balancing.adoc +++ b/installing/installing_openstack/installing-openstack-load-balancing.adoc @@ -5,4 +5,4 @@ include::modules/common-attributes.adoc[] toc::[] -include::modules/installation-osp-balancing-external-loads.adoc[leveloffset=+1] \ No newline at end of file +include::modules/installation-osp-balancing-external-loads.adoc[leveloffset=+1] diff --git a/logging/troubleshooting/cluster-logging-must-gather.adoc b/logging/troubleshooting/cluster-logging-must-gather.adoc index 742f1a0084..e830ed2ccd 100644 --- a/logging/troubleshooting/cluster-logging-must-gather.adoc +++ b/logging/troubleshooting/cluster-logging-must-gather.adoc @@ -4,7 +4,6 @@ include::modules/ossm-document-attributes.adoc[] include::modules/common-attributes.adoc[] - toc::[] When opening a support case, it is helpful to provide debugging information about your cluster to Red Hat Support. diff --git a/machine_management/creating_machinesets/creating-machineset-osp.adoc b/machine_management/creating_machinesets/creating-machineset-osp.adoc index def10e2d42..8aa45952df 100644 --- a/machine_management/creating_machinesets/creating-machineset-osp.adoc +++ b/machine_management/creating_machinesets/creating-machineset-osp.adoc @@ -14,4 +14,4 @@ include::modules/machineset-yaml-osp.adoc[leveloffset=+1] include::modules/machineset-creating.adoc[leveloffset=+1] // Mothballed - re-add when available -// include::modules/machineset-osp-adding-bare-metal.adoc[leveloffset=+1] \ No newline at end of file +// include::modules/machineset-osp-adding-bare-metal.adoc[leveloffset=+1] diff --git a/machine_management/deploying-machine-health-checks.adoc b/machine_management/deploying-machine-health-checks.adoc index 0cccaedfcd..f7825d3a79 100644 --- a/machine_management/deploying-machine-health-checks.adoc +++ b/machine_management/deploying-machine-health-checks.adoc @@ -2,6 +2,7 @@ = Deploying machine health checks include::modules/common-attributes.adoc[] :context: deploying-machine-health-checks + toc::[] You can configure and deploy a machine health check to automatically repair damaged machines in a machine pool. diff --git a/mod_docs_guide/getting-started-modular-docs-ocp.adoc b/mod_docs_guide/getting-started-modular-docs-ocp.adoc index 8bb573472f..3f738cd291 100644 --- a/mod_docs_guide/getting-started-modular-docs-ocp.adoc +++ b/mod_docs_guide/getting-started-modular-docs-ocp.adoc @@ -12,6 +12,7 @@ = Getting started with modular docs on OpenShift include::modules/common-attributes.adoc[] :context: assembly-gsg + toc::[] This is the modular docs getting started guide for the OpenShift documentation diff --git a/mod_docs_guide/mod-docs-conventions-ocp.adoc b/mod_docs_guide/mod-docs-conventions-ocp.adoc index 5cd9d7a1f8..c397d327c7 100644 --- a/mod_docs_guide/mod-docs-conventions-ocp.adoc +++ b/mod_docs_guide/mod-docs-conventions-ocp.adoc @@ -11,6 +11,7 @@ = Modular docs OpenShift conventions include::modules/common-attributes.adoc[] :context: assembly-ocp-conventions + toc::[] Before you contribute to the OpenShift docs repo, review the following modular docs conventions. diff --git a/modules/common-attributes.adoc b/modules/common-attributes.adoc index 975ab66888..e68c1999f5 100644 --- a/modules/common-attributes.adoc +++ b/modules/common-attributes.adoc @@ -1,8 +1,6 @@ -{product-author} // The {product-title} attribute provides the context-sensitive name of the relevant OpenShift distribution, for example, "OpenShift Container Platform" or "OKD". The {product-version} attribute provides the product version relative to the distribution, for example "4.8". // {product-title} and {product-version} are parsed when AsciiBinder queries the _distro_map.yml file in relation to the base branch of a pull request. // See https://github.com/openshift/openshift-docs/blob/master/contributing_to_docs/doc_guidelines.adoc#product-name-version for more information on this topic. -{product-version} // Other common attributes are defined in the following lines: :data-uri: :icons: diff --git a/networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc b/networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc index c0f5a10848..4b325fcdcc 100644 --- a/networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc +++ b/networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc @@ -2,6 +2,7 @@ = About the Kubernetes NMState Operator :FeatureName: Kubernetes NMState Operator :context: k8s-nmstate-operator + toc::[] The Kubernetes NMState Operator provides a Kubernetes API for performing state-driven network configuration across the {product-title} cluster's nodes with NMState. The Kubernetes NMState Operator provides users with functionality to configure various network interface types, DNS, and routing on cluster nodes. Additionally, the daemons on the cluster nodes periodically report on the state of each node's network interfaces to the API server. diff --git a/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc b/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc index 16767d8b80..cd30a45beb 100644 --- a/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc +++ b/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] :VirtProductName: OpenShift Container Platform :context: k8s-nmstate-observing-node-network-state + toc::[] Node network state is the network configuration for all nodes in the cluster. diff --git a/networking/k8s_nmstate/k8s-nmstate-troubleshooting-node-network.adoc b/networking/k8s_nmstate/k8s-nmstate-troubleshooting-node-network.adoc index fe16afc56b..6a1987d89d 100644 --- a/networking/k8s_nmstate/k8s-nmstate-troubleshooting-node-network.adoc +++ b/networking/k8s_nmstate/k8s-nmstate-troubleshooting-node-network.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] :VirtProductName: OpenShift Container Platform :context: k8s-nmstate-troubleshooting-node-network + toc::[] If the node network configuration encounters an issue, the policy is automatically rolled back and the enactments report failure. diff --git a/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc b/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc index ca0ad4ffaa..aaeecf7183 100644 --- a/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc +++ b/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] :VirtProductName: OpenShift Container Platform :context: k8s_nmstate-updating-node-network-config + toc::[] You can update the node network configuration, such as adding or removing interfaces from nodes, by applying `NodeNetworkConfigurationPolicy` manifests to the cluster. diff --git a/networking/routes/route-configuration.adoc b/networking/routes/route-configuration.adoc index 379cb9030e..6023675307 100644 --- a/networking/routes/route-configuration.adoc +++ b/networking/routes/route-configuration.adoc @@ -4,6 +4,7 @@ = Route configuration include::modules/common-attributes.adoc[] :context: route-configuration + toc::[] //Creating route timeouts diff --git a/networking/using-cookies-to-keep-route-statefulness.adoc b/networking/using-cookies-to-keep-route-statefulness.adoc index e5786ebfc9..e7030ff2e4 100644 --- a/networking/using-cookies-to-keep-route-statefulness.adoc +++ b/networking/using-cookies-to-keep-route-statefulness.adoc @@ -24,4 +24,4 @@ sends the cookie back with the next request in the session. The cookie tells the router which endpoint is handling the session, ensuring that client requests use the cookie so that they are routed to the same pod. -include::modules/annotating-a-route-with-a-cookie-name.adoc[leveloffset=+1] \ No newline at end of file +include::modules/annotating-a-route-with-a-cookie-name.adoc[leveloffset=+1] diff --git a/nodes/clusters/nodes-cluster-resource-configure.adoc b/nodes/clusters/nodes-cluster-resource-configure.adoc index 9628eebb8d..9b1306f852 100644 --- a/nodes/clusters/nodes-cluster-resource-configure.adoc +++ b/nodes/clusters/nodes-cluster-resource-configure.adoc @@ -3,7 +3,6 @@ = Configuring cluster memory to meet container memory and risk requirements include::modules/common-attributes.adoc[] - toc::[] diff --git a/nodes/clusters/nodes-cluster-resource-levels.adoc b/nodes/clusters/nodes-cluster-resource-levels.adoc index cce1317018..1ca020764b 100644 --- a/nodes/clusters/nodes-cluster-resource-levels.adoc +++ b/nodes/clusters/nodes-cluster-resource-levels.adoc @@ -3,7 +3,6 @@ = Estimating the number of pods your {product-title} nodes can hold include::modules/common-attributes.adoc[] - toc::[] diff --git a/nodes/containers/nodes-containers-sysctls.adoc b/nodes/containers/nodes-containers-sysctls.adoc index 2182cfcb3d..2cbb69d921 100644 --- a/nodes/containers/nodes-containers-sysctls.adoc +++ b/nodes/containers/nodes-containers-sysctls.adoc @@ -3,7 +3,6 @@ = Using sysctls in containers include::modules/common-attributes.adoc[] - toc::[] diff --git a/nodes/containers/nodes-containers-using.adoc b/nodes/containers/nodes-containers-using.adoc index 146343502b..22f9b0abd0 100644 --- a/nodes/containers/nodes-containers-using.adoc +++ b/nodes/containers/nodes-containers-using.adoc @@ -3,7 +3,6 @@ = Understanding Containers include::modules/common-attributes.adoc[] - toc::[] diff --git a/nodes/nodes/nodes-nodes-garbage-collection.adoc b/nodes/nodes/nodes-nodes-garbage-collection.adoc index c7d35c0437..3726d86c83 100644 --- a/nodes/nodes/nodes-nodes-garbage-collection.adoc +++ b/nodes/nodes/nodes-nodes-garbage-collection.adoc @@ -4,7 +4,6 @@ = Freeing node resources using garbage collection include::modules/common-attributes.adoc[] - toc::[] diff --git a/nodes/scheduling/nodes-scheduler-about.adoc b/nodes/scheduling/nodes-scheduler-about.adoc index f089cab8c8..c2909a80b6 100644 --- a/nodes/scheduling/nodes-scheduler-about.adoc +++ b/nodes/scheduling/nodes-scheduler-about.adoc @@ -3,7 +3,6 @@ = Controlling pod placement using the scheduler include::modules/common-attributes.adoc[] - toc::[] diff --git a/nodes/scheduling/nodes-scheduler-default.adoc b/nodes/scheduling/nodes-scheduler-default.adoc index 04e2377acd..24edbf06e7 100644 --- a/nodes/scheduling/nodes-scheduler-default.adoc +++ b/nodes/scheduling/nodes-scheduler-default.adoc @@ -3,7 +3,6 @@ = Configuring the default scheduler to control pod placement include::modules/common-attributes.adoc[] - toc::[] diff --git a/nodes/scheduling/nodes-scheduler-node-affinity.adoc b/nodes/scheduling/nodes-scheduler-node-affinity.adoc index 2773f59504..bfee2f4cba 100644 --- a/nodes/scheduling/nodes-scheduler-node-affinity.adoc +++ b/nodes/scheduling/nodes-scheduler-node-affinity.adoc @@ -3,7 +3,6 @@ = Controlling pod placement on nodes using node affinity rules include::modules/common-attributes.adoc[] - toc::[] diff --git a/nodes/scheduling/nodes-scheduler-node-names.adoc b/nodes/scheduling/nodes-scheduler-node-names.adoc index f81d033a27..c697240e1d 100644 --- a/nodes/scheduling/nodes-scheduler-node-names.adoc +++ b/nodes/scheduling/nodes-scheduler-node-names.adoc @@ -3,7 +3,6 @@ = Placing a pod on a specific node by name include::modules/common-attributes.adoc[] - toc::[] diff --git a/openshift_images/cnf-building-and-deploying-a-dpdk-payload.adoc b/openshift_images/cnf-building-and-deploying-a-dpdk-payload.adoc index 4cd352c694..cad584785c 100644 --- a/openshift_images/cnf-building-and-deploying-a-dpdk-payload.adoc +++ b/openshift_images/cnf-building-and-deploying-a-dpdk-payload.adoc @@ -3,6 +3,7 @@ = Building and deploying a DPDK application using the S2I image include::modules/common-attributes.adoc[] :context: building-deploying-DPDK-using-s2i-image + toc::[] The Data Plane Development Kit (DPDK) base image is a base image for DPDK diff --git a/openshift_images/configuring-samples-operator.adoc b/openshift_images/configuring-samples-operator.adoc index 6ac6aa9ca1..d8654a2b7c 100644 --- a/openshift_images/configuring-samples-operator.adoc +++ b/openshift_images/configuring-samples-operator.adoc @@ -2,6 +2,7 @@ = Configuring the Cluster Samples Operator include::modules/common-attributes.adoc[] :context: configuring-samples-operator + toc::[] The Cluster Samples Operator, which operates in the `openshift` namespace, installs and updates the {op-system-base-full}-based {product-title} image streams and {product-title} templates. diff --git a/openshift_images/image-configuration.adoc b/openshift_images/image-configuration.adoc index a299662e83..3954907145 100644 --- a/openshift_images/image-configuration.adoc +++ b/openshift_images/image-configuration.adoc @@ -2,6 +2,7 @@ = Image configuration resources include::modules/common-attributes.adoc[] :context: image-configuration + toc::[] Use the following procedure to configure image registries. diff --git a/openshift_images/image-streams-manage.adoc b/openshift_images/image-streams-manage.adoc index 4f31e61c99..5089ea4e39 100644 --- a/openshift_images/image-streams-manage.adoc +++ b/openshift_images/image-streams-manage.adoc @@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[] :toc: macro :toc-title: :prewrap!: + toc::[] Imagestreams provide a means of creating and updating container images in an diff --git a/openshift_images/images-understand.adoc b/openshift_images/images-understand.adoc index 3bf00efaab..0f88596134 100644 --- a/openshift_images/images-understand.adoc +++ b/openshift_images/images-understand.adoc @@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[] :toc: macro :toc-title: :prewrap!: + toc::[] diff --git a/openshift_images/samples-operator-alt-registry.adoc b/openshift_images/samples-operator-alt-registry.adoc index 1a94abc231..1454cfee02 100644 --- a/openshift_images/samples-operator-alt-registry.adoc +++ b/openshift_images/samples-operator-alt-registry.adoc @@ -2,6 +2,7 @@ = Using the Cluster Samples Operator with an alternate registry include::modules/common-attributes.adoc[] :context: samples-operator-alt-registry + toc::[] You can use the Cluster Samples Operator with an alternate registry by first creating a mirror registry. diff --git a/openshift_images/templates-using-ruby-on-rails.adoc b/openshift_images/templates-using-ruby-on-rails.adoc index 3bdc8eac10..22f896674a 100644 --- a/openshift_images/templates-using-ruby-on-rails.adoc +++ b/openshift_images/templates-using-ruby-on-rails.adoc @@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[] :toc: macro :toc-title: :prewrap!: + toc::[] Ruby on Rails is a web framework written in Ruby. This guide covers diff --git a/openshift_images/using-imagestreams-with-kube-resources.adoc b/openshift_images/using-imagestreams-with-kube-resources.adoc index 5f47291dba..c5f550f41c 100644 --- a/openshift_images/using-imagestreams-with-kube-resources.adoc +++ b/openshift_images/using-imagestreams-with-kube-resources.adoc @@ -2,6 +2,7 @@ = Using imagestreams with Kubernetes resources include::modules/common-attributes.adoc[] :context: using-imagestreams-with-kube-resources + toc::[] diff --git a/openshift_images/using-templates.adoc b/openshift_images/using-templates.adoc index eb51c62d8e..3397218d72 100644 --- a/openshift_images/using-templates.adoc +++ b/openshift_images/using-templates.adoc @@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[] :toc: macro :toc-title: :prewrap!: + toc::[] The following sections provide an overview of templates, as well as how to use diff --git a/openshift_images/using_images/images-other-jenkins-agent.adoc b/openshift_images/using_images/images-other-jenkins-agent.adoc index edb1dc03f8..caf2bce2b6 100644 --- a/openshift_images/using_images/images-other-jenkins-agent.adoc +++ b/openshift_images/using_images/images-other-jenkins-agent.adoc @@ -2,6 +2,7 @@ = Jenkins agent include::modules/common-attributes.adoc[] :context: images-other-jenkins-agent + toc::[] {product-title} provides three images that are suitable for use as Jenkins agents: diff --git a/openshift_images/using_images/images-other-jenkins.adoc b/openshift_images/using_images/images-other-jenkins.adoc index 6a37a31023..b6885e72d1 100644 --- a/openshift_images/using_images/images-other-jenkins.adoc +++ b/openshift_images/using_images/images-other-jenkins.adoc @@ -2,6 +2,7 @@ = Configuring Jenkins images include::modules/common-attributes.adoc[] :context: images-other-jenkins + toc::[] {product-title} provides a container image for running Jenkins. This image diff --git a/openshift_images/using_images/using-images-overview.adoc b/openshift_images/using_images/using-images-overview.adoc index 9088a8edc4..e050ca4af7 100644 --- a/openshift_images/using_images/using-images-overview.adoc +++ b/openshift_images/using_images/using-images-overview.adoc @@ -2,6 +2,7 @@ = Using images overview include::modules/common-attributes.adoc[] :context: using-images-overview + toc::[] Use the following topics to discover the different Source-to-Image (S2I), diff --git a/post_installation_configuration/cluster-tasks.adoc b/post_installation_configuration/cluster-tasks.adoc index 4307df6709..58f580c80c 100644 --- a/post_installation_configuration/cluster-tasks.adoc +++ b/post_installation_configuration/cluster-tasks.adoc @@ -2,6 +2,7 @@ [id="post-install-cluster-tasks"] = Post-installation cluster tasks include::modules/common-attributes.adoc[] + toc::[] After installing {product-title}, you can further expand and customize your cluster to your requirements. diff --git a/post_installation_configuration/machine-configuration-tasks.adoc b/post_installation_configuration/machine-configuration-tasks.adoc index 03b57e5fe4..e8a168aa53 100644 --- a/post_installation_configuration/machine-configuration-tasks.adoc +++ b/post_installation_configuration/machine-configuration-tasks.adoc @@ -2,6 +2,7 @@ [id="post-install-machine-configuration-tasks"] = Post-installation machine configuration tasks include::modules/common-attributes.adoc[] + toc::[] There are times when you need to make changes to the operating systems running on {product-title} nodes. This can include changing settings for network time service, adding kernel arguments, or configuring journaling in a specific way. diff --git a/post_installation_configuration/network-configuration.adoc b/post_installation_configuration/network-configuration.adoc index 0717d8cf51..69010f9074 100644 --- a/post_installation_configuration/network-configuration.adoc +++ b/post_installation_configuration/network-configuration.adoc @@ -3,6 +3,7 @@ = Post-installation network configuration include::modules/common-attributes.adoc[] include::modules/ossm-document-attributes.adoc[] + toc::[] After installing {product-title}, you can further expand and customize your diff --git a/post_installation_configuration/node-tasks.adoc b/post_installation_configuration/node-tasks.adoc index 035736ec19..c6b6b6286f 100644 --- a/post_installation_configuration/node-tasks.adoc +++ b/post_installation_configuration/node-tasks.adoc @@ -2,6 +2,7 @@ [id="post-install-node-tasks"] = Post-installation node tasks include::modules/common-attributes.adoc[] + toc::[] After installing {product-title}, you can further expand and customize your diff --git a/post_installation_configuration/preparing-for-users.adoc b/post_installation_configuration/preparing-for-users.adoc index 5bdca8775e..e10e98fa40 100644 --- a/post_installation_configuration/preparing-for-users.adoc +++ b/post_installation_configuration/preparing-for-users.adoc @@ -2,6 +2,7 @@ [id="post-install-preparing-for-users"] = Preparing for users include::modules/common-attributes.adoc[] + toc::[] After installing {product-title}, you can further expand and customize your diff --git a/post_installation_configuration/storage-configuration.adoc b/post_installation_configuration/storage-configuration.adoc index 70fca1fe03..0cf7429cce 100644 --- a/post_installation_configuration/storage-configuration.adoc +++ b/post_installation_configuration/storage-configuration.adoc @@ -16,6 +16,7 @@ ifdef::openshift-enterprise,openshift-webscale[] :gluster-admin-link: https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/html/administration_guide/ :cns-link: https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/html/container-native_storage_for_openshift_container_platform/ endif::[] + toc::[] After installing {product-title}, you can further expand and customize your diff --git a/registry/accessing-the-registry.adoc b/registry/accessing-the-registry.adoc index c1773019a0..9a3e9a0b71 100644 --- a/registry/accessing-the-registry.adoc +++ b/registry/accessing-the-registry.adoc @@ -2,6 +2,7 @@ [id="accessing-the-registry"] = Accessing the registry include::modules/common-attributes.adoc[] + toc::[] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] diff --git a/registry/architecture-component-imageregistry.adoc b/registry/architecture-component-imageregistry.adoc index 4b38bd2483..44aa90543a 100644 --- a/registry/architecture-component-imageregistry.adoc +++ b/registry/architecture-component-imageregistry.adoc @@ -2,6 +2,7 @@ = Image Registry include::modules/common-attributes.adoc[] :context: architecture-component-imageregistry + toc::[] include::modules/registry-integrated-openshift-registry.adoc[leveloffset=+1] diff --git a/registry/configuring-registry-operator.adoc b/registry/configuring-registry-operator.adoc index 67db074c0d..56e18fba41 100644 --- a/registry/configuring-registry-operator.adoc +++ b/registry/configuring-registry-operator.adoc @@ -2,6 +2,7 @@ = Image Registry Operator in {product-title} include::modules/common-attributes.adoc[] :context: configuring-registry-operator + toc::[] [id="image-registry-on-cloud"] diff --git a/registry/configuring_registry_storage/configuring-registry-storage-aws-user-infrastructure.adoc b/registry/configuring_registry_storage/configuring-registry-storage-aws-user-infrastructure.adoc index df32764b37..c54cc1a063 100644 --- a/registry/configuring_registry_storage/configuring-registry-storage-aws-user-infrastructure.adoc +++ b/registry/configuring_registry_storage/configuring-registry-storage-aws-user-infrastructure.adoc @@ -2,6 +2,7 @@ = Configuring the registry for AWS user-provisioned infrastructure include::modules/common-attributes.adoc[] :context: configuring-registry-storage-aws-user-infrastructure + toc::[] :FILE: REGISTRY_STORAGE_S3_ACCESSKEY= diff --git a/registry/configuring_registry_storage/configuring-registry-storage-azure-user-infrastructure.adoc b/registry/configuring_registry_storage/configuring-registry-storage-azure-user-infrastructure.adoc index 9503599fee..828c16b786 100644 --- a/registry/configuring_registry_storage/configuring-registry-storage-azure-user-infrastructure.adoc +++ b/registry/configuring_registry_storage/configuring-registry-storage-azure-user-infrastructure.adoc @@ -2,6 +2,7 @@ = Configuring the registry for Azure user-provisioned infrastructure include::modules/common-attributes.adoc[] :context: configuring-registry-storage-azure-user-infrastructure + toc::[] diff --git a/registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc b/registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc index a7ebe8c236..6d81e43c8b 100644 --- a/registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc +++ b/registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc @@ -2,6 +2,7 @@ = Configuring the registry for bare metal include::modules/common-attributes.adoc[] :context: configuring-registry-storage-baremetal + toc::[] include::modules/registry-removed.adoc[leveloffset=+1] diff --git a/registry/configuring_registry_storage/configuring-registry-storage-gcp-user-infrastructure.adoc b/registry/configuring_registry_storage/configuring-registry-storage-gcp-user-infrastructure.adoc index 8937c03d2b..787814b7ab 100644 --- a/registry/configuring_registry_storage/configuring-registry-storage-gcp-user-infrastructure.adoc +++ b/registry/configuring_registry_storage/configuring-registry-storage-gcp-user-infrastructure.adoc @@ -2,6 +2,7 @@ = Configuring the registry for GCP user-provisioned infrastructure include::modules/common-attributes.adoc[] :context: configuring-registry-storage-gcp-user-infrastructure + toc::[] :FILE: gcp= diff --git a/registry/configuring_registry_storage/configuring-registry-storage-openstack-user-infrastructure.adoc b/registry/configuring_registry_storage/configuring-registry-storage-openstack-user-infrastructure.adoc index 3985f14ea6..12dc242c1c 100644 --- a/registry/configuring_registry_storage/configuring-registry-storage-openstack-user-infrastructure.adoc +++ b/registry/configuring_registry_storage/configuring-registry-storage-openstack-user-infrastructure.adoc @@ -2,6 +2,7 @@ = Configuring the registry for OpenStack user-provisioned infrastructure include::modules/common-attributes.adoc[] :context: configuring-registry-storage-openstack-user-infrastructure + toc::[] diff --git a/registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc b/registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc index 5c8370b15e..8532437040 100644 --- a/registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc +++ b/registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc @@ -2,6 +2,7 @@ = Configuring the registry for vSphere include::modules/common-attributes.adoc[] :context: configuring-registry-storage-vsphere + toc::[] include::modules/registry-removed.adoc[leveloffset=+1] diff --git a/registry/registry-options.adoc b/registry/registry-options.adoc index 5ac7450ed6..8ed178cfd2 100644 --- a/registry/registry-options.adoc +++ b/registry/registry-options.adoc @@ -2,6 +2,7 @@ = Registry options include::modules/common-attributes.adoc[] :context: registry-options + toc::[] {product-title} can build images from your source code, deploy them, and manage diff --git a/registry/securing-exposing-registry.adoc b/registry/securing-exposing-registry.adoc index 7551d73428..08a24a5c4a 100644 --- a/registry/securing-exposing-registry.adoc +++ b/registry/securing-exposing-registry.adoc @@ -2,6 +2,7 @@ [id="securing-exposing-registry"] = Exposing the registry include::modules/common-attributes.adoc[] + toc::[] By default, the {product-title} registry is secured during cluster installation diff --git a/security/file_integrity_operator/file-integrity-operator-advanced-usage.adoc b/security/file_integrity_operator/file-integrity-operator-advanced-usage.adoc index 217e17679a..d556ae5a68 100644 --- a/security/file_integrity_operator/file-integrity-operator-advanced-usage.adoc +++ b/security/file_integrity_operator/file-integrity-operator-advanced-usage.adoc @@ -2,6 +2,7 @@ = Performing advanced Custom File Integrity Operator tasks include::modules/common-attributes.adoc[] :context: file-integrity-operator + toc::[] include::modules/file-integrity-operator-reinitializing-database.adoc[leveloffset=+1] diff --git a/security/file_integrity_operator/file-integrity-operator-configuring.adoc b/security/file_integrity_operator/file-integrity-operator-configuring.adoc index db528ef255..27e9e691ff 100644 --- a/security/file_integrity_operator/file-integrity-operator-configuring.adoc +++ b/security/file_integrity_operator/file-integrity-operator-configuring.adoc @@ -2,6 +2,7 @@ = Configuring the Custom File Integrity Operator include::modules/common-attributes.adoc[] :context: file-integrity-operator + toc::[] diff --git a/security/file_integrity_operator/file-integrity-operator-troubleshooting.adoc b/security/file_integrity_operator/file-integrity-operator-troubleshooting.adoc index 734935c43f..fa03392ce5 100644 --- a/security/file_integrity_operator/file-integrity-operator-troubleshooting.adoc +++ b/security/file_integrity_operator/file-integrity-operator-troubleshooting.adoc @@ -2,6 +2,7 @@ = Troubleshooting the File Integrity Operator include::modules/common-attributes.adoc[] :context: file-integrity-operator + toc::[] == General troubleshooting diff --git a/security/file_integrity_operator/file-integrity-operator-understanding.adoc b/security/file_integrity_operator/file-integrity-operator-understanding.adoc index 1c122fc7b8..ae67ea5232 100644 --- a/security/file_integrity_operator/file-integrity-operator-understanding.adoc +++ b/security/file_integrity_operator/file-integrity-operator-understanding.adoc @@ -2,6 +2,7 @@ = Understanding the File Integrity Operator include::modules/common-attributes.adoc[] :context: file-integrity-operator + toc::[] The File Integrity Operator is an {product-title} Operator that continually runs diff --git a/serverless/admin_guide/upgrading-serverless.adoc b/serverless/admin_guide/upgrading-serverless.adoc index eb521612f4..3ba89f068a 100644 --- a/serverless/admin_guide/upgrading-serverless.adoc +++ b/serverless/admin_guide/upgrading-serverless.adoc @@ -3,6 +3,7 @@ include::modules/serverless-document-attributes.adoc[] = Upgrading {ServerlessProductName} include::modules/common-attributes.adoc[] :context: upgrading-serverless + toc::[] If you have installed a previous version of {ServerlessProductName}, follow the instructions in this guide to upgrade to the latest version. diff --git a/serverless/event_sources/knative-event-sources.adoc b/serverless/event_sources/knative-event-sources.adoc index 5c0af408d8..6b12bd2d41 100644 --- a/serverless/event_sources/knative-event-sources.adoc +++ b/serverless/event_sources/knative-event-sources.adoc @@ -3,6 +3,7 @@ include::modules/serverless-document-attributes.adoc[] = Getting started with event sources include::modules/common-attributes.adoc[] :context: knative-event-sources + toc::[] An _event source_ is an object that links an event producer with an event _sink_, or consumer. A sink can be a Knative service, channel, or broker that receives events from an event source. diff --git a/serverless/event_sources/serverless-kafka-source.adoc b/serverless/event_sources/serverless-kafka-source.adoc index 07df1a2660..461a02cf8f 100644 --- a/serverless/event_sources/serverless-kafka-source.adoc +++ b/serverless/event_sources/serverless-kafka-source.adoc @@ -3,6 +3,7 @@ include::modules/serverless-document-attributes.adoc[] = Using a Kafka source include::modules/common-attributes.adoc[] :context: serverless-kafka-source + toc::[] :FeatureName: Apache Kafka on {ServerlessProductName} diff --git a/service_mesh/v1x/customizing-installation-ossm.adoc b/service_mesh/v1x/customizing-installation-ossm.adoc index b1c007dfc2..4bd9506aa4 100644 --- a/service_mesh/v1x/customizing-installation-ossm.adoc +++ b/service_mesh/v1x/customizing-installation-ossm.adoc @@ -2,6 +2,7 @@ = Customizing the {ProductName} installation include::modules/ossm-document-attributes-1x.adoc[] :context: customizing-installation-ossm-v1x + toc::[] After your default `ServiceMeshControlPlane` resource is deployed, you can configure the resource to suit your environment. diff --git a/service_mesh/v1x/installing-ossm.adoc b/service_mesh/v1x/installing-ossm.adoc index 6d743249bd..92e9d3db7e 100644 --- a/service_mesh/v1x/installing-ossm.adoc +++ b/service_mesh/v1x/installing-ossm.adoc @@ -2,6 +2,7 @@ = Installing {ProductName} include::modules/ossm-document-attributes-1x.adoc[] :context: installing-ossm-v1x + toc::[] Installing the {ProductShortName} involves installing the Elasticsearch, Jaeger, Kiali and {ProductShortName} Operators, creating and managing a `ServiceMeshControlPlane` resource to deploy the control plane, and creating a `ServiceMeshMemberRoll` resource to specify the namespaces associated with the {ProductShortName}. diff --git a/service_mesh/v1x/ossm-architecture.adoc b/service_mesh/v1x/ossm-architecture.adoc index 95973e8479..59696fd9c8 100644 --- a/service_mesh/v1x/ossm-architecture.adoc +++ b/service_mesh/v1x/ossm-architecture.adoc @@ -2,6 +2,7 @@ = Understanding {ProductName} include::modules/ossm-document-attributes-1x.adoc[] :context: ossm-architecture-v1x + toc::[] {ProductName} provides a platform for behavioral insight and operational control over your networked microservices in a service mesh. With {ProductName}, you can connect, secure, and monitor microservices in your {product-title} environment. diff --git a/service_mesh/v1x/ossm-custom-resources.adoc b/service_mesh/v1x/ossm-custom-resources.adoc index 5e5ea8581e..333a43e84c 100644 --- a/service_mesh/v1x/ossm-custom-resources.adoc +++ b/service_mesh/v1x/ossm-custom-resources.adoc @@ -2,6 +2,7 @@ = Custom resources include::modules/ossm-document-attributes.adoc[] :context: ossm-controler-items-v1x + toc::[] You can customize your {ProductName} by modifying the default {ProductShortName} custom resource or by creating a new custom resource. diff --git a/service_mesh/v1x/preparing-ossm-installation.adoc b/service_mesh/v1x/preparing-ossm-installation.adoc index 54e84c1039..0d6d229abd 100644 --- a/service_mesh/v1x/preparing-ossm-installation.adoc +++ b/service_mesh/v1x/preparing-ossm-installation.adoc @@ -2,6 +2,7 @@ = Preparing to install {ProductName} include::modules/ossm-document-attributes-1x.adoc[] :context: preparing-ossm-installation-v1x + toc::[] Before you can install {ProductName}, review the installation activities, ensure that you meet the prerequisites: diff --git a/service_mesh/v1x/removing-ossm.adoc b/service_mesh/v1x/removing-ossm.adoc index 0bfd4aec6a..8486bedf34 100644 --- a/service_mesh/v1x/removing-ossm.adoc +++ b/service_mesh/v1x/removing-ossm.adoc @@ -2,6 +2,7 @@ = Removing {ProductName} include::modules/ossm-document-attributes-1x.adoc[] :context: removing-ossm-v1x + toc::[] This process allows you to remove {ProductName} from an existing {product-title} instance. Remove the control plane before removing the operators. diff --git a/service_mesh/v1x/threescale-adapter.adoc b/service_mesh/v1x/threescale-adapter.adoc index 9a7c90a42a..0341b9d2d2 100644 --- a/service_mesh/v1x/threescale-adapter.adoc +++ b/service_mesh/v1x/threescale-adapter.adoc @@ -2,6 +2,7 @@ = Using the 3scale Istio adapter include::modules/ossm-document-attributes-1x.adoc[] :context: threescale-adapter-v1x + toc::[] The 3scale Istio Adapter is an optional adapter that allows you to label a service running within the {ProductName} and integrate that service with the 3scale API Management solution. diff --git a/service_mesh/v2x/customizing-installation-ossm.adoc b/service_mesh/v2x/customizing-installation-ossm.adoc index b3b277a727..3667725d4c 100644 --- a/service_mesh/v2x/customizing-installation-ossm.adoc +++ b/service_mesh/v2x/customizing-installation-ossm.adoc @@ -2,6 +2,7 @@ = Configuring the {ProductName} installation include::modules/ossm-document-attributes.adoc[] :context: customizing-installation-ossm-v2x + toc::[] After your default `ServiceMeshControlPlane` resource is deployed, you must configure the resource to suit your environment. Note that the default Jaeger deployment must be changed, as the default `allinone` deployment does not supply persistent memory. diff --git a/service_mesh/v2x/installing-ossm.adoc b/service_mesh/v2x/installing-ossm.adoc index c243c7f49a..7095d99599 100644 --- a/service_mesh/v2x/installing-ossm.adoc +++ b/service_mesh/v2x/installing-ossm.adoc @@ -2,6 +2,7 @@ = Installing {ProductName} include::modules/ossm-document-attributes.adoc[] :context: installing-ossm + toc::[] Installing the {ProductShortName} involves installing the Elasticsearch, Jaeger, Kiali and {ProductShortName} Operators, creating and managing a `ServiceMeshControlPlane` resource to deploy the control plane, and creating a `ServiceMeshMemberRoll` resource to specify the namespaces associated with the {ProductShortName}. diff --git a/service_mesh/v2x/ossm-architecture.adoc b/service_mesh/v2x/ossm-architecture.adoc index 70a04f15be..7a704d1108 100644 --- a/service_mesh/v2x/ossm-architecture.adoc +++ b/service_mesh/v2x/ossm-architecture.adoc @@ -2,6 +2,7 @@ include::modules/ossm-document-attributes.adoc[] = Understanding {ProductName} :context: ossm-architecture + toc::[] {ProductName} provides a platform for behavioral insight and operational control over your networked microservices in a service mesh. With {ProductName}, you can connect, secure, and monitor microservices in your {product-title} environment. diff --git a/service_mesh/v2x/ossm-custom-resources.adoc b/service_mesh/v2x/ossm-custom-resources.adoc index 4b8df4810a..79c42f9393 100644 --- a/service_mesh/v2x/ossm-custom-resources.adoc +++ b/service_mesh/v2x/ossm-custom-resources.adoc @@ -2,6 +2,7 @@ = Custom resources include::modules/ossm-document-attributes.adoc[] :context: ossm-custom-resources-v2x + toc::[] You can configure your {ProductName} by modifying the default {ProductShortName} custom resource or by creating a new custom resource. diff --git a/service_mesh/v2x/ossm-traffic-manage.adoc b/service_mesh/v2x/ossm-traffic-manage.adoc index 3d83b2f91a..1eea5f7e7b 100644 --- a/service_mesh/v2x/ossm-traffic-manage.adoc +++ b/service_mesh/v2x/ossm-traffic-manage.adoc @@ -15,4 +15,4 @@ include::modules/ossm-routing-ingress.adoc[leveloffset=+1] include::modules/ossm-routing-bookinfo-example.adoc[leveloffset=+1] -include::modules/ossm-auto-route.adoc[leveloffset=+1] \ No newline at end of file +include::modules/ossm-auto-route.adoc[leveloffset=+1] diff --git a/service_mesh/v2x/preparing-ossm-installation.adoc b/service_mesh/v2x/preparing-ossm-installation.adoc index b14a50ce4d..db2a1035cc 100644 --- a/service_mesh/v2x/preparing-ossm-installation.adoc +++ b/service_mesh/v2x/preparing-ossm-installation.adoc @@ -2,6 +2,7 @@ = Preparing to install {ProductName} include::modules/ossm-document-attributes.adoc[] :context: preparing-ossm-installation + toc::[] Before you can install {ProductName}, review the installation activities, ensure that you meet the prerequisites: diff --git a/service_mesh/v2x/removing-ossm.adoc b/service_mesh/v2x/removing-ossm.adoc index 0118f63a76..829ff4218b 100644 --- a/service_mesh/v2x/removing-ossm.adoc +++ b/service_mesh/v2x/removing-ossm.adoc @@ -2,6 +2,7 @@ = Removing {ProductName} include::modules/ossm-document-attributes.adoc[] :context: removing-ossm + toc::[] This process allows you to remove {ProductName} from an existing {product-title} instance. Remove the control plane before removing the operators. diff --git a/service_mesh/v2x/threescale-adapter.adoc b/service_mesh/v2x/threescale-adapter.adoc index bd816da1d4..fd2ad312f2 100644 --- a/service_mesh/v2x/threescale-adapter.adoc +++ b/service_mesh/v2x/threescale-adapter.adoc @@ -2,6 +2,7 @@ = Using the 3scale Istio adapter include::modules/ossm-document-attributes.adoc[] :context: threescale-adapter + toc::[] The 3scale Istio Adapter is an optional adapter that allows you to label a service running within the {ProductName} and integrate that service with the 3scale API Management solution. diff --git a/service_mesh/v2x/upgrading-ossm.adoc b/service_mesh/v2x/upgrading-ossm.adoc index ff434bd24c..25f2e63c02 100644 --- a/service_mesh/v2x/upgrading-ossm.adoc +++ b/service_mesh/v2x/upgrading-ossm.adoc @@ -2,6 +2,7 @@ = Upgrading {ProductName} from version 1.1 to version 2.0 include::modules/ossm-document-attributes.adoc[] :context: upgrading-ossm + toc::[] To access the most current features of {ProductName}, upgrade to the current version, 2.0. Upgrading from version 1.1 to 2.0 requires manual steps that migrate your workloads and apps to a new instance of {ProductName} running the new version. diff --git a/storage/dynamic-provisioning.adoc b/storage/dynamic-provisioning.adoc index 427d0cddde..dcdcd7848e 100644 --- a/storage/dynamic-provisioning.adoc +++ b/storage/dynamic-provisioning.adoc @@ -2,6 +2,7 @@ = Dynamic provisioning include::modules/common-attributes.adoc[] :context: dynamic-provisioning + toc::[] include::modules/dynamic-provisioning-about.adoc[leveloffset=+1] diff --git a/storage/expanding-persistent-volumes.adoc b/storage/expanding-persistent-volumes.adoc index d7b818c746..b0c6bfbdf1 100644 --- a/storage/expanding-persistent-volumes.adoc +++ b/storage/expanding-persistent-volumes.adoc @@ -2,6 +2,7 @@ = Expanding persistent volumes include::modules/common-attributes.adoc[] :context: expanding-persistent-volumes + toc::[] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] diff --git a/storage/persistent_storage/persistent-storage-azure-file.adoc b/storage/persistent_storage/persistent-storage-azure-file.adoc index da62c90be5..8cb306540f 100644 --- a/storage/persistent_storage/persistent-storage-azure-file.adoc +++ b/storage/persistent_storage/persistent-storage-azure-file.adoc @@ -2,6 +2,7 @@ = Persistent storage using Azure File include::modules/common-attributes.adoc[] :context: persistent-storage-azure-file + toc::[] {product-title} supports Microsoft Azure File volumes. You can diff --git a/storage/persistent_storage/persistent-storage-azure.adoc b/storage/persistent_storage/persistent-storage-azure.adoc index 753bd82048..bc0ce88c4b 100644 --- a/storage/persistent_storage/persistent-storage-azure.adoc +++ b/storage/persistent_storage/persistent-storage-azure.adoc @@ -2,6 +2,7 @@ = Persistent storage using Azure include::modules/common-attributes.adoc[] :context: persistent-storage-azure + toc::[] {product-title} supports Microsoft Azure Disk volumes. You can diff --git a/storage/persistent_storage/persistent-storage-ocs.adoc b/storage/persistent_storage/persistent-storage-ocs.adoc index 8b81c47a8c..31f481e2db 100644 --- a/storage/persistent_storage/persistent-storage-ocs.adoc +++ b/storage/persistent_storage/persistent-storage-ocs.adoc @@ -2,6 +2,7 @@ = Red Hat OpenShift Container Storage include::modules/common-attributes.adoc[] :context: persistent-storage-ocs + toc::[] Red Hat OpenShift Container Storage is a provider of agnostic persistent storage for {product-title} supporting file, block, and object storage, either in-house or in hybrid clouds. As a Red Hat storage solution, Red Hat OpenShift Container Storage is completely integrated with {product-title} for deployment, management, and monitoring. diff --git a/storage/understanding-ephemeral-storage.adoc b/storage/understanding-ephemeral-storage.adoc index 192dee0f0a..15850103bc 100644 --- a/storage/understanding-ephemeral-storage.adoc +++ b/storage/understanding-ephemeral-storage.adoc @@ -2,6 +2,7 @@ = Understanding ephemeral storage include::modules/common-attributes.adoc[] :context: understanding-ephemeral-storage + toc::[] include::modules/storage-ephemeral-storage-overview.adoc[leveloffset=+1] diff --git a/storage/understanding-persistent-storage.adoc b/storage/understanding-persistent-storage.adoc index bd6175e2f6..a6b477fec6 100644 --- a/storage/understanding-persistent-storage.adoc +++ b/storage/understanding-persistent-storage.adoc @@ -2,6 +2,7 @@ = Understanding persistent storage include::modules/common-attributes.adoc[] :context: understanding-persistent-storage + toc::[] include::modules/storage-persistent-storage-overview.adoc[leveloffset=+1] diff --git a/support/remote_health_monitoring/about-remote-health-monitoring.adoc b/support/remote_health_monitoring/about-remote-health-monitoring.adoc index 4a06653255..51335bdb9a 100644 --- a/support/remote_health_monitoring/about-remote-health-monitoring.adoc +++ b/support/remote_health_monitoring/about-remote-health-monitoring.adoc @@ -92,4 +92,4 @@ Red Hat may engage certain service providers to assist in the collection and sto .User control / enabling and disabling telemetry and configuration data collection -You may disable {product-title} Telemetry and the Insights Operator by following the instructions in xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting]. \ No newline at end of file +You may disable {product-title} Telemetry and the Insights Operator by following the instructions in xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting]. diff --git a/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc b/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc index 7837338eed..6ebca03f85 100644 --- a/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc +++ b/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc @@ -2,6 +2,7 @@ = Using Insights to identify issues with your cluster include::modules/common-attributes.adoc[] :context: using-insights-to-identify-issues-with-your-cluster + toc::[] Insights repeatedly analyzes the data Insights Operator sends. Users of {product-title} can display the report on the *Insights* tab of each cluster in {cloud-redhat-com}. diff --git a/updating/understanding-the-update-service.adoc b/updating/understanding-the-update-service.adoc index 9f0420b04e..92393c6478 100644 --- a/updating/understanding-the-update-service.adoc +++ b/updating/understanding-the-update-service.adoc @@ -2,6 +2,7 @@ = Understanding the update service include::modules/common-attributes.adoc[] :context: understanding-the-update-service + toc::[] include::modules/update-service-overview.adoc[leveloffset=+1] diff --git a/virt/about-virt.adoc b/virt/about-virt.adoc index 04c1952838..5d3274b7d3 100644 --- a/virt/about-virt.adoc +++ b/virt/about-virt.adoc @@ -2,6 +2,7 @@ include::modules/virt-document-attributes.adoc[] [id="about-virt"] = About {VirtProductName} :context: about-virt + toc::[] Learn about {VirtProductName}'s capabilities and support scope. diff --git a/virt/install/installing-virt-cli.adoc b/virt/install/installing-virt-cli.adoc index ac6429c99e..da350ba6e8 100644 --- a/virt/install/installing-virt-cli.adoc +++ b/virt/install/installing-virt-cli.adoc @@ -2,6 +2,7 @@ = Installing {VirtProductName} using the CLI include::modules/virt-document-attributes.adoc[] :context: installing-virt-cli + toc::[] Install {VirtProductName} to add virtualization functionality to your {product-title} diff --git a/virt/install/installing-virt-web.adoc b/virt/install/installing-virt-web.adoc index 1029eb00f9..22140d42a0 100644 --- a/virt/install/installing-virt-web.adoc +++ b/virt/install/installing-virt-web.adoc @@ -2,6 +2,7 @@ = Installing {VirtProductName} using the web console include::modules/virt-document-attributes.adoc[] :context: installing-virt-web + toc::[] Install {VirtProductName} to add virtualization functionality to your {product-title} cluster. diff --git a/virt/install/preparing-cluster-for-virt.adoc b/virt/install/preparing-cluster-for-virt.adoc index 0f54b755fe..3ea9feae0f 100644 --- a/virt/install/preparing-cluster-for-virt.adoc +++ b/virt/install/preparing-cluster-for-virt.adoc @@ -2,6 +2,7 @@ = Configuring your cluster for {VirtProductName} include::modules/virt-document-attributes.adoc[] :context: preparing-cluster-for-virt + toc::[] Before you install {VirtProductName}, ensure that your {product-title} cluster meets the following requirements: diff --git a/virt/install/uninstalling-virt-cli.adoc b/virt/install/uninstalling-virt-cli.adoc index 96e634659b..ed72182ddc 100644 --- a/virt/install/uninstalling-virt-cli.adoc +++ b/virt/install/uninstalling-virt-cli.adoc @@ -2,6 +2,7 @@ = Uninstalling {VirtProductName} using the CLI include::modules/virt-document-attributes.adoc[] :context: uninstalling-virt-cli + toc::[] You can uninstall {VirtProductName} by using the {product-title} diff --git a/virt/install/uninstalling-virt-web.adoc b/virt/install/uninstalling-virt-web.adoc index d4f08c3705..f85b1da18f 100644 --- a/virt/install/uninstalling-virt-web.adoc +++ b/virt/install/uninstalling-virt-web.adoc @@ -2,6 +2,7 @@ = Uninstalling {VirtProductName} using the web console include::modules/virt-document-attributes.adoc[] :context: uninstalling-virt-web + toc::[] You can uninstall {VirtProductName} by using the {product-title} diff --git a/virt/install/virt-installing-virtctl.adoc b/virt/install/virt-installing-virtctl.adoc index 387a2e54de..d1837f1a80 100644 --- a/virt/install/virt-installing-virtctl.adoc +++ b/virt/install/virt-installing-virtctl.adoc @@ -2,6 +2,7 @@ = Installing the `virtctl` client include::modules/virt-document-attributes.adoc[] :context: virt-installing-virtctl + toc::[] The `virtctl` client is a command-line utility for managing {VirtProductName} diff --git a/virt/install/virt-specifying-nodes-for-virtualization-components.adoc b/virt/install/virt-specifying-nodes-for-virtualization-components.adoc index 049a66f682..29d64f99f3 100644 --- a/virt/install/virt-specifying-nodes-for-virtualization-components.adoc +++ b/virt/install/virt-specifying-nodes-for-virtualization-components.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-specifying-nodes-for-virtualization-components + toc::[] Specify the nodes where you want to deploy {VirtProductName} Operators, workloads, and controllers by configuring node placement rules. diff --git a/virt/live_migration/virt-cancel-vmi-migration.adoc b/virt/live_migration/virt-cancel-vmi-migration.adoc index 5cd90f1aae..47ee591672 100644 --- a/virt/live_migration/virt-cancel-vmi-migration.adoc +++ b/virt/live_migration/virt-cancel-vmi-migration.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-cancel-vmi-migration + toc::[] Cancel the live migration so that the virtual machine instance remains diff --git a/virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc b/virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc index bf34d13cd3..a88aabfd81 100644 --- a/virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc +++ b/virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc @@ -2,6 +2,7 @@ = Configuring virtual machine eviction strategy include::modules/virt-document-attributes.adoc[] :context: virt-configuring-vmi-eviction-strategy + toc::[] The `LiveMigrate` eviction strategy ensures that a virtual machine instance is diff --git a/virt/live_migration/virt-live-migration-limits.adoc b/virt/live_migration/virt-live-migration-limits.adoc index 92fafe0813..027dc7a493 100644 --- a/virt/live_migration/virt-live-migration-limits.adoc +++ b/virt/live_migration/virt-live-migration-limits.adoc @@ -2,6 +2,7 @@ = Live migration limits and timeouts include::modules/virt-document-attributes.adoc[] :context: virt-live-migration-limits + toc::[] Live migration limits and timeouts are applied so that migration processes do diff --git a/virt/live_migration/virt-live-migration.adoc b/virt/live_migration/virt-live-migration.adoc index d624960063..969ac7df42 100644 --- a/virt/live_migration/virt-live-migration.adoc +++ b/virt/live_migration/virt-live-migration.adoc @@ -2,6 +2,7 @@ = Virtual machine live migration include::modules/virt-document-attributes.adoc[] :context: virt-live-migration + toc::[] include::modules/virt-understanding-live-migration.adoc[leveloffset=+1] diff --git a/virt/live_migration/virt-migrate-vmi.adoc b/virt/live_migration/virt-migrate-vmi.adoc index 8bfe7fe78d..fa262ab83f 100644 --- a/virt/live_migration/virt-migrate-vmi.adoc +++ b/virt/live_migration/virt-migrate-vmi.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-migrate-vmi + toc::[] Manually initiate a live migration of a virtual machine instance to another node using either the web console or the CLI. diff --git a/virt/live_migration/virt-monitor-vmi-migration.adoc b/virt/live_migration/virt-monitor-vmi-migration.adoc index 1d170b28ec..6aafec0792 100644 --- a/virt/live_migration/virt-monitor-vmi-migration.adoc +++ b/virt/live_migration/virt-monitor-vmi-migration.adoc @@ -2,6 +2,7 @@ = Monitoring live migration of a virtual machine instance include::modules/virt-document-attributes.adoc[] :context: virt-monitor-vmi-migration + toc::[] You can monitor the progress of a live migration of a virtual machine instance from either the web console or the CLI. diff --git a/virt/logging_events_monitoring/virt-collecting-virt-data.adoc b/virt/logging_events_monitoring/virt-collecting-virt-data.adoc index 29c4c33c21..8a923be290 100644 --- a/virt/logging_events_monitoring/virt-collecting-virt-data.adoc +++ b/virt/logging_events_monitoring/virt-collecting-virt-data.adoc @@ -2,6 +2,7 @@ = Collecting {VirtProductName} data for Red Hat Support include::modules/virt-document-attributes.adoc[] :context: virt-collecting-virt-data + toc::[] When opening a support case, it is helpful to provide debugging diff --git a/virt/logging_events_monitoring/virt-diagnosing-datavolumes-using-events-and-conditions.adoc b/virt/logging_events_monitoring/virt-diagnosing-datavolumes-using-events-and-conditions.adoc index 0783494ce4..6ac1d8c895 100644 --- a/virt/logging_events_monitoring/virt-diagnosing-datavolumes-using-events-and-conditions.adoc +++ b/virt/logging_events_monitoring/virt-diagnosing-datavolumes-using-events-and-conditions.adoc @@ -2,6 +2,7 @@ = Diagnosing data volumes using events and conditions include::modules/virt-document-attributes.adoc[] :context: virt-diagnosing-datavolumes-using-events-and-conditions + toc::[] Use the `oc describe` command to analyze and help resolve issues with data volumes. diff --git a/virt/logging_events_monitoring/virt-events.adoc b/virt/logging_events_monitoring/virt-events.adoc index cfa168240a..1ab543f9df 100644 --- a/virt/logging_events_monitoring/virt-events.adoc +++ b/virt/logging_events_monitoring/virt-events.adoc @@ -2,6 +2,7 @@ = Viewing events include::modules/virt-document-attributes.adoc[] :context: virt-events + toc::[] include::modules/virt-understanding-events.adoc[leveloffset=+1] diff --git a/virt/logging_events_monitoring/virt-logs.adoc b/virt/logging_events_monitoring/virt-logs.adoc index ce99e014cf..8500b09910 100644 --- a/virt/logging_events_monitoring/virt-logs.adoc +++ b/virt/logging_events_monitoring/virt-logs.adoc @@ -2,6 +2,7 @@ = Viewing virtual machine logs include::modules/virt-document-attributes.adoc[] :context: virt-logs + toc::[] include::modules/virt-understanding-logs.adoc[leveloffset=+1] diff --git a/virt/logging_events_monitoring/virt-monitoring-vm-health.adoc b/virt/logging_events_monitoring/virt-monitoring-vm-health.adoc index e482943ab8..272f2e15a8 100644 --- a/virt/logging_events_monitoring/virt-monitoring-vm-health.adoc +++ b/virt/logging_events_monitoring/virt-monitoring-vm-health.adoc @@ -2,6 +2,7 @@ = Monitoring virtual machine health include::modules/virt-document-attributes.adoc[] :context: virt-monitoring-vm-health + toc::[] Use this procedure to create liveness and readiness probes diff --git a/virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc b/virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc index 4673262870..dfba6d619d 100644 --- a/virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc +++ b/virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc @@ -2,6 +2,7 @@ = {product-title} cluster monitoring, logging, and Telemetry include::modules/virt-document-attributes.adoc[] :context: virt-openshift-cluster-monitoring + toc::[] {product-title} provides various resources for monitoring at the cluster level. diff --git a/virt/logging_events_monitoring/virt-using-dashboard-to-get-cluster-info.adoc b/virt/logging_events_monitoring/virt-using-dashboard-to-get-cluster-info.adoc index 12361ab492..bec35be124 100644 --- a/virt/logging_events_monitoring/virt-using-dashboard-to-get-cluster-info.adoc +++ b/virt/logging_events_monitoring/virt-using-dashboard-to-get-cluster-info.adoc @@ -2,6 +2,7 @@ = Using the {product-title} dashboard to get cluster information include::modules/virt-document-attributes.adoc[] :context: virt-using-dashboard-to-get-cluster-info + toc::[] Access the {product-title} dashboard, which captures high-level information about the cluster, by clicking *Home > Dashboards > Overview* from the {product-title} web console. diff --git a/virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc b/virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc index 3d82967f3c..545d1074bc 100644 --- a/virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc +++ b/virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc @@ -2,6 +2,7 @@ = Viewing information about virtual machine workloads include::modules/virt-document-attributes.adoc[] :context: virt-viewing-information-about-vm-workloads + toc::[] You can view high-level information about your virtual machines by using the *Virtual Machines* dashboard in the {product-title} web console. diff --git a/virt/node_maintenance/virt-automatic-certificates.adoc b/virt/node_maintenance/virt-automatic-certificates.adoc index 4adcfecbd7..aba16296ea 100644 --- a/virt/node_maintenance/virt-automatic-certificates.adoc +++ b/virt/node_maintenance/virt-automatic-certificates.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-automatic-certificates + toc::[] All TLS certificates for {VirtProductName} components are renewed and rotated automatically. You are not required to refresh them manually. diff --git a/virt/node_maintenance/virt-managing-node-labeling-obsolete-cpu-models.adoc b/virt/node_maintenance/virt-managing-node-labeling-obsolete-cpu-models.adoc index 0f16beb700..fdc3b03b1f 100644 --- a/virt/node_maintenance/virt-managing-node-labeling-obsolete-cpu-models.adoc +++ b/virt/node_maintenance/virt-managing-node-labeling-obsolete-cpu-models.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-managing-node-labeling-obsolete-cpu-models + toc::[] You can schedule a virtual machine (VM) on a node where the CPU model and policy attribute of the VM are compatible with the CPU models and policy attributes that the node supports. By specifying a list of obsolete CPU models in a xref:../../authentication/configmaps.adoc#authentication-configmap-overview_builds-configmaps[config map], you can exclude them from the list of labels created for CPU models. diff --git a/virt/node_maintenance/virt-node-maintenance.adoc b/virt/node_maintenance/virt-node-maintenance.adoc index 936c25db62..23901001eb 100644 --- a/virt/node_maintenance/virt-node-maintenance.adoc +++ b/virt/node_maintenance/virt-node-maintenance.adoc @@ -2,6 +2,7 @@ = Node maintenance mode include::modules/virt-document-attributes.adoc[] :context: virt-node-maintenance + toc::[] include::modules/virt-understanding-node-maintenance.adoc[leveloffset=+1] diff --git a/virt/node_maintenance/virt-refresh-certificates.adoc b/virt/node_maintenance/virt-refresh-certificates.adoc index 2b88e28fd1..4b79a95bee 100644 --- a/virt/node_maintenance/virt-refresh-certificates.adoc +++ b/virt/node_maintenance/virt-refresh-certificates.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-refresh-certificates + toc::[] The TLS certificates for {VirtProductName} components are created at the time diff --git a/virt/node_maintenance/virt-resuming-node.adoc b/virt/node_maintenance/virt-resuming-node.adoc index 7c1b756509..0876fd1088 100644 --- a/virt/node_maintenance/virt-resuming-node.adoc +++ b/virt/node_maintenance/virt-resuming-node.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-resuming-node + toc::[] Resuming a node brings it out of maintenance mode and schedulable again. diff --git a/virt/node_maintenance/virt-setting-node-maintenance.adoc b/virt/node_maintenance/virt-setting-node-maintenance.adoc index 4c6ba4bd05..db47b32372 100644 --- a/virt/node_maintenance/virt-setting-node-maintenance.adoc +++ b/virt/node_maintenance/virt-setting-node-maintenance.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-setting-node-maintenance + toc::[] include::modules/virt-understanding-node-maintenance.adoc[leveloffset=+1] diff --git a/virt/node_network/virt-observing-node-network-state.adoc b/virt/node_network/virt-observing-node-network-state.adoc index 3e4fe77833..842000e5d0 100644 --- a/virt/node_network/virt-observing-node-network-state.adoc +++ b/virt/node_network/virt-observing-node-network-state.adoc @@ -2,6 +2,7 @@ = Observing node network state include::modules/virt-document-attributes.adoc[] :context: virt-observing-node-network-state + toc::[] Node network state is the network configuration for all nodes in the cluster. diff --git a/virt/node_network/virt-troubleshooting-node-network.adoc b/virt/node_network/virt-troubleshooting-node-network.adoc index d7528b3150..b66b81930b 100644 --- a/virt/node_network/virt-troubleshooting-node-network.adoc +++ b/virt/node_network/virt-troubleshooting-node-network.adoc @@ -2,6 +2,7 @@ = Troubleshooting node network configuration include::modules/virt-document-attributes.adoc[] :context: virt-troubleshooting-node-network + toc::[] If the node network configuration encounters an issue, the policy is automatically rolled back and the enactments report failure. diff --git a/virt/node_network/virt-updating-node-network-config.adoc b/virt/node_network/virt-updating-node-network-config.adoc index 4e47c0b253..be064f7bc1 100644 --- a/virt/node_network/virt-updating-node-network-config.adoc +++ b/virt/node_network/virt-updating-node-network-config.adoc @@ -2,6 +2,7 @@ = Updating node network configuration include::modules/virt-document-attributes.adoc[] :context: virt-updating-node-network-config + toc::[] You can update the node network configuration, such as adding or removing interfaces diff --git a/virt/upgrading-virt.adoc b/virt/upgrading-virt.adoc index 5260348adb..9252f4331c 100644 --- a/virt/upgrading-virt.adoc +++ b/virt/upgrading-virt.adoc @@ -2,6 +2,7 @@ = Upgrading {VirtProductName} include::modules/virt-document-attributes.adoc[] :context: upgrading-virt + toc::[] You can manually upgrade to the next minor version of {VirtProductName} and diff --git a/virt/virt-2-6-release-notes.adoc b/virt/virt-2-6-release-notes.adoc index 6d5d57cb05..cb743179b3 100644 --- a/virt/virt-2-6-release-notes.adoc +++ b/virt/virt-2-6-release-notes.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-release-notes + toc::[] == About Red Hat {VirtProductName} diff --git a/virt/virt-additional-security-privileges-controller-and-launcher.adoc b/virt/virt-additional-security-privileges-controller-and-launcher.adoc index 50383e8e9d..73f2e444b1 100644 --- a/virt/virt-additional-security-privileges-controller-and-launcher.adoc +++ b/virt/virt-additional-security-privileges-controller-and-launcher.adoc @@ -2,6 +2,7 @@ = Additional security privileges granted for kubevirt-controller and virt-launcher include::modules/virt-document-attributes.adoc[] :context: virt-additional-security-privileges-controller-and-launcher + toc::[] The `kubevirt-controller` and virt-launcher pods are granted some SELinux policies and Security Context Constraints privileges that are in addition to typical pod owners. These privileges enable virtual machines to use {VirtProductName} features. diff --git a/virt/virt-using-the-cli-tools.adoc b/virt/virt-using-the-cli-tools.adoc index 20c310a0af..757f9bdf46 100644 --- a/virt/virt-using-the-cli-tools.adoc +++ b/virt/virt-using-the-cli-tools.adoc @@ -2,6 +2,7 @@ = Using the CLI tools include::modules/virt-document-attributes.adoc[] :context: virt-using-the-cli-tools + toc::[] The two primary CLI tools used for managing resources in the cluster are: diff --git a/virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc b/virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc index 77503aace2..ff3be44b2e 100644 --- a/virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc +++ b/virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc @@ -2,6 +2,7 @@ = Automating management tasks include::modules/virt-document-attributes.adoc[] :context: virt-automating-management-tasks + toc::[] You can automate {VirtProductName} management tasks by using Red Hat Ansible diff --git a/virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc b/virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc index 42c32df48d..9432b66394 100644 --- a/virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc +++ b/virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc @@ -2,6 +2,7 @@ = Configuring PXE booting for virtual machines include::modules/virt-document-attributes.adoc[] :context: pxe-booting + toc::[] PXE booting, or network booting, is available in {VirtProductName}. diff --git a/virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc b/virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc index 95603b1743..be3aa5df52 100644 --- a/virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc +++ b/virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc @@ -2,6 +2,7 @@ = Enabling dedicated resources for virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-dedicated-resources-vm + toc::[] Virtual machines can have resources of a node, such as CPU, diff --git a/virt/virtual_machines/advanced_vm_management/virt-efi-mode-for-vms.adoc b/virt/virtual_machines/advanced_vm_management/virt-efi-mode-for-vms.adoc index 7448d31204..d51825bf51 100644 --- a/virt/virtual_machines/advanced_vm_management/virt-efi-mode-for-vms.adoc +++ b/virt/virtual_machines/advanced_vm_management/virt-efi-mode-for-vms.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-efi-mode-for-vms + toc::[] You can boot a virtual machine (VM) in Extensible Firmware Interface (EFI) mode. diff --git a/virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc b/virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc index ecb42b4ed3..228502f968 100644 --- a/virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc +++ b/virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc @@ -2,6 +2,7 @@ = Managing guest memory include::modules/virt-document-attributes.adoc[] :context: virt-managing-guest-memory + toc::[] If you want to adjust guest memory settings to suit a specific use case, you can do so by editing the guest's YAML configuration file. {VirtProductName} allows you to configure guest memory overcommitment and disable guest memory overhead accounting. diff --git a/virt/virtual_machines/advanced_vm_management/virt-schedule-vms.adoc b/virt/virtual_machines/advanced_vm_management/virt-schedule-vms.adoc index 1a832c5d80..c767dbe921 100644 --- a/virt/virtual_machines/advanced_vm_management/virt-schedule-vms.adoc +++ b/virt/virtual_machines/advanced_vm_management/virt-schedule-vms.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-schedule-vms + toc::[] You can schedule a virtual machine (VM) on a node by ensuring that the VM's CPU model and policy attribute are matched for compatibility with the CPU models and policy attributes supported by the node. diff --git a/virt/virtual_machines/advanced_vm_management/virt-using-huge-pages-with-vms.adoc b/virt/virtual_machines/advanced_vm_management/virt-using-huge-pages-with-vms.adoc index d70b3840e5..dbddb1452f 100644 --- a/virt/virtual_machines/advanced_vm_management/virt-using-huge-pages-with-vms.adoc +++ b/virt/virtual_machines/advanced_vm_management/virt-using-huge-pages-with-vms.adoc @@ -2,6 +2,7 @@ = Using huge pages with virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-using-huge-pages-with-vms + toc::[] You can use huge pages as backing memory for virtual machines in your cluster. diff --git a/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc b/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc index 3e0ef99108..a08ae09878 100644 --- a/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc +++ b/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc @@ -2,6 +2,7 @@ = Cloning a virtual machine disk into a new block storage data volume include::modules/virt-document-attributes.adoc[] :context: virt-cloning-vm-disk-into-new-datavolume-block + toc::[] You can clone the persistent volume claim (PVC) of a virtual machine disk into diff --git a/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc b/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc index 0087427f9d..66ea80e766 100644 --- a/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc +++ b/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc @@ -2,6 +2,7 @@ = Cloning a virtual machine disk into a new data volume include::modules/virt-document-attributes.adoc[] :context: virt-cloning-vm-disk-into-new-datavolume + toc::[] You can clone the persistent volume claim (PVC) of a virtual machine disk into diff --git a/virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc b/virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc index 1306a0d33f..fdee594eeb 100644 --- a/virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc +++ b/virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc @@ -2,6 +2,7 @@ = Cloning a virtual machine by using a data volume template include::modules/virt-document-attributes.adoc[] :context: virt-cloning-vm-using-datavolumetemplate + toc::[] You can create a new virtual machine by cloning the persistent volume claim (PVC) of diff --git a/virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc b/virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc index eb5eda321e..5ef84fb4d3 100644 --- a/virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc +++ b/virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc @@ -2,6 +2,7 @@ = Enabling user permissions to clone data volumes across namespaces include::modules/virt-document-attributes.adoc[] :context: virt-enabling-user-permissions-to-clone-datavolumes + toc::[] The isolating nature of namespaces means that users cannot by default diff --git a/virt/virtual_machines/importing_vms/virt-importing-rhv-vm.adoc b/virt/virtual_machines/importing_vms/virt-importing-rhv-vm.adoc index 46b62fa114..bb811dc0d6 100644 --- a/virt/virtual_machines/importing_vms/virt-importing-rhv-vm.adoc +++ b/virt/virtual_machines/importing_vms/virt-importing-rhv-vm.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] :context: virt-importing-rhv-vm :virt-importing-rhv-vm: + toc::[] You can import a single Red Hat Virtualization (RHV) virtual machine into {VirtProductName} by using the VM Import wizard or the CLI. diff --git a/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc b/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc index cc5d41a174..17324bb7a2 100644 --- a/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc +++ b/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc @@ -2,6 +2,7 @@ = Importing virtual machine images to block storage with data volumes include::modules/virt-document-attributes.adoc[] :context: virt-importing-virtual-machine-images-datavolumes-block + toc::[] You can import an existing virtual machine image into your {product-title} diff --git a/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc b/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc index a3f863f795..f98ad81340 100644 --- a/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc +++ b/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc @@ -2,6 +2,7 @@ = Importing virtual machine images with data volumes include::modules/virt-document-attributes.adoc[] :context: virt-importing-virtual-machine-images-datavolumes + toc::[] Use the Containerized Data Importer (CDI) to import a virtual machine image into a persistent volume claim (PVC) by using a data volume. You can attach a data volume to a virtual machine for persistent storage. diff --git a/virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc b/virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc index 3d3877c89b..05bc763901 100644 --- a/virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc +++ b/virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] :context: virt-importing-vmware-vm :virt-importing-vmware-vm: + toc::[] You can import a VMware vSphere 6.5, 6.7, or 7.0 VM or VM template into {VirtProductName} by using the VM Import wizard. diff --git a/virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc b/virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc index fea2c15467..8a159822d7 100644 --- a/virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc +++ b/virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-tls-certificates-for-dv-imports + toc::[] include::modules/virt-adding-tls-certificates-for-authenticating-dv-imports.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virt-accessing-vm-consoles.adoc b/virt/virtual_machines/virt-accessing-vm-consoles.adoc index 6d6bd02668..c38fff0e1d 100644 --- a/virt/virtual_machines/virt-accessing-vm-consoles.adoc +++ b/virt/virtual_machines/virt-accessing-vm-consoles.adoc @@ -2,6 +2,7 @@ = Accessing virtual machine consoles include::modules/virt-document-attributes.adoc[] :context: virt-accessing-vm-consoles + toc::[] {VirtProductName} provides different virtual machine consoles that you can diff --git a/virt/virtual_machines/virt-controlling-vm-states.adoc b/virt/virtual_machines/virt-controlling-vm-states.adoc index 9811ccbf5e..c5f36b8401 100644 --- a/virt/virtual_machines/virt-controlling-vm-states.adoc +++ b/virt/virtual_machines/virt-controlling-vm-states.adoc @@ -2,6 +2,7 @@ = Controlling virtual machine states include::modules/virt-document-attributes.adoc[] :context: virt-controlling-vm-states + toc::[] You can stop, start, restart, and unpause virtual machines from the web console. diff --git a/virt/virtual_machines/virt-create-vms.adoc b/virt/virtual_machines/virt-create-vms.adoc index 4341d41313..21e7502287 100644 --- a/virt/virtual_machines/virt-create-vms.adoc +++ b/virt/virtual_machines/virt-create-vms.adoc @@ -2,6 +2,7 @@ = Creating virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-create-vms + toc::[] diff --git a/virt/virtual_machines/virt-delete-vms.adoc b/virt/virtual_machines/virt-delete-vms.adoc index f4f54e843f..6009059a5e 100644 --- a/virt/virtual_machines/virt-delete-vms.adoc +++ b/virt/virtual_machines/virt-delete-vms.adoc @@ -2,6 +2,7 @@ = Deleting virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-delete-vms + toc::[] You can delete a virtual machine from the web console or by using the `oc` command line interface. diff --git a/virt/virtual_machines/virt-edit-boot-order.adoc b/virt/virtual_machines/virt-edit-boot-order.adoc index dc16ea6952..6bf2d9fe13 100644 --- a/virt/virtual_machines/virt-edit-boot-order.adoc +++ b/virt/virtual_machines/virt-edit-boot-order.adoc @@ -2,6 +2,7 @@ = Editing boot order include::modules/virt-document-attributes.adoc[] :context: virt-edit-boot-order + toc::[] You can update the values for a boot order list by using the web console or the CLI. diff --git a/virt/virtual_machines/virt-edit-vms.adoc b/virt/virtual_machines/virt-edit-vms.adoc index 7e01b15e20..bfcb24406e 100644 --- a/virt/virtual_machines/virt-edit-vms.adoc +++ b/virt/virtual_machines/virt-edit-vms.adoc @@ -2,6 +2,7 @@ = Editing virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-edit-vms + toc::[] You can update a virtual machine configuration using either the YAML editor in the web console or the OpenShift client on the command line. You can also update a subset of the parameters in the *Virtual Machine Details* screen. diff --git a/virt/virtual_machines/virt-installing-qemu-guest-agent.adoc b/virt/virtual_machines/virt-installing-qemu-guest-agent.adoc index 10d1835dc3..44ff631e79 100644 --- a/virt/virtual_machines/virt-installing-qemu-guest-agent.adoc +++ b/virt/virtual_machines/virt-installing-qemu-guest-agent.adoc @@ -2,6 +2,7 @@ = Installing the QEMU guest agent on virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-installing-qemu-guest-agent + toc::[] The xref:../../virt/virtual_machines/virt-viewing-qemu-guest-agent-web.adoc#virt-viewing-qemu-guest-agent-web[QEMU guest agent] is a daemon that runs on the virtual machine and passes information to the host about the virtual machine, users, file systems, and secondary networks. diff --git a/virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc b/virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc index a32eb602a3..f64622fd08 100644 --- a/virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc +++ b/virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc @@ -2,6 +2,7 @@ = Installing VirtIO driver on an existing Windows virtual machine include::modules/virt-document-attributes.adoc[] :context: virt-installing-virtio-drivers-on-existing-windows-vm + toc::[] include::modules/virt-understanding-virtio-drivers.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc b/virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc index 6d3ac20655..f94143746a 100644 --- a/virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc +++ b/virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc @@ -2,6 +2,7 @@ = Installing VirtIO driver on a new Windows virtual machine include::modules/virt-document-attributes.adoc[] :context: virt-installing-virtio-drivers-on-new-windows-vm" + toc::[] == Prerequisites diff --git a/virt/virtual_machines/virt-manage-vmis.adoc b/virt/virtual_machines/virt-manage-vmis.adoc index 4b919626bc..035d29d139 100644 --- a/virt/virtual_machines/virt-manage-vmis.adoc +++ b/virt/virtual_machines/virt-manage-vmis.adoc @@ -2,6 +2,7 @@ = Managing virtual machine instances include::modules/virt-document-attributes.adoc[] :context: virt-manage-vmis + toc::[] If you have standalone virtual machine instances (VMIs) that were created independently outside of the {VirtProductName} environment, you can manage them by using the web console or the command-line interface (CLI). diff --git a/virt/virtual_machines/virt-managing-configmaps-secrets-service-accounts.adoc b/virt/virtual_machines/virt-managing-configmaps-secrets-service-accounts.adoc index da8d49f600..5333b9f74e 100644 --- a/virt/virtual_machines/virt-managing-configmaps-secrets-service-accounts.adoc +++ b/virt/virtual_machines/virt-managing-configmaps-secrets-service-accounts.adoc @@ -2,6 +2,7 @@ = Managing config maps, secrets, and service accounts in virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-managing-configmaps-secrets-service-accounts + toc::[] You can use secrets, config maps, and service accounts to pass configuration data to virtual machines. For example, you can: diff --git a/virt/virtual_machines/virt-triggering-vm-failover-resolving-failed-node.adoc b/virt/virtual_machines/virt-triggering-vm-failover-resolving-failed-node.adoc index 61668fb28f..42b0a4bf2e 100644 --- a/virt/virtual_machines/virt-triggering-vm-failover-resolving-failed-node.adoc +++ b/virt/virtual_machines/virt-triggering-vm-failover-resolving-failed-node.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] :context: virt-triggering-vm-failover-resolving-failed-node + toc::[] If a node fails and xref:../../machine_management/deploying-machine-health-checks.adoc#machine-health-checks-about_deploying-machine-health-checks[machine health checks] are not deployed on your cluster, virtual machines (VMs) with `RunStrategy: Always` configured are not automatically relocated to healthy nodes. To trigger VM failover, you must manually delete the `Node` object. diff --git a/virt/virtual_machines/virt-viewing-qemu-guest-agent-web.adoc b/virt/virtual_machines/virt-viewing-qemu-guest-agent-web.adoc index 86202ab96b..6d3f6fecb1 100644 --- a/virt/virtual_machines/virt-viewing-qemu-guest-agent-web.adoc +++ b/virt/virtual_machines/virt-viewing-qemu-guest-agent-web.adoc @@ -2,6 +2,7 @@ = Viewing the QEMU guest agent information for virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-viewing-qemu-guest-agent-web + toc::[] When the QEMU guest agent runs on the virtual machine, you can use the web console to view information about the virtual machine, users, file systems, and secondary networks. diff --git a/virt/virtual_machines/virtual_disks/virt-cloning-a-datavolume-using-smart-cloning.adoc b/virt/virtual_machines/virtual_disks/virt-cloning-a-datavolume-using-smart-cloning.adoc index b0a18859aa..792ddad695 100644 --- a/virt/virtual_machines/virtual_disks/virt-cloning-a-datavolume-using-smart-cloning.adoc +++ b/virt/virtual_machines/virtual_disks/virt-cloning-a-datavolume-using-smart-cloning.adoc @@ -2,6 +2,7 @@ = Cloning a data volume using smart-cloning include::modules/virt-document-attributes.adoc[] :context: virt-cloning-a-datavolume-using-smart-cloning + toc::[] Smart-cloning is a built-in feature of {product-title} Storage (OCS), diff --git a/virt/virtual_machines/virtual_disks/virt-configuring-cdi-for-namespace-resourcequota.adoc b/virt/virtual_machines/virtual_disks/virt-configuring-cdi-for-namespace-resourcequota.adoc index 6715367dc4..d4121b6d98 100644 --- a/virt/virtual_machines/virtual_disks/virt-configuring-cdi-for-namespace-resourcequota.adoc +++ b/virt/virtual_machines/virtual_disks/virt-configuring-cdi-for-namespace-resourcequota.adoc @@ -2,6 +2,7 @@ = Configuring CDI to work with namespaces that have a compute resource quota include::modules/virt-document-attributes.adoc[] :context: virt-configuring-cdi-for-namespace-resourcequota + toc::[] You can use the Containerized Data Importer (CDI) to import, upload, and clone virtual machine disks into namespaces that are subject to CPU and memory resource restrictions. diff --git a/virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc b/virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc index 3db309d22b..ab901fe998 100644 --- a/virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc +++ b/virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc @@ -2,6 +2,7 @@ = Configuring local storage for virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-configuring-local-storage-for-vms + toc::[] You can configure local storage for your virtual machines by using the hostpath diff --git a/virt/virtual_machines/virtual_disks/virt-creating-and-using-boot-sources.adoc b/virt/virtual_machines/virtual_disks/virt-creating-and-using-boot-sources.adoc index c3007eb0e6..6e8754509a 100644 --- a/virt/virtual_machines/virtual_disks/virt-creating-and-using-boot-sources.adoc +++ b/virt/virtual_machines/virtual_disks/virt-creating-and-using-boot-sources.adoc @@ -2,6 +2,7 @@ = Creating and using boot sources include::modules/virt-document-attributes.adoc[] :context: virt-creating-and-using-boot-sources + toc::[] A _boot source_ contains a bootable operating system (OS) and all of the configuration settings for the OS, such as drivers. diff --git a/virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc b/virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc index 19fb22caed..8ad3faeccd 100644 --- a/virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc +++ b/virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc @@ -2,6 +2,7 @@ = Deleting data volumes include::modules/virt-document-attributes.adoc[] :context: virt-deleting-datavolumes + toc::[] You can manually delete a data volume by using the `oc` command-line interface. + diff --git a/virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc b/virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc index 7d6c82350b..5c19f6b9e7 100644 --- a/virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc +++ b/virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc @@ -2,6 +2,7 @@ = Expanding virtual storage by adding blank disk images include::modules/virt-document-attributes.adoc[] :context: virt-expanding-virtual-storage-with-blank-disk-images + toc::[] You can increase your storage capacity or create new data partitions by adding diff --git a/virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc b/virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc index 9a41fb1b58..d7c9cc180e 100644 --- a/virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc +++ b/virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc @@ -3,6 +3,7 @@ include::modules/virt-document-attributes.adoc[] :context: virt-features-for-storage :virt-features-for-storage: + toc::[] Use the following table to determine feature availability for local and shared diff --git a/virt/virtual_machines/virtual_disks/virt-managing-offline-vm-snapshots.adoc b/virt/virtual_machines/virtual_disks/virt-managing-offline-vm-snapshots.adoc index 0092489f2d..71502a3aa1 100644 --- a/virt/virtual_machines/virtual_disks/virt-managing-offline-vm-snapshots.adoc +++ b/virt/virtual_machines/virtual_disks/virt-managing-offline-vm-snapshots.adoc @@ -2,6 +2,7 @@ = Managing offline virtual machine snapshots include::modules/virt-document-attributes.adoc[] :context: virt-managing-offline-vm-snapshots + toc::[] You can create, restore, and delete virtual machine (VM) snapshots for VMs that are powered off (offline). {VirtProductName} supports diff --git a/virt/virtual_machines/virtual_disks/virt-moving-local-vm-disk-to-different-node.adoc b/virt/virtual_machines/virtual_disks/virt-moving-local-vm-disk-to-different-node.adoc index 7b0c4c0c57..692c65305c 100644 --- a/virt/virtual_machines/virtual_disks/virt-moving-local-vm-disk-to-different-node.adoc +++ b/virt/virtual_machines/virtual_disks/virt-moving-local-vm-disk-to-different-node.adoc @@ -2,6 +2,7 @@ = Moving a local virtual machine disk to a different node include::modules/virt-document-attributes.adoc[] :context: virt-moving-local-vm-disk-to-different-node + toc::[] Virtual machines that use local volume storage can be moved so that they run on a specific node. diff --git a/virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc b/virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc index c9502ef351..c11f551463 100644 --- a/virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc +++ b/virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc @@ -2,6 +2,7 @@ = Preparing CDI scratch space include::modules/virt-document-attributes.adoc[] :context: virt-preparing-cdi-scratch-space + toc::[] include::modules/virt-about-datavolumes.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virtual_disks/virt-reserving-pvc-space-fs-overhead.adoc b/virt/virtual_machines/virtual_disks/virt-reserving-pvc-space-fs-overhead.adoc index ddac0dce6c..574fadf9c1 100644 --- a/virt/virtual_machines/virtual_disks/virt-reserving-pvc-space-fs-overhead.adoc +++ b/virt/virtual_machines/virtual_disks/virt-reserving-pvc-space-fs-overhead.adoc @@ -2,6 +2,7 @@ = Reserving PVC space for file system overhead include::modules/virt-document-attributes.adoc[] :context: virt-reserving-pvc-space-fs-overhead + toc::[] By default, the Containerized Data Importer (CDI) reserves space for file system overhead data in persistent volume claims (PVCs) that use the `Filesystem` volume mode. You can set the percentage that CDI reserves for this purpose globally and for specific storage classes. diff --git a/virt/virtual_machines/virtual_disks/virt-reusing-statically-provisioned-persistent-volumes.adoc b/virt/virtual_machines/virtual_disks/virt-reusing-statically-provisioned-persistent-volumes.adoc index edfca8a785..1819210861 100644 --- a/virt/virtual_machines/virtual_disks/virt-reusing-statically-provisioned-persistent-volumes.adoc +++ b/virt/virtual_machines/virtual_disks/virt-reusing-statically-provisioned-persistent-volumes.adoc @@ -2,6 +2,7 @@ = Re-using persistent volumes include::modules/virt-document-attributes.adoc[] :context: virt-reusing-statically-provisioned-persistent-volumes + toc::[] In order to re-use a statically provisioned persistent volume (PV), you must first reclaim the volume. diff --git a/virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc b/virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc index e0abe54aa2..6b25da597a 100644 --- a/virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc +++ b/virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc @@ -2,6 +2,7 @@ = Storage defaults for data volumes include::modules/virt-document-attributes.adoc[] :context: virt-storage-defaults-for-datavolumes + toc::[] The `kubevirt-storage-class-defaults` config map provides _access mode_ and _volume mode_ defaults for data volumes. You can edit or add storage class defaults to the config map in order to create data volumes in the web console that better match the underlying storage. diff --git a/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc index 99ec0d11cb..54ce6cd0e3 100644 --- a/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc +++ b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc @@ -2,6 +2,7 @@ = Uploading a local disk image to a block storage data volume include::modules/virt-document-attributes.adoc[] :context: virt-uploading-local-disk-images-block + toc::[] You can upload a local disk image into a block data volume by using the diff --git a/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc index 70af48045f..a33bfe0aaf 100644 --- a/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc +++ b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc @@ -2,6 +2,7 @@ = Uploading local disk images by using the virtctl tool include::modules/virt-document-attributes.adoc[] :context: virt-uploading-local-disk-images-virtctl + toc::[] You can upload a locally stored disk image to a new or existing data volume by using the diff --git a/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-web.adoc b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-web.adoc index d4944aa3c6..06477f1ccc 100644 --- a/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-web.adoc +++ b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-web.adoc @@ -2,6 +2,7 @@ = Uploading local disk images by using the web console include::modules/virt-document-attributes.adoc[] :context: virt-uploading-local-disk-images-web + toc::[] You can upload a locally stored disk image file by using the web console. diff --git a/virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc b/virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc index 37c2799ee3..9f0960303b 100644 --- a/virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc +++ b/virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc @@ -2,6 +2,7 @@ = Using container disks with virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-using-container-disks-with-vms + toc::[] You can build a virtual machine image into a container disk and store it in your container registry. You can then import the container disk into persistent storage for a virtual machine or attach it directly to the virtual machine for ephemeral storage. diff --git a/virt/virtual_machines/virtual_disks/virt-using-preallocation-for-datavolumes.adoc b/virt/virtual_machines/virtual_disks/virt-using-preallocation-for-datavolumes.adoc index 7a1c3636a3..12611c9f68 100644 --- a/virt/virtual_machines/virtual_disks/virt-using-preallocation-for-datavolumes.adoc +++ b/virt/virtual_machines/virtual_disks/virt-using-preallocation-for-datavolumes.adoc @@ -2,6 +2,7 @@ = Using preallocation for data volumes include::modules/virt-document-attributes.adoc[] :context: virt-using-preallocation-for-datavolumes + toc::[] The Containerized Data Importer can preallocate disk space to improve write performance when creating data volumes. diff --git a/virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc b/virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc index 6ff95facb0..edb9fb66af 100644 --- a/virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc +++ b/virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc @@ -2,6 +2,7 @@ = Attaching a virtual machine to multiple networks include::modules/virt-document-attributes.adoc[] :context: virt-attaching-multiple-networks + toc::[] {VirtProductName} provides layer-2 networking capabilities that allow you to connect diff --git a/virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc b/virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc index 13a2a9300f..46057b6369 100644 --- a/virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc +++ b/virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc @@ -2,6 +2,7 @@ = Attaching a virtual machine to an SR-IOV network include::modules/virt-document-attributes.adoc[] :context: virt-attaching-vm-to-sriov-network + toc::[] You can attach a virtual machine to use a Single Root I/O Virtualization (SR-IOV) network as a secondary network. diff --git a/virt/virtual_machines/vm_networking/virt-configuring-ip-for-vms.adoc b/virt/virtual_machines/vm_networking/virt-configuring-ip-for-vms.adoc index 7096303b3f..30026e7dcb 100644 --- a/virt/virtual_machines/vm_networking/virt-configuring-ip-for-vms.adoc +++ b/virt/virtual_machines/vm_networking/virt-configuring-ip-for-vms.adoc @@ -2,6 +2,7 @@ = Configuring IP addresses for virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-configuring-ip-for-vms + toc::[] You can configure either dynamically or statically provisioned IP addresses for virtual machines. diff --git a/virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc b/virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc index 44759d11a7..f3b9e4adfb 100644 --- a/virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc +++ b/virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc @@ -2,6 +2,7 @@ = Configuring an SR-IOV network device for virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-configuring-sriov-device-for-vms + toc::[] You can configure a Single Root I/O Virtualization (SR-IOV) device for virtual machines in your cluster. diff --git a/virt/virtual_machines/vm_networking/virt-defining-an-sriov-network.adoc b/virt/virtual_machines/vm_networking/virt-defining-an-sriov-network.adoc index 256c977f5d..b2c0721e0d 100644 --- a/virt/virtual_machines/vm_networking/virt-defining-an-sriov-network.adoc +++ b/virt/virtual_machines/vm_networking/virt-defining-an-sriov-network.adoc @@ -2,6 +2,7 @@ = Defining an SR-IOV network include::modules/virt-document-attributes.adoc[] :context: virt-defining-an-sriov-network + toc::[] You can create a network attachment for a Single Root I/O Virtualization (SR-IOV) device for virtual machines. diff --git a/virt/virtual_machines/vm_networking/virt-using-mac-address-pool-for-vms.adoc b/virt/virtual_machines/vm_networking/virt-using-mac-address-pool-for-vms.adoc index bd335f1e4e..b05c0079c1 100644 --- a/virt/virtual_machines/vm_networking/virt-using-mac-address-pool-for-vms.adoc +++ b/virt/virtual_machines/vm_networking/virt-using-mac-address-pool-for-vms.adoc @@ -2,6 +2,7 @@ = Using a MAC address pool for virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-using-mac-address-pool-for-vms + toc::[] The _KubeMacPool_ component provides a MAC address pool service for virtual machine NICs in designated namespaces. Enable a MAC address pool in a namespace by applying the KubeMacPool label to that namespace. diff --git a/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc b/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc index d3a4e908d6..3d9d259aea 100644 --- a/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc +++ b/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc @@ -2,6 +2,7 @@ = Using the default pod network for virtual machines include::modules/virt-document-attributes.adoc[] :context: virt-using-the-default-pod-network-with-virt + toc::[] You can use the default pod network with {VirtProductName}. To do so, diff --git a/virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-nic.adoc b/virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-nic.adoc index 191c1b0782..a9f68b8593 100644 --- a/virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-nic.adoc +++ b/virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-nic.adoc @@ -2,6 +2,7 @@ = Viewing the IP address of NICs on a virtual machine include::modules/virt-document-attributes.adoc[] :context: virt-viewing-ip-of-vm-vnic + toc::[] You can view the IP address for a network interface card (NIC) by using the web console or the `oc` client. The xref:../../../virt/virtual_machines/virt-installing-qemu-guest-agent.adoc#virt-installing-qemu-guest-agent[QEMU guest agent] displays additional information about the virtual machine's secondary networks. diff --git a/virt/vm_templates/virt-creating-vm-template.adoc b/virt/vm_templates/virt-creating-vm-template.adoc index 2a28b01154..de7fdb0e1f 100644 --- a/virt/vm_templates/virt-creating-vm-template.adoc +++ b/virt/vm_templates/virt-creating-vm-template.adoc @@ -2,6 +2,7 @@ = Creating virtual machine templates include::modules/virt-document-attributes.adoc[] :context: virt-creating-vm-template + toc::[] include::modules/virt-about-vm-templates.adoc[leveloffset=+1] diff --git a/virt/vm_templates/virt-dedicated-resources-vm-template.adoc b/virt/vm_templates/virt-dedicated-resources-vm-template.adoc index 402627c951..ef8b6a5a1a 100644 --- a/virt/vm_templates/virt-dedicated-resources-vm-template.adoc +++ b/virt/vm_templates/virt-dedicated-resources-vm-template.adoc @@ -2,6 +2,7 @@ = Enabling dedicated resources for virtual machine templates include::modules/virt-document-attributes.adoc[] :context: virt-dedicated-resources-vm-template + toc::[] Virtual machines can have resources of a node, such as CPU, diff --git a/virt/vm_templates/virt-deleting-vm-template.adoc b/virt/vm_templates/virt-deleting-vm-template.adoc index 21909e77b2..550848ffb1 100644 --- a/virt/vm_templates/virt-deleting-vm-template.adoc +++ b/virt/vm_templates/virt-deleting-vm-template.adoc @@ -2,6 +2,7 @@ = Deleting a virtual machine template include::modules/virt-document-attributes.adoc[] :context: virt-deleting-vm-template + toc::[] Red Hat virtual machine templates cannot be deleted. You can use the web console to delete: diff --git a/virt/vm_templates/virt-editing-vm-template.adoc b/virt/vm_templates/virt-editing-vm-template.adoc index 2a3806e688..e31efbac8c 100644 --- a/virt/vm_templates/virt-editing-vm-template.adoc +++ b/virt/vm_templates/virt-editing-vm-template.adoc @@ -2,6 +2,7 @@ = Editing virtual machine templates include::modules/virt-document-attributes.adoc[] :context: virt-editing-vm-template + toc::[] You can update a virtual machine template in the web console, either by editing diff --git a/web_console/configuring-web-console.adoc b/web_console/configuring-web-console.adoc index 0bacad50d9..16c62b13ee 100644 --- a/web_console/configuring-web-console.adoc +++ b/web_console/configuring-web-console.adoc @@ -2,6 +2,7 @@ = Configuring the web console in {product-title} include::modules/common-attributes.adoc[] :context: configuring-web-console + toc::[] You can modify the {product-title} web console to set a logout redirect URL diff --git a/web_console/creating-quick-start-tutorials.adoc b/web_console/creating-quick-start-tutorials.adoc index ea5f652872..6ff90e628b 100644 --- a/web_console/creating-quick-start-tutorials.adoc +++ b/web_console/creating-quick-start-tutorials.adoc @@ -2,6 +2,7 @@ = Creating quick start tutorials in the web console include::modules/common-attributes.adoc[] :context: creating-quick-start-tutorials + toc::[] If you are creating quick start tutorials for the {product-title} web console, follow these guidelines to maintain a consistent user experience across all quick starts. diff --git a/web_console/customizing-the-web-console.adoc b/web_console/customizing-the-web-console.adoc index 24c7b69b1d..c8b821b3c6 100644 --- a/web_console/customizing-the-web-console.adoc +++ b/web_console/customizing-the-web-console.adoc @@ -2,6 +2,7 @@ = Customizing the web console in {product-title} include::modules/common-attributes.adoc[] :context: customizing-web-console + toc::[] You can customize the {product-title} web console to set a custom logo, diff --git a/web_console/disabling-web-console.adoc b/web_console/disabling-web-console.adoc index 3372dbc1fa..76a405cb39 100644 --- a/web_console/disabling-web-console.adoc +++ b/web_console/disabling-web-console.adoc @@ -2,6 +2,7 @@ = Disabling the web console in {product-title} include::modules/common-attributes.adoc[] :context: disabling-web-console + toc::[] You can disable the {product-title} web console. diff --git a/web_console/odc-about-developer-perspective.adoc b/web_console/odc-about-developer-perspective.adoc index 166b42178c..d4876bbb35 100644 --- a/web_console/odc-about-developer-perspective.adoc +++ b/web_console/odc-about-developer-perspective.adoc @@ -2,6 +2,7 @@ = About the Developer perspective in the web console include::modules/common-attributes.adoc[] :context: odc-about-developer-perspective + toc::[] The {product-title} web console provides two perspectives; the *Administrator* perspective and the *Developer* perspective. diff --git a/web_console/using-dashboard-to-get-cluster-information.adoc b/web_console/using-dashboard-to-get-cluster-information.adoc index 44e518320b..3360cc684d 100644 --- a/web_console/using-dashboard-to-get-cluster-information.adoc +++ b/web_console/using-dashboard-to-get-cluster-information.adoc @@ -2,6 +2,7 @@ = Using the {product-title} dashboard to get cluster information include::modules/common-attributes.adoc[] :context: using-dashboard-to-get-cluster-info + toc::[] Access the {product-title} dashboard, which captures high-level information diff --git a/web_console/web-console.adoc b/web_console/web-console.adoc index f34b06de88..ad81f98b4f 100644 --- a/web_console/web-console.adoc +++ b/web_console/web-console.adoc @@ -3,6 +3,7 @@ = Accessing the web console include::modules/common-attributes.adoc[] :context: web-console + toc::[] The {product-title} web console is a user interface accessible from a web browser. diff --git a/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc b/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc index 874d0f7d34..7f7bb9ec83 100644 --- a/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc +++ b/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc @@ -24,4 +24,4 @@ include::modules/machineset-creating.adoc[leveloffset=+1] == Additional resources -* For more information on managing machine sets, see the _Machine management_ section. \ No newline at end of file +* For more information on managing machine sets, see the _Machine management_ section. diff --git a/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.adoc b/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.adoc index 4846148bc4..fec8d1513d 100644 --- a/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.adoc +++ b/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.adoc @@ -24,4 +24,4 @@ include::modules/machineset-creating.adoc[leveloffset=+1] == Additional resources -* For more information on managing machine sets, see the _Machine management_ section. \ No newline at end of file +* For more information on managing machine sets, see the _Machine management_ section. diff --git a/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc b/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc index e2baaa355c..2b9a7b7405 100644 --- a/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc +++ b/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc @@ -33,4 +33,4 @@ include::modules/machineset-creating.adoc[leveloffset=+1] == Additional resources -* For more information on managing machine sets, see the _Machine management_ section. \ No newline at end of file +* For more information on managing machine sets, see the _Machine management_ section. diff --git a/windows_containers/enabling-windows-container-workloads.adoc b/windows_containers/enabling-windows-container-workloads.adoc index 05a27d19a4..a06f6c88dc 100644 --- a/windows_containers/enabling-windows-container-workloads.adoc +++ b/windows_containers/enabling-windows-container-workloads.adoc @@ -34,4 +34,4 @@ include::modules/configuring-secret-for-wmco.adoc[leveloffset=+1] == Additional Resources * xref:../installing/installing_azure/installing-azure-default.adoc#ssh-agent-using_installing-azure-default[Generating an SSH private key and adding it to the agent] -* xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]. \ No newline at end of file +* xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster].