diff --git a/applications/crds/crd-extending-api-with-crds.adoc b/applications/crds/crd-extending-api-with-crds.adoc index 006d189bb5..13a7ab7e2e 100644 --- a/applications/crds/crd-extending-api-with-crds.adoc +++ b/applications/crds/crd-extending-api-with-crds.adoc @@ -1,4 +1,4 @@ -[id='crd-extending-api-with-crds'] +[id="crd-extending-api-with-crds"] = Extending the Kubernetes API with Custom Resource Definitions include::modules/common-attributes.adoc[] :context: crd-extending-api-with-crds diff --git a/applications/crds/crd-managing-resources-from-crds.adoc b/applications/crds/crd-managing-resources-from-crds.adoc index 24a9d85adc..43df2fd7ee 100644 --- a/applications/crds/crd-managing-resources-from-crds.adoc +++ b/applications/crds/crd-managing-resources-from-crds.adoc @@ -1,4 +1,4 @@ -[id='crd-managing-resources-from-crds'] +[id="crd-managing-resources-from-crds"] = Managing resources from Custom Resource Definitions include::modules/common-attributes.adoc[] :context: crd-managing-resources-from-crds diff --git a/applications/deployments/deployment-strategies.adoc b/applications/deployments/deployment-strategies.adoc index 9423699fcb..cf847bc387 100644 --- a/applications/deployments/deployment-strategies.adoc +++ b/applications/deployments/deployment-strategies.adoc @@ -1,4 +1,4 @@ -[id='deployment-strategies'] +[id="deployment-strategies"] = Using DeploymentConfig strategies include::modules/common-attributes.adoc[] :context: deployment-strategies diff --git a/applications/deployments/managing-deployment-processes.adoc b/applications/deployments/managing-deployment-processes.adoc index 5a356a9cae..1fe591eb37 100644 --- a/applications/deployments/managing-deployment-processes.adoc +++ b/applications/deployments/managing-deployment-processes.adoc @@ -1,11 +1,11 @@ -[id='deployment-operations'] +[id="deployment-operations"] = Managing deployment processes include::modules/common-attributes.adoc[] :context: deployment-operations toc::[] -[id='deploymentconfig-operations'] +[id="deploymentconfig-operations"] == Managing DeploymentConfigs DeploymentConfigs can be managed from the {product-title} web console's diff --git a/applications/deployments/route-based-deployment-strategies.adoc b/applications/deployments/route-based-deployment-strategies.adoc index 7df3de811f..70907efa07 100644 --- a/applications/deployments/route-based-deployment-strategies.adoc +++ b/applications/deployments/route-based-deployment-strategies.adoc @@ -1,4 +1,4 @@ -[id='route-based-deployment-strategies'] +[id="route-based-deployment-strategies"] = Using route-based deployment strategies include::modules/common-attributes.adoc[] :context: route-based-deployment-strategies diff --git a/applications/deployments/what-deployments-are.adoc b/applications/deployments/what-deployments-are.adoc index f5d0d3692c..f5729a1f4e 100644 --- a/applications/deployments/what-deployments-are.adoc +++ b/applications/deployments/what-deployments-are.adoc @@ -1,4 +1,4 @@ -[id='what-deployments-are'] +[id="what-deployments-are"] = What Deployments and DeploymentConfigs are include::modules/common-attributes.adoc[] :context: what-deployments-are @@ -33,7 +33,7 @@ xref:../../applications/basic_deployment_operations.adoc#scaling[scaling] xref:../../dev_guide/pod_autoscaling.adoc#dev-guide-pod-autoscaling[autoscaling] //// -[id='what-deployments-are-build-blocks'] +[id="what-deployments-are-build-blocks"] == Building blocks of a deployment Deployments and DeploymentConfigs are enabled by the use of native Kubernetes diff --git a/applications/idling-applications.adoc b/applications/idling-applications.adoc index c66cd4999f..a76e677dba 100644 --- a/applications/idling-applications.adoc +++ b/applications/idling-applications.adoc @@ -1,4 +1,4 @@ -[id='idling-applications'] +[id="idling-applications"] = Idling applications include::modules/common-attributes.adoc[] :context: idling-applications diff --git a/applications/operator_sdk/osdk-ansible.adoc b/applications/operator_sdk/osdk-ansible.adoc index 9a23cbc0c2..e85227d0ff 100644 --- a/applications/operator_sdk/osdk-ansible.adoc +++ b/applications/operator_sdk/osdk-ansible.adoc @@ -1,4 +1,4 @@ -[id='osdk-ansible'] +[id="osdk-ansible"] = Creating Ansible-based Operators include::modules/common-attributes.adoc[] :context: osdk-ansible @@ -18,7 +18,7 @@ include::modules/osdk-ansible-runner-directory.adoc[leveloffset=+2] include::modules/osdk-installing-cli.adoc[leveloffset=+1] include::modules/osdk-building-ansible-operator.adoc[leveloffset=+1] -[id='osdk-ansible-k8s-module'] +[id="osdk-ansible-k8s-module"] == Managing application lifecycle using the k8s Ansible module To manage the lifecycle of your application on Kubernetes using Ansible, you @@ -41,7 +41,7 @@ include::modules/osdk-ansible-k8s-module-inside-operator.adoc[leveloffset=+2] include::modules/osdk-ansible-managing-cr-status.adoc[leveloffset=+1] -[id='osdk-ansible-addtl-resources'] +[id="osdk-ansible-addtl-resources"] == Additional resources - See diff --git a/applications/operator_sdk/osdk-appendices.adoc b/applications/operator_sdk/osdk-appendices.adoc index a8f6ac1e74..86bde1b7c8 100644 --- a/applications/operator_sdk/osdk-appendices.adoc +++ b/applications/operator_sdk/osdk-appendices.adoc @@ -1,4 +1,4 @@ -[id='operator-appendices'] +[id="operator-appendices"] = Appendices include::modules/common-attributes.adoc[] :context: operator-appendices diff --git a/applications/operator_sdk/osdk-cli-reference.adoc b/applications/operator_sdk/osdk-cli-reference.adoc index 09297635fa..9ecb073730 100644 --- a/applications/operator_sdk/osdk-cli-reference.adoc +++ b/applications/operator_sdk/osdk-cli-reference.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference'] +[id="osdk-cli-reference"] = Operator SDK CLI reference include::modules/common-attributes.adoc[] :context: osdk-cli-reference diff --git a/applications/operator_sdk/osdk-generating-csvs.adoc b/applications/operator_sdk/osdk-generating-csvs.adoc index 757fb33c99..fbd4eb0dbc 100644 --- a/applications/operator_sdk/osdk-generating-csvs.adoc +++ b/applications/operator_sdk/osdk-generating-csvs.adoc @@ -1,4 +1,4 @@ -[id='osdk-generating-csvs'] +[id="osdk-generating-csvs"] = Generating a ClusterServiceVersion (CSV) include::modules/common-attributes.adoc[] :context: osdk-generating-csvs diff --git a/applications/operator_sdk/osdk-getting-started.adoc b/applications/operator_sdk/osdk-getting-started.adoc index e9a7b0dc09..b65334a925 100644 --- a/applications/operator_sdk/osdk-getting-started.adoc +++ b/applications/operator_sdk/osdk-getting-started.adoc @@ -1,4 +1,4 @@ -[id='osdk-getting-started'] +[id="osdk-getting-started"] = Getting started with the Operator SDK include::modules/common-attributes.adoc[] :context: osdk-getting-started @@ -21,7 +21,7 @@ include::modules/osdk-installing-cli.adoc[leveloffset=+1] include::modules/building-memcached-operator-using-osdk.adoc[leveloffset=+1] include::modules/managing-memcached-operator-using-olm.adoc[leveloffset=+1] -[id='osdk-getting-started-addtl-resources'] +[id="osdk-getting-started-addtl-resources"] == Additional resources - See @@ -31,7 +31,7 @@ to learn about the project directory structures created by the Operator SDK. - link:https://operators.gitbook.io/operator-developer-guide-for-red-hat-partners/[Operator Development Guide for Red Hat Partners] ifdef::openshift-origin[] -[id='osdk-getting-started-getting-involved'] +[id="osdk-getting-started-getting-involved"] == Getting involved This guide provides an effective demonstration of the value of the Operator diff --git a/applications/operator_sdk/osdk-helm.adoc b/applications/operator_sdk/osdk-helm.adoc index 739e316ab0..f132c090f9 100644 --- a/applications/operator_sdk/osdk-helm.adoc +++ b/applications/operator_sdk/osdk-helm.adoc @@ -1,4 +1,4 @@ -[id='osdk-helm'] +[id="osdk-helm"] = Creating Helm-based Operators include::modules/common-attributes.adoc[] :context: osdk-helm @@ -13,7 +13,7 @@ include::modules/osdk-helm-chart-support.adoc[leveloffset=+1] include::modules/osdk-installing-cli.adoc[leveloffset=+1] include::modules/osdk-building-helm-operator.adoc[leveloffset=+1] -[id='osdk-helm-addtl-resources'] +[id="osdk-helm-addtl-resources"] == Additional resources - See diff --git a/applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc b/applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc index 3b5b561c59..8814d7f4c4 100644 --- a/applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc +++ b/applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc @@ -1,4 +1,4 @@ -[id='osdk-migrating-to-v0-1-0'] +[id="osdk-migrating-to-v0-1-0"] = Migrating to Operator SDK v0.1.0 include::modules/common-attributes.adoc[] :context: osdk-migrating-to-v0-1-0 diff --git a/applications/operator_sdk/osdk-monitoring-prometheus.adoc b/applications/operator_sdk/osdk-monitoring-prometheus.adoc index c00b795a81..685cb3b44b 100644 --- a/applications/operator_sdk/osdk-monitoring-prometheus.adoc +++ b/applications/operator_sdk/osdk-monitoring-prometheus.adoc @@ -1,4 +1,4 @@ -[id='osdk-monitoring-prometheus'] +[id="osdk-monitoring-prometheus"] = Configuring built-in monitoring with Prometheus include::modules/common-attributes.adoc[] :context: osdk-monitoring-prometheus diff --git a/applications/operators/olm-adding-operators-to-cluster.adoc b/applications/operators/olm-adding-operators-to-cluster.adoc index 11bd171aa6..805983db48 100644 --- a/applications/operators/olm-adding-operators-to-cluster.adoc +++ b/applications/operators/olm-adding-operators-to-cluster.adoc @@ -1,4 +1,4 @@ -[id='olm-adding-operators-to-a-cluster'] +[id="olm-adding-operators-to-a-cluster"] = Adding Operators to a cluster include::modules/common-attributes.adoc[] :context: olm-adding-operators-to-a-cluster @@ -12,7 +12,7 @@ and subscribing a cluster to Operators from the OperatorHub. include::modules/olm-operator-lifecycle-manager.adoc[leveloffset=+1] include::modules/olm-operatorhub.adoc[leveloffset=+1] -[id='olm-installing-operators-from-operatorhub-{context}'] +[id="olm-installing-operators-from-operatorhub-{context}"] == Installing Operators from the OperatorHub As a cluster administrator, you can install an Operator from the OperatorHub diff --git a/applications/operators/olm-creating-apps-from-installed-operators.adoc b/applications/operators/olm-creating-apps-from-installed-operators.adoc index 53aa4baa11..e976463881 100644 --- a/applications/operators/olm-creating-apps-from-installed-operators.adoc +++ b/applications/operators/olm-creating-apps-from-installed-operators.adoc @@ -1,4 +1,4 @@ -[id='olm-creating-apps-from-installed-operators'] +[id="olm-creating-apps-from-installed-operators"] = Creating applications from installed Operators include::modules/common-attributes.adoc[] :context: olm-creating-apps-from-installed-operators diff --git a/applications/operators/olm-what-operators-are.adoc b/applications/operators/olm-what-operators-are.adoc index 474eebbd5e..05889ef280 100644 --- a/applications/operators/olm-what-operators-are.adoc +++ b/applications/operators/olm-what-operators-are.adoc @@ -1,4 +1,4 @@ -[id='olm-what-operators-are'] +[id="olm-what-operators-are"] = What Operators are include::modules/common-attributes.adoc[] :context: olm-what-operators-are diff --git a/applications/pruning-objects.adoc b/applications/pruning-objects.adoc index 27f98a4be0..4d35973c5c 100644 --- a/applications/pruning-objects.adoc +++ b/applications/pruning-objects.adoc @@ -1,4 +1,4 @@ -[id='pruning-objects'] +[id="pruning-objects"] = Pruning objects to reclaim resources include::modules/common-attributes.adoc[] :context: pruning-objects @@ -30,5 +30,5 @@ include::modules/pruning-hard-pruning-registry.adoc[leveloffset=+1] include::modules/pruning-cronjobs.adoc[leveloffset=+1] .Additional resources - xref:../nodes/jobs/nodes-nodes-jobs.adoc#nodes-nodes-jobs_nodes-nodes-jobs[Running tasks in pods using jobs] -- xref:../applications/quotas/quotas-setting-across-multiple-projects.adoc#setting-quotas-across-multiple-projects[Resource quotas across multiple projects] +- xref:../applications/quotas/quotas-setting-across-multiple-projects.adoc[Resource quotas across multiple projects] - xref:../authentication/using-rbac.adoc#using-rbac[Using RBAC to define and apply permissions] diff --git a/applications/quotas/quotas-setting-across-multiple-projects.adoc b/applications/quotas/quotas-setting-across-multiple-projects.adoc index 6cc50d3f02..f190c5db94 100644 --- a/applications/quotas/quotas-setting-across-multiple-projects.adoc +++ b/applications/quotas/quotas-setting-across-multiple-projects.adoc @@ -1,4 +1,4 @@ -[id='setting-quotas-across-multiple-projects'] +[id="setting-quotas-across-multiple-projects"] = Resource quotas across multiple projects include::modules/common-attributes.adoc[] :context: setting-quotas-across-multiple-projects diff --git a/applications/quotas/quotas-setting-per-project.adoc b/applications/quotas/quotas-setting-per-project.adoc index cac09303df..95d9001dd2 100644 --- a/applications/quotas/quotas-setting-per-project.adoc +++ b/applications/quotas/quotas-setting-per-project.adoc @@ -1,4 +1,4 @@ -[id='quotas-setting-per-project'] +[id="quotas-setting-per-project"] = Resource quotas per project include::modules/common-attributes.adoc[] :context: quotas-setting-per-project diff --git a/applications/service_brokers/configuring-ansible-service-broker.adoc b/applications/service_brokers/configuring-ansible-service-broker.adoc index 8571f5682a..a4372d0e97 100644 --- a/applications/service_brokers/configuring-ansible-service-broker.adoc +++ b/applications/service_brokers/configuring-ansible-service-broker.adoc @@ -1,4 +1,4 @@ -[id='sb-configuring-asb'] +[id="sb-configuring-asb"] = Configuring the {asb-name} include::modules/common-attributes.adoc[] :context: sb-configuring-asb diff --git a/applications/service_brokers/installing-ansible-service-broker.adoc b/applications/service_brokers/installing-ansible-service-broker.adoc index ff85091604..7131bc3662 100644 --- a/applications/service_brokers/installing-ansible-service-broker.adoc +++ b/applications/service_brokers/installing-ansible-service-broker.adoc @@ -1,4 +1,4 @@ -[id='sb-installing-asb'] +[id="sb-installing-asb"] = Installing the {asb-name} include::modules/common-attributes.adoc[] :context: sb-installing-asb diff --git a/applications/service_brokers/installing-service-catalog.adoc b/applications/service_brokers/installing-service-catalog.adoc index 6920f6f481..ef837916a7 100644 --- a/applications/service_brokers/installing-service-catalog.adoc +++ b/applications/service_brokers/installing-service-catalog.adoc @@ -1,4 +1,4 @@ -[id='sb-installing-service-catalog'] +[id="sb-installing-service-catalog"] = Installing the service catalog include::modules/common-attributes.adoc[] :context: sb-installing-service-catalog diff --git a/applications/service_brokers/installing-template-service-broker.adoc b/applications/service_brokers/installing-template-service-broker.adoc index c464118721..dead833637 100644 --- a/applications/service_brokers/installing-template-service-broker.adoc +++ b/applications/service_brokers/installing-template-service-broker.adoc @@ -1,4 +1,4 @@ -[id='sb-installing-tsb'] +[id="sb-installing-tsb"] = Installing the template service broker include::modules/common-attributes.adoc[] :context: sb-installing-tsb diff --git a/applications/service_brokers/provisioning-service-bundle.adoc b/applications/service_brokers/provisioning-service-bundle.adoc index 3b4499451e..dbaf82f029 100644 --- a/applications/service_brokers/provisioning-service-bundle.adoc +++ b/applications/service_brokers/provisioning-service-bundle.adoc @@ -1,4 +1,4 @@ -[id='sb-provisioning-service-bundles'] +[id="sb-provisioning-service-bundles"] = Provisioning service bundles include::modules/common-attributes.adoc[] :context: sb-provisioning-service-bundles diff --git a/applications/service_brokers/provisioning-template-application.adoc b/applications/service_brokers/provisioning-template-application.adoc index 777472c67c..36c6e1f0eb 100644 --- a/applications/service_brokers/provisioning-template-application.adoc +++ b/applications/service_brokers/provisioning-template-application.adoc @@ -1,4 +1,4 @@ -[id='sb-provisioning-template-application'] +[id="sb-provisioning-template-application"] = Provisioning template applications include::modules/common-attributes.adoc[] :context: sb-provisioning-template-application diff --git a/applications/working-with-quotas.adoc b/applications/working-with-quotas.adoc index a1cae38bcb..7386b255f3 100644 --- a/applications/working-with-quotas.adoc +++ b/applications/working-with-quotas.adoc @@ -1,4 +1,4 @@ -[id='working-with-quotas'] +[id="working-with-quotas"] = Working with quotas include::modules/common-attributes.adoc[] :context: working-with-quotas diff --git a/architecture/architecture.adoc b/architecture/architecture.adoc index 81d536e6c3..3b8ddf3cf6 100644 --- a/architecture/architecture.adoc +++ b/architecture/architecture.adoc @@ -2,7 +2,7 @@ // // * n/a -[id='architecture'] +[id="architecture"] = {product-title} architecture include::modules/common-attributes.adoc[] :context: architecture @@ -31,7 +31,7 @@ include::modules/abstraction-layers.adoc[leveloffset=+2] include::modules/machine-api-overview.adoc[leveloffset=+1] -[id='observability-architecture-{context}'] +[id="observability-architecture-{context}"] == Observability [IMPORTANT] diff --git a/architecture/customizations.adoc b/architecture/customizations.adoc index ac89ff2ff1..1d6f495706 100644 --- a/architecture/customizations.adoc +++ b/architecture/customizations.adoc @@ -2,7 +2,7 @@ // // * n/a -[id='customizations'] +[id="customizations"] = Available cluster customizations include::modules/common-attributes.adoc[] :context: customizations @@ -18,7 +18,7 @@ cluster, such as the networking configuration and the identity provider. You can also deploy Custom Resources (CRs) that are based on a number of Custom Resource Definitions (CRDs) that are deployed on your cluster. -[id='configuration-resources-{context}'] +[id="configuration-resources-{context}"] == Configuration resources [cols="2a,5a",options="header"] @@ -49,7 +49,7 @@ xref:../authentication/understanding-identity-provider.adoc#understanding-identi |=== -[id='default-crds-{context}'] +[id="default-crds-{context}"] == Custom resources A number of Custom Resource Definitions (CRDs) are available for you to use to diff --git a/authentication/configuring-internal-oauth.adoc b/authentication/configuring-internal-oauth.adoc index df446b23ad..2992ff5aed 100644 --- a/authentication/configuring-internal-oauth.adoc +++ b/authentication/configuring-internal-oauth.adoc @@ -1,4 +1,4 @@ -[id='configuring-internal-oauth'] +[id="configuring-internal-oauth"] = Configuring the internal OAuth server include::modules/common-attributes.adoc[] :context: configuring-internal-oauth diff --git a/authentication/configuring-ldap-failover.adoc b/authentication/configuring-ldap-failover.adoc index fbb01bf33d..f21c87f1f1 100644 --- a/authentication/configuring-ldap-failover.adoc +++ b/authentication/configuring-ldap-failover.adoc @@ -1,4 +1,4 @@ -[id='configuring-ldap-failover'] +[id="configuring-ldap-failover"] = Configuring LDAP failover include::modules/common-attributes.adoc[] :context: sssd-ldap-failover diff --git a/authentication/configuring-user-agent.adoc b/authentication/configuring-user-agent.adoc index 559bf62443..e72c4f7abf 100644 --- a/authentication/configuring-user-agent.adoc +++ b/authentication/configuring-user-agent.adoc @@ -1,4 +1,4 @@ -[id='configuring-user-agent'] +[id="configuring-user-agent"] = Configuring the user agent include::modules/common-attributes.adoc[] :context: configuring-user-agent diff --git a/authentication/creating-project-other-user.adoc b/authentication/creating-project-other-user.adoc index 77f5480fec..107404e7e0 100644 --- a/authentication/creating-project-other-user.adoc +++ b/authentication/creating-project-other-user.adoc @@ -1,4 +1,4 @@ -[id='creating-project-other-user'] +[id="creating-project-other-user"] = Creating a project as another user include::modules/common-attributes.adoc[] :context: creating-project-other-user diff --git a/authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc b/authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc index cc9ba806e3..09ac569d2f 100644 --- a/authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc +++ b/authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='configuring-basic-authentication-identity-provider'] +[id="configuring-basic-authentication-identity-provider"] = Configuring an basic authentication identity provider include::modules/common-attributes.adoc[] :context: configuring-basic-authentication-identity-provider diff --git a/authentication/identity_providers/configuring-github-identity-provider.adoc b/authentication/identity_providers/configuring-github-identity-provider.adoc index e303d941a9..572a4959dd 100644 --- a/authentication/identity_providers/configuring-github-identity-provider.adoc +++ b/authentication/identity_providers/configuring-github-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='configuring-github-identity-provider'] +[id="configuring-github-identity-provider"] = Configuring a GitHub or GitHub Enterprise identity provider include::modules/common-attributes.adoc[] :context: configuring-github-identity-provider diff --git a/authentication/identity_providers/configuring-gitlab-identity-provider.adoc b/authentication/identity_providers/configuring-gitlab-identity-provider.adoc index 01079398d9..a06a2d832b 100644 --- a/authentication/identity_providers/configuring-gitlab-identity-provider.adoc +++ b/authentication/identity_providers/configuring-gitlab-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='configuring-gitlab-identity-provider'] +[id="configuring-gitlab-identity-provider"] = Configuring a GitLab identity provider include::modules/common-attributes.adoc[] :context: configuring-gitlab-identity-provider diff --git a/authentication/identity_providers/configuring-google-identity-provider.adoc b/authentication/identity_providers/configuring-google-identity-provider.adoc index 5212420f3d..2eb9df3b13 100644 --- a/authentication/identity_providers/configuring-google-identity-provider.adoc +++ b/authentication/identity_providers/configuring-google-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='configuring-google-identity-provider'] +[id="configuring-google-identity-provider"] = Configuring a Google identity provider include::modules/common-attributes.adoc[] :context: configuring-google-identity-provider diff --git a/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc b/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc index 4cc1a393fa..8bf2f8229c 100644 --- a/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc +++ b/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='configuring-htpasswd-identity-provider'] +[id="configuring-htpasswd-identity-provider"] = Configuring an HTPasswd identity provider include::modules/common-attributes.adoc[] :context: configuring-htpasswd-identity-provider diff --git a/authentication/identity_providers/configuring-keystone-identity-provider.adoc b/authentication/identity_providers/configuring-keystone-identity-provider.adoc index 9012fbe2d2..6caff1da9e 100644 --- a/authentication/identity_providers/configuring-keystone-identity-provider.adoc +++ b/authentication/identity_providers/configuring-keystone-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='configuring-keystone-identity-provider'] +[id="configuring-keystone-identity-provider"] = Configuring a Keystone identity provider include::modules/common-attributes.adoc[] :context: configuring-keystone-identity-provider diff --git a/authentication/identity_providers/configuring-ldap-identity-provider.adoc b/authentication/identity_providers/configuring-ldap-identity-provider.adoc index d746b92532..6d07c9b3c2 100644 --- a/authentication/identity_providers/configuring-ldap-identity-provider.adoc +++ b/authentication/identity_providers/configuring-ldap-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='configuring-ldap-identity-provider'] +[id="configuring-ldap-identity-provider"] = Configuring an LDAP identity provider include::modules/common-attributes.adoc[] :context: configuring-ldap-identity-provider diff --git a/authentication/identity_providers/configuring-oidc-identity-provider.adoc b/authentication/identity_providers/configuring-oidc-identity-provider.adoc index 12bb5c52a1..2ad5be18b0 100644 --- a/authentication/identity_providers/configuring-oidc-identity-provider.adoc +++ b/authentication/identity_providers/configuring-oidc-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='configuring-oidc-identity-provider'] +[id="configuring-oidc-identity-provider"] = Configuring a OpenID Connect identity provider include::modules/common-attributes.adoc[] :context: configuring-oidc-identity-provider diff --git a/authentication/identity_providers/configuring-request-header-identity-provider.adoc b/authentication/identity_providers/configuring-request-header-identity-provider.adoc index 43f9788b88..1e28d4f085 100644 --- a/authentication/identity_providers/configuring-request-header-identity-provider.adoc +++ b/authentication/identity_providers/configuring-request-header-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='configuring-request-header-identity-provider'] +[id="configuring-request-header-identity-provider"] = Configuring a request header identity provider include::modules/common-attributes.adoc[] :context: configuring-request-header-identity-provider diff --git a/authentication/impersonating-system-admin.adoc b/authentication/impersonating-system-admin.adoc index ea712a987c..8e5c4c2b30 100644 --- a/authentication/impersonating-system-admin.adoc +++ b/authentication/impersonating-system-admin.adoc @@ -1,4 +1,4 @@ -[id='impersonating-system-admin'] +[id="impersonating-system-admin"] = Impersonating the `system:admin` user include::modules/common-attributes.adoc[] :context: impersonating-system-admin diff --git a/authentication/managing-security-context-constraints.adoc b/authentication/managing-security-context-constraints.adoc index d4592be13a..d8fe8e4b07 100644 --- a/authentication/managing-security-context-constraints.adoc +++ b/authentication/managing-security-context-constraints.adoc @@ -1,4 +1,4 @@ -[id='managing-pod-security-policies'] +[id="managing-pod-security-policies"] = Managing Security Context Constraints include::modules/common-attributes.adoc[] :context: configuring-internal-oauth diff --git a/authentication/tokens-scoping.adoc b/authentication/tokens-scoping.adoc index 9459ce5e68..b15fffb7e0 100644 --- a/authentication/tokens-scoping.adoc +++ b/authentication/tokens-scoping.adoc @@ -1,4 +1,4 @@ -[id='tokens-scoping'] +[id="tokens-scoping"] = Scoping tokens include::modules/common-attributes.adoc[] :context: configuring-internal-oauth diff --git a/authentication/understanding-and-creating-service-accounts.adoc b/authentication/understanding-and-creating-service-accounts.adoc index 2cad4dd895..b636085130 100644 --- a/authentication/understanding-and-creating-service-accounts.adoc +++ b/authentication/understanding-and-creating-service-accounts.adoc @@ -1,4 +1,4 @@ -[id='understanding-and-creating-service-accounts'] +[id="understanding-and-creating-service-accounts"] = Understanding and creating service accounts include::modules/common-attributes.adoc[] :context: understanding-service-accounts diff --git a/authentication/understanding-authentication.adoc b/authentication/understanding-authentication.adoc index 685e4ba7a4..88ba5137a3 100644 --- a/authentication/understanding-authentication.adoc +++ b/authentication/understanding-authentication.adoc @@ -1,4 +1,4 @@ -[id='understanding-authentication'] +[id="understanding-authentication"] = Understanding authentication include::modules/common-attributes.adoc[] :context: understanding-authentication diff --git a/authentication/understanding-identity-provider.adoc b/authentication/understanding-identity-provider.adoc index fed852eb95..d52c1f895e 100644 --- a/authentication/understanding-identity-provider.adoc +++ b/authentication/understanding-identity-provider.adoc @@ -1,4 +1,4 @@ -[id='understanding-identity-provider'] +[id="understanding-identity-provider"] = Understanding identity provider configuration include::modules/common-attributes.adoc[] :context: understanding-identity-provider @@ -12,7 +12,7 @@ after you install your cluster. include::modules/identity-provider-overview.adoc[leveloffset=+1] -[id='supported-identity-providers'] +[id="supported-identity-providers"] == Supported identity providers You can configure the following types of identity providers: @@ -23,45 +23,45 @@ You can configure the following types of identity providers: |Identity provider |Description -|xref:../authentication/identity_providers/configuring-htpasswd-identity-provider.adoc#configuring-htpasswd-identity-provider[HTPasswd] +|xref:../authentication/identity_providers/configuring-htpasswd-identity-provider.adoc[HTPasswd] |Configure the `htpasswd` identity provider to validate user names and passwords against a flat file generated using link:http://httpd.apache.org/docs/2.4/programs/htpasswd.html[`htpasswd`]. -|xref:../authentication/identity_providers/configuring-keystone-identity-provider.adoc#configuring-keystone-identity-provider[Keystone] +|xref:../authentication/identity_providers/configuring-keystone-identity-provider.adoc[Keystone] |Configure the `keystone` identity provider to integrate your {product-title} cluster with Keystone to enable shared authentication with an OpenStack Keystone v3 server configured to store users in an internal database. -|xref:../authentication/identity_providers/configuring-ldap-identity-provider.adoc#configuring-ldap-identity-provider[LDAP] +|xref:../authentication/identity_providers/configuring-ldap-identity-provider.adoc[LDAP] |Configure the `ldap` identity provider to validate user names and passwords against an LDAPv3 server, using simple bind authentication. -|xref:../authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc#configuring-basic-authentication-identity-provider[Basic authentication] +|xref:../authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc[Basic authentication] |Configure a `basic-authentication` identity provider for users to log in to {product-title} with credentials validated against a remote identity provider. Basic authentication is a generic backend integration mechanism. -|xref:../authentication/identity_providers/configuring-request-header-identity-provider.adoc#configuring-request-header-identity-provider[Request header] +|xref:../authentication/identity_providers/configuring-request-header-identity-provider.adoc[Request header] |Configure a `request-header` identity provider to identify users from request header values, such as `X-Remote-User`. It is typically used in combination with an authenticating proxy, which sets the request header value. -|xref:../authentication/identity_providers/configuring-github-identity-provider.adoc#configuring-github-identity-provider[GitHub or GitHub Enterprise] +|xref:../authentication/identity_providers/configuring-github-identity-provider.adoc[GitHub or GitHub Enterprise] |Configure a `github` identity provider to validate user names and passwords against GitHub or GitHub Enterprise's OAuth authentication server. -|xref:../authentication/identity_providers/configuring-gitlab-identity-provider.adoc#configuring-gitlab-identity-provider[GitLab] +|xref:../authentication/identity_providers/configuring-gitlab-identity-provider.adoc[GitLab] |Configure a `gitlab` identity provider to use link:https://gitlab.com/[GitLab.com] or any other GitLab instance as an identity provider. -|xref:../authentication/identity_providers/configuring-google-identity-provider.adoc#configuring-google-identity-provider[Google] +|xref:../authentication/identity_providers/configuring-google-identity-provider.adoc[Google] |Configure a `google` identity provider using link:https://developers.google.com/identity/protocols/OpenIDConnect[Google's OpenID Connect integration]. -|xref:../authentication/identity_providers/configuring-oidc-identity-provider.adoc#configuring-oidc-identity-provider[OpenID Connect] +|xref:../authentication/identity_providers/configuring-oidc-identity-provider.adoc[OpenID Connect] |Configure an `oidc` identity provider to integrate with an OpenID Connect identity provider using an link:http://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth[Authorization Code Flow]. diff --git a/authentication/using-rbac.adoc b/authentication/using-rbac.adoc index 94d10b1a9b..9284be5f61 100644 --- a/authentication/using-rbac.adoc +++ b/authentication/using-rbac.adoc @@ -1,4 +1,4 @@ -[id='using-rbac'] +[id="using-rbac"] = Using RBAC to define and apply permissions include::modules/common-attributes.adoc[] :context: using-rbac diff --git a/authentication/using-service-accounts-as-oauth-client.adoc b/authentication/using-service-accounts-as-oauth-client.adoc index f35774e3ea..66a13b3dbf 100644 --- a/authentication/using-service-accounts-as-oauth-client.adoc +++ b/authentication/using-service-accounts-as-oauth-client.adoc @@ -1,4 +1,4 @@ -[id='using-service-accounts-as-oauth-client'] +[id="using-service-accounts-as-oauth-client"] = Using a service account as an OAuth client include::modules/common-attributes.adoc[] :context: using-service-accounts-as-oauth-client diff --git a/authentication/using-service-accounts-in-applications.adoc b/authentication/using-service-accounts-in-applications.adoc index fd08ee13a6..d31cd84075 100644 --- a/authentication/using-service-accounts-in-applications.adoc +++ b/authentication/using-service-accounts-in-applications.adoc @@ -1,4 +1,4 @@ -[id='using-service-accounts'] +[id="using-service-accounts"] = Using service accounts in applications include::modules/common-attributes.adoc[] :context: using-service-accounts diff --git a/builds/advanced-build-operations.adoc b/builds/advanced-build-operations.adoc index 14877f434b..37aae6d139 100644 --- a/builds/advanced-build-operations.adoc +++ b/builds/advanced-build-operations.adoc @@ -1,7 +1,7 @@ // This assembly is included in the following assemblies: // * assembly/builds -[id='advanced-build-operations'] +[id="advanced-build-operations"] = Performing advanced builds include::modules/common-attributes.adoc[] :context: advanced-build-operations diff --git a/builds/basic-build-operations.adoc b/builds/basic-build-operations.adoc index ccb0e414b4..1bc7fb9d40 100644 --- a/builds/basic-build-operations.adoc +++ b/builds/basic-build-operations.adoc @@ -1,7 +1,7 @@ // This assembly is included in the following assemblies: // * assembly/builds -[id='basic-build-operations'] +[id="basic-build-operations"] = Performing basic builds include::modules/common-attributes.adoc[] :context: basic-build-operations diff --git a/builds/build-strategies.adoc b/builds/build-strategies.adoc index 806a4de810..e6eabfed4f 100644 --- a/builds/build-strategies.adoc +++ b/builds/build-strategies.adoc @@ -3,7 +3,7 @@ //ifdef::context[:parent-context: {context}] -[id='build-strategies'] +[id="build-strategies"] = Using build strategies include::modules/common-attributes.adoc[] :context: build-strategies diff --git a/builds/custom-builds-buildah.adoc b/builds/custom-builds-buildah.adoc index 9a46ddc002..20547e8cab 100644 --- a/builds/custom-builds-buildah.adoc +++ b/builds/custom-builds-buildah.adoc @@ -1,4 +1,4 @@ -[id='custom-builds-buildah'] +[id="custom-builds-buildah"] = Adding a Docker socket to custom builds with Buildah include::modules/common-attributes.adoc[] :context: custom-builds-buildah diff --git a/builds/securing-builds-by-strategy.adoc b/builds/securing-builds-by-strategy.adoc index 8016689483..f7f5ff55b9 100644 --- a/builds/securing-builds-by-strategy.adoc +++ b/builds/securing-builds-by-strategy.adoc @@ -1,4 +1,4 @@ -[id='securing-builds-by-strategy'] +[id="securing-builds-by-strategy"] = Securing builds by strategy include::modules/common-attributes.adoc[] :context: securing-builds-by-strategy diff --git a/builds/triggering-builds-build-hooks.adoc b/builds/triggering-builds-build-hooks.adoc index d6cde13246..b32837f207 100644 --- a/builds/triggering-builds-build-hooks.adoc +++ b/builds/triggering-builds-build-hooks.adoc @@ -1,7 +1,7 @@ // This assembly is included in the following assemblies: // * assembly/builds -[id='triggering-builds-build-hooks'] +[id="triggering-builds-build-hooks"] = Triggering and modifying builds include::modules/common-attributes.adoc[] :context: triggering-builds-build-hooks diff --git a/builds/troubleshooting-builds.adoc b/builds/troubleshooting-builds.adoc index 45b20d6613..71a5fb1a5d 100644 --- a/builds/troubleshooting-builds.adoc +++ b/builds/troubleshooting-builds.adoc @@ -3,7 +3,7 @@ :context: troubleshooting-builds -[id='troubleshooting-builds-{context}'] +[id="troubleshooting-builds-{context}"] = Troubleshooting builds include::modules/common-attributes.adoc[] toc::[] diff --git a/builds/understanding-builds.adoc b/builds/understanding-builds.adoc index 3ccc5811a4..1230744eb7 100644 --- a/builds/understanding-builds.adoc +++ b/builds/understanding-builds.adoc @@ -1,4 +1,4 @@ -[id='understanding-build'] +[id="understanding-build"] = Understanding builds include::modules/common-attributes.adoc[] :context: understanding-builds diff --git a/cli_reference/administrator-cli-commands.adoc b/cli_reference/administrator-cli-commands.adoc index 5558b9ff13..f934e20370 100644 --- a/cli_reference/administrator-cli-commands.adoc +++ b/cli_reference/administrator-cli-commands.adoc @@ -1,4 +1,4 @@ -[id='cli-administrator-commands'] +[id="cli-administrator-commands"] = Administrator CLI commands include::modules/common-attributes.adoc[] :context: cli-administrator-commands diff --git a/cli_reference/configuring-cli.adoc b/cli_reference/configuring-cli.adoc index 2a2b857ea4..28ae11769b 100644 --- a/cli_reference/configuring-cli.adoc +++ b/cli_reference/configuring-cli.adoc @@ -1,4 +1,4 @@ -[id='cli-configuring-cli'] +[id="cli-configuring-cli"] = Configuring the CLI include::modules/common-attributes.adoc[] :context: cli-configuring-cli diff --git a/cli_reference/developer-cli-commands.adoc b/cli_reference/developer-cli-commands.adoc index 50bfabee3f..1fc31758e5 100644 --- a/cli_reference/developer-cli-commands.adoc +++ b/cli_reference/developer-cli-commands.adoc @@ -1,4 +1,4 @@ -[id='cli-developer-commands'] +[id="cli-developer-commands"] = Developer CLI commands include::modules/common-attributes.adoc[] :context: cli-developer-commands diff --git a/cli_reference/extending-cli-plugins.adoc b/cli_reference/extending-cli-plugins.adoc index 17c9ccadcf..10195d8489 100644 --- a/cli_reference/extending-cli-plugins.adoc +++ b/cli_reference/extending-cli-plugins.adoc @@ -1,4 +1,4 @@ -[id='cli-extend-plugins'] +[id="cli-extend-plugins"] = Extending the CLI with plug-ins include::modules/common-attributes.adoc[] :context: cli-extend-plugins diff --git a/cli_reference/getting-started-cli.adoc b/cli_reference/getting-started-cli.adoc index f9f10fe908..178d045cb5 100644 --- a/cli_reference/getting-started-cli.adoc +++ b/cli_reference/getting-started-cli.adoc @@ -1,4 +1,4 @@ -[id='cli-getting-started'] +[id="cli-getting-started"] = Getting started with the CLI include::modules/common-attributes.adoc[] :context: cli-developer-commands diff --git a/contributing_to_docs/contributing.adoc b/contributing_to_docs/contributing.adoc index 02aeac7fb8..1830edbba4 100644 --- a/contributing_to_docs/contributing.adoc +++ b/contributing_to_docs/contributing.adoc @@ -1,4 +1,4 @@ -[id='contributing-to-docs-contributing'] +[id="contributing-to-docs-contributing"] = Contribute to OpenShift documentation :icons: :toc: macro diff --git a/contributing_to_docs/create_or_edit_content.adoc b/contributing_to_docs/create_or_edit_content.adoc index c79b55ca2b..976cf41823 100644 --- a/contributing_to_docs/create_or_edit_content.adoc +++ b/contributing_to_docs/create_or_edit_content.adoc @@ -1,4 +1,4 @@ -[id='contributing-to-docs-create-or-edit-content'] +[id="contributing-to-docs-create-or-edit-content"] = Create content or edit existing content :icons: :toc: macro diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc index 55c8f5f8ed..22c90db74f 100644 --- a/contributing_to_docs/doc_guidelines.adoc +++ b/contributing_to_docs/doc_guidelines.adoc @@ -1,4 +1,4 @@ -[id='contributing-to-docs-doc-guidelines'] +[id="contributing-to-docs-doc-guidelines"] = Documentation guidelines include::modules/common-attributes.adoc @@ -10,7 +10,7 @@ Every assembly file should contain the following metadata at the top, with no li spacing in between, except where noted: ---- -[id=''] <1> +[id=""] <1> = Assembly title <2> include::modules/common-attributes.adoc[] <3> :context: <4> @@ -43,7 +43,7 @@ Every module should be placed in the modules folder and should contain the follo // // * list of assemblies where this module is included <1> -[id='-{context}'] <2> +[id="-{context}"] <2> = Module title <3> ---- @@ -60,7 +60,7 @@ Example: // // * cli_reference/developer-cli-commands.adoc -[id='cli-basic-commands-{context}'] +[id="cli-basic-commands-{context}"] = Basic CLI commands ---- @@ -68,7 +68,7 @@ Example: anchor and the section title and the anchor id should match the section title*: ---- -[id='-{context}'] +[id="-{context}"] === Section title ---- @@ -113,7 +113,7 @@ ID. For example: ---- [discrete] -[id='managing-authorization-policies-{context}'] +[id="managing-authorization-policies-{context}"] == Managing authorization policies ---- @@ -626,7 +626,7 @@ Text for admonition ==== .... -[id='api-object-formatting'] +[id="api-object-formatting"] == API object formatting Use initial capitalization and camel case for Kubernetes/OpenShift API objects @@ -641,7 +641,7 @@ concept is being referred to. For example: - Operator - DaemonSet (and not "daemon set", "daemonset", or "Daemonset") -[id='operator-name-capitalization'] +[id="operator-name-capitalization"] ==== Operator name capitalization An Operator's full name must be a proper noun, with each word initially diff --git a/contributing_to_docs/term_glossary.adoc b/contributing_to_docs/term_glossary.adoc index d55bd341eb..9c61ae7c8a 100644 --- a/contributing_to_docs/term_glossary.adoc +++ b/contributing_to_docs/term_glossary.adoc @@ -1,4 +1,4 @@ -[id='contributing-to-docs-term-glossary'] +[id="contributing-to-docs-term-glossary"] = OpenShift glossary of terms {product-author} {product-version} @@ -61,7 +61,7 @@ Usage: app(s) Acceptable when referring to a mobile or web xref:application[application]. '''' -[id='application'] +[id="application"] === application Usage: application(s) diff --git a/contributing_to_docs/tools_and_setup.adoc b/contributing_to_docs/tools_and_setup.adoc index 337f8388f7..3101934aa0 100644 --- a/contributing_to_docs/tools_and_setup.adoc +++ b/contributing_to_docs/tools_and_setup.adoc @@ -1,4 +1,4 @@ -[id='contributing-to-docs-tools-and-setup'] +[id="contributing-to-docs-tools-and-setup"] = Install and set up the tools and software :icons: :toc: macro diff --git a/installing/installing-existing-hosts.adoc b/installing/installing-existing-hosts.adoc index 66244531aa..958a5dc085 100644 --- a/installing/installing-existing-hosts.adoc +++ b/installing/installing-existing-hosts.adoc @@ -1,4 +1,4 @@ -[id='installing-existing-hosts'] +[id="installing-existing-hosts"] = Installing a cluster on existing hosts (BYO) include::modules/common-attributes.adoc[] :context: install-existing-hosts @@ -32,7 +32,7 @@ include::modules/installation-storage-requirements.adoc[leveloffset=+1] include::modules/installation-byo-cloud-requirements.adoc[leveloffset=+1] -[id='installing-BYO-other-requirements'] +[id="installing-BYO-other-requirements"] == Requirements for installing other components Other required or common {product-title} components have additional system diff --git a/installing/installing_aws/installing-aws-account.adoc b/installing/installing_aws/installing-aws-account.adoc index 3d4041a667..dd30d6119b 100644 --- a/installing/installing_aws/installing-aws-account.adoc +++ b/installing/installing_aws/installing-aws-account.adoc @@ -1,4 +1,4 @@ -[id='installing-aws-account'] +[id="installing-aws-account"] = Configuring an AWS account include::modules/common-attributes.adoc[] :context: installing-aws-account @@ -21,6 +21,6 @@ include::modules/installation-aws-regions.adoc[leveloffset=+1] .Next steps * Install a {product-title} cluster. You can -xref:../../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[install a customized cluster] -or xref:../../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[quickly install a cluster] +xref:../../installing/installing_aws/installing-aws-customizations.adoc[install a customized cluster] +or xref:../../installing/installing_aws/installing-aws-default.adoc[quickly install a cluster] with default options. diff --git a/installing/installing_aws/installing-aws-customizations.adoc b/installing/installing_aws/installing-aws-customizations.adoc index 509e6be539..ba0da9a953 100644 --- a/installing/installing_aws/installing-aws-customizations.adoc +++ b/installing/installing_aws/installing-aws-customizations.adoc @@ -1,4 +1,4 @@ -[id='installing-aws-customizations'] +[id="installing-aws-customizations"] = Installing a cluster on AWS with customizations include::modules/common-attributes.adoc[] :context: install-customizations-cloud @@ -10,7 +10,7 @@ cluster on Amazon Web Services (AWS). .Prerequisites -* xref:../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[Configure an AWS account] +* xref:../../installing/installing_aws/installing-aws-account.adoc[Configure an AWS account] to host the cluster. include::modules/installation-overview.adoc[leveloffset=+1] diff --git a/installing/installing_aws/installing-aws-default.adoc b/installing/installing_aws/installing-aws-default.adoc index dffc620691..fbfd2c7bd3 100644 --- a/installing/installing_aws/installing-aws-default.adoc +++ b/installing/installing_aws/installing-aws-default.adoc @@ -1,4 +1,4 @@ -[id='installing-aws-default'] +[id="installing-aws-default"] = Installing a cluster quickly on AWS include::modules/common-attributes.adoc[] :context: installing-aws-default @@ -10,7 +10,7 @@ Amazon Web Services (AWS) that uses the default configuration options. .Prerequisites -* xref:../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[Configure an AWS account] +* xref:../../installing/installing_aws/installing-aws-account.adoc[Configure an AWS account] to host the cluster. include::modules/installation-overview.adoc[leveloffset=+1] diff --git a/installing/installing_aws/uninstalling-cluster-aws.adoc b/installing/installing_aws/uninstalling-cluster-aws.adoc index cba53a7e1f..4870ca45dc 100644 --- a/installing/installing_aws/uninstalling-cluster-aws.adoc +++ b/installing/installing_aws/uninstalling-cluster-aws.adoc @@ -1,4 +1,4 @@ -[id='uninstalling-cluster-aws'] +[id="uninstalling-cluster-aws"] = Uninstalling a cluster on AWS include::modules/common-attributes.adoc[] :context: uninstall-cluster-aws diff --git a/installing/uninstalling-existing-hosts.adoc b/installing/uninstalling-existing-hosts.adoc index d05e5e9302..ddeb82936f 100644 --- a/installing/uninstalling-existing-hosts.adoc +++ b/installing/uninstalling-existing-hosts.adoc @@ -1,4 +1,4 @@ -[id='uninstalling-existing-hosts'] +[id="uninstalling-existing-hosts"] = Uninstalling a cluster from existing hosts include::modules/common-attributes.adoc[] :context: uninstall-existing-hosts diff --git a/logging/efk-logging-configuring.adoc b/logging/efk-logging-configuring.adoc index aeca39477a..7087af55c0 100644 --- a/logging/efk-logging-configuring.adoc +++ b/logging/efk-logging-configuring.adoc @@ -1,14 +1,14 @@ :context: efk-logging-configuring -[id='efk-logging-configuring'] +[id="efk-logging-configuring"] = Configuring cluster logging include::modules/common-attributes.adoc[] toc::[] Cluster logging is configurable using a Cluster Logging Custom Resource (CR) deployed -in the `openshift-logging` project. +in the `openshift-logging` project. -The Cluster Logging Operator watches for changes to xref:efk-logging-configuring-about-sample#efk-logging-configuring[Cluster Logging CRs], +The Cluster Logging Operator watches for changes to Cluster Logging CRs, creates any missing logging components, and adjusts the logging deployment accordingly. The Cluster Logging CR is based on the Cluster Logging Custom Resource Definition (CRD), which defines a complete cluster logging deployment diff --git a/logging/efk-logging-curator.adoc b/logging/efk-logging-curator.adoc index c9decaf8a8..ccbaa8d13a 100644 --- a/logging/efk-logging-curator.adoc +++ b/logging/efk-logging-curator.adoc @@ -1,14 +1,14 @@ :context: efk-logging-curator -[id='efk-logging-curator'] +[id="efk-logging-curator"] = Curation of Elasticsearch Data include::modules/common-attributes.adoc[] toc::[] The Elasticsearch Curator tool performs scheduled maintenance operations on a per-project basis. Curator performs actions daily based on its configuration. Only one Curator Pod is -recommended per Elasticsearch cluster. +recommended per Elasticsearch cluster. -The cluster logging installation creates a Curator configuration map, `curator` in the `openshift-logging` project, which incorporates the Curator configuration file, *_curator5.yaml_* and an {product-title} custom configuration file, *_config.yaml_*. +The cluster logging installation creates a Curator configuration map, `curator` in the `openshift-logging` project, which incorporates the Curator configuration file, *_curator5.yaml_* and an {product-title} custom configuration file, *_config.yaml_*. .Sample default Curator configuration map [source,yaml] diff --git a/logging/efk-logging-deploy.adoc b/logging/efk-logging-deploy.adoc index ea6ee02352..219633a154 100644 --- a/logging/efk-logging-deploy.adoc +++ b/logging/efk-logging-deploy.adoc @@ -1,5 +1,5 @@ :context: efk-logging-deploy -[id='efk-logging-deploy'] +[id="efk-logging-deploy"] = Deploying cluster logging include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-elasticsearch-storage.adoc b/logging/efk-logging-elasticsearch-storage.adoc index 16a9ce64c2..d8d5e6bdfa 100644 --- a/logging/efk-logging-elasticsearch-storage.adoc +++ b/logging/efk-logging-elasticsearch-storage.adoc @@ -1,4 +1,4 @@ -[id='efk-logging-elasticsearch-storage'] +[id="efk-logging-elasticsearch-storage"] = Configuring Elasticsearch storage include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-elasticsearch.adoc b/logging/efk-logging-elasticsearch.adoc index 920c9ed4df..d3a994c163 100644 --- a/logging/efk-logging-elasticsearch.adoc +++ b/logging/efk-logging-elasticsearch.adoc @@ -1,5 +1,5 @@ :context: efk-logging-elasticsearch -[id='efk-logging-elasticsearch'] +[id="efk-logging-elasticsearch"] = Configuring Elasticsearch in {product-title} include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-eventrouter.adoc b/logging/efk-logging-eventrouter.adoc index cfe92fc0aa..ba6c58d386 100644 --- a/logging/efk-logging-eventrouter.adoc +++ b/logging/efk-logging-eventrouter.adoc @@ -1,5 +1,5 @@ :context: efk-logging-curator -[id='efk-logging-eventrouter'] +[id="efk-logging-eventrouter"] = Working with Event Router in {product-title} include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-exported-fields.adoc b/logging/efk-logging-exported-fields.adoc index e60e52bfa3..58f775048e 100644 --- a/logging/efk-logging-exported-fields.adoc +++ b/logging/efk-logging-exported-fields.adoc @@ -1,5 +1,5 @@ :context: efk-logging-exported-fields -[id='efk-logging-exported-fields'] +[id="efk-logging-exported-fields"] = Exported fields include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-external.adoc b/logging/efk-logging-external.adoc index 0ac9e41ccb..c704f2e654 100644 --- a/logging/efk-logging-external.adoc +++ b/logging/efk-logging-external.adoc @@ -1,5 +1,5 @@ :context: efk-logging-external -[id='efk-logging-external'] +[id="efk-logging-external"] = Sending {product-title} logs to external devices include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-fluentd.adoc b/logging/efk-logging-fluentd.adoc index 9d488923e6..6f897e007e 100644 --- a/logging/efk-logging-fluentd.adoc +++ b/logging/efk-logging-fluentd.adoc @@ -1,5 +1,5 @@ :context: efk-logging-fluentd -[id='efk-logging-fluentd'] +[id="efk-logging-fluentd"] = Configuring Fluentd in {product-title} include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-kibana.adoc b/logging/efk-logging-kibana.adoc index b8c99f944d..382ad37162 100644 --- a/logging/efk-logging-kibana.adoc +++ b/logging/efk-logging-kibana.adoc @@ -1,5 +1,5 @@ :context: efk-logging-kibana -[id='efk-logging-kibana'] +[id="efk-logging-kibana"] = Configuring Kibana in {product-title} include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-manual-rollout.adoc b/logging/efk-logging-manual-rollout.adoc index 7b1ece841e..295791536b 100644 --- a/logging/efk-logging-manual-rollout.adoc +++ b/logging/efk-logging-manual-rollout.adoc @@ -1,5 +1,5 @@ :context: efk-logging-rollout -[id='efk-logging-rollout'] +[id="efk-logging-rollout"] = Manually rolling out Elasticsearch include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-systemd.adoc b/logging/efk-logging-systemd.adoc index 8199daef45..b9bb787073 100644 --- a/logging/efk-logging-systemd.adoc +++ b/logging/efk-logging-systemd.adoc @@ -1,5 +1,5 @@ :context: efk-logging-systemd -[id='efk-logging-systemd'] +[id="efk-logging-systemd"] = Configuring systemd-journald and rsyslog in {product-title} include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-troubleshooting.adoc b/logging/efk-logging-troubleshooting.adoc index 2a54a7ea17..3229a14221 100644 --- a/logging/efk-logging-troubleshooting.adoc +++ b/logging/efk-logging-troubleshooting.adoc @@ -1,5 +1,5 @@ :context: efk-logging-troubleshooting -[id='efk-logging-troubleshooting'] +[id="efk-logging-troubleshooting"] = Troubleshooting Kibana in {product-title} include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging-uninstall.adoc b/logging/efk-logging-uninstall.adoc index 1f544ab09b..c1581c1c72 100644 --- a/logging/efk-logging-uninstall.adoc +++ b/logging/efk-logging-uninstall.adoc @@ -1,5 +1,5 @@ :context: efk-logging-uninstall -[id='efk-logging-uninstall'] +[id="efk-logging-uninstall"] = Uninstalling Cluster Logging include::modules/common-attributes.adoc[] diff --git a/logging/efk-logging.adoc b/logging/efk-logging.adoc index 295cc4c91c..0e267da075 100644 --- a/logging/efk-logging.adoc +++ b/logging/efk-logging.adoc @@ -1,5 +1,5 @@ :context: efk-logging -[id='efk-logging'] +[id="efk-logging"] = About cluster logging and {product-title} include::modules/common-attributes.adoc[] diff --git a/machine_management/applying-autoscaling.adoc b/machine_management/applying-autoscaling.adoc index c48e50f4c6..7a5d5a10eb 100644 --- a/machine_management/applying-autoscaling.adoc +++ b/machine_management/applying-autoscaling.adoc @@ -1,4 +1,4 @@ -[id='applying-autoscaling'] +[id="applying-autoscaling"] = Applying autoscaling to a {product-title} cluster include::modules/common-attributes.adoc[] :context: applying-autoscaling @@ -13,7 +13,7 @@ include::modules/cluster-autoscaler-about.adoc[leveloffset=+1] include::modules/machine-autoscaler-about.adoc[leveloffset=+1] -[id='configuring-clusterautoscaler'] +[id="configuring-clusterautoscaler"] == Configuring the ClusterAutoscaler First, deploy the ClusterAutoscaler to manage automatic resource scaling in @@ -30,7 +30,7 @@ include::modules/cluster-autoscaler-cr.adoc[leveloffset=+2] :FeatureName: ClusterAutoscaler include::modules/deploying-resource.adoc[leveloffset=+2] -[id='configuring-machineautoscaler'] +[id="configuring-machineautoscaler"] == Configuring the MachineAutoscalers After you deploy the ClusterAutoscaler, you can diff --git a/machine_management/creating-infrastructure-machinesets.adoc b/machine_management/creating-infrastructure-machinesets.adoc index 14b36bfbb7..30d090dea9 100644 --- a/machine_management/creating-infrastructure-machinesets.adoc +++ b/machine_management/creating-infrastructure-machinesets.adoc @@ -1,4 +1,4 @@ -[id='creating-infrastructure-machinesets'] +[id="creating-infrastructure-machinesets"] = Creating infrastructure MachineSets include::modules/common-attributes.adoc[] :context: creating-infrastructure-machinesets @@ -15,7 +15,7 @@ include::modules/infrastructure-components.adoc[leveloffset=+1] include::modules/machine-api-overview.adoc[leveloffset=+1] -[id='creating-infrastructure-machinesets-production'] +[id="creating-infrastructure-machinesets-production"] == Creating infrastructure MachineSets for production environments In a production deployment, deploy at least three MachineSets to hold @@ -27,7 +27,7 @@ MachineSets for each availability zone, create at least three MachineSets. include::modules/machineset-creating.adoc[leveloffset=+2] -[id='moving-resources-to-infrastructure-machinesets'] +[id="moving-resources-to-infrastructure-machinesets"] == Moving resources to infrastructure MachineSets Some of the infrastructure resources are deployed in your cluster by default. diff --git a/machine_management/creating-machineset.adoc b/machine_management/creating-machineset.adoc index 36a99134d8..00a8957303 100644 --- a/machine_management/creating-machineset.adoc +++ b/machine_management/creating-machineset.adoc @@ -1,4 +1,4 @@ -[id='creating-machineset'] +[id="creating-machineset"] = Creating a MachineSet include::modules/common-attributes.adoc[] :context: creating-machineset diff --git a/machine_management/deploying-machine-health-checks.adoc b/machine_management/deploying-machine-health-checks.adoc index 2ff2ca9f75..cc8d2219b3 100644 --- a/machine_management/deploying-machine-health-checks.adoc +++ b/machine_management/deploying-machine-health-checks.adoc @@ -1,4 +1,4 @@ -[id='deploying-machine-health-checks'] +[id="deploying-machine-health-checks"] = Deploying machine health checks include::modules/common-attributes.adoc[] :context: deploying-machine-health-checks diff --git a/machine_management/manually-scaling-machineset.adoc b/machine_management/manually-scaling-machineset.adoc index 6f7a1b8d6c..b6ccdb5aba 100644 --- a/machine_management/manually-scaling-machineset.adoc +++ b/machine_management/manually-scaling-machineset.adoc @@ -1,4 +1,4 @@ -[id='manually-scaling-machineset'] +[id="manually-scaling-machineset"] = Manually scaling a MachineSet include::modules/common-attributes.adoc[] :context: manually-scaling-machineset diff --git a/mod_docs_guide/getting-started-modular-docs-ocp.adoc b/mod_docs_guide/getting-started-modular-docs-ocp.adoc index e4393af4de..f40f27dd59 100644 --- a/mod_docs_guide/getting-started-modular-docs-ocp.adoc +++ b/mod_docs_guide/getting-started-modular-docs-ocp.adoc @@ -1,12 +1,12 @@ // Base the file name and the ID on the assembly title. For example: // * file name: my-assembly-a.adoc -// * ID: [id='my-assembly-a'] +// * ID: [id="my-assembly-a"] // * Title: = My assembly A // Choose a context that is not too long and encapsulates what this assembly or // module is about. Context MUST be unique. -[id='getting-started-modular-docs-ocp'] +[id="getting-started-modular-docs-ocp"] = Getting started with modular docs on OpenShift include::modules/common-attributes.adoc[] :context: assembly-gsg diff --git a/mod_docs_guide/mod-docs-conventions-ocp.adoc b/mod_docs_guide/mod-docs-conventions-ocp.adoc index b7595b818a..f2d8bd9ddf 100644 --- a/mod_docs_guide/mod-docs-conventions-ocp.adoc +++ b/mod_docs_guide/mod-docs-conventions-ocp.adoc @@ -1,13 +1,13 @@ // Base the file name and the ID on the assembly title. For example: // * file name: my-assembly-a.adoc -// * ID: [id='my-assembly-a'] +// * ID: [id="my-assembly-a"] // * Title: = My assembly A // Choose a context that is not too long and encapsulates what this assembly or // module is about. Context MUST be unique. -[id='mod-docs-ocp-references'] +[id="mod-docs-ocp-references"] = Modular docs OpenShift conventions include::modules/common-attributes.adoc[] :context: assembly-ocp-conventions diff --git a/modules/abstraction-layers.adoc b/modules/abstraction-layers.adoc index b5cb27c6b6..7d5c904e25 100644 --- a/modules/abstraction-layers.adoc +++ b/modules/abstraction-layers.adoc @@ -2,7 +2,7 @@ // // * architecture/architecture.adoc -[id='abstraction-layers-{context}'] +[id="abstraction-layers-{context}"] = {product-title} abstraction layers The container service provides the abstraction for packaging and creating diff --git a/modules/accessing-an-example-cluster-node-tuning-operator-specification.adoc b/modules/accessing-an-example-cluster-node-tuning-operator-specification.adoc index 833e94d8d0..9a5b6a4c20 100644 --- a/modules/accessing-an-example-cluster-node-tuning-operator-specification.adoc +++ b/modules/accessing-an-example-cluster-node-tuning-operator-specification.adoc @@ -2,7 +2,7 @@ // // * scalability_and_performance/using-node-tuning-operator.adoc -[id='accessing-an-example-node-tuning-operator-specification-{context}'] +[id="accessing-an-example-node-tuning-operator-specification-{context}"] = Accessing an example Node Tuning Operator specification Use this process to access an example Node Tuning Operator specification. diff --git a/modules/adding-new-devices.adoc b/modules/adding-new-devices.adoc index 6c2da5f3ce..3199262dc2 100644 --- a/modules/adding-new-devices.adoc +++ b/modules/adding-new-devices.adoc @@ -1,4 +1,4 @@ -[id='adding-new-devices-{context}'] +[id="adding-new-devices-{context}"] = Adding new devices Adding a new device is semi-automatic. The provisioner periodically checks for new mounts in configured directories. Administrators must create a new subdirectory, mount a device, and allow Pods to use the device by applying the SELinux label, for example: diff --git a/modules/adding-to-a-project.adoc b/modules/adding-to-a-project.adoc index f801e00570..ef12e9d55e 100644 --- a/modules/adding-to-a-project.adoc +++ b/modules/adding-to-a-project.adoc @@ -2,7 +2,7 @@ // // web-console/working-with-projects.adoc -[id='adding-to-a-project-{context}'] +[id="adding-to-a-project-{context}"] = Adding to a project .Procedure diff --git a/modules/annotating-a-route-with-a-cookie-name.adoc b/modules/annotating-a-route-with-a-cookie-name.adoc index c59f43695f..05fe6705eb 100644 --- a/modules/annotating-a-route-with-a-cookie-name.adoc +++ b/modules/annotating-a-route-with-a-cookie-name.adoc @@ -2,7 +2,7 @@ // // *using-cookies-to-keep-route-statefulness -[id='annotating-a-route-with-a-cookie-{context}'] +[id="annotating-a-route-with-a-cookie-{context}"] = Annotating a route with a cookie You can set a cookie name to overwrite the default, auto-generated one for the diff --git a/modules/architecture-new-content.adoc b/modules/architecture-new-content.adoc index 626c970cf5..0e8169050d 100644 --- a/modules/architecture-new-content.adoc +++ b/modules/architecture-new-content.adoc @@ -2,7 +2,7 @@ // // * architecture/architecture.adoc -[id='architecture-updates-{context}'] +[id="architecture-updates-{context}"] = Additional architecture content //Please add additional architecture content for the 4.0 release to this file. diff --git a/modules/architecture-overview.adoc b/modules/architecture-overview.adoc index bd5d037265..b4cb1f62da 100644 --- a/modules/architecture-overview.adoc +++ b/modules/architecture-overview.adoc @@ -2,7 +2,7 @@ // // * architecture/architecture.adoc -[id='architecture-overview-{context}'] +[id="architecture-overview-{context}"] = Architecture overview With {product-title} 4, the core story remains unchanged: {product-title} offers diff --git a/modules/authentication-api-impersonation.adoc b/modules/authentication-api-impersonation.adoc index 920c0e8ea5..ac8ef1d28a 100644 --- a/modules/authentication-api-impersonation.adoc +++ b/modules/authentication-api-impersonation.adoc @@ -4,7 +4,7 @@ // * users_and_roles/creating-project-other-user.adoc // * users_and_roles/impersonating-system-admin.adoc -[id='authentication-api-impersonation-{context}'] +[id="authentication-api-impersonation-{context}"] = API impersonation A request to the {product-title} API can include an `Impersonate-User` header, which indicates that the requester wants the request handled as though diff --git a/modules/authentication-prometheus-system-metrics.adoc b/modules/authentication-prometheus-system-metrics.adoc index 57fc1f5343..665e2b75bf 100644 --- a/modules/authentication-prometheus-system-metrics.adoc +++ b/modules/authentication-prometheus-system-metrics.adoc @@ -2,7 +2,7 @@ // // * authentication/understanding-authentication.adoc -[id='authentication-prometheus-system-metrics-{context}'] +[id="authentication-prometheus-system-metrics-{context}"] = Authentication metrics for Prometheus {product-title} captures the following Prometheus system metrics during authentication attempts: diff --git a/modules/available-persistent-storage-options.adoc b/modules/available-persistent-storage-options.adoc index 09e854c546..42ea2790a4 100644 --- a/modules/available-persistent-storage-options.adoc +++ b/modules/available-persistent-storage-options.adoc @@ -2,7 +2,7 @@ // // * storage/optimizing-storage.adoc -[id='available-persistent-storage-options-{context}'] +[id="available-persistent-storage-options-{context}"] = Available persistent storage options Understand your persistent storage options so that you can optimize your diff --git a/modules/baseline-router-performance.adoc b/modules/baseline-router-performance.adoc index bdb74d4f1f..0e994ae2ba 100644 --- a/modules/baseline-router-performance.adoc +++ b/modules/baseline-router-performance.adoc @@ -1,4 +1,4 @@ -[id='baseline-router-performance-{context}'] +[id="baseline-router-performance-{context}"] = Baseline router performance The {product-title} router is the ingress point for all external traffic diff --git a/modules/building-memcached-operator-using-osdk.adoc b/modules/building-memcached-operator-using-osdk.adoc index e7c296e0db..fbdecfac63 100644 --- a/modules/building-memcached-operator-using-osdk.adoc +++ b/modules/building-memcached-operator-using-osdk.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-getting-started.adoc -[id='building-memcached-operator-using-osdk-{context}'] +[id="building-memcached-operator-using-osdk-{context}"] = Building a Go-based Memcached Operator using the Operator SDK The Operator SDK makes it easier to build Kubernetes native applications, a @@ -150,7 +150,7 @@ return reconcile.Result{}, err // Requeue for any reason other than error return reconcile.Result{Requeue: true}, nil ---- -[id='building-memcached-operator-using-osdk-build-and-run-{context}'] +[id="building-memcached-operator-using-osdk-build-and-run-{context}"] . *Build and run the Operator.* diff --git a/modules/builds-about.adoc b/modules/builds-about.adoc index 33ba78d449..cc3568a66a 100644 --- a/modules/builds-about.adoc +++ b/modules/builds-about.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-about-{context}'] +[id="builds-about-{context}"] = Builds A _build_ is the process of transforming input parameters into a resulting diff --git a/modules/builds-adding-input-secrets-configmaps.adoc b/modules/builds-adding-input-secrets-configmaps.adoc index 24c083bf4b..fda9fc94d0 100644 --- a/modules/builds-adding-input-secrets-configmaps.adoc +++ b/modules/builds-adding-input-secrets-configmaps.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-adding-input-secrets-configmaps.adoc[leveloffset=+1] -[id='builds-adding-input-secrets-configmaps-{context}'] +[id="builds-adding-input-secrets-configmaps-{context}"] = Adding input secrets and ConfigMaps In some scenarios, build operations require credentials or other configuration diff --git a/modules/builds-adding-source-clone-secrets.adoc b/modules/builds-adding-source-clone-secrets.adoc index 9efcd9038c..8a9199549c 100644 --- a/modules/builds-adding-source-clone-secrets.adoc +++ b/modules/builds-adding-source-clone-secrets.adoc @@ -3,7 +3,7 @@ //* assembly/builds //* builds/creating-build-inputs.adoc -[id='adding-source-clone-secrets-{context}'] +[id="adding-source-clone-secrets-{context}"] = Adding Source Clone Secrets Builder Pods require access to any Git repositories defined as source for a diff --git a/modules/builds-assigning-builds-to-nodes.adoc b/modules/builds-assigning-builds-to-nodes.adoc index 8fb6238f10..3a1075ccfb 100644 --- a/modules/builds-assigning-builds-to-nodes.adoc +++ b/modules/builds-assigning-builds-to-nodes.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-assigning-builds-to-nodes-{context}'] +[id="builds-assigning-builds-to-nodes-{context}"] = Assigning builds to specific nodes Builds can be targeted to run on specific nodes by specifying labels in the diff --git a/modules/builds-automatically-add-source-clone-secrets.adoc b/modules/builds-automatically-add-source-clone-secrets.adoc index 9cb640be33..c834e9310b 100644 --- a/modules/builds-automatically-add-source-clone-secrets.adoc +++ b/modules/builds-automatically-add-source-clone-secrets.adoc @@ -6,7 +6,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-automatically-add-source-clone-secrets.adoc[leveloffset=+1] -[id='build-auto-add-source-clone-secrets-{context}'] +[id="build-auto-add-source-clone-secrets-{context}"] = Automatically Adding a Source Clone Secret to a Build Configuration When a `BuildConfig` is created, {product-title} can automatically populate its diff --git a/modules/builds-basic-access-build-logs.adoc b/modules/builds-basic-access-build-logs.adoc index 3c3e776f2f..1595e0f1b9 100644 --- a/modules/builds-basic-access-build-logs.adoc +++ b/modules/builds-basic-access-build-logs.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-access-build-logs-{context}'] +[id="builds-basic-access-build-logs-{context}"] = Accessing build logs You can access build logs using the web console or the CLI. diff --git a/modules/builds-basic-access-build-verbosity.adoc b/modules/builds-basic-access-build-verbosity.adoc index ec3078ca6c..8494280a28 100644 --- a/modules/builds-basic-access-build-verbosity.adoc +++ b/modules/builds-basic-access-build-verbosity.adoc @@ -2,7 +2,7 @@ // * assembly/builds // * builds/basic-build-operations.adoc -[id='builds-basic-access-build-verbosity-{context}'] +[id="builds-basic-access-build-verbosity-{context}"] = Enabling log verbosity You can enable a more verbose output by passing the `BUILD_LOGLEVEL` environment diff --git a/modules/builds-basic-access-buildconfig-logs.adoc b/modules/builds-basic-access-buildconfig-logs.adoc index 392e87855c..a1abed34b5 100644 --- a/modules/builds-basic-access-buildconfig-logs.adoc +++ b/modules/builds-basic-access-buildconfig-logs.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-access-buildconfig-logs-{context}'] +[id="builds-basic-access-buildconfig-logs-{context}"] = Accessing BuildConfig logs You can access BuildConfig logs using the web console or the CLI. diff --git a/modules/builds-basic-access-buildconfig-version-logs.adoc b/modules/builds-basic-access-buildconfig-version-logs.adoc index 35c4fd9a1f..5f11d81e23 100644 --- a/modules/builds-basic-access-buildconfig-version-logs.adoc +++ b/modules/builds-basic-access-buildconfig-version-logs.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-access-buildconfig-version-logs-{context}'] +[id="builds-basic-access-buildconfig-version-logs-{context}"] = Accessing BuildConfig logs for a given version build You can access logs for a given version build for a BuildConfig using the web diff --git a/modules/builds-basic-cancel-all-state.adoc b/modules/builds-basic-cancel-all-state.adoc index 87213009c5..345ec86a01 100644 --- a/modules/builds-basic-cancel-all-state.adoc +++ b/modules/builds-basic-cancel-all-state.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-cancel-all-state-{context}'] +[id="builds-basic-cancel-all-state-{context}"] = Canceling all builds in a given state You can cancel all builds in a given state (for example, *new* or *pending*), diff --git a/modules/builds-basic-cancel-all.adoc b/modules/builds-basic-cancel-all.adoc index 3f95f10df9..c3d41d2dfc 100644 --- a/modules/builds-basic-cancel-all.adoc +++ b/modules/builds-basic-cancel-all.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-cancel-all-{context}'] +[id="builds-basic-cancel-all-{context}"] = Canceling all builds You can cancel all builds from the build configuration with the following CLI diff --git a/modules/builds-basic-cancel-build.adoc b/modules/builds-basic-cancel-build.adoc index a128fdd6bc..b7eeba6b44 100644 --- a/modules/builds-basic-cancel-build.adoc +++ b/modules/builds-basic-cancel-build.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-cancel-build-{context}'] +[id="builds-basic-cancel-build-{context}"] = Canceling a build You can cancel a build using the web console, or with the following CLI command. diff --git a/modules/builds-basic-cancel-multiple.adoc b/modules/builds-basic-cancel-multiple.adoc index 4cd2fa981b..26ed391030 100644 --- a/modules/builds-basic-cancel-multiple.adoc +++ b/modules/builds-basic-cancel-multiple.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-cancel-multiple-{context}'] +[id="builds-basic-cancel-multiple-{context}"] = Canceling multiple builds You can cancel multiple builds with the following CLI command. diff --git a/modules/builds-basic-delete-buildconfig.adoc b/modules/builds-basic-delete-buildconfig.adoc index 3c2eb3747d..c4e6bf6f74 100644 --- a/modules/builds-basic-delete-buildconfig.adoc +++ b/modules/builds-basic-delete-buildconfig.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-delete-buildconfig-{context}'] +[id="builds-basic-delete-buildconfig-{context}"] = Deleting a BuildConfig You can delete a `BuildConfig` using the following command. diff --git a/modules/builds-basic-start-build.adoc b/modules/builds-basic-start-build.adoc index d8f2d69c46..7d827fc6a4 100644 --- a/modules/builds-basic-start-build.adoc +++ b/modules/builds-basic-start-build.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-start-build-{context}'] +[id="builds-basic-start-build-{context}"] = Starting a build You can manually start a new build from an existing build configuration in your diff --git a/modules/builds-basic-start-environment-variable.adoc b/modules/builds-basic-start-environment-variable.adoc index 279d9d38ce..79e6ddaaf3 100644 --- a/modules/builds-basic-start-environment-variable.adoc +++ b/modules/builds-basic-start-environment-variable.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-start-environment-variable-{context}'] +[id="builds-basic-start-environment-variable-{context}"] = Setting environment variables when starting a build You can specify the `--env` flag to set any desired environment variable for the diff --git a/modules/builds-basic-start-logs.adoc b/modules/builds-basic-start-logs.adoc index bf2c7ab66c..2a3ff39550 100644 --- a/modules/builds-basic-start-logs.adoc +++ b/modules/builds-basic-start-logs.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-start-logs-{context}'] +[id="builds-basic-start-logs-{context}"] = Streaming build logs You can specify the `--follow` flag to stream the build's logs in stdout. diff --git a/modules/builds-basic-start-re-run.adoc b/modules/builds-basic-start-re-run.adoc index 9b4a21c217..63cf8e5ee7 100644 --- a/modules/builds-basic-start-re-run.adoc +++ b/modules/builds-basic-start-re-run.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-start-re-run-{context}'] +[id="builds-basic-start-re-run-{context}"] = Re-running a build You can manually re-run a build using the `--from-build` flag. diff --git a/modules/builds-basic-start-source.adoc b/modules/builds-basic-start-source.adoc index 74be0bfd0a..65d71686b4 100644 --- a/modules/builds-basic-start-source.adoc +++ b/modules/builds-basic-start-source.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-start-source-{context}'] +[id="builds-basic-start-source-{context}"] = Starting a build with source Rather than relying on a Git source pull diff --git a/modules/builds-basic-view-build-details.adoc b/modules/builds-basic-view-build-details.adoc index 95a0dec07b..57df404649 100644 --- a/modules/builds-basic-view-build-details.adoc +++ b/modules/builds-basic-view-build-details.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-basic-view-build-details-{context}'] +[id="builds-basic-view-build-details-{context}"] = Viewing build details You can view build details with the web console or by using the `oc describe` diff --git a/modules/builds-binary-source.adoc b/modules/builds-binary-source.adoc index 0609c4e7e2..b3455db394 100644 --- a/modules/builds-binary-source.adoc +++ b/modules/builds-binary-source.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-binary-source.adoc[leveloffset=+1] -[id='builds-binary-source-{context}'] +[id="builds-binary-source-{context}"] = Binary (local) source Streaming content from a local file system to the builder is diff --git a/modules/builds-build-custom-builder-image.adoc b/modules/builds-build-custom-builder-image.adoc index 1b027d3170..a5b643d6e4 100644 --- a/modules/builds-build-custom-builder-image.adoc +++ b/modules/builds-build-custom-builder-image.adoc @@ -4,7 +4,7 @@ // * builds/custom-builds-buildah.adoc -[id='builds-build-custom-builder-image-{context}'] +[id="builds-build-custom-builder-image-{context}"] = Build custom builder image You can use {product-title} to build and push custom builder images to use in diff --git a/modules/builds-build-environment.adoc b/modules/builds-build-environment.adoc index 646e88cc21..9f177e38a0 100644 --- a/modules/builds-build-environment.adoc +++ b/modules/builds-build-environment.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-build-environment-{context}'] +[id="builds-build-environment-{context}"] = Build environments As with pod environment variables, build environment variables can be defined in diff --git a/modules/builds-build-hooks.adoc b/modules/builds-build-hooks.adoc index 5c9a3e4bb8..f5be6f970a 100644 --- a/modules/builds-build-hooks.adoc +++ b/modules/builds-build-hooks.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-build-hooks-{context}'] +[id="builds-build-hooks-{context}"] = Build hooks Build hooks allow behavior to be injected into the build process. diff --git a/modules/builds-build-pruning.adoc b/modules/builds-build-pruning.adoc index f5245bf533..3ef6861bf7 100644 --- a/modules/builds-build-pruning.adoc +++ b/modules/builds-build-pruning.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-build-pruning-{context}'] +[id="builds-build-pruning-{context}"] = Pruning builds By default, builds that have completed their lifecycle are persisted diff --git a/modules/builds-build-run-policy.adoc b/modules/builds-build-run-policy.adoc index 96ad00d131..46979bc503 100644 --- a/modules/builds-build-run-policy.adoc +++ b/modules/builds-build-run-policy.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-build-run-policy-{context}'] +[id="builds-build-run-policy-{context}"] = Build run policy The build run policy describes the order in which the builds created from the diff --git a/modules/builds-buildconfig.adoc b/modules/builds-buildconfig.adoc index 9758ea5cc6..457cb58006 100644 --- a/modules/builds-buildconfig.adoc +++ b/modules/builds-buildconfig.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-buildconfig-{context}'] +[id="builds-buildconfig-{context}"] = BuildConfigs A build configuration describes a single build definition and a set of diff --git a/modules/builds-chaining-builds.adoc b/modules/builds-chaining-builds.adoc index 247ec356aa..c1bc4cb78b 100644 --- a/modules/builds-chaining-builds.adoc +++ b/modules/builds-chaining-builds.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-chaining-builds-{context}'] +[id="builds-chaining-builds-{context}"] = Chained builds For compiled languages (such as Go, C, C++, and Java), including the dependencies diff --git a/modules/builds-configuration-change-triggers.adoc b/modules/builds-configuration-change-triggers.adoc index 85be968469..da05edd346 100644 --- a/modules/builds-configuration-change-triggers.adoc +++ b/modules/builds-configuration-change-triggers.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-configuration-change-triggers-{context}'] +[id="builds-configuration-change-triggers-{context}"] = Configuration change triggers A configuration change trigger allows a build to be automatically invoked as diff --git a/modules/builds-configuring-post-commit-build-hooks.adoc b/modules/builds-configuring-post-commit-build-hooks.adoc index c3bd96e85b..0eb99c4b46 100644 --- a/modules/builds-configuring-post-commit-build-hooks.adoc +++ b/modules/builds-configuring-post-commit-build-hooks.adoc @@ -3,7 +3,7 @@ // * assembly/builds // * builds/triggering-builds-build-hooks.adoc -[id='builds-configuring-post-commit-build-hooks-{context}'] +[id="builds-configuring-post-commit-build-hooks-{context}"] = Configuring post commit build hooks There are different ways to configure the post build hook. All forms in the diff --git a/modules/builds-create-custom-build-artifacts.adoc b/modules/builds-create-custom-build-artifacts.adoc index b8945fd1ee..65eaf21a84 100644 --- a/modules/builds-create-custom-build-artifacts.adoc +++ b/modules/builds-create-custom-build-artifacts.adoc @@ -4,7 +4,7 @@ // * builds/custom-builds-buildah.adoc -[id='builds-create-custom-build-artifacts-{context}'] +[id="builds-create-custom-build-artifacts-{context}"] = Creating custom build artifacts You need to create the image you want to use as your custom build image. diff --git a/modules/builds-creating-secrets.adoc b/modules/builds-creating-secrets.adoc index 1b278e9f74..35a11c2982 100644 --- a/modules/builds-creating-secrets.adoc +++ b/modules/builds-creating-secrets.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-creating-secrets-{context}'] +[id="builds-creating-secrets-{context}"] = Creating secrets You must create a secret before creating the pods that depend on that secret. diff --git a/modules/builds-custom-strategy.adoc b/modules/builds-custom-strategy.adoc index 5e8b2f768b..a81240c05b 100644 --- a/modules/builds-custom-strategy.adoc +++ b/modules/builds-custom-strategy.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-custom-strategy.adoc[leveloffset=+1] -[id='builds-custom-strategy-{context}'] +[id="builds-custom-strategy-{context}"] = Custom strategy //[NOTE] diff --git a/modules/builds-disabling-build-strategy-globally.adoc b/modules/builds-disabling-build-strategy-globally.adoc index 1ca33d4dc2..474c612f9e 100644 --- a/modules/builds-disabling-build-strategy-globally.adoc +++ b/modules/builds-disabling-build-strategy-globally.adoc @@ -4,7 +4,7 @@ // * builds/securing-builds-by-strategy.adoc -[id='builds-disabling-build-strategy-globally-{context}'] +[id="builds-disabling-build-strategy-globally-{context}"] = Disabling access to a build strategy globally To prevent access to a particular build strategy globally, log in as a user with diff --git a/modules/builds-displaying-webhook-urls.adoc b/modules/builds-displaying-webhook-urls.adoc index eff5978db2..b74fea3710 100644 --- a/modules/builds-displaying-webhook-urls.adoc +++ b/modules/builds-displaying-webhook-urls.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-displaying-webhook-urls-{context}'] +[id="builds-displaying-webhook-urls-{context}"] = Displaying webhook URLs You can use the following command to display webhook URLs associated with a diff --git a/modules/builds-docker-credentials-private-registries.adoc b/modules/builds-docker-credentials-private-registries.adoc index ed4a11c164..65e1f5aa8d 100644 --- a/modules/builds-docker-credentials-private-registries.adoc +++ b/modules/builds-docker-credentials-private-registries.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-docker-credentials-private-registries.adoc[leveloffset=+1] -[id='builds-docker-credentials-private-registries-{context}'] +[id="builds-docker-credentials-private-registries-{context}"] = Using Docker credentials for private registries You can supply builds with a *_.docker/config.json_* file with valid credentials diff --git a/modules/builds-docker-source-build-output.adoc b/modules/builds-docker-source-build-output.adoc index 1bb99d8f61..29df01ee3b 100644 --- a/modules/builds-docker-source-build-output.adoc +++ b/modules/builds-docker-source-build-output.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-docker-source-build-output-{context}'] +[id="builds-docker-source-build-output-{context}"] = Build output Builds that use the diff --git a/modules/builds-docker-strategy.adoc b/modules/builds-docker-strategy.adoc index daf087396b..2852bddb7b 100644 --- a/modules/builds-docker-strategy.adoc +++ b/modules/builds-docker-strategy.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-docker-strategy.adoc[leveloffset=+1] -[id='builds-docker-strategy-{context}'] +[id="builds-docker-strategy-{context}"] = Docker strategy //[NOTE] diff --git a/modules/builds-gitconfig-file-secured-git.adoc b/modules/builds-gitconfig-file-secured-git.adoc index 88040cc84a..08472cc85e 100644 --- a/modules/builds-gitconfig-file-secured-git.adoc +++ b/modules/builds-gitconfig-file-secured-git.adoc @@ -6,7 +6,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-gitconfig-file-secured-git.adoc[leveloffset=+1] -[id='source-secrets-gitconfig-file-for-secured-git-{context}'] +[id="source-secrets-gitconfig-file-for-secured-git-{context}"] = Creating a secret from a .gitconfig file for secured Git If your Git server is secured with two-way SSL and user name with password, diff --git a/modules/builds-gitconfig-file.adoc b/modules/builds-gitconfig-file.adoc index 04958ccbe3..353b436945 100644 --- a/modules/builds-gitconfig-file.adoc +++ b/modules/builds-gitconfig-file.adoc @@ -6,7 +6,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-gitconfig-file.adoc[leveloffset=+1] -[id='source-secrets-gitconfig-file-{context}'] +[id="source-secrets-gitconfig-file-{context}"] = Creating a secret from a .gitconfig file If the cloning of your application is dependent on a *_.gitconfig_* file, diff --git a/modules/builds-input-secrets-configmaps.adoc b/modules/builds-input-secrets-configmaps.adoc index 94b9dfe3ec..6db6286502 100644 --- a/modules/builds-input-secrets-configmaps.adoc +++ b/modules/builds-input-secrets-configmaps.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-input-secrets-configmaps.adoc[leveloffset=+1] -[id='builds-input-secrets-configmaps-{context}'] +[id="builds-input-secrets-configmaps-{context}"] = Input Secrets and ConfigMaps In some scenarios, build operations require credentials or other configuration diff --git a/modules/builds-manually-add-source-clone-secrets.adoc b/modules/builds-manually-add-source-clone-secrets.adoc index 0c0805fdc8..9d8e7d67b7 100644 --- a/modules/builds-manually-add-source-clone-secrets.adoc +++ b/modules/builds-manually-add-source-clone-secrets.adoc @@ -6,7 +6,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-manually-add-source-clone-secrets.adoc[leveloffset=+1] -[id='manually-add-source-clone-secrets-{context}'] +[id="manually-add-source-clone-secrets-{context}"] = Manually Adding a Source Clone Secrets Source clone secrets can be added manually to a build configuration by adding a `sourceSecret` field to the `source` section inside the `BuildConfig` and diff --git a/modules/builds-output-image-digest.adoc b/modules/builds-output-image-digest.adoc index ef93e63395..f5e3e10658 100644 --- a/modules/builds-output-image-digest.adoc +++ b/modules/builds-output-image-digest.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-output-image-digest-{context}'] +[id="builds-output-image-digest-{context}"] = Output image digest Built images can be uniquely identified by their digest, which can diff --git a/modules/builds-output-image-environment-variables.adoc b/modules/builds-output-image-environment-variables.adoc index efcdeee8c3..a3120c6289 100644 --- a/modules/builds-output-image-environment-variables.adoc +++ b/modules/builds-output-image-environment-variables.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-output-image-environment-variables-{context}'] +[id="builds-output-image-environment-variables-{context}"] = Output image environment variables ifdef::openshift-enterprise,openshift-origin,openshift-dedicated[] diff --git a/modules/builds-output-image-labels.adoc b/modules/builds-output-image-labels.adoc index 40c7b10740..03395eeb5a 100644 --- a/modules/builds-output-image-labels.adoc +++ b/modules/builds-output-image-labels.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-output-image-labels-{context}'] +[id="builds-output-image-labels-{context}"] = Output image labels ifdef::openshift-enterprise,openshift-origin,openshift-dedicated[] diff --git a/modules/builds-restricting-build-strategy-globally.adoc b/modules/builds-restricting-build-strategy-globally.adoc index 172e43f23e..d8ea2c4f7c 100644 --- a/modules/builds-restricting-build-strategy-globally.adoc +++ b/modules/builds-restricting-build-strategy-globally.adoc @@ -4,7 +4,7 @@ // * builds/securing-builds-by-strategy.adoc -[id='builds-restricting-build-strategy-globally-{context}'] +[id="builds-restricting-build-strategy-globally-{context}"] = Restricting build strategies to users globally You can allow a set of specific users to create builds with a particular diff --git a/modules/builds-restricting-build-strategy-to-user.adoc b/modules/builds-restricting-build-strategy-to-user.adoc index ba9749a8c1..3c301107db 100644 --- a/modules/builds-restricting-build-strategy-to-user.adoc +++ b/modules/builds-restricting-build-strategy-to-user.adoc @@ -4,7 +4,7 @@ // * builds/securing-builds-by-strategy.adoc -[id='builds-restricting-build-strategy-to-user-{context}'] +[id="builds-restricting-build-strategy-to-user-{context}"] = Restricting build strategies to a user within a project Similar to granting the build strategy role to a user globally, you can allow diff --git a/modules/builds-secrets-overview.adoc b/modules/builds-secrets-overview.adoc index 2c8195defa..a79ac18568 100644 --- a/modules/builds-secrets-overview.adoc +++ b/modules/builds-secrets-overview.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-secrets-overview-{context}'] +[id="builds-secrets-overview-{context}"] = What is a secret? The `Secret` object type provides a mechanism to hold sensitive information such diff --git a/modules/builds-secrets-restrictions.adoc b/modules/builds-secrets-restrictions.adoc index 01ddf51915..0f8aed17ef 100644 --- a/modules/builds-secrets-restrictions.adoc +++ b/modules/builds-secrets-restrictions.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-secrets-restrictions-{context}'] +[id="builds-secrets-restrictions-{context}"] = Secrets restrictions To use a secret, a pod needs to reference the secret. A secret can be used with diff --git a/modules/builds-service-serving-certificate-secrets.adoc b/modules/builds-service-serving-certificate-secrets.adoc index 6b90242609..3586f37bfe 100644 --- a/modules/builds-service-serving-certificate-secrets.adoc +++ b/modules/builds-service-serving-certificate-secrets.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-service-serving-certificate-secrets-{context}'] +[id="builds-service-serving-certificate-secrets-{context}"] = Service serving certificate secrets Service serving certificate secrets are intended to support complex middleware diff --git a/modules/builds-setting-build-resources.adoc b/modules/builds-setting-build-resources.adoc index ebe21381ba..0e66e8f6b4 100644 --- a/modules/builds-setting-build-resources.adoc +++ b/modules/builds-setting-build-resources.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-setting-build-resources-{context}'] +[id="builds-setting-build-resources-{context}"] = Setting build resources By default, builds are completed by pods using unbound resources, such as memory diff --git a/modules/builds-setting-maximum-duration.adoc b/modules/builds-setting-maximum-duration.adoc index d1b20b9e7a..1b3eb73675 100644 --- a/modules/builds-setting-maximum-duration.adoc +++ b/modules/builds-setting-maximum-duration.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-setting-maximum-duration-{context}'] +[id="builds-setting-maximum-duration-{context}"] = Setting maximum duration When defining a `BuildConfig`, you can define its maximum duration by setting diff --git a/modules/builds-setting-triggers-manually.adoc b/modules/builds-setting-triggers-manually.adoc index 53a1a29cc5..6a44ff6541 100644 --- a/modules/builds-setting-triggers-manually.adoc +++ b/modules/builds-setting-triggers-manually.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-setting-triggers-manually-{context}'] +[id="builds-setting-triggers-manually-{context}"] = Setting triggers manually Triggers can be added to and removed from build configurations with `oc set diff --git a/modules/builds-source-input-satellite-config.adoc b/modules/builds-source-input-satellite-config.adoc index 3bdaf62161..8c4e7fc4bf 100644 --- a/modules/builds-source-input-satellite-config.adoc +++ b/modules/builds-source-input-satellite-config.adoc @@ -1,4 +1,4 @@ -[id='builds-source-input-satellite-config-{context}'] +[id="builds-source-input-satellite-config-{context}"] = Adding satellite configurations to builds Builds which use Satellite to install content must provide appropriate diff --git a/modules/builds-source-input-subman-config.adoc b/modules/builds-source-input-subman-config.adoc index dbdad4fd42..bb9a4230f2 100644 --- a/modules/builds-source-input-subman-config.adoc +++ b/modules/builds-source-input-subman-config.adoc @@ -1,4 +1,4 @@ -[id='builds-source-input-subman-config-{context}'] +[id="builds-source-input-subman-config-{context}"] = Adding Subscription Manager configurations to builds Builds which use the Subscription Manager to install content must provide diff --git a/modules/builds-source-secret-basic-auth.adoc b/modules/builds-source-secret-basic-auth.adoc index 621e41fd67..eaeebccec2 100644 --- a/modules/builds-source-secret-basic-auth.adoc +++ b/modules/builds-source-secret-basic-auth.adoc @@ -6,7 +6,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-secret-basic-auth.adoc[leveloffset=+1] -[id='source-secrets-basic-auth-{context}'] +[id="source-secrets-basic-auth-{context}"] = Creating a secret from source code basic authentication Basic authentication requires either a combination of `--username` and diff --git a/modules/builds-source-secret-combinations-basic-auth-ca.adoc b/modules/builds-source-secret-combinations-basic-auth-ca.adoc index 0e24f038c2..f237ed9d91 100644 --- a/modules/builds-source-secret-combinations-basic-auth-ca.adoc +++ b/modules/builds-source-secret-combinations-basic-auth-ca.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-secret-combinations-basic-auth-ca.adoc[leveloffset=+1] -[id='builds-source-secret-combinations-basic-auth-ca-{context}'] +[id="builds-source-secret-combinations-basic-auth-ca-{context}"] = Creating a basic authentication secret with a CA certificate You can combine the different methods for creating source clone secrets for your diff --git a/modules/builds-source-secret-combinations-basic-auth-gitconfig-ca.adoc b/modules/builds-source-secret-combinations-basic-auth-gitconfig-ca.adoc index fcfb8d1d7b..28c21e00a7 100644 --- a/modules/builds-source-secret-combinations-basic-auth-gitconfig-ca.adoc +++ b/modules/builds-source-secret-combinations-basic-auth-gitconfig-ca.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-secret-combinations-basic-auth-gitconfig-ca.adoc[leveloffset=+1] -[id='builds-source-secret-combinations-basic-auth-gitconfig-ca-{context}'] +[id="builds-source-secret-combinations-basic-auth-gitconfig-ca-{context}"] = Creating a basic authentication secret with a *_.gitconfig_* file and CA certificate You can combine the different methods for creating source clone secrets for your diff --git a/modules/builds-source-secret-combinations-basic-auth-gitconfig.adoc b/modules/builds-source-secret-combinations-basic-auth-gitconfig.adoc index 05b68d964b..e36b23234c 100644 --- a/modules/builds-source-secret-combinations-basic-auth-gitconfig.adoc +++ b/modules/builds-source-secret-combinations-basic-auth-gitconfig.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-secret-combinations-basic-auth-gitconfig.adoc[leveloffset=+1] -[id='builds-source-secret-combinations-basic-auth-gitconfig-{context}'] +[id="builds-source-secret-combinations-basic-auth-gitconfig-{context}"] = Creating a basic authentication secret with a *_.gitconfig_* file You can combine the different methods for creating source clone secrets for your diff --git a/modules/builds-source-secret-combinations-gitconfig-ca.adoc b/modules/builds-source-secret-combinations-gitconfig-ca.adoc index 5204760d7f..dc931028cd 100644 --- a/modules/builds-source-secret-combinations-gitconfig-ca.adoc +++ b/modules/builds-source-secret-combinations-gitconfig-ca.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-secret-combinations-gitconfig-ca.adoc[leveloffset=+1] -[id='builds-source-secret-combinations-gitconfig-ca-{context}'] +[id="builds-source-secret-combinations-gitconfig-ca-{context}"] = Creating a secret that combines a *_.gitconfig_* file and CA certificate You can combine the different methods for creating source clone secrets for your diff --git a/modules/builds-source-secret-combinations-ssh-gitconfig.adoc b/modules/builds-source-secret-combinations-ssh-gitconfig.adoc index 2ff28f828d..00d055b7b6 100644 --- a/modules/builds-source-secret-combinations-ssh-gitconfig.adoc +++ b/modules/builds-source-secret-combinations-ssh-gitconfig.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-secret-combinations-ssh-gitconfig.adoc[leveloffset=+1] -[id='builds-source-secret-combinations-ssh-gitconfig-{context}'] +[id="builds-source-secret-combinations-ssh-gitconfig-{context}"] = Creating a SSH-based authentication secret with a *_.gitconfig_* file You can combine the different methods for creating source clone secrets for your diff --git a/modules/builds-source-secret-combinations.adoc b/modules/builds-source-secret-combinations.adoc index 050fa4f614..2e60745c92 100644 --- a/modules/builds-source-secret-combinations.adoc +++ b/modules/builds-source-secret-combinations.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-secret-combinations.adoc[leveloffset=+1] -[id='builds-source-secret-combinations-{context}'] +[id="builds-source-secret-combinations-{context}"] = Source secret combinations You can combine the different methods for creating source clone secrets for your diff --git a/modules/builds-source-secret-ssh-key-auth.adoc b/modules/builds-source-secret-ssh-key-auth.adoc index 03c251bd62..8446855aaa 100644 --- a/modules/builds-source-secret-ssh-key-auth.adoc +++ b/modules/builds-source-secret-ssh-key-auth.adoc @@ -6,7 +6,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-secret-ssh-key-auth.adoc[leveloffset=+1] -[id='source-secrets-ssh-key-auth-{context}'] +[id="source-secrets-ssh-key-auth-{context}"] = Creating a secret from source code SSH key authentication SSH key based authentication requires a private SSH key. diff --git a/modules/builds-source-secret-trusted-ca.adoc b/modules/builds-source-secret-trusted-ca.adoc index 22da5229f3..9a9f0393f5 100644 --- a/modules/builds-source-secret-trusted-ca.adoc +++ b/modules/builds-source-secret-trusted-ca.adoc @@ -6,7 +6,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-secret-trusted-ca.adoc[leveloffset=+1] -[id='source-secrets-trusted-ca-{context}'] +[id="source-secrets-trusted-ca-{context}"] = Creating a secret from source code trusted certificate authorities The set of TLS certificate authorities (CA) that are trusted during a `git clone` diff --git a/modules/builds-source-secrets-entitlements.adoc b/modules/builds-source-secrets-entitlements.adoc index 767fe7790b..2447e15bbb 100644 --- a/modules/builds-source-secrets-entitlements.adoc +++ b/modules/builds-source-secrets-entitlements.adoc @@ -1,4 +1,4 @@ -[id='builds-source-secrets-entitlements-{context}'] +[id="builds-source-secrets-entitlements-{context}"] = Adding entitlements as a build secret Builds which use entitlements to install subscription content must include the diff --git a/modules/builds-source-to-image.adoc b/modules/builds-source-to-image.adoc index 0c91d512d3..00c58f4a6b 100644 --- a/modules/builds-source-to-image.adoc +++ b/modules/builds-source-to-image.adoc @@ -5,7 +5,7 @@ // This module can be included from assemblies using the following include statement: // include::/builds-source-to-image.adoc[leveloffset=+1] -[id='builds-source-to-image-{context}'] +[id="builds-source-to-image-{context}"] = Source-to-image strategy When using a `Source` strategy, all defined input secrets are copied to their diff --git a/modules/builds-strategy-custom-build.adoc b/modules/builds-strategy-custom-build.adoc index c50d1e9aae..2564d986db 100644 --- a/modules/builds-strategy-custom-build.adoc +++ b/modules/builds-strategy-custom-build.adoc @@ -2,7 +2,7 @@ // // -[id='build-strategy-custom-build-{context}'] +[id="build-strategy-custom-build-{context}"] = Custom build The Custom build strategy allows developers to define a specific builder image diff --git a/modules/builds-strategy-custom-environment-variables.adoc b/modules/builds-strategy-custom-environment-variables.adoc index f074cc6bd0..07140088f5 100644 --- a/modules/builds-strategy-custom-environment-variables.adoc +++ b/modules/builds-strategy-custom-environment-variables.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-custom-environment-variables-{context}'] +[id="builds-strategy-custom-environment-variables-{context}"] = Using environment variables for custom builds To make environment variables available to the Custom build diff --git a/modules/builds-strategy-custom-from-image.adoc b/modules/builds-strategy-custom-from-image.adoc index e707452688..796e0fde8f 100644 --- a/modules/builds-strategy-custom-from-image.adoc +++ b/modules/builds-strategy-custom-from-image.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-custom-from-image-{context}'] +[id="builds-strategy-custom-from-image-{context}"] = Using FROM image for custom builds You can use the `customStrategy.from` section to indicate the image to use for the diff --git a/modules/builds-strategy-custom-secrets.adoc b/modules/builds-strategy-custom-secrets.adoc index 2db130b269..0e3a3b7a41 100644 --- a/modules/builds-strategy-custom-secrets.adoc +++ b/modules/builds-strategy-custom-secrets.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-custom-secrets-{context}'] +[id="builds-strategy-custom-secrets-{context}"] = Using secrets in custom builds In addition to secrets for source and images that can be added to all build diff --git a/modules/builds-strategy-docker-build-arguments.adoc b/modules/builds-strategy-docker-build-arguments.adoc index 32dc7aba87..da5d688cde 100644 --- a/modules/builds-strategy-docker-build-arguments.adoc +++ b/modules/builds-strategy-docker-build-arguments.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-docker-build-arguments-{context}'] +[id="builds-strategy-docker-build-arguments-{context}"] = Adding Docker build arguments You can set link:http://docs.docker.com/v1.7/reference/api/hub_registry_spec/#docker-registry-1-0[Docker diff --git a/modules/builds-strategy-docker-build.adoc b/modules/builds-strategy-docker-build.adoc index 4ed607283c..844eacdbcb 100644 --- a/modules/builds-strategy-docker-build.adoc +++ b/modules/builds-strategy-docker-build.adoc @@ -3,7 +3,7 @@ //*assembly/builds //*builds/build-strategies.adoc -[id='builds-strategy-docker-build-{context}'] +[id="builds-strategy-docker-build-{context}"] = Docker build The Docker build strategy invokes the Buildah build diff --git a/modules/builds-strategy-docker-entitled-satellite.adoc b/modules/builds-strategy-docker-entitled-satellite.adoc index af0d1e5edc..b28c7fabdb 100644 --- a/modules/builds-strategy-docker-entitled-satellite.adoc +++ b/modules/builds-strategy-docker-entitled-satellite.adoc @@ -1,4 +1,4 @@ -[id='builds-strategy-docker-entitled-satellite-{context}'] +[id="builds-strategy-docker-entitled-satellite-{context}"] = Entitled docker builds using Satellite Docker strategy builds can use Satellite repositories to install subscription diff --git a/modules/builds-strategy-docker-entitled-subman.adoc b/modules/builds-strategy-docker-entitled-subman.adoc index bb260f8d1d..5c4dffc99e 100644 --- a/modules/builds-strategy-docker-entitled-subman.adoc +++ b/modules/builds-strategy-docker-entitled-subman.adoc @@ -1,4 +1,4 @@ -[id='builds-strategy-docker-entitled-subman-{context}'] +[id="builds-strategy-docker-entitled-subman-{context}"] = Entitled docker builds using Subscription Manager Docker strategy builds can use the Subscription Manager to install subscription diff --git a/modules/builds-strategy-docker-environment-variables.adoc b/modules/builds-strategy-docker-environment-variables.adoc index 7cb53318bf..d1a97d39f5 100644 --- a/modules/builds-strategy-docker-environment-variables.adoc +++ b/modules/builds-strategy-docker-environment-variables.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-docker-environment-variables-{context}'] +[id="builds-strategy-docker-environment-variables-{context}"] = Using Docker environment variables To make environment variables available to the Docker build diff --git a/modules/builds-strategy-docker-force-pull-example.adoc b/modules/builds-strategy-docker-force-pull-example.adoc index 6da56ebae9..8c1f93b638 100644 --- a/modules/builds-strategy-docker-force-pull-example.adoc +++ b/modules/builds-strategy-docker-force-pull-example.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-docker-force-pull-example-{context}'] +[id="builds-strategy-docker-force-pull-example-{context}"] = Docker force pull flag example Set the following to use the `forcePull` flag with Docker: diff --git a/modules/builds-strategy-docker-from-image.adoc b/modules/builds-strategy-docker-from-image.adoc index 254700b0b8..fd5c7e6ae3 100644 --- a/modules/builds-strategy-docker-from-image.adoc +++ b/modules/builds-strategy-docker-from-image.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-docker-from-image-{context}'] +[id="builds-strategy-docker-from-image-{context}"] = Replacing Dockerfile FROM image You can replace the `FROM` instruction of the *_Dockerfile_* with the `from` of diff --git a/modules/builds-strategy-docker-squash-layers.adoc b/modules/builds-strategy-docker-squash-layers.adoc index ddc22d7225..4a26aba4e8 100644 --- a/modules/builds-strategy-docker-squash-layers.adoc +++ b/modules/builds-strategy-docker-squash-layers.adoc @@ -1,4 +1,4 @@ -[id='builds-strategy-docker-squash-layers-{context}'] +[id="builds-strategy-docker-squash-layers-{context}"] = Squash layers with docker builds Docker builds normally create a layer representing each instruction in a diff --git a/modules/builds-strategy-dockerfile-path.adoc b/modules/builds-strategy-dockerfile-path.adoc index 1e74e845b7..9a352280bf 100644 --- a/modules/builds-strategy-dockerfile-path.adoc +++ b/modules/builds-strategy-dockerfile-path.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-dockerfile-path-{context}'] +[id="builds-strategy-dockerfile-path-{context}"] = Using Dockerfile path By default, Docker builds use a Dockerfile (named *_Dockerfile_*) located at the diff --git a/modules/builds-strategy-enable-pulling-pushing.adoc b/modules/builds-strategy-enable-pulling-pushing.adoc index 351bbb40de..453951f946 100644 --- a/modules/builds-strategy-enable-pulling-pushing.adoc +++ b/modules/builds-strategy-enable-pulling-pushing.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-enable-pulling-pushing-{context}'] +[id="builds-strategy-enable-pulling-pushing-{context}"] = Enabling pulling and pushing You can enable pulling to a private registry by setting the `Pull Secret` and diff --git a/modules/builds-strategy-force-pull-procedure.adoc b/modules/builds-strategy-force-pull-procedure.adoc index 8816c2c8fc..43772c5bef 100644 --- a/modules/builds-strategy-force-pull-procedure.adoc +++ b/modules/builds-strategy-force-pull-procedure.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-force-pull-procedure-{context}'] +[id="builds-strategy-force-pull-procedure-{context}"] = Using the force pull flag By default, if the builder image specified in the build configuration is diff --git a/modules/builds-strategy-pipeline-build.adoc b/modules/builds-strategy-pipeline-build.adoc index 7bda79c45b..e0ea97c2c7 100644 --- a/modules/builds-strategy-pipeline-build.adoc +++ b/modules/builds-strategy-pipeline-build.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-pipeline-build-{context}'] +[id="builds-strategy-pipeline-build-{context}"] = Pipeline build The Pipeline build strategy allows developers to define a _Jenkins pipeline_ for diff --git a/modules/builds-strategy-pipeline-environment-variables.adoc b/modules/builds-strategy-pipeline-environment-variables.adoc index f8a43dfec5..80d83d4d97 100644 --- a/modules/builds-strategy-pipeline-environment-variables.adoc +++ b/modules/builds-strategy-pipeline-environment-variables.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-pipeline-environment-variables-{context}'] +[id="builds-strategy-pipeline-environment-variables-{context}"] = Using environment variables for pipeline builds To make environment variables available to the Pipeline build process, you can diff --git a/modules/builds-strategy-pipeline-mapping-buildconfig-jenkins.adoc b/modules/builds-strategy-pipeline-mapping-buildconfig-jenkins.adoc index bd7ac6d3d1..287a825f11 100644 --- a/modules/builds-strategy-pipeline-mapping-buildconfig-jenkins.adoc +++ b/modules/builds-strategy-pipeline-mapping-buildconfig-jenkins.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-pipeline-mapping-buildconfig-jenkins-{context}'] +[id="builds-strategy-pipeline-mapping-buildconfig-jenkins-{context}"] = Mapping Between BuildConfig Environment Variables and Jenkins Job Parameters When a Jenkins job is created or updated based on changes to a Pipeline diff --git a/modules/builds-strategy-pipeline-providing-jenkinsfile.adoc b/modules/builds-strategy-pipeline-providing-jenkinsfile.adoc index 84a6c6cc9b..a66bacdf94 100644 --- a/modules/builds-strategy-pipeline-providing-jenkinsfile.adoc +++ b/modules/builds-strategy-pipeline-providing-jenkinsfile.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-pipeline-providing-jenkinsfile-{context}'] +[id="builds-strategy-pipeline-providing-jenkinsfile-{context}"] = Providing the Jenkinsfile for pipeline builds The `jenkinsfile` uses the standard groovy language syntax to allow fine diff --git a/modules/builds-strategy-s2i-build.adoc b/modules/builds-strategy-s2i-build.adoc index c0fdaa658e..d0904d7577 100644 --- a/modules/builds-strategy-s2i-build.adoc +++ b/modules/builds-strategy-s2i-build.adoc @@ -2,7 +2,7 @@ //* assembly/builds //* builds/build-strategies.adoc -[id='build-strategy-s2i-{context}'] +[id="build-strategy-s2i-{context}"] = Source-to-Image (S2I) build Source-to-Image (S2I) is a tool for building reproducible, Docker-formatted diff --git a/modules/builds-strategy-s2i-buildconfig-environment.adoc b/modules/builds-strategy-s2i-buildconfig-environment.adoc index 69367e309c..871cfd07a9 100644 --- a/modules/builds-strategy-s2i-buildconfig-environment.adoc +++ b/modules/builds-strategy-s2i-buildconfig-environment.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-s2i-buildconfig-environment-{context}'] +[id="builds-strategy-s2i-buildconfig-environment-{context}"] = Using Source-to-Image (S2I) BuildConfig environment You can add environment variables to the `sourceStrategy` definition of the diff --git a/modules/builds-strategy-s2i-environment-files.adoc b/modules/builds-strategy-s2i-environment-files.adoc index 055055b7e4..ddfb908a03 100644 --- a/modules/builds-strategy-s2i-environment-files.adoc +++ b/modules/builds-strategy-s2i-environment-files.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-s2i-environment-files-{context}'] +[id="builds-strategy-s2i-environment-files-{context}"] = Using Source-to-Image (S2I) environment files Source build enables you to set environment values (one per line) inside your diff --git a/modules/builds-strategy-s2i-environment-variables.adoc b/modules/builds-strategy-s2i-environment-variables.adoc index f3119d3426..dc7a1e19bd 100644 --- a/modules/builds-strategy-s2i-environment-variables.adoc +++ b/modules/builds-strategy-s2i-environment-variables.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-s2i-environment-variables-{context}'] +[id="builds-strategy-s2i-environment-variables-{context}"] = Source-to-Image (S2I) environment variables There are two ways to make environment variables available to the source build diff --git a/modules/builds-strategy-s2i-force-pull-example.adoc b/modules/builds-strategy-s2i-force-pull-example.adoc index 4d842a6bf5..5f78fd2474 100644 --- a/modules/builds-strategy-s2i-force-pull-example.adoc +++ b/modules/builds-strategy-s2i-force-pull-example.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-s2i-force-pull-example-{context}'] +[id="builds-strategy-s2i-force-pull-example-{context}"] = Source-to-Image (S2I) force pull flag example Set the following to use the `forcePull` flag with S2I: diff --git a/modules/builds-strategy-s2i-ignore-source-files.adoc b/modules/builds-strategy-s2i-ignore-source-files.adoc index 88cc90356e..1ef1f30485 100644 --- a/modules/builds-strategy-s2i-ignore-source-files.adoc +++ b/modules/builds-strategy-s2i-ignore-source-files.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-s2i-ignore-source-files-{context}'] +[id="builds-strategy-s2i-ignore-source-files-{context}"] = Ignoring Source-to-Image (S2I) source files Source to image supports a `.s2iignore` file, which contains a list of file diff --git a/modules/builds-strategy-s2i-incremental-builds.adoc b/modules/builds-strategy-s2i-incremental-builds.adoc index 067dfabc8e..1db75402b9 100644 --- a/modules/builds-strategy-s2i-incremental-builds.adoc +++ b/modules/builds-strategy-s2i-incremental-builds.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/build-strategies -[id='builds-strategy-s2i-incremental-builds-{context}'] +[id="builds-strategy-s2i-incremental-builds-{context}"] = Performing Source-to-Image (S2I) incremental builds S2I can perform incremental builds, which means it reuses artifacts from diff --git a/modules/builds-strategy-s2i-override-builder-image-scripts.adoc b/modules/builds-strategy-s2i-override-builder-image-scripts.adoc index b11c3c7910..11682a442d 100644 --- a/modules/builds-strategy-s2i-override-builder-image-scripts.adoc +++ b/modules/builds-strategy-s2i-override-builder-image-scripts.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-s2i-override-builder-image-scripts-{context}'] +[id="builds-strategy-s2i-override-builder-image-scripts-{context}"] = Overriding Source-to-Image (S2I) builder image scripts You can override the *_assemble_*, *_run_*, and *_save-artifacts_* diff --git a/modules/builds-strategy-secrets-web-console.adoc b/modules/builds-strategy-secrets-web-console.adoc index 5391768bc0..80c17109e1 100644 --- a/modules/builds-strategy-secrets-web-console.adoc +++ b/modules/builds-strategy-secrets-web-console.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-strategy-secrets-web-console-{context}'] +[id="builds-strategy-secrets-web-console-{context}"] = Adding secrets with web console You can add a secret to your build configuration so that it can access a private diff --git a/modules/builds-triggers.adoc b/modules/builds-triggers.adoc index ebd98fd11a..6770fd51cf 100644 --- a/modules/builds-triggers.adoc +++ b/modules/builds-triggers.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-triggers-{context}'] +[id="builds-triggers-{context}"] = Build triggers When defining a `BuildConfig`, you can define triggers to control the diff --git a/modules/builds-troubleshooting-access-resources.adoc b/modules/builds-troubleshooting-access-resources.adoc index bb4991f860..efa6bae203 100644 --- a/modules/builds-troubleshooting-access-resources.adoc +++ b/modules/builds-troubleshooting-access-resources.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-troubleshooting-access-resources-{context}'] +[id="builds-troubleshooting-access-resources-{context}"] = Resolving denial for access to resources If your request for access to resources is denied: diff --git a/modules/builds-troubleshooting-service-certificate-generation.adoc b/modules/builds-troubleshooting-service-certificate-generation.adoc index b0851cfd8f..95cab2e89e 100644 --- a/modules/builds-troubleshooting-service-certificate-generation.adoc +++ b/modules/builds-troubleshooting-service-certificate-generation.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-troubleshooting-service-certificate-generation-{context}'] +[id="builds-troubleshooting-service-certificate-generation-{context}"] = Service certificate generation failure If your request for access to resources is denied: diff --git a/modules/builds-tutorial-pipeline.adoc b/modules/builds-tutorial-pipeline.adoc index 382d1c81c8..fbde4887f4 100644 --- a/modules/builds-tutorial-pipeline.adoc +++ b/modules/builds-tutorial-pipeline.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-tutorial-pipeline-{context}'] +[id="builds-tutorial-pipeline-{context}"] = Pipeline build tutorial This example demonstrates how to create an OpenShift Pipeline that will build, diff --git a/modules/builds-understanding-openshift-pipeline.adoc b/modules/builds-understanding-openshift-pipeline.adoc index e631d1ea38..153b92e2fd 100644 --- a/modules/builds-understanding-openshift-pipeline.adoc +++ b/modules/builds-understanding-openshift-pipeline.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: //* assembly/builds -[id='builds-understanding-openshift-pipeline-{context}'] +[id="builds-understanding-openshift-pipeline-{context}"] = Understanding {product-title} pipelines Pipelines give you control over building, deploying, and promoting your diff --git a/modules/builds-use-custom-builder-image.adoc b/modules/builds-use-custom-builder-image.adoc index ea7b17cc28..998ee0ef26 100644 --- a/modules/builds-use-custom-builder-image.adoc +++ b/modules/builds-use-custom-builder-image.adoc @@ -4,7 +4,7 @@ // * builds/custom-builds-buildah.adoc -[id='builds-use-custom-builder-image-{context}'] +[id="builds-use-custom-builder-image-{context}"] = Use custom builder image You can define a BuildConfig that uses the custom strategy in conjunction with diff --git a/modules/builds-using-bitbucket-webhooks.adoc b/modules/builds-using-bitbucket-webhooks.adoc index 4afe4fa6ce..6d67498376 100644 --- a/modules/builds-using-bitbucket-webhooks.adoc +++ b/modules/builds-using-bitbucket-webhooks.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-using-bitbucket-webhooks-{context}'] +[id="builds-using-bitbucket-webhooks-{context}"] = Using Bitbucket webhooks link:https://confluence.atlassian.com/bitbucket/manage-webhooks-735643732.html[Bitbucket diff --git a/modules/builds-using-build-fields-as-environment-variables.adoc b/modules/builds-using-build-fields-as-environment-variables.adoc index 4dc0f27785..988d83b90f 100644 --- a/modules/builds-using-build-fields-as-environment-variables.adoc +++ b/modules/builds-using-build-fields-as-environment-variables.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-using-build-fields-as-environments-{context}'] +[id="builds-using-build-fields-as-environments-{context}"] = Using build fields as environment variables You can inject information about the build object by setting the `fieldPath` diff --git a/modules/builds-using-cli-post-commit-build-hooks.adoc b/modules/builds-using-cli-post-commit-build-hooks.adoc index bde613b16a..f2320fdc0f 100644 --- a/modules/builds-using-cli-post-commit-build-hooks.adoc +++ b/modules/builds-using-cli-post-commit-build-hooks.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-using-cli-post-commit-build-hooks-{context}'] +[id="builds-using-cli-post-commit-build-hooks-{context}"] = Using the CLI to set post commit build hooks The `oc set build-hook` command can be used to set the build hook for a build diff --git a/modules/builds-using-external-artifacts.adoc b/modules/builds-using-external-artifacts.adoc index 099525c337..b6f6a06a3c 100644 --- a/modules/builds-using-external-artifacts.adoc +++ b/modules/builds-using-external-artifacts.adoc @@ -3,7 +3,7 @@ // * assembly/builds //* builds/creating-build-inputs.adoc -[id='builds-using-external-artifacts-{context}'] +[id="builds-using-external-artifacts-{context}"] = External artifacts It is not recommended to store binary files in a source repository. Therefore, diff --git a/modules/builds-using-generic-webhooks.adoc b/modules/builds-using-generic-webhooks.adoc index 10a810da7e..325b56b639 100644 --- a/modules/builds-using-generic-webhooks.adoc +++ b/modules/builds-using-generic-webhooks.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-using-generic-webhooks-{context}'] +[id="builds-using-generic-webhooks-{context}"] = Using generic webhooks Generic webhooks are invoked from any system capable of making a web request. diff --git a/modules/builds-using-github-webhooks.adoc b/modules/builds-using-github-webhooks.adoc index 7e7a4f3be0..437c14baa8 100644 --- a/modules/builds-using-github-webhooks.adoc +++ b/modules/builds-using-github-webhooks.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-using-github-webhooks-{context}'] +[id="builds-using-github-webhooks-{context}"] = Using GitHub webhooks link:https://developer.github.com/webhooks/creating/[GitHub webhooks] handle the diff --git a/modules/builds-using-gitlab-webhooks.adoc b/modules/builds-using-gitlab-webhooks.adoc index ee0f1367e3..faf4450643 100644 --- a/modules/builds-using-gitlab-webhooks.adoc +++ b/modules/builds-using-gitlab-webhooks.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-using-gitlab-webhooks-{context}'] +[id="builds-using-gitlab-webhooks-{context}"] = Using GitLab webhooks link:https://docs.gitlab.com/ce/user/project/integrations/webhooks.html[GitLab webhooks] diff --git a/modules/builds-using-image-change-triggers.adoc b/modules/builds-using-image-change-triggers.adoc index 4cafb635a4..1ef5b51951 100644 --- a/modules/builds-using-image-change-triggers.adoc +++ b/modules/builds-using-image-change-triggers.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-using-image-change-triggers-{context}'] +[id="builds-using-image-change-triggers-{context}"] = Using image change triggers Image change triggers allow your build to be automatically invoked when a new diff --git a/modules/builds-using-secrets-as-environment-variables.adoc b/modules/builds-using-secrets-as-environment-variables.adoc index 36cab598b3..578859544d 100644 --- a/modules/builds-using-secrets-as-environment-variables.adoc +++ b/modules/builds-using-secrets-as-environment-variables.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-using-secrets-as-environment-variables-{context}'] +[id="builds-using-secrets-as-environment-variables-{context}"] = Using secrets as environment variables You can make key values from Secrets available as environment variables using diff --git a/modules/builds-using-secrets.adoc b/modules/builds-using-secrets.adoc index c8afa6cc61..0cea7f18bb 100644 --- a/modules/builds-using-secrets.adoc +++ b/modules/builds-using-secrets.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/builds -[id='builds-using-secrets-{context}'] +[id="builds-using-secrets-{context}"] = Using secrets After creating secrets, you can create a pod to reference your secret, get logs, diff --git a/modules/builds-webhook-triggers.adoc b/modules/builds-webhook-triggers.adoc index ddc6a22398..2c30568f28 100644 --- a/modules/builds-webhook-triggers.adoc +++ b/modules/builds-webhook-triggers.adoc @@ -2,7 +2,7 @@ // // * assembly/builds -[id='builds-webhook-triggers-{context}'] +[id="builds-webhook-triggers-{context}"] = Webhook triggers Webhook triggers allow you to trigger a new build by sending a request to the diff --git a/modules/checking-project-status-using-the-CLI.adoc b/modules/checking-project-status-using-the-CLI.adoc index 210831c80a..7d24bdf617 100644 --- a/modules/checking-project-status-using-the-CLI.adoc +++ b/modules/checking-project-status-using-the-CLI.adoc @@ -2,7 +2,7 @@ // // web-console/working-with-projects.adoc -[id='checking-project-status-using-the-CLI{context}'] +[id="checking-project-status-using-the-CLI{context}"] = Checking project status using the CLI .Procedure diff --git a/modules/checking-project-status-using-the-web-console.adoc b/modules/checking-project-status-using-the-web-console.adoc index 35fac36529..585a5602ed 100644 --- a/modules/checking-project-status-using-the-web-console.adoc +++ b/modules/checking-project-status-using-the-web-console.adoc @@ -2,7 +2,7 @@ // // web-console/working-with-projects.adoc -[id='checking-project-status-using-the-web-console-{context}'] +[id="checking-project-status-using-the-web-console-{context}"] = Checking project status using the web console .Procedure diff --git a/modules/cli-about-cli.adoc b/modules/cli-about-cli.adoc index 49043ed544..ec4f6b124d 100644 --- a/modules/cli-about-cli.adoc +++ b/modules/cli-about-cli.adoc @@ -2,7 +2,7 @@ // // * cli_reference/getting-started.adoc -[id='cli-about-cli-{context}'] +[id="cli-about-cli-{context}"] = About the CLI With the {product-title} command-line interface (CLI), you can create diff --git a/modules/cli-administrator-cluster-management.adoc b/modules/cli-administrator-cluster-management.adoc index ee89d25c05..1fdd51136a 100644 --- a/modules/cli-administrator-cluster-management.adoc +++ b/modules/cli-administrator-cluster-management.adoc @@ -2,7 +2,7 @@ // // * cli_reference/administrator-cli-commands.adoc -[id='cli-cluster-management-commands-{context}'] +[id="cli-cluster-management-commands-{context}"] = Cluster management CLI commands == top diff --git a/modules/cli-administrator-configuration.adoc b/modules/cli-administrator-configuration.adoc index 0cdc90c9b0..698b98d1ba 100644 --- a/modules/cli-administrator-configuration.adoc +++ b/modules/cli-administrator-configuration.adoc @@ -2,7 +2,7 @@ // // * cli_reference/administrator-cli-commands.adoc -[id='cli-configuration-commands-{context}'] +[id="cli-configuration-commands-{context}"] = Configuration CLI commands == create-api-client-config diff --git a/modules/cli-administrator-maintenance.adoc b/modules/cli-administrator-maintenance.adoc index 31cb6f6500..b24dad4761 100644 --- a/modules/cli-administrator-maintenance.adoc +++ b/modules/cli-administrator-maintenance.adoc @@ -2,7 +2,7 @@ // // * cli_reference/administrator-cli-commands.adoc -[id='cli-maintenance-commands-{context}'] +[id="cli-maintenance-commands-{context}"] = Maintenance CLI commands == migrate diff --git a/modules/cli-administrator-node-management.adoc b/modules/cli-administrator-node-management.adoc index 4cdb485ed4..5349cb1251 100644 --- a/modules/cli-administrator-node-management.adoc +++ b/modules/cli-administrator-node-management.adoc @@ -2,7 +2,7 @@ // // * cli_reference/administrator-cli-commands.adoc -[id='cli-node-management-commands-{context}'] +[id="cli-node-management-commands-{context}"] = Node management CLI commands == cordon diff --git a/modules/cli-administrator-other.adoc b/modules/cli-administrator-other.adoc index a257c4ddcf..707aaeb05b 100644 --- a/modules/cli-administrator-other.adoc +++ b/modules/cli-administrator-other.adoc @@ -2,7 +2,7 @@ // // * cli_reference/administrator-cli-commands.adoc -[id='cli-other-administrator-commands-{context}'] +[id="cli-other-administrator-commands-{context}"] = Other Administrator CLI commands == build-chain diff --git a/modules/cli-administrator-security-policy.adoc b/modules/cli-administrator-security-policy.adoc index c7f93cb9a9..c5d914d775 100644 --- a/modules/cli-administrator-security-policy.adoc +++ b/modules/cli-administrator-security-policy.adoc @@ -2,7 +2,7 @@ // // * cli_reference/administrator-cli-commands.adoc -[id='cli-security-policy-commands-{context}'] +[id="cli-security-policy-commands-{context}"] = Security and policy CLI commands == certificate diff --git a/modules/cli-configuring-completion.adoc b/modules/cli-configuring-completion.adoc index 294d369642..97ed77d250 100644 --- a/modules/cli-configuring-completion.adoc +++ b/modules/cli-configuring-completion.adoc @@ -2,7 +2,7 @@ // // * cli_reference/configuring-cli.adoc -[id='cli-enabling-tab-completion-{context}'] +[id="cli-enabling-tab-completion-{context}"] = Enabling tab completion After you install the `oc` CLI tool, you can enable tab completion to diff --git a/modules/cli-developer-advanced.adoc b/modules/cli-developer-advanced.adoc index 1c51766ba1..3015e5efc6 100644 --- a/modules/cli-developer-advanced.adoc +++ b/modules/cli-developer-advanced.adoc @@ -2,7 +2,7 @@ // // * cli_reference/developer-cli-commands.adoc -[id='cli-advanced-developer-commands-{context}'] +[id="cli-advanced-developer-commands-{context}"] = Advanced developer CLI commands == api-resources diff --git a/modules/cli-developer-application-management.adoc b/modules/cli-developer-application-management.adoc index ee67c4d69e..80fc483726 100644 --- a/modules/cli-developer-application-management.adoc +++ b/modules/cli-developer-application-management.adoc @@ -2,7 +2,7 @@ // // * cli_reference/developer-cli-commands.adoc -[id='cli-application-management-commands-{context}'] +[id="cli-application-management-commands-{context}"] = Application management CLI commands == annotate diff --git a/modules/cli-developer-basic.adoc b/modules/cli-developer-basic.adoc index 301bc19dd6..5e19b41e9c 100644 --- a/modules/cli-developer-basic.adoc +++ b/modules/cli-developer-basic.adoc @@ -2,7 +2,7 @@ // // * cli_reference/developer-cli-commands.adoc -[id='cli-basic-commands-{context}'] +[id="cli-basic-commands-{context}"] = Basic CLI commands == explain diff --git a/modules/cli-developer-build-deploy.adoc b/modules/cli-developer-build-deploy.adoc index eaf299ee4a..9e4bc09438 100644 --- a/modules/cli-developer-build-deploy.adoc +++ b/modules/cli-developer-build-deploy.adoc @@ -2,7 +2,7 @@ // // * cli_reference/developer-cli-commands.adoc -[id='cli-build-deploy-commands-{context}'] +[id="cli-build-deploy-commands-{context}"] = Build and Deploy CLI commands == cancel-build diff --git a/modules/cli-developer-other.adoc b/modules/cli-developer-other.adoc index 764280a99d..79c3c21eb6 100644 --- a/modules/cli-developer-other.adoc +++ b/modules/cli-developer-other.adoc @@ -2,7 +2,7 @@ // // * cli_reference/developer-cli-commands.adoc -[id='cli-other-developer-commands-{context}'] +[id="cli-other-developer-commands-{context}"] = Other developer CLI commands == help diff --git a/modules/cli-developer-settings.adoc b/modules/cli-developer-settings.adoc index 14a988ca18..7d5bfced72 100644 --- a/modules/cli-developer-settings.adoc +++ b/modules/cli-developer-settings.adoc @@ -2,7 +2,7 @@ // // * cli_reference/developer-cli-commands.adoc -[id='cli-settings-commands-{context}'] +[id="cli-settings-commands-{context}"] = Settings CLI commands == completion diff --git a/modules/cli-developer-troubleshooting.adoc b/modules/cli-developer-troubleshooting.adoc index 84237bd47b..4d2964cd97 100644 --- a/modules/cli-developer-troubleshooting.adoc +++ b/modules/cli-developer-troubleshooting.adoc @@ -2,7 +2,7 @@ // // * cli_reference/developer-cli-commands.adoc -[id='cli-troubleshooting-commands-{context}'] +[id="cli-troubleshooting-commands-{context}"] = Troubleshooting and debugging CLI commands == attach diff --git a/modules/cli-extending-plugins-installing.adoc b/modules/cli-extending-plugins-installing.adoc index d3603b9e49..c83966e0be 100644 --- a/modules/cli-extending-plugins-installing.adoc +++ b/modules/cli-extending-plugins-installing.adoc @@ -2,7 +2,7 @@ // // * cli_reference/extending-cli-plugins.adoc -[id='cli-installing-plugins-{context}'] +[id="cli-installing-plugins-{context}"] = Installing and using CLI plug-ins After you write a custom plug-in for the {product-title} CLI, you must install diff --git a/modules/cli-extending-plugins-writing.adoc b/modules/cli-extending-plugins-writing.adoc index a632e6dd59..10b94dea74 100644 --- a/modules/cli-extending-plugins-writing.adoc +++ b/modules/cli-extending-plugins-writing.adoc @@ -2,7 +2,7 @@ // // * cli_reference/extending-cli-plugins.adoc -[id='cli-writing-plugins-{context}'] +[id="cli-writing-plugins-{context}"] = Writing CLI plug-ins You can write a plug-in for the {product-title} CLI in any programming language diff --git a/modules/cli-getting-help.adoc b/modules/cli-getting-help.adoc index 0bdf709c55..4c612a5642 100644 --- a/modules/cli-getting-help.adoc +++ b/modules/cli-getting-help.adoc @@ -2,7 +2,7 @@ // // * cli_reference/getting-started.adoc -[id='cli-getting-help-{context}'] +[id="cli-getting-help-{context}"] = Getting help You can get help with CLI commands and {product-title} resources in the diff --git a/modules/cli-install.adoc b/modules/cli-install.adoc index 194b5faf3c..47b09ad036 100644 --- a/modules/cli-install.adoc +++ b/modules/cli-install.adoc @@ -3,7 +3,7 @@ // * installing/installing_aws/installing-aws-customizations.adoc // * installing/installing_aws/installing-aws-default.adoc -[id='cli-install-{context}'] +[id="cli-install-{context}"] = Installing the {product-title} CLI You can download and install the `oc` command line interface (CLI) diff --git a/modules/cli-installing-cli.adoc b/modules/cli-installing-cli.adoc index 7918570462..ae02ffbb1b 100644 --- a/modules/cli-installing-cli.adoc +++ b/modules/cli-installing-cli.adoc @@ -2,7 +2,7 @@ // // * cli_reference/getting-started.adoc -[id='cli-installing-cli-{context}'] +[id="cli-installing-cli-{context}"] = Installing the CLI You can install the CLI in order to interact with {product-title} using a diff --git a/modules/cli-logging-in-kubeadmin.adoc b/modules/cli-logging-in-kubeadmin.adoc index f3a6cfe91a..92cfc64b77 100644 --- a/modules/cli-logging-in-kubeadmin.adoc +++ b/modules/cli-logging-in-kubeadmin.adoc @@ -3,7 +3,7 @@ // * installing/installing_aws/installing-aws-default.adoc // * installing/installing_aws/installing-aws-customizations.adoc -[id='cli-logging-in-kubeadmin-{context}'] +[id="cli-logging-in-kubeadmin-{context}"] = Logging into the cluster as the `kubeadmin` user by using the `oc` CLI You can log into your cluster as the default `kubeadmin` user by using the `oc` diff --git a/modules/cli-logging-in.adoc b/modules/cli-logging-in.adoc index 1313998945..060bd561d0 100644 --- a/modules/cli-logging-in.adoc +++ b/modules/cli-logging-in.adoc @@ -2,7 +2,7 @@ // // * cli_reference/getting-started.adoc -[id='cli-logging-in-{context}'] +[id="cli-logging-in-{context}"] = Logging in to the CLI You can log in to the `oc` CLI to access and manage your cluster. diff --git a/modules/cli-logging-out.adoc b/modules/cli-logging-out.adoc index 0951ba00d5..de00180f9f 100644 --- a/modules/cli-logging-out.adoc +++ b/modules/cli-logging-out.adoc @@ -2,7 +2,7 @@ // // * cli_reference/getting-started.adoc -[id='cli-logging-out-{context}'] +[id="cli-logging-out-{context}"] = Logging out of the CLI You can log out the CLI to end your current session. diff --git a/modules/cli-using-cli.adoc b/modules/cli-using-cli.adoc index af01c98772..8eb5da5d56 100644 --- a/modules/cli-using-cli.adoc +++ b/modules/cli-using-cli.adoc @@ -2,7 +2,7 @@ // // * cli_reference/getting-started.adoc -[id='cli-using-cli-{context}'] +[id="cli-using-cli-{context}"] = Using the CLI Review the following sections to learn how to complete common tasks using the CLI. diff --git a/modules/cluster-autoscaler-about.adoc b/modules/cluster-autoscaler-about.adoc index b9457be1a1..dc7e89f518 100644 --- a/modules/cluster-autoscaler-about.adoc +++ b/modules/cluster-autoscaler-about.adoc @@ -2,7 +2,7 @@ // // * machine_management/applying-autoscaling.adoc -[id='cluster-autoscaler-about-{context}'] +[id="cluster-autoscaler-about-{context}"] = About the ClusterAutoscaler The ClusterAutoscaler adjusts the size of an {product-title} cluster to meet diff --git a/modules/cluster-autoscaler-cr.adoc b/modules/cluster-autoscaler-cr.adoc index bc0b8fd639..5d60a13494 100644 --- a/modules/cluster-autoscaler-cr.adoc +++ b/modules/cluster-autoscaler-cr.adoc @@ -2,7 +2,7 @@ // // * machine_management/applying-autoscaling.adoc -[id='cluster-autoscaler-cr-{context}'] +[id="cluster-autoscaler-cr-{context}"] = ClusterAutoscaler resource definition This `ClusterAutoscaler` resource definition shows the parameters and sample diff --git a/modules/cluster-autoscaler-deploying.adoc b/modules/cluster-autoscaler-deploying.adoc index 83af5a7c2a..79a7299a69 100644 --- a/modules/cluster-autoscaler-deploying.adoc +++ b/modules/cluster-autoscaler-deploying.adoc @@ -2,7 +2,7 @@ // // * machine_management/applying-autoscaling.adoc -[id='cluster-autoscaler-deploying-{context}'] +[id="cluster-autoscaler-deploying-{context}"] = Deploying the ClusterAutoscaler To deploy the ClusterAutoscaler, you create an instance of the `ClusterAutoscaler` diff --git a/modules/cluster-node-tuning-operator-default-profiles-set.adoc b/modules/cluster-node-tuning-operator-default-profiles-set.adoc index f649ddb0db..17803bf5fc 100644 --- a/modules/cluster-node-tuning-operator-default-profiles-set.adoc +++ b/modules/cluster-node-tuning-operator-default-profiles-set.adoc @@ -2,7 +2,7 @@ // // * scalability_and_performance/using-node-tuning-operator.adoc -[id='custom-tuning-default-profiles-set-{context}'] +[id="custom-tuning-default-profiles-set-{context}"] = Default profiles set on a cluster The following are the default profiles set on a cluster. diff --git a/modules/configuration-resource-configure.adoc b/modules/configuration-resource-configure.adoc index f73ed223ab..a43c2553ae 100644 --- a/modules/configuration-resource-configure.adoc +++ b/modules/configuration-resource-configure.adoc @@ -3,7 +3,7 @@ // * TBD -[id='configuration-resource-configure-{context}'] +[id="configuration-resource-configure-{context}"] = Configure the Configuration Resource To configure the Configuration Resource, you customize the Custom Resource Definition (CRD) that controls its Operator and deploy it to your cluster. diff --git a/modules/configuration-resource-overview.adoc b/modules/configuration-resource-overview.adoc index a198f39006..bf6189a0d1 100644 --- a/modules/configuration-resource-overview.adoc +++ b/modules/configuration-resource-overview.adoc @@ -2,7 +2,7 @@ // // * TBD -[id='configuration-resource-overview-{context}'] +[id="configuration-resource-overview-{context}"] = About Configuration Resources in {product-title} You perform many customization and configuration tasks after you deploy your diff --git a/modules/configuring-cluster-loader.adoc b/modules/configuring-cluster-loader.adoc index e968be6783..30821da0dc 100644 --- a/modules/configuring-cluster-loader.adoc +++ b/modules/configuring-cluster-loader.adoc @@ -2,7 +2,7 @@ // // scalability_and_performance/using-cluster-loader.adoc -[id='configuring_cluster_loader-{context}'] +[id="configuring_cluster_loader-{context}"] = Configuring Cluster Loader The tool creates multiple namespaces (projects), which contain multiple templates or pods. diff --git a/modules/configuring-local-provisioner.adoc b/modules/configuring-local-provisioner.adoc index 435e03f7db..b19c5b6c78 100644 --- a/modules/configuring-local-provisioner.adoc +++ b/modules/configuring-local-provisioner.adoc @@ -1,4 +1,4 @@ -[id='configuring-local-provisioner-{context}'] +[id="configuring-local-provisioner-{context}"] = Configuring the local provisioner {product-title} depends on an external provisioner to create PVs for local devices and to clean up PVs when they are not in use to enable reuse. diff --git a/modules/configuring-network-subnets.adoc b/modules/configuring-network-subnets.adoc index 738bbda5ad..30ef8551c4 100644 --- a/modules/configuring-network-subnets.adoc +++ b/modules/configuring-network-subnets.adoc @@ -2,7 +2,7 @@ // // networking/network-optimization.adoc -[id='Configuring-network-subnets-{context}'] +[id="Configuring-network-subnets-{context}"] = Configuring network subnets All Pods are assigned IPs. This enables Pod to Pod communication and Pod to node diff --git a/modules/containers-about.adoc b/modules/containers-about.adoc index 05d9f0f9e5..9573fa5a06 100644 --- a/modules/containers-about.adoc +++ b/modules/containers-about.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='containers-about-{context}'] +[id="containers-about-{context}"] = Containers The basic units of {product-title} applications are called _containers_. diff --git a/modules/crd-creating-aggregated-cluster-roles.adoc b/modules/crd-creating-aggregated-cluster-roles.adoc index 99a085db29..f518456c24 100644 --- a/modules/crd-creating-aggregated-cluster-roles.adoc +++ b/modules/crd-creating-aggregated-cluster-roles.adoc @@ -2,7 +2,7 @@ // // * applications/crds/extending-api-with-crds.adoc -[id='crd-creating-aggregated-cluster-role-{context}'] +[id="crd-creating-aggregated-cluster-role-{context}"] = Creating cluster roles for Custom Resource Definitions After creating a cluster-scoped Custom Resource Definition (CRD), cluster diff --git a/modules/crd-creating-crds.adoc b/modules/crd-creating-crds.adoc index 15300a5c1e..3b5079bb91 100644 --- a/modules/crd-creating-crds.adoc +++ b/modules/crd-creating-crds.adoc @@ -2,7 +2,7 @@ // // * applications/crds/extending-api-with-crds.adoc -[id='crd-creating-custom-resources-definition-{context}'] +[id="crd-creating-custom-resources-definition-{context}"] = Creating a Custom Resource Definition To create Custom Resource (CR) objects, cluster administrators must first create diff --git a/modules/crd-creating-custom-resources-from-file.adoc b/modules/crd-creating-custom-resources-from-file.adoc index 83fe3d642a..6efc9dc084 100644 --- a/modules/crd-creating-custom-resources-from-file.adoc +++ b/modules/crd-creating-custom-resources-from-file.adoc @@ -5,7 +5,7 @@ // * applications/crds/crd-managing-resources-from-crds.adoc // * applications/crds/extending-api-with-crds.adoc -[id='crd-creating-custom-resources-from-file-{context}'] +[id="crd-creating-custom-resources-from-file-{context}"] = Creating Custom Resources from a file After a Custom Resource Definition (CRD) has been added to the cluster by a diff --git a/modules/crd-custom-resource-definitions.adoc b/modules/crd-custom-resource-definitions.adoc index 5fd71b8827..95f2369a46 100644 --- a/modules/crd-custom-resource-definitions.adoc +++ b/modules/crd-custom-resource-definitions.adoc @@ -3,7 +3,7 @@ // * applications/crds/crd-managing-resources-from-crds.adoc // * applications/crds/extending-api-with-crds.adoc -[id='crd-custom-resource-definitions-{context}'] +[id="crd-custom-resource-definitions-{context}"] = Custom Resource Definitions In the Kubernetes API, a resource is an endpoint that stores a collection of API diff --git a/modules/crd-inspecting-custom-resources.adoc b/modules/crd-inspecting-custom-resources.adoc index f181eb2473..e38b92529b 100644 --- a/modules/crd-inspecting-custom-resources.adoc +++ b/modules/crd-inspecting-custom-resources.adoc @@ -5,7 +5,7 @@ // * applications/crds/crd-managing-resources-from-crds.adoc // * applications/crds/extending-api-with-crds.adoc -[id='crd-inspecting-custom-resources-{context}'] +[id="crd-inspecting-custom-resources-{context}"] = Inspecting Custom Resources After you create a Custom Resource (CR) object, you can inspect and get diff --git a/modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc b/modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc index 6d5e199baf..dd16cfc807 100644 --- a/modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc +++ b/modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc @@ -2,7 +2,7 @@ // // * scalability_and_performance/recommended-host-practices.adoc -[id='create-a-kubeletconfig-crd-to-edit-kubelet-parameters-{context}'] +[id="create-a-kubeletconfig-crd-to-edit-kubelet-parameters-{context}"] = Create a KubeletConfig CRD to edit kubelet parameters The kubelet configuration is currently serialized as an ignition configuration, diff --git a/modules/creating-a-project-using-the-CLI.adoc b/modules/creating-a-project-using-the-CLI.adoc index e6ea7eff1c..0494eafc23 100644 --- a/modules/creating-a-project-using-the-CLI.adoc +++ b/modules/creating-a-project-using-the-CLI.adoc @@ -2,7 +2,7 @@ // // applications_and_projects/working-with-projects.adoc -[id='creating-a-project-using-the-CLI-{context}'] +[id="creating-a-project-using-the-CLI-{context}"] = Creating a project using the CLI If allowed by your cluster administrator, you can create a new project. diff --git a/modules/creating-a-project-using-the-web-console.adoc b/modules/creating-a-project-using-the-web-console.adoc index dd22b97c79..9e88ddacc7 100644 --- a/modules/creating-a-project-using-the-web-console.adoc +++ b/modules/creating-a-project-using-the-web-console.adoc @@ -2,7 +2,7 @@ // // applications_and_projects/working-with-projects.adoc -[id='creating-a-project-using-the-web-console-{context}'] +[id="creating-a-project-using-the-web-console-{context}"] = Creating a project using the web console If allowed by your cluster administrator, you can create a new project. diff --git a/modules/creating-new-osdk-v0-1-0-project.adoc b/modules/creating-new-osdk-v0-1-0-project.adoc index c5a08d0209..73b8ebed0d 100644 --- a/modules/creating-new-osdk-v0-1-0-project.adoc +++ b/modules/creating-new-osdk-v0-1-0-project.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc -[id='creating-new-operator-sdk-v0-1-0-project-{context}'] +[id="creating-new-operator-sdk-v0-1-0-project-{context}"] = Creating a new Operator SDK v0.1.0 project Rename your Operator SDK v0.0.x project and create a new v0.1.0 project in its diff --git a/modules/creating-your-first-content.adoc b/modules/creating-your-first-content.adoc index 34564e80c9..da4d062c1e 100644 --- a/modules/creating-your-first-content.adoc +++ b/modules/creating-your-first-content.adoc @@ -4,10 +4,10 @@ // Base the file name and the ID on the module title. For example: // * file name: doing-procedure-a.adoc -// * ID: [id='doing-procedure-a'] +// * ID: [id="doing-procedure-a"] // * Title: = Doing procedure A -[id='creating-your-first-content-{context}'] +[id="creating-your-first-content-{context}"] = Creating your first content In this procedure, you will create your first example content using modular diff --git a/modules/custom-tuning-specification.adoc b/modules/custom-tuning-specification.adoc index a821d22fc4..81b14d8483 100644 --- a/modules/custom-tuning-specification.adoc +++ b/modules/custom-tuning-specification.adoc @@ -2,7 +2,7 @@ // // * scalability_and_performance/using-node-tuning-operator.adoc -[id='custom-tuning-specification-{context}'] +[id="custom-tuning-specification-{context}"] = Custom tuning specification The custom resource (CR) for the operator has two major sections. The first diff --git a/modules/debugging-issues-with-rhel-tools.adoc b/modules/debugging-issues-with-rhel-tools.adoc index fc5d935863..b502810a43 100644 --- a/modules/debugging-issues-with-rhel-tools.adoc +++ b/modules/debugging-issues-with-rhel-tools.adoc @@ -2,7 +2,7 @@ // // scalability_and_performance/optimizing-compute-resources.adoc -[id='how-to-debug-issues-with-rhel-tools-{context}'] +[id="how-to-debug-issues-with-rhel-tools-{context}"] = Debugging scaling or performance issues using the RHEL Tools container image Red Hat distributes a `rhel-tools` container image, packaging tools that aid in diff --git a/modules/dedicated-admin-role-overview.adoc b/modules/dedicated-admin-role-overview.adoc index f683cfdcb2..be2bff311f 100644 --- a/modules/dedicated-admin-role-overview.adoc +++ b/modules/dedicated-admin-role-overview.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='dedicated-admin-role-overview-{context}'] +[id="dedicated-admin-role-overview-{context}"] ifdef::openshift-dedicated[] = About the dedicated administrator role diff --git a/modules/deleting-a-project-using-the-CLI.adoc b/modules/deleting-a-project-using-the-CLI.adoc index b099b784e7..1846f52cb3 100644 --- a/modules/deleting-a-project-using-the-CLI.adoc +++ b/modules/deleting-a-project-using-the-CLI.adoc @@ -2,7 +2,7 @@ // // web-console/working-with-projects.adoc -[id='deleting-a-project-using-the-CLI{context}'] +[id="deleting-a-project-using-the-CLI{context}"] = Deleting a project using the CLI When you delete a project, the server updates the project status to diff --git a/modules/deleting-a-project-using-the-web-console.adoc b/modules/deleting-a-project-using-the-web-console.adoc index 0001a538ed..ab4802abae 100644 --- a/modules/deleting-a-project-using-the-web-console.adoc +++ b/modules/deleting-a-project-using-the-web-console.adoc @@ -2,7 +2,7 @@ // // web-console/working-with-projects.adoc -[id='deleting-a-project-using-the-web-console{context}'] +[id="deleting-a-project-using-the-web-console{context}"] = Deleting a project using the web console .Procedure diff --git a/modules/deploying-local-provisioner.adoc b/modules/deploying-local-provisioner.adoc index dffff62dff..1646dfc820 100644 --- a/modules/deploying-local-provisioner.adoc +++ b/modules/deploying-local-provisioner.adoc @@ -1,4 +1,4 @@ -[id='deploying-local-provisioner-{context}'] +[id="deploying-local-provisioner-{context}"] = Deploying the local provisioner This paragraph is the procedure module introduction: a short description of the procedure. diff --git a/modules/deploying-resource.adoc b/modules/deploying-resource.adoc index 392f54025d..6bf873673b 100644 --- a/modules/deploying-resource.adoc +++ b/modules/deploying-resource.adoc @@ -8,7 +8,7 @@ -[id='{FeatureName}-deploying-{context}'] +[id="{FeatureName}-deploying-{context}"] = Deploying the {FeatureName} To deploy the {FeatureName}, you create an instance of the `{FeatureName}` diff --git a/modules/deployments-ab-testing-lb.adoc b/modules/deployments-ab-testing-lb.adoc index ba290da303..2bb7da5379 100644 --- a/modules/deployments-ab-testing-lb.adoc +++ b/modules/deployments-ab-testing-lb.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/route-based-deployment-strategies.adoc -[id='deployments-ab-testing-lb-{context}'] +[id="deployments-ab-testing-lb-{context}"] = Load balancing for A/B testing The user sets up a route with multiple services. Each service handles a version @@ -97,7 +97,7 @@ spec: ... ---- -[id='deployments-ab-testing-lb-web-{context}'] +[id="deployments-ab-testing-lb-web-{context}"] == Managing weights using the web console .Procedure @@ -116,7 +116,7 @@ specified by integers between 0 and 256 for each service. Traffic weightings are shown on the *Overview* in the expanded rows of the applications between which traffic is split. -[id='deployments-ab-testing-lb-cli-{context}'] +[id="deployments-ab-testing-lb-cli-{context}"] == Managing weights using the CLI .Procedure @@ -181,7 +181,7 @@ Not all routers may support multiple or weighted backends. ==== -[id='deployments-ab-one-service-multi-dc-{context}'] +[id="deployments-ab-one-service-multi-dc-{context}"] == One service, multiple DeploymentConfigs .Procedure diff --git a/modules/deployments-ab-testing.adoc b/modules/deployments-ab-testing.adoc index ab8cbe35e3..28f61e5a09 100644 --- a/modules/deployments-ab-testing.adoc +++ b/modules/deployments-ab-testing.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/route-based-deployment-strategies.adoc -[id='deployments-ab-testing-{context}'] +[id="deployments-ab-testing-{context}"] = A/B deployments The A/B deployment strategy lets you try a new version of the application in a diff --git a/modules/deployments-accessing-private-repos.adoc b/modules/deployments-accessing-private-repos.adoc index b13fec52fc..ea790e3e19 100644 --- a/modules/deployments-accessing-private-repos.adoc +++ b/modules/deployments-accessing-private-repos.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-accessing-private-repos-{context}'] +[id="deployments-accessing-private-repos-{context}"] = Accessing private repositories from DeploymentConfigs You can add a Secret to your DeploymentConfig so that it can access images from diff --git a/modules/deployments-assigning-pods-to-nodes.adoc b/modules/deployments-assigning-pods-to-nodes.adoc index 203bd88621..9159b2785e 100644 --- a/modules/deployments-assigning-pods-to-nodes.adoc +++ b/modules/deployments-assigning-pods-to-nodes.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-assigning-pods-to-nodes-{context}'] +[id="deployments-assigning-pods-to-nodes-{context}"] = Assigning pods to specific nodes You can use node selectors in conjunction with labeled nodes to control Pod diff --git a/modules/deployments-blue-green.adoc b/modules/deployments-blue-green.adoc index 72a92ad26a..c5d5c984cf 100644 --- a/modules/deployments-blue-green.adoc +++ b/modules/deployments-blue-green.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/route-based-deployment-strategies.adoc -[id='deployments-blue-green-{context}'] +[id="deployments-blue-green-{context}"] = Blue-green deployments Blue-green deployments involve running two versions of an application at the @@ -18,7 +18,7 @@ copies of the data layer. Consider the data used in testing the new version. If it is the production data, a bug in the new version can break the production version. -[id='deployments-blue-green-setting-up-{context}'] +[id="deployments-blue-green-setting-up-{context}"] == Setting up a blue-green deployment Blue-green deployments use two DeploymentConfigs. Both are running, and diff --git a/modules/deployments-canary-deployments.adoc b/modules/deployments-canary-deployments.adoc index 9875ce57a2..c6f6380c21 100644 --- a/modules/deployments-canary-deployments.adoc +++ b/modules/deployments-canary-deployments.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/deployment-strategies.adoc -[id='deployments-canary-deployments-{context}'] +[id="deployments-canary-deployments-{context}"] = Canary deployments All Rolling deployments in {product-title} are _canary deployments_; a new diff --git a/modules/deployments-comparing-deploymentconfigs.adoc b/modules/deployments-comparing-deploymentconfigs.adoc index dceb6621a5..84ca2ef2b1 100644 --- a/modules/deployments-comparing-deploymentconfigs.adoc +++ b/modules/deployments-comparing-deploymentconfigs.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/what-deployments-are.adoc -[id='deployments-comparing-deploymentconfigs-{context}'] +[id="deployments-comparing-deploymentconfigs-{context}"] = Comparing Deployments and DeploymentConfigs Because deployment configurations existed in {product-title} prior to @@ -25,7 +25,7 @@ The following sections go into more details on the differences between the two object types to further help you decide when you might want to use Kubernetes deployments over deployment configurations. -[id='delpoymentconfigs-specific-features-{context}'] +[id="delpoymentconfigs-specific-features-{context}"] == DeploymentConfigs-specific features [discrete] @@ -72,7 +72,7 @@ Deployments do not yet run canaries as part of a new rollout. Deployments do not support running test tracks. -[id='delpoyments-specific-features-{context}'] +[id="delpoyments-specific-features-{context}"] == Deployments-specific features [discrete] diff --git a/modules/deployments-creating-rolling-deployment.adoc b/modules/deployments-creating-rolling-deployment.adoc index 1c6aa87b14..4341b38006 100644 --- a/modules/deployments-creating-rolling-deployment.adoc +++ b/modules/deployments-creating-rolling-deployment.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/deployment-strategies.adoc -[id='deployments-creating-rolling-deployment-{context}'] +[id="deployments-creating-rolling-deployment-{context}"] = Creating a Rolling deployment Rolling deployments are the default type in {product-title}. You can create a diff --git a/modules/deployments-custom-strategy.adoc b/modules/deployments-custom-strategy.adoc index 884df0eaca..0dc258fd6f 100644 --- a/modules/deployments-custom-strategy.adoc +++ b/modules/deployments-custom-strategy.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/deployment-strategies.adoc -[id='deployments-custom-strategy-{context}'] +[id="deployments-custom-strategy-{context}"] = Custom strategy The Custom strategy allows you to provide your own deployment behavior. diff --git a/modules/deployments-deploymentconfigs.adoc b/modules/deployments-deploymentconfigs.adoc index ae231007d8..6f552bc229 100644 --- a/modules/deployments-deploymentconfigs.adoc +++ b/modules/deployments-deploymentconfigs.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/what-deployments-are.adoc -[id='deployments-and-deploymentconfigs-{context}'] +[id="deployments-and-deploymentconfigs-{context}"] = DeploymentConfigs Building on ReplicationControllers, {product-title} adds expanded support for diff --git a/modules/deployments-exec-cmd-in-container.adoc b/modules/deployments-exec-cmd-in-container.adoc index e8f6625c2a..4cddcd22e1 100644 --- a/modules/deployments-exec-cmd-in-container.adoc +++ b/modules/deployments-exec-cmd-in-container.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-exe-cmd-in-container-{context}'] +[id="deployments-exe-cmd-in-container-{context}"] = Executing commands inside a container You can add a command to a container, which modifies the container's startup diff --git a/modules/deployments-graceful-termination.adoc b/modules/deployments-graceful-termination.adoc index a2f80b9faa..24e1b42b73 100644 --- a/modules/deployments-graceful-termination.adoc +++ b/modules/deployments-graceful-termination.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/route-based-deployment-strategies.adoc -[id='deployments-graceful-termination-{context}'] +[id="deployments-graceful-termination-{context}"] = Graceful termination {product-title} and Kubernetes give application instances time to shut down diff --git a/modules/deployments-kube-deployments.adoc b/modules/deployments-kube-deployments.adoc index 7bed93b2f9..b4f5276fe3 100644 --- a/modules/deployments-kube-deployments.adoc +++ b/modules/deployments-kube-deployments.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/what-deployments-are.adoc -[id='deployments-kube-deployments-{context}'] +[id="deployments-kube-deployments-{context}"] = Deployments Kubernetes provides a first-class, native API object type in {product-title} diff --git a/modules/deployments-lifecycle-hooks.adoc b/modules/deployments-lifecycle-hooks.adoc index bfbc4dac98..c31685bba9 100644 --- a/modules/deployments-lifecycle-hooks.adoc +++ b/modules/deployments-lifecycle-hooks.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/deployment-strategies.adoc -[id='deployments-lifecycle-hooks-{context}'] +[id="deployments-lifecycle-hooks-{context}"] = Lifecycle hooks The Rolling and Recreate strategies support _lifecycle hooks_, or deployment @@ -93,7 +93,7 @@ Pod has the following properties: * The hook failure policy is `Abort`, meaning the deployment process fails if the hook fails. * The hook Pod inherits the `data` volume from the DeploymentConfig Pod. -[id='deployments-setting-lifecycle-hooks-{context}'] +[id="deployments-setting-lifecycle-hooks-{context}"] == Setting lifecycle hooks You can set lifecycle hooks, or deployment hooks, for a DeploymentConfig using diff --git a/modules/deployments-n1-compatibility.adoc b/modules/deployments-n1-compatibility.adoc index 36597b818a..b3206a99b2 100644 --- a/modules/deployments-n1-compatibility.adoc +++ b/modules/deployments-n1-compatibility.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/route-based-deployment-strategies.adoc -[id='deployments-n1-compatibility-{context}'] +[id="deployments-n1-compatibility-{context}"] = N-1 compatibility Applications that have new code and old code running at the same time must be diff --git a/modules/deployments-proxy-shards.adoc b/modules/deployments-proxy-shards.adoc index 2a666c0bd8..519dc13dfe 100644 --- a/modules/deployments-proxy-shards.adoc +++ b/modules/deployments-proxy-shards.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/route-based-deployment-strategies.adoc -[id='deployments-proxy-shard-{context}'] +[id="deployments-proxy-shard-{context}"] = Proxy shards and traffic splitting In production environments, you can precisely control the distribution of diff --git a/modules/deployments-recreate-strategy.adoc b/modules/deployments-recreate-strategy.adoc index 068ce2a90b..b71694f483 100644 --- a/modules/deployments-recreate-strategy.adoc +++ b/modules/deployments-recreate-strategy.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/deployment-strategies.adoc -[id='deployments-recreate-strategy-{context}'] +[id="deployments-recreate-strategy-{context}"] = Recreate strategy The Recreate strategy has basic rollout behavior and supports lifecycle hooks diff --git a/modules/deployments-replicasets.adoc b/modules/deployments-replicasets.adoc index 0a73e81a23..9a31e38ced 100644 --- a/modules/deployments-replicasets.adoc +++ b/modules/deployments-replicasets.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/what-deployments-are.adoc -[id='deployments-repliasets-{context}'] +[id="deployments-repliasets-{context}"] = ReplicaSets Similar to a ReplicationController, a ReplicaSet is a native Kubernetes API diff --git a/modules/deployments-replicationcontrollers.adoc b/modules/deployments-replicationcontrollers.adoc index 7b02a84d28..c43570ee8b 100644 --- a/modules/deployments-replicationcontrollers.adoc +++ b/modules/deployments-replicationcontrollers.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/what-deployments-are.adoc -[id='deployments-replicationcontrollers-{context}'] +[id="deployments-replicationcontrollers-{context}"] = ReplicationControllers A ReplicationController ensures that a specified number of replicas of a Pod are running at diff --git a/modules/deployments-retrying-deployment.adoc b/modules/deployments-retrying-deployment.adoc index 13f751f530..2ae96def2e 100644 --- a/modules/deployments-retrying-deployment.adoc +++ b/modules/deployments-retrying-deployment.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-retrying-deployment-{context}'] +[id="deployments-retrying-deployment-{context}"] = Retrying a deployment If the current revision of your DeploymentConfig failed to deploy, you can diff --git a/modules/deployments-rolling-back.adoc b/modules/deployments-rolling-back.adoc index c0d68c8876..7e6be17dd5 100644 --- a/modules/deployments-rolling-back.adoc +++ b/modules/deployments-rolling-back.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-rolling-back-{context}'] +[id="deployments-rolling-back-{context}"] = Rolling back a deployment Rollbacks revert an application back to a previous revision and can be diff --git a/modules/deployments-rolling-strategy.adoc b/modules/deployments-rolling-strategy.adoc index 3ee8061144..251201be04 100644 --- a/modules/deployments-rolling-strategy.adoc +++ b/modules/deployments-rolling-strategy.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/deployment-strategies.adoc -[id='deployments-rolling-strategy-{context}'] +[id="deployments-rolling-strategy-{context}"] = Rolling strategy A rolling deployment slowly replaces instances of the previous version of an diff --git a/modules/deployments-running-pod-svc-acct.adoc b/modules/deployments-running-pod-svc-acct.adoc index 583ff601b6..fc83b3596c 100644 --- a/modules/deployments-running-pod-svc-acct.adoc +++ b/modules/deployments-running-pod-svc-acct.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-running-pod-svc-acct-{context}'] +[id="deployments-running-pod-svc-acct-{context}"] = Running a Pod with a different service account You can run a Pod with a service account other than the default. diff --git a/modules/deployments-scaling-manually.adoc b/modules/deployments-scaling-manually.adoc index e29cdc1408..632c39600b 100644 --- a/modules/deployments-scaling-manually.adoc +++ b/modules/deployments-scaling-manually.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-scaling-manually-{context}'] +[id="deployments-scaling-manually-{context}"] = Scaling manually In addition to rollbacks, you can exercise fine-grained control over the number diff --git a/modules/deployments-setting-resources.adoc b/modules/deployments-setting-resources.adoc index cd4feab47e..15c6d82ba1 100644 --- a/modules/deployments-setting-resources.adoc +++ b/modules/deployments-setting-resources.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-setting-resources-{context}'] +[id="deployments-setting-resources-{context}"] = Setting deployment resources [NOTE] diff --git a/modules/deployments-setting-triggers.adoc b/modules/deployments-setting-triggers.adoc index f499e95717..86fb7fdace 100644 --- a/modules/deployments-setting-triggers.adoc +++ b/modules/deployments-setting-triggers.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-setting-triggers-{context}'] +[id="deployments-setting-triggers-{context}"] = Setting deployment triggers .Procedure diff --git a/modules/deployments-starting-deployment.adoc b/modules/deployments-starting-deployment.adoc index fdd90afed1..1812585a57 100644 --- a/modules/deployments-starting-deployment.adoc +++ b/modules/deployments-starting-deployment.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-starting-a-deployment-{context}'] +[id="deployments-starting-a-deployment-{context}"] = Starting a deployment You can start a _rollout_ to begin the deployment process of your application. diff --git a/modules/deployments-triggers.adoc b/modules/deployments-triggers.adoc index 7dc641963b..63b54f156e 100644 --- a/modules/deployments-triggers.adoc +++ b/modules/deployments-triggers.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-triggers-{context}'] +[id="deployments-triggers-{context}"] = Deployment triggers A DeploymentConfig can contain triggers, which drive the creation of new @@ -16,7 +16,7 @@ must be started manually. ==== [discrete] -[id='deployments-configchange-trigger-{context}'] +[id="deployments-configchange-trigger-{context}"] === ConfigChange deployment triggers The `ConfigChange` trigger results in a new ReplicationController whenever @@ -37,7 +37,7 @@ triggers: ---- [discrete] -[id='deployments-imagechange-trigger-{context}'] +[id="deployments-imagechange-trigger-{context}"] === ImageChange deployment triggers The `ImageChange` trigger results in a new ReplicationController whenever the diff --git a/modules/deployments-viewing-deployment.adoc b/modules/deployments-viewing-deployment.adoc index 59d8ea6276..755b996af8 100644 --- a/modules/deployments-viewing-deployment.adoc +++ b/modules/deployments-viewing-deployment.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-viewing-a-deployment-{context}'] +[id="deployments-viewing-a-deployment-{context}"] = Viewing a deployment You can view a deployment to get basic information about all the available diff --git a/modules/deployments-viewing-logs.adoc b/modules/deployments-viewing-logs.adoc index bfa7e7a2e0..0d13ec9395 100644 --- a/modules/deployments-viewing-logs.adoc +++ b/modules/deployments-viewing-logs.adoc @@ -2,7 +2,7 @@ // // * applications/deployments/managing-deployment-processes.adoc -[id='deployments-viewing-logs-{context}'] +[id="deployments-viewing-logs-{context}"] = Viewing deployment logs .Procedure diff --git a/modules/efk-logging-about-components.adoc b/modules/efk-logging-about-components.adoc index 3e48405bd3..7317de8469 100644 --- a/modules/efk-logging-about-components.adoc +++ b/modules/efk-logging-about-components.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging.adoc -[id='efk-logging-about-components-{context}'] +[id="efk-logging-about-components-{context}"] = About cluster logging components There are currently 4 different types of cluster logging components: diff --git a/modules/efk-logging-about-crd.adoc b/modules/efk-logging-about-crd.adoc index 86d7f33301..78785e05fd 100644 --- a/modules/efk-logging-about-crd.adoc +++ b/modules/efk-logging-about-crd.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging.adoc -[id='efk-logging-configuring-crd-{context}'] +[id="efk-logging-configuring-crd-{context}"] = About the Cluster logging CRD The Cluster Logging Operator Custom Resource Definition (CRD) defines a complete cluster logging deployment @@ -13,7 +13,7 @@ Instructions for creating or modifying a CR are provided in this documentation a The following is an example of a typical Custom Resource Definition for cluster logging. -[id='efk-logging-configuring-about-sample-{context}'] +[id="efk-logging-configuring-about-sample-{context}"] .Sample ClusterLogging CRD [source,yaml] ---- diff --git a/modules/efk-logging-about-curator.adoc b/modules/efk-logging-about-curator.adoc index 2b99a05e69..b8f79da7ac 100644 --- a/modules/efk-logging-about-curator.adoc +++ b/modules/efk-logging-about-curator.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging.adoc -[id='efk-logging-about-curator-{context}'] +[id="efk-logging-about-curator-{context}"] = About Curator in {product-title} The Elasticsearch Curator tool performs scheduled maintenance operations on a per-project basis. Curator performs actions daily based on its configuration. Only one Curator Pod is diff --git a/modules/efk-logging-about-elasticsearch.adoc b/modules/efk-logging-about-elasticsearch.adoc index f17faccaf7..051d3a583d 100644 --- a/modules/efk-logging-about-elasticsearch.adoc +++ b/modules/efk-logging-about-elasticsearch.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging.adoc -[id='efk-logging-about-elasticsearch-{context}'] +[id="efk-logging-about-elasticsearch-{context}"] = About Elasticsearch in {product-title} {product-title} uses link:https://www.elastic.co/products/elasticsearch[Elasticsearch (ES)] to organize the log data from Fluentd into datastores, or _indices_. diff --git a/modules/efk-logging-about-eventrouter.adoc b/modules/efk-logging-about-eventrouter.adoc index 7222ebf6a0..356a277507 100644 --- a/modules/efk-logging-about-eventrouter.adoc +++ b/modules/efk-logging-about-eventrouter.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging.adoc -[id='efk-logging-about-eventrouter-{context}'] +[id="efk-logging-about-eventrouter-{context}"] = About Event Router in {product-title} The Event Router forwards {product-title} events for Cluster Logging. diff --git a/modules/efk-logging-about-fluentd.adoc b/modules/efk-logging-about-fluentd.adoc index 917b6e0ad5..0a33d5d3a8 100644 --- a/modules/efk-logging-about-fluentd.adoc +++ b/modules/efk-logging-about-fluentd.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging.adoc -[id='efk-logging-about-fluentd-{context}'] +[id="efk-logging-about-fluentd-{context}"] = About Fluentd in {product-title} {product-title} uses Fluentd to collect data about your cluster. diff --git a/modules/efk-logging-about-kibana.adoc b/modules/efk-logging-about-kibana.adoc index 3408c3eb81..3adbaa8c43 100644 --- a/modules/efk-logging-about-kibana.adoc +++ b/modules/efk-logging-about-kibana.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging.adoc -[id='efk-logging-about-kibana-{context}'] +[id="efk-logging-about-kibana-{context}"] = About Kibana in {product-title} {product-title} uses Kibana to display the log data collected by Fluentd and indexed by Elasticsearch. diff --git a/modules/efk-logging-about.adoc b/modules/efk-logging-about.adoc index 29db91baec..13ca2114db 100644 --- a/modules/efk-logging-about.adoc +++ b/modules/efk-logging-about.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging.adoc -[id='efk-logging-about-{context}'] +[id="efk-logging-about-{context}"] = About cluster logging in {product-title} As an {product-title} cluster administrator, you can deploy cluster logging to diff --git a/modules/efk-logging-configuring-image-about.adoc b/modules/efk-logging-configuring-image-about.adoc index 13de72ba7d..63f944602d 100644 --- a/modules/efk-logging-configuring-image-about.adoc +++ b/modules/efk-logging-configuring-image-about.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-configuring.adoc -[id='efk-logging-configuring-image-about-{context}'] +[id="efk-logging-configuring-image-about-{context}"] = Understanding the cluster logging component images There are several components in cluster logging, each one implemented with one diff --git a/modules/efk-logging-configuring-node-selector.adoc b/modules/efk-logging-configuring-node-selector.adoc index e336ca81ba..b7b2380889 100644 --- a/modules/efk-logging-configuring-node-selector.adoc +++ b/modules/efk-logging-configuring-node-selector.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch.adoc -[id='efk-logging-configuring-node-selector-{context}'] +[id="efk-logging-configuring-node-selector-{context}"] = Specifying a node for cluster logging components using node selectors Each component specification allows the component to target a specific node. diff --git a/modules/efk-logging-curator-actions.adoc b/modules/efk-logging-curator-actions.adoc index 3bf2073967..5a3b03d7cf 100644 --- a/modules/efk-logging-curator-actions.adoc +++ b/modules/efk-logging-curator-actions.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-curator.adoc -[id='efk-logging-curator-actions-{context}'] +[id="efk-logging-curator-actions-{context}"] = Preventing Curator from deleting internal indices The Cluster Logging Operator installation creates a Curator *action file*, *_curator-actions.yaml_*, that includes only the *delete_indices* action. You configure the *action file* using the{product-title} custom configuration file, *_config.yaml_*. Currently, the only action you can use with the automatically-created *action file* is `delete_indices`. diff --git a/modules/efk-logging-curator-configuration.adoc b/modules/efk-logging-curator-configuration.adoc index 329cd904e7..98bbd1f9e8 100644 --- a/modules/efk-logging-curator-configuration.adoc +++ b/modules/efk-logging-curator-configuration.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-curator.adoc -[id='configuration-cronjob-{context}'] +[id="configuration-cronjob-{context}"] = Modifying the Curator configuration You can configure your ops and non-ops Curator instances using the Cluster Logging Custom Resource diff --git a/modules/efk-logging-curator-cron.adoc b/modules/efk-logging-curator-cron.adoc index d7f132be89..92ddcc9f2e 100644 --- a/modules/efk-logging-curator-cron.adoc +++ b/modules/efk-logging-curator-cron.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-curator.adoc -[id='efk-logging-curator-cron-{context}'] +[id="efk-logging-curator-cron-{context}"] = Configuring Curator using a CronJob You can alternatively create, configure, and run Curator using a CronJob. The next scheduled job uses this configuration. diff --git a/modules/efk-logging-curator-delete-index.adoc b/modules/efk-logging-curator-delete-index.adoc index 3d3ed514f4..7a1f72648c 100644 --- a/modules/efk-logging-curator-delete-index.adoc +++ b/modules/efk-logging-curator-delete-index.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-curator.adoc -[id='efk-logging-curator-yaml-{context}'] +[id="efk-logging-curator-yaml-{context}"] = Deleting Elasticsearch data //// diff --git a/modules/efk-logging-curator-schedule.adoc b/modules/efk-logging-curator-schedule.adoc index 9ae52ad842..700776d57d 100644 --- a/modules/efk-logging-curator-schedule.adoc +++ b/modules/efk-logging-curator-schedule.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-curator.adoc -[id='efk-logging-curator-schedule-{context}'] +[id="efk-logging-curator-schedule-{context}"] = Configuring the Curator schedule You can specify the schedule for Curator using the cluster logging Custom Reosurce diff --git a/modules/efk-logging-curator-yaml.adoc b/modules/efk-logging-curator-yaml.adoc index 1535f43208..d0db24f664 100644 --- a/modules/efk-logging-curator-yaml.adoc +++ b/modules/efk-logging-curator-yaml.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-curator.adoc -[id='efk-logging-curator-yaml-{context}'] +[id="efk-logging-curator-yaml-{context}"] = Deleting Curator Indices You can configure Elasticsearch Curator to delete indices. diff --git a/modules/efk-logging-deploy-certificates.adoc b/modules/efk-logging-deploy-certificates.adoc index 63331cecfd..6e45ecfcbf 100644 --- a/modules/efk-logging-deploy-certificates.adoc +++ b/modules/efk-logging-deploy-certificates.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-deploy.adoc -[id='efk-logging-deploy-certificates-{context}'] +[id="efk-logging-deploy-certificates-{context}"] = Deploying custom certificates You can specify custom certificates using the following variables diff --git a/modules/efk-logging-deploy-label.adoc b/modules/efk-logging-deploy-label.adoc index 0e1ee9b32e..6821056cf3 100644 --- a/modules/efk-logging-deploy-label.adoc +++ b/modules/efk-logging-deploy-label.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-deploy.adoc -[id='efk-logging-deploy-label-{context}'] +[id="efk-logging-deploy-label-{context}"] = Labeling nodes At 100 nodes or more, it is recommended to first pre-pull the logging images diff --git a/modules/efk-logging-deploy-memory.adoc b/modules/efk-logging-deploy-memory.adoc index 3f1d311209..0b6f9dcbc8 100644 --- a/modules/efk-logging-deploy-memory.adoc +++ b/modules/efk-logging-deploy-memory.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-deploy.adoc -[id='efk-logging-deploy-memory-{context}'] +[id="efk-logging-deploy-memory-{context}"] = Configure memory for Elasticsearch instances By default the amount of RAM allocated to each ES instance is 16GB. You can change this value as needed. diff --git a/modules/efk-logging-deploy-storage-considerations.adoc b/modules/efk-logging-deploy-storage-considerations.adoc index 35b27cb58c..b9d78d00d3 100644 --- a/modules/efk-logging-deploy-storage-considerations.adoc +++ b/modules/efk-logging-deploy-storage-considerations.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-deploy.adoc -[id='efk-logging-deploy-storage-considerations-{context}'] +[id="efk-logging-deploy-storage-considerations-{context}"] = Storage considerations for cluster logging and {product-title} An Elasticsearch index is a collection of primary shards and its corresponding replica diff --git a/modules/efk-logging-deploy-subscription.adoc b/modules/efk-logging-deploy-subscription.adoc index 701081c271..341b1cf8a8 100644 --- a/modules/efk-logging-deploy-subscription.adoc +++ b/modules/efk-logging-deploy-subscription.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-deploy.adoc -[id='efk-logging-deploy-subscription-{context}'] +[id="efk-logging-deploy-subscription-{context}"] = Installing the Cluster Logging and Elasticsearch Operators You can use the {product-title} console to install cluster logging, by deploying, diff --git a/modules/efk-logging-elasticsearch-add-remove.adoc b/modules/efk-logging-elasticsearch-add-remove.adoc index cd1bed44e8..b13f9bacc0 100644 --- a/modules/efk-logging-elasticsearch-add-remove.adoc +++ b/modules/efk-logging-elasticsearch-add-remove.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch.adoc -[id='efk-logging-elasticsearch-add-remove-{context}'] +[id="efk-logging-elasticsearch-add-remove-{context}"] = Scaling your Elasticsearch cluster You can scale the number of data nodes in Elasticsearch. diff --git a/modules/efk-logging-elasticsearch-admin.adoc b/modules/efk-logging-elasticsearch-admin.adoc index 1fb1d1ab0a..e63f7b3257 100644 --- a/modules/efk-logging-elasticsearch-admin.adoc +++ b/modules/efk-logging-elasticsearch-admin.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch.adoc -[id='efk-logging-elasticsearch-admin-{context}'] +[id="efk-logging-elasticsearch-admin-{context}"] = Performing administrative Elasticsearch operations An administrator certificate, key, and CA that can be used to communicate with and perform diff --git a/modules/efk-logging-elasticsearch-exposing.adoc b/modules/efk-logging-elasticsearch-exposing.adoc index 700b5eba68..81a26970c2 100644 --- a/modules/efk-logging-elasticsearch-exposing.adoc +++ b/modules/efk-logging-elasticsearch-exposing.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch.adoc -[id='efk-logging-elasticsearch-exposing-{context}'] +[id="efk-logging-elasticsearch-exposing-{context}"] = Exposing Elasticsearch as a route By default, Elasticsearch deployed with cluster logging is not diff --git a/modules/efk-logging-elasticsearch-ha.adoc b/modules/efk-logging-elasticsearch-ha.adoc index 862a3ea606..bc7827487d 100644 --- a/modules/efk-logging-elasticsearch-ha.adoc +++ b/modules/efk-logging-elasticsearch-ha.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch.adoc -[id='efk-logging-elasticsearch-ha-{context}'] +[id="efk-logging-elasticsearch-ha-{context}"] = Configuring Elasticsearch replication policy You can define how Elasticsearch shards are replicated across data nodes in the cluster: diff --git a/modules/efk-logging-elasticsearch-limits.adoc b/modules/efk-logging-elasticsearch-limits.adoc index e10b9a9b9f..15d4e768bc 100644 --- a/modules/efk-logging-elasticsearch-limits.adoc +++ b/modules/efk-logging-elasticsearch-limits.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch.adoc -[id='efk-logging-elasticsearch-limits-{context}'] +[id="efk-logging-elasticsearch-limits-{context}"] = Configuring Elasticsearch CPU and memory limits Each component specification allows for adjustments to both the CPU and memory limits. diff --git a/modules/efk-logging-elasticsearch-persistent-storage-about.adoc b/modules/efk-logging-elasticsearch-persistent-storage-about.adoc index 6e673e4e03..dea054c589 100644 --- a/modules/efk-logging-elasticsearch-persistent-storage-about.adoc +++ b/modules/efk-logging-elasticsearch-persistent-storage-about.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch.adoc -[id='efk-logging-elasticsearch-persistent-storage-about-{context}'] +[id="efk-logging-elasticsearch-persistent-storage-about-{context}"] = Configuring persistent storage for Elasticsearch By default, the `openshift_logging` creates an ephemeral diff --git a/modules/efk-logging-elasticsearch-persistent-storage-empty.adoc b/modules/efk-logging-elasticsearch-persistent-storage-empty.adoc index e5925357c5..bb65176e52 100644 --- a/modules/efk-logging-elasticsearch-persistent-storage-empty.adoc +++ b/modules/efk-logging-elasticsearch-persistent-storage-empty.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch-storage.adoc -[id='efk-logging-elasticsearch-persistent-storage-empty-{context}'] +[id="efk-logging-elasticsearch-persistent-storage-empty-{context}"] = Configuring Elasticsearch for emptyDir storage You can use emptyDir with Elasticsearch, which uses ephemeral storage for each pod. diff --git a/modules/efk-logging-elasticsearch-rules.adoc b/modules/efk-logging-elasticsearch-rules.adoc index 03fed49fce..3ed8ecfd7f 100644 --- a/modules/efk-logging-elasticsearch-rules.adoc +++ b/modules/efk-logging-elasticsearch-rules.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch -[id='efk-logging-elasticsearch-rules-{context}'] +[id="efk-logging-elasticsearch-rules-{context}"] = About Elasticsearch alerting rules [cols="3,6,1",options="header"] diff --git a/modules/efk-logging-elasticsearch-status.adoc b/modules/efk-logging-elasticsearch-status.adoc index 57d1c98883..6187cc18d8 100644 --- a/modules/efk-logging-elasticsearch-status.adoc +++ b/modules/efk-logging-elasticsearch-status.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch.adoc -[id='efk-logging-elasticsearch-status-{context}'] +[id="efk-logging-elasticsearch-status-{context}"] = Viewing Elasticsearch status You can view the status of your Elasticsearch cluster. diff --git a/modules/efk-logging-elasticsearch-storage.adoc b/modules/efk-logging-elasticsearch-storage.adoc index c2c3d1e6f1..93b85fc68e 100644 --- a/modules/efk-logging-elasticsearch-storage.adoc +++ b/modules/efk-logging-elasticsearch-storage.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-elasticsearch.adoc -[id='efk-logging-elasticsearch-storage-{context}'] +[id="efk-logging-elasticsearch-storage-{context}"] = Configuring Elasticsearch storage Elasticsearch requires persistent storage. The faster the storage, the faster the Elasticsearch performance is. diff --git a/modules/efk-logging-eventrouter-deploy.adoc b/modules/efk-logging-eventrouter-deploy.adoc index 17a19e4845..c95e5afbd0 100644 --- a/modules/efk-logging-eventrouter-deploy.adoc +++ b/modules/efk-logging-eventrouter-deploy.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-eventrouter.adoc -[id='efk-logging-eventrouter-deploy-{context}'] +[id="efk-logging-eventrouter-deploy-{context}"] = Deploying and Configuring the Event Router Use the following steps to deploy Event Router into your cluster. diff --git a/modules/efk-logging-exported-fields-aushape.adoc b/modules/efk-logging-exported-fields-aushape.adoc index 97cb3a3c73..d6730f0435 100644 --- a/modules/efk-logging-exported-fields-aushape.adoc +++ b/modules/efk-logging-exported-fields-aushape.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-aushape-{context}'] +[id="efk-logging-exported-fields-aushape-{context}"] = Aushape exported fields These are the Aushape fields exported by the {product-title} cluster logging available for searching @@ -36,7 +36,7 @@ the trimming occurred by unspecified objects and arrays. |=== [discrete] -[id='exported-fields-aushape.data-{context}'] +[id="exported-fields-aushape.data-{context}"] === `aushape.data` Fields Parsed audit event data related to Aushape. diff --git a/modules/efk-logging-exported-fields-collectd.adoc b/modules/efk-logging-exported-fields-collectd.adoc index aabf001933..cc19a4d228 100644 --- a/modules/efk-logging-exported-fields-collectd.adoc +++ b/modules/efk-logging-exported-fields-collectd.adoc @@ -2,14 +2,14 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-collectd-{context}'] +[id="efk-logging-exported-fields-collectd-{context}"] = `collectd` exported fields These are the `collectd` and `collectd-*` fields exported by the logging system and available for searching from Elasticsearch and Kibana. [discrete] -[id='exported-fields-collectd-{context}'] +[id="exported-fields-collectd-{context}"] === `collectd` Fields The following fields represent namespace metrics metadata. @@ -51,7 +51,7 @@ The `collectd` dstypes. |=== [discrete] -[id='exported-fields-collectd.processes-{context}'] +[id="exported-fields-collectd.processes-{context}"] === `collectd.processes` Fields The following field corresponds to the `collectd` processes plug-in. @@ -67,7 +67,7 @@ The `collectd ps_state` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_disk_ops-{context}'] +[id="exported-fields-collectd.processes.ps_disk_ops-{context}"] === `collectd.processes.ps_disk_ops` Fields The `collectd` `ps_disk_ops` type of processes plug-in. @@ -114,7 +114,7 @@ The `collectd` `ps_stacksize` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_cputime-{context}'] +[id="exported-fields-collectd.processes.ps_cputime-{context}"] === `collectd.processes.ps_cputime` Fields The `collectd` `ps_cputime` type of processes plug-in. @@ -136,7 +136,7 @@ The `collectd` `ps_cputime` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_count-{context}'] +[id="exported-fields-collectd.processes.ps_count-{context}"] === `collectd.processes.ps_count` Fields The `collectd` `ps_count` type of processes plug-in. @@ -158,7 +158,7 @@ The `collectd` `ps_count` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_pagefaults-{context}'] +[id="exported-fields-collectd.processes.ps_pagefaults-{context}"] === `collectd.processes.ps_pagefaults` Fields The `collectd` `ps_pagefaults` type of processes plug-in. @@ -180,7 +180,7 @@ The `collectd` `ps_pagefaults` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_disk_octets-{context}'] +[id="exported-fields-collectd.processes.ps_disk_octets-{context}"] === `collectd.processes.ps_disk_octets` Fields The `collectd ps_disk_octets` type of processes plug-in. @@ -207,13 +207,13 @@ The `collectd` `fork_rate` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.disk-{context}'] +[id="exported-fields-collectd.disk-{context}"] === `collectd.disk` Fields Corresponds to `collectd` disk plug-in. [discrete] -[id='exported-fields-collectd.disk.disk_merged-{context}'] +[id="exported-fields-collectd.disk.disk_merged-{context}"] === `collectd.disk.disk_merged` Fields The `collectd` `disk_merged` type of disk plug-in. @@ -235,7 +235,7 @@ The `collectd` `disk_merged` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.disk.disk_octets-{context}'] +[id="exported-fields-collectd.disk.disk_octets-{context}"] === `collectd.disk.disk_octets` Fields The `collectd` `disk_octets` type of disk plug-in. @@ -257,7 +257,7 @@ The `collectd` `disk_octets` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.disk.disk_time-{context}'] +[id="exported-fields-collectd.disk.disk_time-{context}"] === `collectd.disk.disk_time` Fields The `collectd` `disk_time` type of disk plug-in. @@ -279,7 +279,7 @@ The `collectd` `disk_time` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.disk.disk_ops-{context}'] +[id="exported-fields-collectd.disk.disk_ops-{context}"] === `collectd.disk.disk_ops` Fields The `collectd` `disk_ops` type of disk plug-in. @@ -306,7 +306,7 @@ The `collectd` `pending_operations` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.disk.disk_io_time-{context}'] +[id="exported-fields-collectd.disk.disk_io_time-{context}"] === `collectd.disk.disk_io_time` Fields The `collectd disk_io_time` type of disk plug-in. @@ -328,13 +328,13 @@ The `collectd disk_io_time` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.interface-{context}'] +[id="exported-fields-collectd.interface-{context}"] === `collectd.interface` Fields Corresponds to the `collectd` interface plug-in. [discrete] -[id='exported-fields-collectd.interface.if_octets-{context}'] +[id="exported-fields-collectd.interface.if_octets-{context}"] === `collectd.interface.if_octets` Fields The `collectd` `if_octets` type of interface plug-in. @@ -356,7 +356,7 @@ The `collectd` `if_octets` type of interface plug-in. |=== [discrete] -[id='exported-fields-collectd.interface.if_packets-{context}'] +[id="exported-fields-collectd.interface.if_packets-{context}"] === `collectd.interface.if_packets` Fields The `collectd` `if_packets` type of interface plug-in. @@ -378,7 +378,7 @@ The `collectd` `if_packets` type of interface plug-in. |=== [discrete] -[id='exported-fields-collectd.interface.if_errors-{context}'] +[id="exported-fields-collectd.interface.if_errors-{context}"] === `collectd.interface.if_errors` Fields The `collectd` `if_errors` type of interface plug-in. @@ -400,7 +400,7 @@ The `collectd` `if_errors` type of interface plug-in. |=== [discrete] -[id='exported-fields-collectd.interface.if_dropped-{context}'] +[id="exported-fields-collectd.interface.if_dropped-{context}"] === collectd.interface.if_dropped Fields The `collectd` `if_dropped` type of interface plug-in. @@ -422,13 +422,13 @@ The `collectd` `if_dropped` type of interface plug-in. |=== [discrete] -[id='exported-fields-collectd.virt-{context}'] +[id="exported-fields-collectd.virt-{context}"] === `collectd.virt` Fields Corresponds to `collectd` virt plug-in. [discrete] -[id='exported-fields-collectd.virt.if_octets-{context}'] +[id="exported-fields-collectd.virt.if_octets-{context}"] === `collectd.virt.if_octets` Fields The `collectd if_octets` type of virt plug-in. @@ -450,7 +450,7 @@ The `collectd if_octets` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.if_packets-{context}'] +[id="exported-fields-collectd.virt.if_packets-{context}"] === `collectd.virt.if_packets` Fields The `collectd` `if_packets` type of virt plug-in. @@ -472,7 +472,7 @@ The `collectd` `if_packets` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.if_errors-{context}'] +[id="exported-fields-collectd.virt.if_errors-{context}"] === `collectd.virt.if_errors` Fields The `collectd` `if_errors` type of virt plug-in. @@ -494,7 +494,7 @@ The `collectd` `if_errors` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.if_dropped-{context}'] +[id="exported-fields-collectd.virt.if_dropped-{context}"] === `collectd.virt.if_dropped` Fields The `collectd` `if_dropped` type of virt plug-in. @@ -516,7 +516,7 @@ The `collectd` `if_dropped` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.disk_ops-{context}'] +[id="exported-fields-collectd.virt.disk_ops-{context}"] === `collectd.virt.disk_ops` Fields The `collectd` `disk_ops` type of virt plug-in. @@ -538,7 +538,7 @@ The `collectd` `disk_ops` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.disk_octets-{context}'] +[id="exported-fields-collectd.virt.disk_octets-{context}"] === `collectd.virt.disk_octets` Fields The `collectd` `disk_octets` type of virt plug-in. @@ -575,7 +575,7 @@ The `collectd` `virt_cpu_total` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.CPU-{context}'] +[id="exported-fields-collectd.CPU-{context}"] === `collectd.CPU` Fields Corresponds to the `collectd` CPU plug-in. @@ -592,7 +592,7 @@ The `collectd` type percent of plug-in CPU. |=== [discrete] -[id='exported-fields-collectd.df-{context}'] +[id="exported-fields-collectd.df-{context}"] === collectd.df Fields Corresponds to the `collectd` `df` plug-in. @@ -614,7 +614,7 @@ The `collectd` type `percent_bytes` of plug-in `df`. |=== [discrete] -[id='exported-fields-collectd.entropy-{context}'] +[id="exported-fields-collectd.entropy-{context}"] === `collectd.entropy` Fields Corresponds to the `collectd` entropy plug-in. @@ -632,7 +632,7 @@ The `collectd` entropy type of entropy plug-in. //// [discrete] -[id='exported-fields-collectd.nfs-{context}'] +[id="exported-fields-collectd.nfs-{context}"] === `collectd.nfs` Fields Corresponds to the `collectd` NFS plug-in. @@ -650,7 +650,7 @@ The `collectd` `nfs_procedure` type of nfs plug-in. //// [discrete] -[id='exported-fields-collectd.memory-{context}'] +[id="exported-fields-collectd.memory-{context}"] === `collectd.memory` Fields Corresponds to the `collectd` memory plug-in. @@ -672,7 +672,7 @@ The `collectd` percent type of memory plug-in. |=== [discrete] -[id='exported-fields-collectd.swap-{context}'] +[id="exported-fields-collectd.swap-{context}"] === `collectd.swap` Fields Corresponds to the `collectd` swap plug-in. @@ -694,13 +694,13 @@ The `collectd swap_io` type of swap plug-in. |=== [discrete] -[id='exported-fields-collectd.load-{context}'] +[id="exported-fields-collectd.load-{context}"] === `collectd.load` Fields Corresponds to the `collectd` load plug-in. [discrete] -[id='exported-fields-collectd.load.load-{context}'] +[id="exported-fields-collectd.load.load-{context}"] === `collectd.load.load` Fields The `collectd` load type of load plug-in @@ -727,7 +727,7 @@ The `collectd` load type of load plug-in |=== [discrete] -[id='exported-fields-collectd.aggregation-{context}'] +[id="exported-fields-collectd.aggregation-{context}"] === `collectd.aggregation` Fields Corresponds to `collectd` aggregation plug-in. @@ -744,7 +744,7 @@ Corresponds to `collectd` aggregation plug-in. |=== [discrete] -[id='exported-fields-collectd.statsd-{context}'] +[id="exported-fields-collectd.statsd-{context}"] === `collectd.statsd` Fields Corresponds to `collectd` `statsd` plug-in. @@ -951,7 +951,7 @@ The `collectd` `nic_speed` type of `statsd` plug-in. |=== [discrete] -[id='exported-fields-collectd.postgresql-{context}'] +[id="exported-fields-collectd.postgresql-{context}"] === `collectd.postgresql Fields` Corresponds to `collectd` `postgresql` plug-in. diff --git a/modules/efk-logging-exported-fields-container.adoc b/modules/efk-logging-exported-fields-container.adoc index 0ff0da8042..5636c00285 100644 --- a/modules/efk-logging-exported-fields-container.adoc +++ b/modules/efk-logging-exported-fields-container.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-container-{context}'] +[id="efk-logging-exported-fields-container-{context}"] = Container exported fields These are the Docker fields exported by the OpenShift Container Platform cluster logging available for searching from Elasticsearch and Kibana. @@ -10,7 +10,7 @@ Namespace for docker container-specific metadata. The docker.container_id is the [discrete] -[id='exported-fields-pipeline_metadata.collector-{context}'] +[id="exported-fields-pipeline_metadata.collector-{context}"] === `pipeline_metadata.collector` Fields This section contains metadata specific to the collector. @@ -49,7 +49,7 @@ source as possible. |=== [discrete] -[id='exported-fields-pipeline_metadata.normalizer-{context}'] +[id="exported-fields-pipeline_metadata.normalizer-{context}"] === `pipeline_metadata.normalizer` Fields This section contains metadata specific to the normalizer. diff --git a/modules/efk-logging-exported-fields-default.adoc b/modules/efk-logging-exported-fields-default.adoc index 2dbdb494bf..c5ea5891db 100644 --- a/modules/efk-logging-exported-fields-default.adoc +++ b/modules/efk-logging-exported-fields-default.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-default-{context}'] +[id="efk-logging-exported-fields-default-{context}"] = Default exported fields These are the default fields exported by the logging system and available for searching @@ -154,7 +154,7 @@ The `collectd` dstypes. |=== [discrete] -[id='exported-fields-collectd.processes-{context}'] +[id="exported-fields-collectd.processes-{context}"] === `collectd.processes` Fields The following field corresponds to the `collectd` processes plug-in. @@ -170,7 +170,7 @@ The `collectd ps_state` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_disk_ops-{context}'] +[id="exported-fields-collectd.processes.ps_disk_ops-{context}"] === `collectd.processes.ps_disk_ops` Fields The `collectd` `ps_disk_ops` type of processes plug-in. @@ -217,7 +217,7 @@ The `collectd` `ps_stacksize` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_cputime-{context}'] +[id="exported-fields-collectd.processes.ps_cputime-{context}"] === `collectd.processes.ps_cputime` Fields The `collectd` `ps_cputime` type of processes plug-in. @@ -239,7 +239,7 @@ The `collectd` `ps_cputime` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_count-{context}'] +[id="exported-fields-collectd.processes.ps_count-{context}"] === `collectd.processes.ps_count` Fields The `collectd` `ps_count` type of processes plug-in. @@ -261,7 +261,7 @@ The `collectd` `ps_count` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_pagefaults-{context}'] +[id="exported-fields-collectd.processes.ps_pagefaults-{context}"] === `collectd.processes.ps_pagefaults` Fields The `collectd` `ps_pagefaults` type of processes plug-in. @@ -283,7 +283,7 @@ The `collectd` `ps_pagefaults` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.processes.ps_disk_octets-{context}'] +[id="exported-fields-collectd.processes.ps_disk_octets-{context}"] === `collectd.processes.ps_disk_octets` Fields The `collectd ps_disk_octets` type of processes plug-in. @@ -310,13 +310,13 @@ The `collectd` `fork_rate` type of processes plug-in. |=== [discrete] -[id='exported-fields-collectd.disk-{context}'] +[id="exported-fields-collectd.disk-{context}"] === `collectd.disk` Fields Corresponds to `collectd` disk plug-in. [discrete] -[id='exported-fields-collectd.disk.disk_merged-{context}'] +[id="exported-fields-collectd.disk.disk_merged-{context}"] === `collectd.disk.disk_merged` Fields The `collectd` `disk_merged` type of disk plug-in. @@ -338,7 +338,7 @@ The `collectd` `disk_merged` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.disk.disk_octets-{context}'] +[id="exported-fields-collectd.disk.disk_octets-{context}"] === `collectd.disk.disk_octets` Fields The `collectd` `disk_octets` type of disk plug-in. @@ -360,7 +360,7 @@ The `collectd` `disk_octets` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.disk.disk_time-{context}'] +[id="exported-fields-collectd.disk.disk_time-{context}"] === `collectd.disk.disk_time` Fields The `collectd` `disk_time` type of disk plug-in. @@ -382,7 +382,7 @@ The `collectd` `disk_time` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.disk.disk_ops-{context}'] +[id="exported-fields-collectd.disk.disk_ops-{context}"] === `collectd.disk.disk_ops` Fields The `collectd` `disk_ops` type of disk plug-in. @@ -409,7 +409,7 @@ The `collectd` `pending_operations` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.disk.disk_io_time-{context}'] +[id="exported-fields-collectd.disk.disk_io_time-{context}"] === `collectd.disk.disk_io_time` Fields The `collectd disk_io_time` type of disk plug-in. @@ -431,13 +431,13 @@ The `collectd disk_io_time` type of disk plug-in. |=== [discrete] -[id='exported-fields-collectd.interface-{context}'] +[id="exported-fields-collectd.interface-{context}"] === `collectd.interface` Fields Corresponds to the `collectd` interface plug-in. [discrete] -[id='exported-fields-collectd.interface.if_octets-{context}'] +[id="exported-fields-collectd.interface.if_octets-{context}"] === `collectd.interface.if_octets` Fields The `collectd` `if_octets` type of interface plug-in. @@ -459,7 +459,7 @@ The `collectd` `if_octets` type of interface plug-in. |=== [discrete] -[id='exported-fields-collectd.interface.if_packets-{context}'] +[id="exported-fields-collectd.interface.if_packets-{context}"] === `collectd.interface.if_packets` Fields The `collectd` `if_packets` type of interface plug-in. @@ -481,7 +481,7 @@ The `collectd` `if_packets` type of interface plug-in. |=== [discrete] -[id='exported-fields-collectd.interface.if_errors-{context}'] +[id="exported-fields-collectd.interface.if_errors-{context}"] === `collectd.interface.if_errors` Fields The `collectd` `if_errors` type of interface plug-in. @@ -503,7 +503,7 @@ The `collectd` `if_errors` type of interface plug-in. |=== [discrete] -[id='exported-fields-collectd.interface.if_dropped-{context}'] +[id="exported-fields-collectd.interface.if_dropped-{context}"] === collectd.interface.if_dropped Fields The `collectd` `if_dropped` type of interface plug-in. @@ -525,13 +525,13 @@ The `collectd` `if_dropped` type of interface plug-in. |=== [discrete] -[id='exported-fields-collectd.virt-{context}'] +[id="exported-fields-collectd.virt-{context}"] === `collectd.virt` Fields Corresponds to `collectd` virt plug-in. [discrete] -[id='exported-fields-collectd.virt.if_octets-{context}'] +[id="exported-fields-collectd.virt.if_octets-{context}"] === `collectd.virt.if_octets` Fields The `collectd if_octets` type of virt plug-in. @@ -553,7 +553,7 @@ The `collectd if_octets` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.if_packets-{context}'] +[id="exported-fields-collectd.virt.if_packets-{context}"] === `collectd.virt.if_packets` Fields The `collectd` `if_packets` type of virt plug-in. @@ -575,7 +575,7 @@ The `collectd` `if_packets` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.if_errors-{context}'] +[id="exported-fields-collectd.virt.if_errors-{context}"] === `collectd.virt.if_errors` Fields The `collectd` `if_errors` type of virt plug-in. @@ -597,7 +597,7 @@ The `collectd` `if_errors` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.if_dropped-{context}'] +[id="exported-fields-collectd.virt.if_dropped-{context}"] === `collectd.virt.if_dropped` Fields The `collectd` `if_dropped` type of virt plug-in. @@ -619,7 +619,7 @@ The `collectd` `if_dropped` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.disk_ops-{context}'] +[id="exported-fields-collectd.virt.disk_ops-{context}"] === `collectd.virt.disk_ops` Fields The `collectd` `disk_ops` type of virt plug-in. @@ -641,7 +641,7 @@ The `collectd` `disk_ops` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.virt.disk_octets-{context}'] +[id="exported-fields-collectd.virt.disk_octets-{context}"] === `collectd.virt.disk_octets` Fields The `collectd` `disk_octets` type of virt plug-in. @@ -678,7 +678,7 @@ The `collectd` `virt_cpu_total` type of virt plug-in. |=== [discrete] -[id='exported-fields-collectd.CPU-{context}'] +[id="exported-fields-collectd.CPU-{context}"] === `collectd.CPU` Fields Corresponds to the `collectd` CPU plug-in. @@ -695,7 +695,7 @@ The `collectd` type percent of plug-in CPU. |=== [discrete] -[id='exported-fields-collectd.df-{context}'] +[id="exported-fields-collectd.df-{context}"] === collectd.df Fields Corresponds to the `collectd` `df` plug-in. @@ -717,7 +717,7 @@ The `collectd` type `percent_bytes` of plug-in `df`. |=== [discrete] -[id='exported-fields-collectd.entropy-{context}'] +[id="exported-fields-collectd.entropy-{context}"] === `collectd.entropy` Fields Corresponds to the `collectd` entropy plug-in. @@ -735,7 +735,7 @@ The `collectd` entropy type of entropy plug-in. //// [discrete] -[id='exported-fields-collectd.nfs-{context}'] +[id="exported-fields-collectd.nfs-{context}"] === `collectd.nfs` Fields Corresponds to the `collectd` NFS plug-in. @@ -753,7 +753,7 @@ The `collectd` `nfs_procedure` type of nfs plug-in. //// [discrete] -[id='exported-fields-collectd.memory-{context}'] +[id="exported-fields-collectd.memory-{context}"] === `collectd.memory` Fields Corresponds to the `collectd` memory plug-in. @@ -775,7 +775,7 @@ The `collectd` percent type of memory plug-in. |=== [discrete] -[id='exported-fields-collectd.swap-{context}'] +[id="exported-fields-collectd.swap-{context}"] === `collectd.swap` Fields Corresponds to the `collectd` swap plug-in. @@ -797,13 +797,13 @@ The `collectd swap_io` type of swap plug-in. |=== [discrete] -[id='exported-fields-collectd.load-{context}'] +[id="exported-fields-collectd.load-{context}"] === `collectd.load` Fields Corresponds to the `collectd` load plug-in. [discrete] -[id='exported-fields-collectd.load.load-{context}'] +[id="exported-fields-collectd.load.load-{context}"] === `collectd.load.load` Fields The `collectd` load type of load plug-in @@ -830,7 +830,7 @@ The `collectd` load type of load plug-in |=== [discrete] -[id='exported-fields-collectd.aggregation-{context}'] +[id="exported-fields-collectd.aggregation-{context}"] === `collectd.aggregation` Fields Corresponds to `collectd` aggregation plug-in. @@ -847,7 +847,7 @@ Corresponds to `collectd` aggregation plug-in. |=== [discrete] -[id='exported-fields-collectd.statsd-{context}'] +[id="exported-fields-collectd.statsd-{context}"] === `collectd.statsd` Fields Corresponds to `collectd` `statsd` plug-in. @@ -1054,7 +1054,7 @@ The `collectd` `nic_speed` type of `statsd` plug-in. |=== [discrete] -[id='exported-fields-collectd.postgresql-{context}'] +[id="exported-fields-collectd.postgresql-{context}"] === `collectd.postgresql Fields` Corresponds to `collectd` `postgresql` plug-in. diff --git a/modules/efk-logging-exported-fields-docker.adoc b/modules/efk-logging-exported-fields-docker.adoc index d0d77e2447..7830cd43a1 100644 --- a/modules/efk-logging-exported-fields-docker.adoc +++ b/modules/efk-logging-exported-fields-docker.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-container-{context}'] +[id="efk-logging-exported-fields-container-{context}"] = Container exported fields These are the Docker fields exported by the OpenShift Container Platform cluster logging available for searching from Elasticsearch and Kibana. @@ -10,7 +10,7 @@ Namespace for docker container-specific metadata. The docker.container_id is the [discrete] -[id='pipeline_metadata.collector-{context}'] +[id="pipeline_metadata.collector-{context}"] === `pipeline_metadata.collector` Fields This section contains metadata specific to the collector. @@ -49,7 +49,7 @@ source as possible. |=== [discrete] -[id='exported-fields-pipeline_metadata.normalizer-{context}'] +[id="exported-fields-pipeline_metadata.normalizer-{context}"] === `pipeline_metadata.normalizer` Fields This section contains metadata specific to the normalizer. diff --git a/modules/efk-logging-exported-fields-kubernetes.adoc b/modules/efk-logging-exported-fields-kubernetes.adoc index c2b665c675..266293a801 100644 --- a/modules/efk-logging-exported-fields-kubernetes.adoc +++ b/modules/efk-logging-exported-fields-kubernetes.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-kubernetes-{context}'] +[id="efk-logging-exported-fields-kubernetes-{context}"] = Kubernetes exported fields These are the Kubernetes fields exported by the {product-title} cluster logging available for searching @@ -12,7 +12,7 @@ The namespace for Kubernetes-specific metadata. The `kubernetes.pod_name` is the name of the pod. [discrete] -[id='exported-fields-kubernetes.labels-{context}'] +[id="exported-fields-kubernetes.labels-{context}"] === `kubernetes.labels` Fields Labels attached to the OpenShift object are `kubernetes.labels`. Each label name @@ -53,7 +53,7 @@ name are replaced with underscores. |=== [discrete] -[id='exported-fields-kubernetes.annotations-{context}'] +[id="exported-fields-kubernetes.annotations-{context}"] === `kubernetes.annotations` Fields Annotations associated with the OpenShift object are `kubernetes.annotations` diff --git a/modules/efk-logging-exported-fields-ovirt.adoc b/modules/efk-logging-exported-fields-ovirt.adoc index b7493c4790..bf4f443039 100644 --- a/modules/efk-logging-exported-fields-ovirt.adoc +++ b/modules/efk-logging-exported-fields-ovirt.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-ovirt-{context}'] +[id="efk-logging-exported-fields-ovirt-{context}"] = oVirt exported fields These are the oVirt fields exported by the {product-title} cluster logging available for searching @@ -23,7 +23,7 @@ Namespace for oVirt metadata. |=== [discrete] -[id='exported-fields-ovirt.engine-{context}'] +[id="exported-fields-ovirt.engine-{context}"] === `ovirt.engine` Fields Namespace for oVirt engine related metadata. The FQDN of the oVirt engine is diff --git a/modules/efk-logging-exported-fields-rsyslog.adoc b/modules/efk-logging-exported-fields-rsyslog.adoc index 5059eb83e5..3c84f16efb 100644 --- a/modules/efk-logging-exported-fields-rsyslog.adoc +++ b/modules/efk-logging-exported-fields-rsyslog.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-rsyslog-{context}'] +[id="efk-logging-exported-fields-rsyslog-{context}"] = `rsyslog` exported fields These are the `rsyslog` fields exported by the logging system and available for searching diff --git a/modules/efk-logging-exported-fields-systemd.adoc b/modules/efk-logging-exported-fields-systemd.adoc index 9b8f63cda8..e5f67ab31a 100644 --- a/modules/efk-logging-exported-fields-systemd.adoc +++ b/modules/efk-logging-exported-fields-systemd.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-systemd-{context}'] +[id="efk-logging-exported-fields-systemd-{context}"] = `systemmd` exported fields These are the `systemd` fields exported by the {product-title} cluster logging available for searching @@ -14,7 +14,7 @@ may write their own fields to the journal. These will be available under the `systemd.u` namespace. `RESULT` and `UNIT` are two such fields. [discrete] -[id='exported-fields-systemd.k-{context}'] +[id="exported-fields-systemd.k-{context}"] === `systemd.k` Fields The following table contains `systemd` kernel-specific metadata. @@ -47,7 +47,7 @@ is the kernel device name. |=== [discrete] -[id='exported-fields-systemd.t-{context}'] +[id="exported-fields-systemd.t-{context}"] === `systemd.t` Fields `systemd.t Fields` are trusted journal fields, fields that are implicitly added @@ -157,7 +157,7 @@ is the client process ID for `syslog`. |=== [discrete] -[id='exported-fields-systemd.u-{context}'] +[id="exported-fields-systemd.u-{context}"] === `systemd.u` Fields `systemd.u Fields` are directly passed from clients and stored in the journal. diff --git a/modules/efk-logging-exported-fields-tlog.adoc b/modules/efk-logging-exported-fields-tlog.adoc index bffc714f0a..4b41db07c4 100644 --- a/modules/efk-logging-exported-fields-tlog.adoc +++ b/modules/efk-logging-exported-fields-tlog.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-exported-fields.adoc -[id='efk-logging-exported-fields-tlog-{context}'] +[id="efk-logging-exported-fields-tlog-{context}"] = Tlog exported fields These are the Tlog fields exported by the {product-title} cluster logging system and available for searching diff --git a/modules/efk-logging-external-elasticsearch.adoc b/modules/efk-logging-external-elasticsearch.adoc index f05e44ea5a..c6e9935ccd 100644 --- a/modules/efk-logging-external-elasticsearch.adoc +++ b/modules/efk-logging-external-elasticsearch.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-external.adoc -[id='efk-logging-external-elasticsearch-{context}'] +[id="efk-logging-external-elasticsearch-{context}"] = Configuring Fluentd to send logs to an external Elasticsearch instance Fluentd sends logs to the value of the `ES_HOST`, `ES_PORT`, `OPS_HOST`, diff --git a/modules/efk-logging-external-syslog.adoc b/modules/efk-logging-external-syslog.adoc index 157156bd0d..6f21ee9e85 100644 --- a/modules/efk-logging-external-syslog.adoc +++ b/modules/efk-logging-external-syslog.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-external.adoc -[id='efk-logging-external-syslog-{context}'] +[id="efk-logging-external-syslog-{context}"] = Configuring Fluentd to send logs to an external syslog server Use the `fluent-plugin-remote-syslog` plug-in on the host to send logs to an diff --git a/modules/efk-logging-fluentd-collector.adoc b/modules/efk-logging-fluentd-collector.adoc index 47fedd447e..a674e8ff23 100644 --- a/modules/efk-logging-fluentd-collector.adoc +++ b/modules/efk-logging-fluentd-collector.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-fluentd.adoc -[id='efk-logging-fluentd-collector-{context}'] +[id="efk-logging-fluentd-collector-{context}"] = Selecting the logging collector {product-title} cluster logging uses Fluentd by default. diff --git a/modules/efk-logging-fluentd-external.adoc b/modules/efk-logging-fluentd-external.adoc index 2bd9f7eabd..75967b47c3 100644 --- a/modules/efk-logging-fluentd-external.adoc +++ b/modules/efk-logging-fluentd-external.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-external.adoc -[id='efk-logging-fluentd-external-{context}'] +[id="efk-logging-fluentd-external-{context}"] = Configuring Fluentd to send logs to an external log aggregator You can configure Fluentd to send a copy of its logs to an external log diff --git a/modules/efk-logging-fluentd-limits.adoc b/modules/efk-logging-fluentd-limits.adoc index 236033b7b1..bdaba80f03 100644 --- a/modules/efk-logging-fluentd-limits.adoc +++ b/modules/efk-logging-fluentd-limits.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-fluentd.adoc -[id='efk-logging-fluentd-limits-{context}'] +[id="efk-logging-fluentd-limits-{context}"] = Configure Fluentd CPU and memory limits Each component specification allows for adjustments to both the CPU and memory limits. diff --git a/modules/efk-logging-fluentd-log-location.adoc b/modules/efk-logging-fluentd-log-location.adoc index de0ec2ba81..a3c4941723 100644 --- a/modules/efk-logging-fluentd-log-location.adoc +++ b/modules/efk-logging-fluentd-log-location.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-fluentd.adoc -[id='efk-logging-fluentd-log-location-{context}'] +[id="efk-logging-fluentd-log-location-{context}"] = Configuring Fluentd log location Fluentd writes logs to a specified file or to the default location, `/var/log/fluentd/fluentd.log`, diff --git a/modules/efk-logging-fluentd-log-rotation.adoc b/modules/efk-logging-fluentd-log-rotation.adoc index 50cc738d1c..7440cc443c 100644 --- a/modules/efk-logging-fluentd-log-rotation.adoc +++ b/modules/efk-logging-fluentd-log-rotation.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-fluentd.adoc -[id='efk-logging-fluentd-log-rotation-{context}'] +[id="efk-logging-fluentd-log-rotation-{context}"] = Configuring Fluentd log rotation When the current Fluentd log file reaches a specified size, {product-title} automatically renames the *fluentd.log* log file so that new logging data can be collected. diff --git a/modules/efk-logging-fluentd-log-viewing.adoc b/modules/efk-logging-fluentd-log-viewing.adoc index f4eec32a43..fe16ee7dec 100644 --- a/modules/efk-logging-fluentd-log-viewing.adoc +++ b/modules/efk-logging-fluentd-log-viewing.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-fluentd.adoc -[id='efk-logging-fluentd-log-viewing-{context}'] +[id="efk-logging-fluentd-log-viewing-{context}"] = Viewing Fluentd logs How you view logs depends upon the `LOGGING_FILE_PATH` setting. diff --git a/modules/efk-logging-fluentd-pod-location.adoc b/modules/efk-logging-fluentd-pod-location.adoc index eb10f5e5fa..9775c618ae 100644 --- a/modules/efk-logging-fluentd-pod-location.adoc +++ b/modules/efk-logging-fluentd-pod-location.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-fluentd.adoc -[id='efk-logging-fluentd-pod-location-{context}'] +[id="efk-logging-fluentd-pod-location-{context}"] = Viewing Fluentd pods You can use the `oc get pods -o wide` command to see the nodes where the Fluentd pod are deployed. diff --git a/modules/efk-logging-fluentd-throttling.adoc b/modules/efk-logging-fluentd-throttling.adoc index 1478d850aa..783f35d14c 100644 --- a/modules/efk-logging-fluentd-throttling.adoc +++ b/modules/efk-logging-fluentd-throttling.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-fluentd.adoc -[id='efk-logging-fluentd-throttling-{context}'] +[id="efk-logging-fluentd-throttling-{context}"] = Throttling Fluentd logs For projects that are especially verbose, an administrator can throttle down the diff --git a/modules/efk-logging-kibana-limits.adoc b/modules/efk-logging-kibana-limits.adoc index eb6dbea5a7..b80278012e 100644 --- a/modules/efk-logging-kibana-limits.adoc +++ b/modules/efk-logging-kibana-limits.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-kibana.adoc -[id='efk-logging-kibana-limits-{context}'] +[id="efk-logging-kibana-limits-{context}"] = Configure Kibana CPU and memory limits Each component specification allows for adjustments to both the CPU and memory limits. diff --git a/modules/efk-logging-kibana-scaling.adoc b/modules/efk-logging-kibana-scaling.adoc index c8c7dcfabf..bf18ba105b 100644 --- a/modules/efk-logging-kibana-scaling.adoc +++ b/modules/efk-logging-kibana-scaling.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-kibana.adoc -[id='efk-logging-kibana-scaling-{context}'] +[id="efk-logging-kibana-scaling-{context}"] = Scaling Kibana for redundancy You can scale the Kibana deployment for redundancy. diff --git a/modules/efk-logging-kibana-visualize.adoc b/modules/efk-logging-kibana-visualize.adoc index bbf4c823c7..dc98b7f81c 100644 --- a/modules/efk-logging-kibana-visualize.adoc +++ b/modules/efk-logging-kibana-visualize.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-kibana.adoc -[id='efk-logging-kibana-visualize-{context}'] +[id="efk-logging-kibana-visualize-{context}"] = Installing the Kibana Visualize tool Kibana's *Visualize* tab enables you to create visualizations and dashboards for diff --git a/modules/efk-logging-management-state-changing.adoc b/modules/efk-logging-management-state-changing.adoc index d2187fda20..50023ae80a 100644 --- a/modules/efk-logging-management-state-changing.adoc +++ b/modules/efk-logging-management-state-changing.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-management-state.adoc -[id='efk-logging-elasticsearch-management-state-changing-{context}'] +[id="efk-logging-elasticsearch-management-state-changing-{context}"] = Changing the cluster logging management state In managed state, the Cluster Logging Operator (CLO) responds to changes in the Cluster Logging Custom Resource (CR) diff --git a/modules/efk-logging-manual-rollout-rolling.adoc b/modules/efk-logging-manual-rollout-rolling.adoc index 4221f8351f..8e59ad7923 100644 --- a/modules/efk-logging-manual-rollout-rolling.adoc +++ b/modules/efk-logging-manual-rollout-rolling.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-manual-rollout.adoc -[id='efk-logging-manual-rollout-rolling-{context}'] +[id="efk-logging-manual-rollout-rolling-{context}"] = Performing an Elasticsearch rolling cluster restart A rolling restart is recommended, when any of the following changes are made: diff --git a/modules/efk-logging-systemd-scaling.adoc b/modules/efk-logging-systemd-scaling.adoc index c7d4946aaf..6cd14bc081 100644 --- a/modules/efk-logging-systemd-scaling.adoc +++ b/modules/efk-logging-systemd-scaling.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-deploy.adoc -[id='efk-logging-fluentd-scaling-{context}'] +[id="efk-logging-fluentd-scaling-{context}"] = Scaling up systemd-journald and rsyslog As you scale up your project, the default logging environment might need some diff --git a/modules/efk-logging-troubleshooting-cryptic.adoc b/modules/efk-logging-troubleshooting-cryptic.adoc index 35519bd5ad..97130dbd93 100644 --- a/modules/efk-logging-troubleshooting-cryptic.adoc +++ b/modules/efk-logging-troubleshooting-cryptic.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-troublehsooting.adoc -[id='efk-logging-troubleshooting-cryptic-{context}'] +[id="efk-logging-troubleshooting-cryptic-{context}"] = Troubleshooting a Kubernetes cryptic error when viewing the Kibana console When attempting to visit the Kibana console, you may receive a browser diff --git a/modules/efk-logging-troubleshooting-loop.adoc b/modules/efk-logging-troubleshooting-loop.adoc index 136f0c4af9..f6686a8570 100644 --- a/modules/efk-logging-troubleshooting-loop.adoc +++ b/modules/efk-logging-troubleshooting-loop.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-troublehsooting.adoc -[id='efk-logging-troubleshooting-loop-{context}'] +[id="efk-logging-troubleshooting-loop-{context}"] = Troubleshooting a Kubernetes login loop The OAuth2 proxy on the Kibana console must share a secret with the master diff --git a/modules/efk-logging-troubleshooting-proxy.adoc b/modules/efk-logging-troubleshooting-proxy.adoc index e3b5062645..8f54e611f0 100644 --- a/modules/efk-logging-troubleshooting-proxy.adoc +++ b/modules/efk-logging-troubleshooting-proxy.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-troublehsooting.adoc -[id='efk-logging-troubleshooting-proxy-{context}'] +[id="efk-logging-troubleshooting-proxy-{context}"] = Troubleshooting a Kubernetes 503 error when viewing the Kibana console If you receive a proxy error when viewing the Kibana console, it could be caused diff --git a/modules/efk-logging-troubleshooting-unknown.adoc b/modules/efk-logging-troubleshooting-unknown.adoc index 2b4f63f9c6..9d47f108c4 100644 --- a/modules/efk-logging-troubleshooting-unknown.adoc +++ b/modules/efk-logging-troubleshooting-unknown.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-troublehsooting.adoc -[id='efk-logging-troubleshooting-unknown-{context}'] +[id="efk-logging-troubleshooting-unknown-{context}"] = Troubleshooting a Kubernetes unknown error while connecting to Elasticsearch If you are attempting to use a F-5 load balancer in front of Kibana with diff --git a/modules/efk-logging-uninstall-efk-ops.adoc b/modules/efk-logging-uninstall-efk-ops.adoc index fa5282a869..783a1e77f5 100644 --- a/modules/efk-logging-uninstall-efk-ops.adoc +++ b/modules/efk-logging-uninstall-efk-ops.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-uninstall.adoc -[id='efk-logging-uninstall-efk-ops-{context}'] +[id="efk-logging-uninstall-efk-ops-{context}"] = Uninstall the infra cluster in {product-title} You can uninstall the infra cluster from the {product-title} cluster logging. diff --git a/modules/efk-logging-uninstall-efk.adoc b/modules/efk-logging-uninstall-efk.adoc index 699829800c..61230e6c7c 100644 --- a/modules/efk-logging-uninstall-efk.adoc +++ b/modules/efk-logging-uninstall-efk.adoc @@ -2,7 +2,7 @@ // // * logging/efk-logging-uninstall.adoc -[id='efk-logging-uninstall-efk-{context}'] +[id="efk-logging-uninstall-efk-{context}"] = Uninstalling cluster logging from {product-title} You can remove cluster logging from your cluster. diff --git a/modules/glusterfs-hardware-requirements.adoc b/modules/glusterfs-hardware-requirements.adoc index 69f7591249..55c0af725a 100644 --- a/modules/glusterfs-hardware-requirements.adoc +++ b/modules/glusterfs-hardware-requirements.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='glusterfs-hardware-requirements-{context}'] +[id="glusterfs-hardware-requirements-{context}"] = {gluster} hardware requirements Any nodes used in a {gluster-native} or {gluster-external} cluster are diff --git a/modules/glusterfs-installing-node-prerequisites.adoc b/modules/glusterfs-installing-node-prerequisites.adoc index 57c2211b25..b8c7019a22 100644 --- a/modules/glusterfs-installing-node-prerequisites.adoc +++ b/modules/glusterfs-installing-node-prerequisites.adoc @@ -2,7 +2,7 @@ // // * orphaned -[id='glusterfs-installing-node-prerequisites-{context}'] +[id="glusterfs-installing-node-prerequisites-{context}"] = Installing {gluster} prerequisites If you plan to use {gluster} in your cluster, you must install or update the diff --git a/modules/how-to-plan-your-environment-according-to-application-requirements.adoc b/modules/how-to-plan-your-environment-according-to-application-requirements.adoc index 1151a95117..c826beebf2 100644 --- a/modules/how-to-plan-your-environment-according-to-application-requirements.adoc +++ b/modules/how-to-plan-your-environment-according-to-application-requirements.adoc @@ -2,7 +2,7 @@ // // * scalability_and_performance/planning-your-environment-according-to-object-limits.adoc -[id='how-to-plan-according-to-application-requirements-{context}' +[id="how-to-plan-according-to-application-requirements-{context}' = How to plan your environment according to application requirements Consider an example application environment: diff --git a/modules/how-to-plan-your-environment-according-to-cluster-limits.adoc b/modules/how-to-plan-your-environment-according-to-cluster-limits.adoc index 7051d32e64..b2a4dcb7cb 100644 --- a/modules/how-to-plan-your-environment-according-to-cluster-limits.adoc +++ b/modules/how-to-plan-your-environment-according-to-cluster-limits.adoc @@ -2,7 +2,7 @@ // // * scalability_and_performance/planning-your-environment-according-to-object-limits.adoc -[id='how-to-plan-according-to-cluster-limits-{context}' +[id="how-to-plan-according-to-cluster-limits-{context}' = How to plan your environment according to cluster limits [IMPORTANT] diff --git a/modules/identity-provider-about-basic-authentication.adoc b/modules/identity-provider-about-basic-authentication.adoc index d200dddcd1..ec53048fc2 100644 --- a/modules/identity-provider-about-basic-authentication.adoc +++ b/modules/identity-provider-about-basic-authentication.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc -[id='identity-provider-about-basic-authentication-{context}'] +[id="identity-provider-about-basic-authentication-{context}"] = About basic authentication Basic authentication is a generic backend integration mechanism that allows diff --git a/modules/identity-provider-about-ldap.adoc b/modules/identity-provider-about-ldap.adoc index 95a969482e..aa27b53aee 100644 --- a/modules/identity-provider-about-ldap.adoc +++ b/modules/identity-provider-about-ldap.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-ldap-identity-provider.adoc -[id='identity-provider-about-ldap-{context}'] +[id="identity-provider-about-ldap-{context}"] = About LDAP authentication During authentication, the LDAP directory is searched for an entry that matches diff --git a/modules/identity-provider-about-request-header.adoc b/modules/identity-provider-about-request-header.adoc index 1f2ad9521a..a24c73ffba 100644 --- a/modules/identity-provider-about-request-header.adoc +++ b/modules/identity-provider-about-request-header.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-request-header-identity-provider.adoc -[id='identity-provider-about-request-header-{context}'] +[id="identity-provider-about-request-header-{context}"] = About request header authentication A request header identity provider identifies users from request @@ -50,7 +50,7 @@ checked for a user name. Otherwise, any direct request to the OAuth server can impersonate any identity from this provider, merely by setting a request header. ==== -[id='sspi-windows-{context}'] +[id="sspi-windows-{context}"] == SSPI connection support on Microsoft Windows ifdef::openshift-enterprise[] diff --git a/modules/identity-provider-add.adoc b/modules/identity-provider-add.adoc index 57adf39141..c6c0a59591 100644 --- a/modules/identity-provider-add.adoc +++ b/modules/identity-provider-add.adoc @@ -12,7 +12,7 @@ // * authentication/identity_providers/configuring-google-identity-provider.adoc // * authentication/identity_providers/configuring-oidc-identity-provider.adoc -[id='add-identity-provider-{context}'] +[id="add-identity-provider-{context}"] = Adding an identity provider to your clusters After you install your cluster, add an identity provider to it so your diff --git a/modules/identity-provider-basic-authentication-CR.adoc b/modules/identity-provider-basic-authentication-CR.adoc index 99fd059fea..02d75436b7 100644 --- a/modules/identity-provider-basic-authentication-CR.adoc +++ b/modules/identity-provider-basic-authentication-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc -[id='identity-provider-basic-authentication-CR-{context}'] +[id="identity-provider-basic-authentication-CR-{context}"] = Sample basic authentication CR The following Custom Resource (CR) shows the parameters and acceptable values for an diff --git a/modules/identity-provider-basic-authentication-troubleshooting.adoc b/modules/identity-provider-basic-authentication-troubleshooting.adoc index ec0ca6964a..52ca35328f 100644 --- a/modules/identity-provider-basic-authentication-troubleshooting.adoc +++ b/modules/identity-provider-basic-authentication-troubleshooting.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc -[id='identity-provider-basic-authentication-troubleshooting{context}'] +[id="identity-provider-basic-authentication-troubleshooting{context}"] = Basic authentication troubleshooting The most common issue relates to network connectivity to the backend server. For diff --git a/modules/identity-provider-config-map.adoc b/modules/identity-provider-config-map.adoc index 8e34de5b20..786e03bb79 100644 --- a/modules/identity-provider-config-map.adoc +++ b/modules/identity-provider-config-map.adoc @@ -7,7 +7,7 @@ // * authentication/identity_providers/configuring-oidc-identity-provider.adoc // * authentication/identity_providers/configuring-request-header-identity-provider.adoc -[id='identity-provider-creating-configmap-{context}'] +[id="identity-provider-creating-configmap-{context}"] = Creating a ConfigMap Identity providers use {product-title} ConfigMaps to contain the diff --git a/modules/identity-provider-configuring-apache-request-header.adoc b/modules/identity-provider-configuring-apache-request-header.adoc index 2a088cff56..26ce9f82f4 100644 --- a/modules/identity-provider-configuring-apache-request-header.adoc +++ b/modules/identity-provider-configuring-apache-request-header.adoc @@ -2,7 +2,7 @@ // // * orphaned -[id='identity-provider-configuring-apache-request-header-{context}'] +[id="identity-provider-configuring-apache-request-header-{context}"] = Configuring Apache authentication using request header This example configures an authentication proxy on the same host as the master. @@ -209,7 +209,7 @@ RequestHeader unset X-Remote-User ---- [discrete] -[id='requestheader-master-ca-config-{context}'] +[id="requestheader-master-ca-config-{context}"] ===== Configuring the master The `identityProviders` stanza in the diff --git a/modules/identity-provider-create-CR.adoc b/modules/identity-provider-create-CR.adoc index 7f1aa37ae6..73210cdc85 100644 --- a/modules/identity-provider-create-CR.adoc +++ b/modules/identity-provider-create-CR.adoc @@ -12,7 +12,7 @@ // * authentication/identity_providers/configuring-google-identity-provider.adoc // * authentication/identity_providers/configuring-oidc-identity-provider.adoc -[id='identity-provider-create-CR-{context}'] +[id="identity-provider-create-CR-{context}"] = Creating the CR that describes an identity provider Before you can add an identity provider to your cluster, create a Custom diff --git a/modules/identity-provider-creating-htpasswd-file.adoc b/modules/identity-provider-creating-htpasswd-file.adoc index f986d020e3..bb267119b3 100644 --- a/modules/identity-provider-creating-htpasswd-file.adoc +++ b/modules/identity-provider-creating-htpasswd-file.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-htpasswd-identity-provider.adoc -[id='identity-provider-creating-htpasswd-file-{context}'] +[id="identity-provider-creating-htpasswd-file-{context}"] = Creating an HTPasswd file To use the HTPasswd identity provider, you must generate a flat file that diff --git a/modules/identity-provider-default-CR.adoc b/modules/identity-provider-default-CR.adoc index 6922bf598f..88024c3267 100644 --- a/modules/identity-provider-default-CR.adoc +++ b/modules/identity-provider-default-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/understanding-identity-provider.adoc -[id='identity-provider-default-CR-{context}'] +[id="identity-provider-default-CR-{context}"] = Sample identity provider CR The following Custom Resource (CR) shows the parameters and default diff --git a/modules/identity-provider-github-CR.adoc b/modules/identity-provider-github-CR.adoc index 638749b63e..1c1317aa75 100644 --- a/modules/identity-provider-github-CR.adoc +++ b/modules/identity-provider-github-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-github-identity-provider.adoc -[id='identity-provider-github-CR-{context}'] +[id="identity-provider-github-CR-{context}"] = Sample GitHub CR The following Custom Resource (CR) shows the parameters and acceptable values for a diff --git a/modules/identity-provider-gitlab-CR.adoc b/modules/identity-provider-gitlab-CR.adoc index cbc6a9cff4..8166e6accd 100644 --- a/modules/identity-provider-gitlab-CR.adoc +++ b/modules/identity-provider-gitlab-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-gitlab-identity-provider.adoc -[id='identity-provider-gitlab-CR-{context}'] +[id="identity-provider-gitlab-CR-{context}"] = Sample GitLab CR The following Custom Resource (CR) shows the parameters and acceptable values for a diff --git a/modules/identity-provider-google-CR.adoc b/modules/identity-provider-google-CR.adoc index 6678ffb407..32167c3cfa 100644 --- a/modules/identity-provider-google-CR.adoc +++ b/modules/identity-provider-google-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-google-identity-provider.adoc -[id='identity-provider-google-CR-{context}'] +[id="identity-provider-google-CR-{context}"] = Sample Google CR The following Custom Resource (CR) shows the parameters and acceptable diff --git a/modules/identity-provider-htpasswd-CR.adoc b/modules/identity-provider-htpasswd-CR.adoc index 145543e6b4..a0cb548315 100644 --- a/modules/identity-provider-htpasswd-CR.adoc +++ b/modules/identity-provider-htpasswd-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-htpasswd-identity-provider.adoc -[id='identity-provider-htpasswd-CR-{context}'] +[id="identity-provider-htpasswd-CR-{context}"] = Sample HTPasswd CR The following Custom Resource (CR) shows the parameters and acceptable values for an diff --git a/modules/identity-provider-htpasswd-secret.adoc b/modules/identity-provider-htpasswd-secret.adoc index 742e00d37c..af06ccee7c 100644 --- a/modules/identity-provider-htpasswd-secret.adoc +++ b/modules/identity-provider-htpasswd-secret.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-htpasswd-identity-provider.adoc -[id='identity-provider-creating-htpasswd-secret-{context}'] +[id="identity-provider-creating-htpasswd-secret-{context}"] = Creating the HTPasswd Secret To use the HTPasswd identity provider, you must define a secret that diff --git a/modules/identity-provider-keystone-CR.adoc b/modules/identity-provider-keystone-CR.adoc index 78f607a1c1..6d0fe81727 100644 --- a/modules/identity-provider-keystone-CR.adoc +++ b/modules/identity-provider-keystone-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-keystone-identity-provider.adoc -[id='identity-provider-keystone-CR-{context}'] +[id="identity-provider-keystone-CR-{context}"] = Sample Keystone CR The following Custom Resource (CR) shows the parameters and acceptable values for a diff --git a/modules/identity-provider-ldap-CR.adoc b/modules/identity-provider-ldap-CR.adoc index 5dbb0fe813..fa5d8ba692 100644 --- a/modules/identity-provider-ldap-CR.adoc +++ b/modules/identity-provider-ldap-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-ldap-identity-provider.adoc -[id='identity-provider-ldap-CR-{context}'] +[id="identity-provider-ldap-CR-{context}"] = Sample LDAP CR The following Custom Resource (CR) shows the parameters and acceptable values for an diff --git a/modules/identity-provider-ldap-secret.adoc b/modules/identity-provider-ldap-secret.adoc index e4f14e92b0..ea66352f47 100644 --- a/modules/identity-provider-ldap-secret.adoc +++ b/modules/identity-provider-ldap-secret.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-ldap-identity-provider.adoc -[id='identity-provider-creating-ldap-secret-{context}'] +[id="identity-provider-creating-ldap-secret-{context}"] = Creating the LDAP Secret To use the identity provider, you must define a {product-title} Secret diff --git a/modules/identity-provider-oidc-CR.adoc b/modules/identity-provider-oidc-CR.adoc index 87f0948e30..079f375e35 100644 --- a/modules/identity-provider-oidc-CR.adoc +++ b/modules/identity-provider-oidc-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-oidc-identity-provider.adoc -[id='identity-provider-oidc-CR-{context}'] +[id="identity-provider-oidc-CR-{context}"] = Sample OpenID Connect CRs The following Custom Resource (CR)s shows the parameters and acceptable values for an diff --git a/modules/identity-provider-overview.adoc b/modules/identity-provider-overview.adoc index 8a9d8291cb..3746c2754b 100644 --- a/modules/identity-provider-overview.adoc +++ b/modules/identity-provider-overview.adoc @@ -13,7 +13,7 @@ // * authentication/identity_providers/configuring-google-identity-provider.adoc // * authentication/identity_providers/configuring-oidc-identity-provider.adoc -[id='identity-provider-overview-{context}'] +[id="identity-provider-overview-{context}"] = About identity providers in {product-title} By default, only a `kube-admin` user exists on your cluster. To specify an diff --git a/modules/identity-provider-parameters.adoc b/modules/identity-provider-parameters.adoc index 545cd6ea39..6b50d9a907 100644 --- a/modules/identity-provider-parameters.adoc +++ b/modules/identity-provider-parameters.adoc @@ -2,7 +2,7 @@ // // * authentication/understanding-identity-provider.adoc -[id='identity-provider-parameters-{context}'] +[id="identity-provider-parameters-{context}"] = Identity provider parameters Four parameters are common to all identity providers: diff --git a/modules/identity-provider-provisioning-user-lookup-mapping.adoc b/modules/identity-provider-provisioning-user-lookup-mapping.adoc index b81028637f..bc13e3869d 100644 --- a/modules/identity-provider-provisioning-user-lookup-mapping.adoc +++ b/modules/identity-provider-provisioning-user-lookup-mapping.adoc @@ -2,7 +2,7 @@ // // * orphaned -[id='identity-provider-provisioning-user-lookup-mapping-{context}'] +[id="identity-provider-provisioning-user-lookup-mapping-{context}"] = Manually provisioning a user when using the lookup mapping method When using the `lookup` mapping method, user provisioning is done by an external system, via the API. diff --git a/modules/identity-provider-registering-github.adoc b/modules/identity-provider-registering-github.adoc index a7bea980b1..a2efeceee0 100644 --- a/modules/identity-provider-registering-github.adoc +++ b/modules/identity-provider-registering-github.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-github-identity-provider.adoc -[id='identity-provider-registering-github-{context}'] +[id="identity-provider-registering-github-{context}"] = Registering a GitHub application To use GitHub or GitHub Enterprise as an identity provider, you must register diff --git a/modules/identity-provider-request-header-CR.adoc b/modules/identity-provider-request-header-CR.adoc index 8dbe511f55..1619081929 100644 --- a/modules/identity-provider-request-header-CR.adoc +++ b/modules/identity-provider-request-header-CR.adoc @@ -2,7 +2,7 @@ // // * authentication/identity_providers/configuring-request-header-identity-provider.adoc -[id='identity-provider-request-header-CR-{context}'] +[id="identity-provider-request-header-CR-{context}"] = Sample request header CR The following Custom Resource (CR) shows the parameters and diff --git a/modules/identity-provider-secret.adoc b/modules/identity-provider-secret.adoc index 1cb01936ee..4d9ef13930 100644 --- a/modules/identity-provider-secret.adoc +++ b/modules/identity-provider-secret.adoc @@ -8,7 +8,7 @@ // * authentication/identity_providers/configuring-oidc-identity-provider.adoc // * authentication/identity_providers/configuring-request-header-identity-provider.adoc -[id='identity-provider-creating-secret-{context}'] +[id="identity-provider-creating-secret-{context}"] = Creating the Secret Identity providers use {product-title} Secrets to contain the client diff --git a/modules/idle-idling-applications.adoc b/modules/idle-idling-applications.adoc index b741b3b520..1a800758a8 100644 --- a/modules/idle-idling-applications.adoc +++ b/modules/idle-idling-applications.adoc @@ -2,7 +2,7 @@ // // * applications/idling-applications.adoc -[id='idle-idling-applications-{context}'] +[id="idle-idling-applications-{context}"] = Idling applications Idling an application involves finding the scalable resources (deployment @@ -13,7 +13,7 @@ resources to zero replicas. You can use the `oc idle` command to idle a single service, or use the `--resource-names-file` option to idle multiple services. -[id='idle-idling-applications-single-{context}'] +[id="idle-idling-applications-single-{context}"] == Idling a single service .Procedure @@ -24,7 +24,7 @@ You can use the `oc idle` command to idle a single service, or use the $ oc idle ---- -[id='idle-idling-applications-multiple-{context}'] +[id="idle-idling-applications-multiple-{context}"] == Idling multiple services Idling multiple services is helpful if an application spans across a set of diff --git a/modules/idle-unidling-applications.adoc b/modules/idle-unidling-applications.adoc index 79a68275b1..78a3cd6da7 100644 --- a/modules/idle-unidling-applications.adoc +++ b/modules/idle-unidling-applications.adoc @@ -2,7 +2,7 @@ // // * applications/idling-applications.adoc -[id='idle-unidling-applications-{context}'] +[id="idle-unidling-applications-{context}"] = Unidling applications Application services become active again when they receive network traffic and diff --git a/modules/images-about.adoc b/modules/images-about.adoc index 94aba5085e..dc09f4ec8e 100644 --- a/modules/images-about.adoc +++ b/modules/images-about.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-about-{context}'] +[id="images-about-{context}"] = Images Containers in {product-title} are based on OCI- or diff --git a/modules/images-container-registry-about.adoc b/modules/images-container-registry-about.adoc index eb43175025..5fb94606fe 100644 --- a/modules/images-container-registry-about.adoc +++ b/modules/images-container-registry-about.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-container-registry-about-{context}'] +[id="images-container-registry-about-{context}"] = Container registry A *container registry* is a content server that can store and service diff --git a/modules/images-create-guide-openshift.adoc b/modules/images-create-guide-openshift.adoc index b2dbeb0346..9ba56566d1 100644 --- a/modules/images-create-guide-openshift.adoc +++ b/modules/images-create-guide-openshift.adoc @@ -35,7 +35,7 @@ For example, this https://github.com/sclorg/s2i-python-container[Python image] defines S2I scripts for building various versions of Python applications. [discrete] -[id='use-uid-{context}'] +[id="use-uid-{context}"] == Support arbitrary user ids By default, {product-title} runs containers using an arbitrarily assigned user @@ -117,7 +117,7 @@ run as any user. endif::[] [discrete] -[id='use-services-{context}'] +[id="use-services-{context}"] == Use services for inter-image communication For cases where your image needs to communicate with a service provided by @@ -145,7 +145,7 @@ application image builds. It also simplifies the work required by application developers to ensure all of their dependencies are met. [discrete] -[id='use-env-vars-{context}'] +[id="use-env-vars-{context}"] == Use environment variables for configuration Users of your image should be able to configure it without having to create a diff --git a/modules/images-create-s2i-scripts.adoc b/modules/images-create-s2i-scripts.adoc index a31f846d9e..ca5f1c944e 100644 --- a/modules/images-create-s2i-scripts.adoc +++ b/modules/images-create-s2i-scripts.adoc @@ -147,7 +147,7 @@ EOF ---- ==== -[id='using-images-with-onbuild-instructions-{context}'] +[id="using-images-with-onbuild-instructions-{context}"] == Using Images with ONBUILD Instructions The `ONBUILD` instructions can be found in many official container images. For diff --git a/modules/images-custom.adoc b/modules/images-custom.adoc index d3f8d01b83..9d8e7a518b 100644 --- a/modules/images-custom.adoc +++ b/modules/images-custom.adoc @@ -23,7 +23,7 @@ To fully leverage the benefits of the Custom build strategy, you must understand how to create a Custom builder image that will be capable of building desired objects. -[id='custom-builder-image-{context}'] +[id="custom-builder-image-{context}"] == Custom builder image Upon invocation, a custom builder image will receive the following environment @@ -68,7 +68,7 @@ present if defined. |=== -[id='custom-builder-workflow-{context}'] +[id="custom-builder-workflow-{context}"] == Custom builder workflow Although custom builder image authors have great flexibility in defining the diff --git a/modules/images-getting-info-about-imagestreams.adoc b/modules/images-getting-info-about-imagestreams.adoc index 178462184c..a91ac43374 100644 --- a/modules/images-getting-info-about-imagestreams.adoc +++ b/modules/images-getting-info-about-imagestreams.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-getting-info-about-imagestreams-{context}'] +[id="images-getting-info-about-imagestreams-{context}"] = Getting information about image streams You can get general information about the image stream and detailed information diff --git a/modules/images-id.adoc b/modules/images-id.adoc index 57f37536ec..c13c74aa85 100644 --- a/modules/images-id.adoc +++ b/modules/images-id.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-id-{context}'] +[id="images-id-{context}"] = Image IDs An image ID is a SHA (Secure Hash Algorithm) code that can be used to diff --git a/modules/images-imagestream-adding-tags.adoc b/modules/images-imagestream-adding-tags.adoc index 2accfe45a4..0b0e0c81d7 100644 --- a/modules/images-imagestream-adding-tags.adoc +++ b/modules/images-imagestream-adding-tags.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-imagestreams-adding-tags-{context}'] +[id="images-imagestreams-adding-tags-{context}"] = Adding tags to an image stream You can add additional tags to image streams. diff --git a/modules/images-imagestream-configure.adoc b/modules/images-imagestream-configure.adoc index ed3774bc4c..e659f1a5df 100644 --- a/modules/images-imagestream-configure.adoc +++ b/modules/images-imagestream-configure.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='image-stream-configure-{context}'] +[id="image-stream-configure-{context}"] = Configuring image streams ifdef::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[] @@ -9,7 +9,7 @@ An image stream object file contains the following elements. endif::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[] -[id='image-stream-object-definition-{context}'] +[id="image-stream-object-definition-{context}"] .Image Stream Object Definition [source,yaml] diff --git a/modules/images-imagestream-external-image-tags.adoc b/modules/images-imagestream-external-image-tags.adoc index c3ac712fda..c7e8bca7a7 100644 --- a/modules/images-imagestream-external-image-tags.adoc +++ b/modules/images-imagestream-external-image-tags.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-imagestreams-external-image-tags-{context}'] +[id="images-imagestreams-external-image-tags-{context}"] = Adding tags for an external image You can add tags for external images. diff --git a/modules/images-imagestream-image.adoc b/modules/images-imagestream-image.adoc index 1b60f95cad..1ee54528ff 100644 --- a/modules/images-imagestream-image.adoc +++ b/modules/images-imagestream-image.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='image-stream-image-about-{context}'] +[id="image-stream-image-about-{context}"] = Image stream images An image stream image allows you to retrieve a specific diff --git a/modules/images-imagestream-import.adoc b/modules/images-imagestream-import.adoc index bdc1f28dda..d032815b72 100644 --- a/modules/images-imagestream-import.adoc +++ b/modules/images-imagestream-import.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-imagestreams-import-{context}'] +[id="images-imagestreams-import-{context}"] = Configuring periodic importing of image stream tags When working with an external container image registry, to periodically diff --git a/modules/images-imagestream-mapping.adoc b/modules/images-imagestream-mapping.adoc index 7164e20ff8..366bef5512 100644 --- a/modules/images-imagestream-mapping.adoc +++ b/modules/images-imagestream-mapping.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-imagestream-mapping-{context}'] +[id="images-imagestream-mapping-{context}"] = Image stream mapping When the integrated registry receives a new image, it creates and sends an image diff --git a/modules/images-imagestream-remove-tag.adoc b/modules/images-imagestream-remove-tag.adoc index 594e5c1b95..6b9465e56f 100644 --- a/modules/images-imagestream-remove-tag.adoc +++ b/modules/images-imagestream-remove-tag.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-imagestreams-remove-tag-{context}'] +[id="images-imagestreams-remove-tag-{context}"] = Removing image stream tags You can remove old tags from an image stream. diff --git a/modules/images-imagestream-tag.adoc b/modules/images-imagestream-tag.adoc index cdaaf9b3dd..6827a74ed2 100644 --- a/modules/images-imagestream-tag.adoc +++ b/modules/images-imagestream-tag.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-imagestream-tag-{context}'] +[id="images-imagestream-tag-{context}"] = Image stream tags An image stream tag is a named pointer to an image in an image stream. An image diff --git a/modules/images-imagestream-trigger.adoc b/modules/images-imagestream-trigger.adoc index a1e72682a5..95c9ac4d3d 100644 --- a/modules/images-imagestream-trigger.adoc +++ b/modules/images-imagestream-trigger.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='image-stream-trigger-{context}'] +[id="image-stream-trigger-{context}"] = Image stream triggers An image stream trigger causes a specific action when an image stream tag diff --git a/modules/images-imagestream-update-tag.adoc b/modules/images-imagestream-update-tag.adoc index da3ac3ddfb..0beaace10c 100644 --- a/modules/images-imagestream-update-tag.adoc +++ b/modules/images-imagestream-update-tag.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-imagestreams-update-tag-{context}'] +[id="images-imagestreams-update-tag-{context}"] = Updating image stream tags You can update a tag to reflect another tag in an image stream. diff --git a/modules/images-imagestream-use.adoc b/modules/images-imagestream-use.adoc index 7242302ff2..859d6366d4 100644 --- a/modules/images-imagestream-use.adoc +++ b/modules/images-imagestream-use.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-imagestream-use-{context}'] +[id="images-imagestream-use-{context}"] = Using image streams An image stream and its associated tags provide an abstraction for referencing diff --git a/modules/images-tag.adoc b/modules/images-tag.adoc index 6ed2155631..b254902042 100644 --- a/modules/images-tag.adoc +++ b/modules/images-tag.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-tag-about-{context}'] +[id="images-tag-about-{context}"] = Image tags An image tag is a label applied to a container image in a repository that diff --git a/modules/images-test-s2i.adoc b/modules/images-test-s2i.adoc index 9128729bf7..fe3a15dcf3 100644 --- a/modules/images-test-s2i.adoc +++ b/modules/images-test-s2i.adoc @@ -22,7 +22,7 @@ The goal of testing an S2I image is to make sure that all of these described commands work properly, even if the base container image has changed or the tooling used by the commands was updated. -[id='testing-requirements-{context}'] +[id="testing-requirements-{context}"] == Understanding testing requirements The standard location for the *_test_* script is *_test/run_*. This script is invoked by the {product-title} S2I image builder and it could be a simple Bash @@ -39,7 +39,7 @@ it you need a sample application source to verify that the source successfully transforms into a runnable container image. The sample application should be simple, but it should exercise the crucial steps of `assemble` and `run` scripts. -[id='generating-scripts-and-tools-{context}'] +[id="generating-scripts-and-tools-{context}"] == Generating scripts and tools The S2I tooling comes with powerful generation tools to speed up the process of creating a new S2I image. The `s2i create` command produces all the necessary S2I @@ -57,7 +57,7 @@ useful, but it provides a good starting point to begin developing. The *_test/run_* script produced by the `s2i create` command requires that the sample application sources are inside the *_test/test-app_* directory. ==== ifndef::openshift-online[] -[id='testing-locally-{context}'] +[id="testing-locally-{context}"] == Testing locally The easiest way to run the S2I image tests locally is to use the generated @@ -81,7 +81,7 @@ test: IMAGE_NAME=$(IMAGE_NAME)-candidate test/run ---- -[id='basic-testing-workflow-{context}'] +[id="basic-testing-workflow-{context}"] == Basic testing workflow The *_test_* script assumes you have already built the image you want to @@ -142,7 +142,7 @@ Running these steps is generally enough to tell if the builder image is working as expected. -[id='using-openshift-for-building-the-image-{context}'] +[id="using-openshift-for-building-the-image-{context}"] == Using {product-title} for building the image Once you have a `Dockerfile` and the other artifacts that make up your new diff --git a/modules/images-using-imagestream-change-triggers.adoc b/modules/images-using-imagestream-change-triggers.adoc index 305836117d..c9eacb08f4 100644 --- a/modules/images-using-imagestream-change-triggers.adoc +++ b/modules/images-using-imagestream-change-triggers.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-using-imagestream-change-triggers-{context}'] +[id="images-using-imagestream-change-triggers-{context}"] = Image stream change triggers Image stream triggers allow your Builds and Deployments to be automatically diff --git a/modules/images-using-imagestream-images.adoc b/modules/images-using-imagestream-images.adoc index b1587b6c46..a6e6e8e6c8 100644 --- a/modules/images-using-imagestream-images.adoc +++ b/modules/images-using-imagestream-images.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-using-imagestream-images-{context}'] +[id="images-using-imagestream-images-{context}"] = Image stream images An image stream image points from within an image stream diff --git a/modules/images-using-imagestream-tags.adoc b/modules/images-using-imagestream-tags.adoc index e8c25ed1c7..3ac563fc91 100644 --- a/modules/images-using-imagestream-tags.adoc +++ b/modules/images-using-imagestream-tags.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/openshift_images -[id='images-using-imagestream-tags-{context}'] +[id="images-using-imagestream-tags-{context}"] = Image stream tags An image stream tag is a named pointer to an image in an _image stream_. It is diff --git a/modules/impersonation-project-creation.adoc b/modules/impersonation-project-creation.adoc index 05a291d847..8b890eefb0 100644 --- a/modules/impersonation-project-creation.adoc +++ b/modules/impersonation-project-creation.adoc @@ -2,7 +2,7 @@ // // * users_and_roles/creating-project-other-user.adoc -[id='impersonation-project-creation-{context}'] +[id="impersonation-project-creation-{context}"] = Impersonating a user when you create a project You can impersonate a different user when you create a project request. Because diff --git a/modules/impersonation-system-admin-user.adoc b/modules/impersonation-system-admin-user.adoc index a9b721435e..864d0c799f 100644 --- a/modules/impersonation-system-admin-user.adoc +++ b/modules/impersonation-system-admin-user.adoc @@ -2,7 +2,7 @@ // // * users_and_roles/impersonating-system-admin.adoc -[id='impersonation-system-admin-user-{context}'] +[id="impersonation-system-admin-user-{context}"] = Impersonating the `system:admin` user You can grant a user permission to impersonate `system:admin`, which grants them diff --git a/modules/infrastructure-components.adoc b/modules/infrastructure-components.adoc index 8e21ee4dd7..ca523738f3 100644 --- a/modules/infrastructure-components.adoc +++ b/modules/infrastructure-components.adoc @@ -2,7 +2,7 @@ // // * machine_management/creating-infrastructure-machinesets.adoc -[id='infrastructure-components-{context}'] +[id="infrastructure-components-{context}"] = {product-title} infrastructure components The following {product-title} components are infrastructure components: diff --git a/modules/infrastructure-moving-logging.adoc b/modules/infrastructure-moving-logging.adoc index 3b5f660186..b6ebd08b97 100644 --- a/modules/infrastructure-moving-logging.adoc +++ b/modules/infrastructure-moving-logging.adoc @@ -2,7 +2,7 @@ // // * machine_management/creating-infrastructure-machinesets.adoc -[id='infrastructure-moving-logging-{context}'] +[id="infrastructure-moving-logging-{context}"] = Moving the logging aggregation solution [IMPORTANT] diff --git a/modules/infrastructure-moving-registry.adoc b/modules/infrastructure-moving-registry.adoc index 8347d47b1c..724e2c2886 100644 --- a/modules/infrastructure-moving-registry.adoc +++ b/modules/infrastructure-moving-registry.adoc @@ -2,7 +2,7 @@ // // * machine_management/creating-infrastructure-machinesets.adoc -[id='infrastructure-moving-registry-{context}'] +[id="infrastructure-moving-registry-{context}"] = Moving the default registry You configure the registry Operator to deploy its pods to different nodes. diff --git a/modules/infrastructure-moving-router.adoc b/modules/infrastructure-moving-router.adoc index 9fedf13c7c..0638254536 100644 --- a/modules/infrastructure-moving-router.adoc +++ b/modules/infrastructure-moving-router.adoc @@ -2,7 +2,7 @@ // // * machine_management/creating-infrastructure-machinesets.adoc -[id='infrastructure-moving-router-{context}'] +[id="infrastructure-moving-router-{context}"] = Moving the router You can deploy the router Pod to a different MachineSet. By default, the Pod diff --git a/modules/installation-about-custom.adoc b/modules/installation-about-custom.adoc index 6ba1774fdc..592efbcf32 100644 --- a/modules/installation-about-custom.adoc +++ b/modules/installation-about-custom.adoc @@ -2,7 +2,7 @@ // // * orphaned -[id='installation-about-custom-{context}'] +[id="installation-about-custom-{context}"] = About the custom installation You can use the {product-title} installation program to customize four levels diff --git a/modules/installation-aws-config-yaml.adoc b/modules/installation-aws-config-yaml.adoc index 283dd6463a..d45964cfaf 100644 --- a/modules/installation-aws-config-yaml.adoc +++ b/modules/installation-aws-config-yaml.adoc @@ -2,7 +2,7 @@ // // * installing/installing_aws/installing-aws-customizations.adoc -[id='installation-aws-config-yaml-{context}'] +[id="installation-aws-config-yaml-{context}"] = Sample customized `install-config.yaml` file for AWS You can customize the `install-config.yaml` file to specify more details about diff --git a/modules/installation-aws-iam-user.adoc b/modules/installation-aws-iam-user.adoc index 8551a170ad..cd8e43e281 100644 --- a/modules/installation-aws-iam-user.adoc +++ b/modules/installation-aws-iam-user.adoc @@ -2,7 +2,7 @@ // // * installing/installing_aws/installing-aws-account.adoc -[id='installing-aws-iam-user-{context}'] +[id="installing-aws-iam-user-{context}"] = Creating an IAM user Each Amazon Web Services (AWS) account contains a root user account that is diff --git a/modules/installation-aws-limits.adoc b/modules/installation-aws-limits.adoc index 7c8b2809df..179794477b 100644 --- a/modules/installation-aws-limits.adoc +++ b/modules/installation-aws-limits.adoc @@ -2,7 +2,7 @@ // // * installing/installing_aws/installing-aws-account.adoc -[id='installing-aws-limits-{context}'] +[id="installing-aws-limits-{context}"] = AWS account limits The {product-title} cluster uses a number of Amazon Web Services (AWS) diff --git a/modules/installation-aws-permissions.adoc b/modules/installation-aws-permissions.adoc index a940bbf527..e4bbfb91e2 100644 --- a/modules/installation-aws-permissions.adoc +++ b/modules/installation-aws-permissions.adoc @@ -2,7 +2,7 @@ // // * instaling-awst/installing-aws-account.adoc -[id='installation-aws-permissions-{context}'] +[id="installation-aws-permissions-{context}"] = Required AWS permissions When you attach the `AdministratorAccess` policy to the IAM user that you create, diff --git a/modules/installation-aws-regions.adoc b/modules/installation-aws-regions.adoc index 536d68a8c0..30d324cd49 100644 --- a/modules/installation-aws-regions.adoc +++ b/modules/installation-aws-regions.adoc @@ -2,7 +2,7 @@ // // * installing/installing_aws/installing-aws-account.adoc -[id='installation-aws-regions-{context}'] +[id="installation-aws-regions-{context}"] = Supported AWS regions You can deploy an {product-title} cluster to the following regions: diff --git a/modules/installation-aws-route53.adoc b/modules/installation-aws-route53.adoc index 7b986babc6..fef793b5e5 100644 --- a/modules/installation-aws-route53.adoc +++ b/modules/installation-aws-route53.adoc @@ -2,7 +2,7 @@ // // * installing/installing_aws/installing-aws-account.adoc -[id='installing-aws-route53-{context}'] +[id="installing-aws-route53-{context}"] = Configuring Route53 To install {product-title}, the Amazon Web Services (AWS) account you use must diff --git a/modules/installation-base-packages.adoc b/modules/installation-base-packages.adoc index 289e629227..541dcb63c7 100644 --- a/modules/installation-base-packages.adoc +++ b/modules/installation-base-packages.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installing-base-packages-{context}'] +[id="installing-base-packages-{context}"] = Installing base packages This module needs to be reworked or removed. diff --git a/modules/installation-byo-cloud-requirements.adoc b/modules/installation-byo-cloud-requirements.adoc index a163d61e29..ffba557b35 100644 --- a/modules/installation-byo-cloud-requirements.adoc +++ b/modules/installation-byo-cloud-requirements.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-BYO-cloud-requirements-{context}'] +[id="installation-BYO-cloud-requirements-{context}"] = Cloud requirements for BYO installations There are certain aspects to take into consideration if installing {product-title} @@ -11,7 +11,7 @@ on a cloud provider using the BYO installer. * For Amazon Web Services, you must correctly configure the permissions and Security Group. * For OpenStack, you must correctly configure the permissions and Security Group. -[id='overriding-detected-ip-addresses-host-names-{context}'] +[id="overriding-detected-ip-addresses-host-names-{context}"] == Overriding detected IP addresses and host names Some deployments require that the user override the detected host names and IP diff --git a/modules/installation-byo-system-requirements.adoc b/modules/installation-byo-system-requirements.adoc index cc6fdfdf22..8850217e14 100644 --- a/modules/installation-byo-system-requirements.adoc +++ b/modules/installation-byo-system-requirements.adoc @@ -2,13 +2,13 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-byo-system-requirements-{context}'] +[id="installation-byo-system-requirements-{context}"] = System requirements for installing on BYO The hosts in your {product-title} environment must meet the following hardware specifications and system-level requirements. -[id='hardware-{context}'] +[id="hardware-{context}"] == Minimum hardware requirements The system requirements vary per host type: @@ -116,7 +116,7 @@ Oversubscribing the physical resources on a node affects resource guarantees the Kubernetes scheduler makes during pod placement. ==== -[id='prerequisites-storage-management-{context}'] +[id="prerequisites-storage-management-{context}"] == Detailed cluster storage requirements You must provide sufficient disk space for the following directories. diff --git a/modules/installation-clouds.adoc b/modules/installation-clouds.adoc index 8aaa562c4e..67642f559f 100644 --- a/modules/installation-clouds.adoc +++ b/modules/installation-clouds.adoc @@ -3,7 +3,7 @@ // * installing/installing_aws/installing-aws-default.adoc // * installing/installing_aws/installing-aws-customizations.adoc -[id='cloud-installations-{context}'] +[id="cloud-installations-{context}"] = {product-title} clusters on Installer Provisioned Infrastructure [IMPORTANT] diff --git a/modules/installation-configuration-parameters.adoc b/modules/installation-configuration-parameters.adoc index 4951b69360..69dc693e21 100644 --- a/modules/installation-configuration-parameters.adoc +++ b/modules/installation-configuration-parameters.adoc @@ -4,7 +4,7 @@ // Consider also adding the installation-configuration-parameters.adoc module. -[id='installation-configuration-parameters-{context}'] +[id="installation-configuration-parameters-{context}"] = Installation configuration parameters Before you deploy a {product-title} cluster, you provide parameter values to diff --git a/modules/installation-configuring-dns.adoc b/modules/installation-configuring-dns.adoc index d4aac20543..0c9d1bb84f 100644 --- a/modules/installation-configuring-dns.adoc +++ b/modules/installation-configuring-dns.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-configuring-dns-{context}'] +[id="installation-configuring-dns-{context}"] = Configuring hosts to use DNS Make sure each host in your environment is configured to resolve hostnames from diff --git a/modules/installation-configuring-node-host-names.adoc b/modules/installation-configuring-node-host-names.adoc index 97cc6bbea6..2a7a42819d 100644 --- a/modules/installation-configuring-node-host-names.adoc +++ b/modules/installation-configuring-node-host-names.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-configuring-node-host-names-{context}'] +[id="installation-configuring-node-host-names-{context}"] = Configuring node host names When you set up a cluster that is not integrated with a cloud provider, you must diff --git a/modules/installation-customizing.adoc b/modules/installation-customizing.adoc index 7aa54794d7..1e70e7a1da 100644 --- a/modules/installation-customizing.adoc +++ b/modules/installation-customizing.adoc @@ -3,7 +3,7 @@ // * installing/installing_aws/installing-aws-customizations.adoc -[id='installation-customizing-{context}'] +[id="installation-customizing-{context}"] = Further customizing the installation If you need to make even more customizations, you can. diff --git a/modules/installation-initializing.adoc b/modules/installation-initializing.adoc index c1985ff7b2..23ff560ee1 100644 --- a/modules/installation-initializing.adoc +++ b/modules/installation-initializing.adoc @@ -3,7 +3,7 @@ // * installing/installing_aws/installing-aws-customizations.adoc // Consider also adding the installation-configuration-parameters.adoc module. -[id='installation-initializing-{context}'] +[id="installation-initializing-{context}"] = Creating the installation configuration file You can customize your installation of {product-title} on a compatible cloud. diff --git a/modules/installation-launching-installer.adoc b/modules/installation-launching-installer.adoc index cf716ea941..22051c93d4 100644 --- a/modules/installation-launching-installer.adoc +++ b/modules/installation-launching-installer.adoc @@ -5,7 +5,7 @@ // If you use this module in any other assembly, you must update the ifeval // statements. -[id='launching-installer-{context}'] +[id="launching-installer-{context}"] = Deploy the cluster You can install {product-title} on a compatible cloud. diff --git a/modules/installation-networking-requirements.adoc b/modules/installation-networking-requirements.adoc index 1a7388e3d8..6875a847a2 100644 --- a/modules/installation-networking-requirements.adoc +++ b/modules/installation-networking-requirements.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-networking-requirements-{context}'] +[id="installation-networking-requirements-{context}"] = Networking requirements for BYO installations The following section defines the requirements of the environment containing @@ -10,7 +10,7 @@ your {product-title} configuration. This includes networking considerations and access to external services, such as Git repository access, storage, and cloud infrastructure providers. -[id='prereq-dns-{context}'] +[id="prereq-dns-{context}"] == DNS Requirements {product-title} requires a fully functional DNS server in the environment. This @@ -61,7 +61,7 @@ failure with: IP address alone -[id='prereq-network-access-{context}'] +[id="prereq-network-access-{context}"] == Network access requirements A shared network must exist between the master and node hosts. If you plan to @@ -71,7 +71,7 @@ during the installation process. The IP that you select must be routable between all of your nodes, and if you configure using a FQDN it must resolve on all nodes. -[id='prereq-networkmanager-{context}'] +[id="prereq-networkmanager-{context}"] === NetworkManager `NetworkManager`, a program for providing detection and configuration for @@ -83,7 +83,7 @@ then the NetworkManager dispatch script does not create the relevant *_origin-upstream-dns.conf_* dnsmasq file, and you must configure dnsmasq manually. -[id='install-config-network-using-firewalld-{context}'] +[id="install-config-network-using-firewalld-{context}"] === Firewall requirements While iptables is the default firewall, firewalld is recommended for new diff --git a/modules/installation-obtaining-installer.adoc b/modules/installation-obtaining-installer.adoc index a56152b4b9..08a8a2a2a0 100644 --- a/modules/installation-obtaining-installer.adoc +++ b/modules/installation-obtaining-installer.adoc @@ -4,7 +4,7 @@ // * installing/installing_aws/installing-aws-customizations.adoc -[id='installing-aws-default-{context}'] +[id="installing-aws-default-{context}"] = Obtaining the installation program Before you install {product-title} on a compatible cloud, download the diff --git a/modules/installation-options.adoc b/modules/installation-options.adoc index b96609de37..a373352e00 100644 --- a/modules/installation-options.adoc +++ b/modules/installation-options.adoc @@ -2,7 +2,7 @@ // // * architecture/architecture.adoc -[id='installation-options-{context}'] +[id="installation-options-{context}"] = Installation options In {product-title} version 4.0, you can install only clusters that use diff --git a/modules/installation-overview.adoc b/modules/installation-overview.adoc index d2ffa29b3e..cb6b149004 100644 --- a/modules/installation-overview.adoc +++ b/modules/installation-overview.adoc @@ -4,7 +4,7 @@ // * installing/installing_aws/installing-aws-customizations.adoc // * installing-byoh/installing-existing-hosts.adoc -[id='installation-overview-{context}'] +[id="installation-overview-{context}"] = {product-title} installation overview You use the {product-title} installer to create {product-title} clusters in diff --git a/modules/installation-planning.adoc b/modules/installation-planning.adoc index 069ed92406..cb6504e5f3 100644 --- a/modules/installation-planning.adoc +++ b/modules/installation-planning.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-planning-{context}'] +[id="installation-planning-{context}"] = Planning your installation You install {product-title} by running a series of Ansible playbooks. As you @@ -13,7 +13,7 @@ familiarity with Ansible might make this process easier, it is not required. You can read more about Ansible and its basic usage in the link:http://docs.ansible.com/ansible/[official documentation]. -[id='inital-planning-{context}'] +[id="inital-planning-{context}"] == Initial planning Before you install your production {product-title} cluster, you need answers to @@ -57,7 +57,7 @@ for a list of tested integrations. endif::[] ifdef::openshift-origin[] -[id='planning-cloud-providers-{context}'] +[id="planning-cloud-providers-{context}"] == On-premise versus cloud providers You can install {product-title} on-premise or host it on public or private @@ -65,14 +65,14 @@ clouds. You can use the provided Ansible playbooks to help you automate the provisioning and installation processes. endif::[] -[id='sizing-{context}'] +[id="sizing-{context}"] == Sizing considerations Determine how many nodes and pods you require for your {product-title} cluster. Cluster scalability correlates to the number of pods in a cluster environment. That number influences the other numbers in your setup -[id='environment-scenarios-{context}'] +[id="environment-scenarios-{context}"] == Environment scenarios Use these environment scenarios to help plan your {product-title} cluster @@ -88,14 +88,14 @@ In all environments, if your etcd hosts are co-located with master hosts, etcd runs as a static pod on the host. If your etcd hosts are not co-located with master hosts, they run etcd as standalone processes. -[id='single-master-single-box-{context}'] +[id="single-master-single-box-{context}"] === Single master and node on one system You can install {product-title} on a single system for only a development environment. You cannot use an _all-in-one environment_ as a production environment. -[id='single-master-multi-node-{context}'] +[id="single-master-multi-node-{context}"] === Single master and multiple nodes The following table describes an example environment for a single @@ -116,7 +116,7 @@ and two nodes: |`node2.example.com` |=== -[id='multi-masters-using-native-ha-colocated-{context}'] +[id="multi-masters-using-native-ha-colocated-{context}"] === Multiple masters using native HA The following describes an example environment for three masters, @@ -144,7 +144,7 @@ using the `native` HA method. etcd runs as static pods on the master nodes: |`node2.example.com` |=== -[id='multi-masters-using-native-ha-{context}'] +[id="multi-masters-using-native-ha-{context}"] === Multiple Masters Using Native HA with External Clustered etcd The following describes an example environment for three @@ -180,13 +180,13 @@ hosts, and two nodes using the `native` HA method: |`node2.example.com` |=== -[id='planning-stand-alone-registry-{context}'] +[id="planning-stand-alone-registry-{context}"] === Stand-alone registry You can also install {product-title} to act as a stand-alone registry using the {product-title}'s integrated registry. -[id='planning-installation-types-{context}'] +[id="planning-installation-types-{context}"] == Installation types for supported infrastructure Starting in {product-title} 4.0, you can install the cluster on your own @@ -203,7 +203,7 @@ infrastructure nodes or install a fully-managed cluster on certain cloud provide |=== //// -[id='containerized-required-images-{context}'] +[id="containerized-required-images-{context}"] === Required images for system containers The system container installation type makes use of the following images: @@ -248,14 +248,14 @@ applied before attempting to pull any of the required images. //// -[id='planning-installation-types-service-names-{context}'] +[id="planning-installation-types-service-names-{context}"] === systemd service names The installation process creates relevant `systemd` units which can be used to start, stop, and poll services using normal `systemctl` commands. For system container installations, these unit names match those of an RPM installation. -[id='containerized-file-paths-{context}'] +[id="containerized-file-paths-{context}"] === File path locations All {product-title} configuration files are placed in the same locations during diff --git a/modules/installation-preparing-assets.adoc b/modules/installation-preparing-assets.adoc index 3e7fe0ecfb..2a4e529fe2 100644 --- a/modules/installation-preparing-assets.adoc +++ b/modules/installation-preparing-assets.adoc @@ -3,7 +3,7 @@ // * installing/installing_aws/installing-aws-customizations.adoc -[id='installation-preparing-assets-{context}'] +[id="installation-preparing-assets-{context}"] = Preparing assets for installation Prepare the final Ignition configurations for the master and bootstrap nodes. diff --git a/modules/installation-preparing-custom.adoc b/modules/installation-preparing-custom.adoc index b47593b57d..14663e1f3f 100644 --- a/modules/installation-preparing-custom.adoc +++ b/modules/installation-preparing-custom.adoc @@ -2,7 +2,7 @@ // // * installing/installing_aws/installing-aws-customizations.adoc -[id='installation-preparing-custom-{context}'] +[id="installation-preparing-custom-{context}"] = Preparing to install a custom {product-title} cluster Before you install {product-title} on a cloud, you need to plan any diff --git a/modules/installation-preparing-hosts.adoc b/modules/installation-preparing-hosts.adoc index 284c045197..2c9640eaaa 100644 --- a/modules/installation-preparing-hosts.adoc +++ b/modules/installation-preparing-hosts.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-preparing-hosts-{context}'] +[id="installation-preparing-hosts-{context}"] = Preparing your hosts Before you install {product-title}, you must prepare the node hosts. Each node diff --git a/modules/installation-provide-credentials.adoc b/modules/installation-provide-credentials.adoc index 283fc57e1a..29d66e7521 100644 --- a/modules/installation-provide-credentials.adoc +++ b/modules/installation-provide-credentials.adoc @@ -3,7 +3,7 @@ // * installing/installing_aws/installing-aws-customizations.adoc // * installing/installing_aws/installing-aws-default.adoc -[id='installation-provide-credentials-{context}'] +[id="installation-provide-credentials-{context}"] = Configuring your computer for installation Before you install your {product-title} cluster, add your Amazon Web Services (AWS) diff --git a/modules/installation-registering-hosts.adoc b/modules/installation-registering-hosts.adoc index 75c6632459..beb907ca4e 100644 --- a/modules/installation-registering-hosts.adoc +++ b/modules/installation-registering-hosts.adoc @@ -4,7 +4,7 @@ ifdef::openshift-enterprise[] -[id='installation-registering-hosts-{context}'] +[id="installation-registering-hosts-{context}"] = Registering hosts Before you install {product-title} on your infrastructure, you must register diff --git a/modules/installation-required-ports.adoc b/modules/installation-required-ports.adoc index 1fce08da5b..6c8be770c1 100644 --- a/modules/installation-required-ports.adoc +++ b/modules/installation-required-ports.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-required-ports-{context}'] +[id="installation-required-ports-{context}"] = Required ports The following ports are required by {product-title} and must be open for your diff --git a/modules/installation-security-warning.adoc b/modules/installation-security-warning.adoc index 243f40a946..ffaac637aa 100644 --- a/modules/installation-security-warning.adoc +++ b/modules/installation-security-warning.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-security-warning-{context}'] +[id="installation-security-warning-{context}"] = Security Warning {product-title} runs containers on hosts in the cluster, and in some cases, such diff --git a/modules/installation-storage-requirements.adoc b/modules/installation-storage-requirements.adoc index 5e5c5a7a93..6eb1796a9e 100644 --- a/modules/installation-storage-requirements.adoc +++ b/modules/installation-storage-requirements.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installation-storage-requirements-{context}'] +[id="installation-storage-requirements-{context}"] = Persistent storage requirements for BYO installations The Kubernetes persistent volume framework allows you to provision an {product-title} cluster with persistent storage diff --git a/modules/installation-uninstall-aws.adoc b/modules/installation-uninstall-aws.adoc index a6eda8938f..b25c6148c7 100644 --- a/modules/installation-uninstall-aws.adoc +++ b/modules/installation-uninstall-aws.adoc @@ -2,7 +2,7 @@ // // * installing/installing_aws/uninstalling-cluster-aws'adoc -[id='installation-uninstall-aws-{context}'] +[id="installation-uninstall-aws-{context}"] = Removing a cluster from AWS You can remove a cluster that you installed on Amazon Web Services (AWS). diff --git a/modules/installing-aws-customizations.adoc b/modules/installing-aws-customizations.adoc index 637bdee3aa..9205d65ec5 100644 --- a/modules/installing-aws-customizations.adoc +++ b/modules/installing-aws-customizations.adoc @@ -2,7 +2,7 @@ // // * installing/installing_aws/installing-aws-customizations.adoc -[id='installing-aws-customizations-{context}'] +[id="installing-aws-customizations-{context}"] = Installation command options The installation program uses diff --git a/modules/installing-cluster-loader.adoc b/modules/installing-cluster-loader.adoc index 021c948a3f..61d39f7097 100644 --- a/modules/installing-cluster-loader.adoc +++ b/modules/installing-cluster-loader.adoc @@ -2,7 +2,7 @@ // // scalability_and_performance/using-cluster-loader.adoc -[id='installing_cluster_loader-{context}'] +[id="installing_cluster_loader-{context}"] = Installing Cluster Loader Cluster Loader is included in the `origin-tests` container image. diff --git a/modules/installing-docker.adoc b/modules/installing-docker.adoc index d6a8125f89..e6228bcc79 100644 --- a/modules/installing-docker.adoc +++ b/modules/installing-docker.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='installing-docker-{context}'] +[id="installing-docker-{context}"] = Installing Docker [IMPORTANT] @@ -35,7 +35,7 @@ the *_/etc/sysconfig/docker_* file. # docker version ---- -[id='configuring-docker-storage-{context}'] +[id="configuring-docker-storage-{context}"] == Configuring Docker Storage Containers and the images they are created from are stored in Docker's storage diff --git a/modules/ldap-failover-configure-apache.adoc b/modules/ldap-failover-configure-apache.adoc index 9d6df537e3..d3b15289e9 100644 --- a/modules/ldap-failover-configure-apache.adoc +++ b/modules/ldap-failover-configure-apache.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-ldap-failover.adoc -[id='sssd-configuring-apache-{context}'] +[id="sssd-configuring-apache-{context}"] = Configuring Apache to use SSSD .Procedure diff --git a/modules/ldap-failover-configure-openshift.adoc b/modules/ldap-failover-configure-openshift.adoc index 1077077794..e07f274657 100644 --- a/modules/ldap-failover-configure-openshift.adoc +++ b/modules/ldap-failover-configure-openshift.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-ldap-failover.adoc -[id='sssd-for-ldap-configure-openshift-{context}'] +[id="sssd-for-ldap-configure-openshift-{context}"] = Configuring {product-title} to use SSSD as the basic remote authentication server Modify the default configuration of your cluster to use the new identity diff --git a/modules/ldap-failover-configure-sssd.adoc b/modules/ldap-failover-configure-sssd.adoc index 6094502c07..264e82f166 100644 --- a/modules/ldap-failover-configure-sssd.adoc +++ b/modules/ldap-failover-configure-sssd.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-ldap-failover.adoc -[id='sssd-configuring-sssd-{context}'] +[id="sssd-configuring-sssd-{context}"] = Configuring SSSD for LDAP failover Complete these steps on the remote basic authentication server. diff --git a/modules/ldap-failover-generate-certs.adoc b/modules/ldap-failover-generate-certs.adoc index 703f8897dc..43674c255f 100644 --- a/modules/ldap-failover-generate-certs.adoc +++ b/modules/ldap-failover-generate-certs.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-ldap-failover.adoc -[id='sssd-generating-certificates-{context}'] +[id="sssd-generating-certificates-{context}"] = Generating and sharing certificates with the remote basic authentication server Complete the following steps on the first master host listed in the Ansible host inventory file, diff --git a/modules/ldap-failover-overview.adoc b/modules/ldap-failover-overview.adoc index 430c9a11e3..5737199f84 100644 --- a/modules/ldap-failover-overview.adoc +++ b/modules/ldap-failover-overview.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-ldap-failover.adoc -[id='sssd-for-ldap-overview-{context}'] +[id="sssd-for-ldap-overview-{context}"] {product-title} provides an authentication provider for use with Lightweight Directory Access Protocol (LDAP) setups, but diff --git a/modules/ldap-failover-prereqs.adoc b/modules/ldap-failover-prereqs.adoc index 33a5e3cebf..d30229c1ce 100644 --- a/modules/ldap-failover-prereqs.adoc +++ b/modules/ldap-failover-prereqs.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-ldap-failover.adoc -[id='sssd-for-ldap-prereqs-{context}'] +[id="sssd-for-ldap-prereqs-{context}"] = Prerequisites for configuring basic remote authentication * Before starting setup, you need to know the following information about your diff --git a/modules/machine-api-overview.adoc b/modules/machine-api-overview.adoc index 333ffaf72b..bf1bb7d49e 100644 --- a/modules/machine-api-overview.adoc +++ b/modules/machine-api-overview.adoc @@ -2,7 +2,7 @@ // // * architecture/architecture.adoc -[id='machine-api-overview-{context}'] +[id="machine-api-overview-{context}"] = Machine API overview For {product-title} 4 clusters, the Machine API performs all node diff --git a/modules/machine-autoscaler-about.adoc b/modules/machine-autoscaler-about.adoc index 5c973b6490..628526865b 100644 --- a/modules/machine-autoscaler-about.adoc +++ b/modules/machine-autoscaler-about.adoc @@ -2,7 +2,7 @@ // // * machine_management/applying-autoscaling.adoc -[id='machine-autoscaler-about-{context}'] +[id="machine-autoscaler-about-{context}"] = About the MachineAutoscaler The MachineAutoscaler adjusts the number of Machines in the MachineSets that you diff --git a/modules/machine-autoscaler-cr.adoc b/modules/machine-autoscaler-cr.adoc index 4eaee31873..6c569ac468 100644 --- a/modules/machine-autoscaler-cr.adoc +++ b/modules/machine-autoscaler-cr.adoc @@ -2,7 +2,7 @@ // // * machine_management/applying-autoscaling.adoc -[id='machine-autoscaler-cr-{context}'] +[id="machine-autoscaler-cr-{context}"] = MachineAutoscaler resource definition This MachineAutoscaler resource definition shows the parameters and sample diff --git a/modules/machine-health-checks-about.adoc b/modules/machine-health-checks-about.adoc index a49a745c77..c28fee0bd9 100644 --- a/modules/machine-health-checks-about.adoc +++ b/modules/machine-health-checks-about.adoc @@ -2,7 +2,7 @@ // // * master/deploying-machine-health-checks.adoc -[id='machine-health-checks-about-{context}'] +[id="machine-health-checks-about-{context}"] = About MachineHealthChecks MachineHealthChecks automatically repairs unhealthy Machines in a particular diff --git a/modules/machine-health-checks-creating.adoc b/modules/machine-health-checks-creating.adoc index ebeb620b76..c0ef56d7ec 100644 --- a/modules/machine-health-checks-creating.adoc +++ b/modules/machine-health-checks-creating.adoc @@ -2,7 +2,7 @@ // // * master/deploying-machine-health-checks.adoc -[id='machine-health-checks-creating-{context}'] +[id="machine-health-checks-creating-{context}"] = Creating a MachineHealthCheck resource You can create a MachineHealthCheck resource for all MachinePools in your diff --git a/modules/machine-health-checks-resource.adoc b/modules/machine-health-checks-resource.adoc index 395e915fb6..5e9de300af 100644 --- a/modules/machine-health-checks-resource.adoc +++ b/modules/machine-health-checks-resource.adoc @@ -2,7 +2,7 @@ // // * master/deploying-machine-health-checks.adoc -[id='machine-health-checks-resource-{context}'] +[id="machine-health-checks-resource-{context}"] = Sample MachineHealthCheck resource The MachineHealthCheck resource resembles the following YAML file: diff --git a/modules/machineset-cr.adoc b/modules/machineset-cr.adoc index dde3608bc7..c4cea6cd4f 100644 --- a/modules/machineset-cr.adoc +++ b/modules/machineset-cr.adoc @@ -2,7 +2,7 @@ // // * machine_management/creating-infrastructure-machinesets.adoc -[id='machineset-cr-{context}'] +[id="machineset-cr-{context}"] = Sample MachineSet Custom Resource [source,yaml] diff --git a/modules/machineset-creating.adoc b/modules/machineset-creating.adoc index 858d83545c..9b77f484f0 100644 --- a/modules/machineset-creating.adoc +++ b/modules/machineset-creating.adoc @@ -2,7 +2,7 @@ // // * machine-management/creating-infrastructure-machinesets.adoc -[id='machineset-creating-{context}'] +[id="machineset-creating-{context}"] = Creating a MachineSet You can create more MachineSets. Because the MachineSet definition contains diff --git a/modules/machineset-manually-scaling.adoc b/modules/machineset-manually-scaling.adoc index bb84d22843..a52c787c97 100644 --- a/modules/machineset-manually-scaling.adoc +++ b/modules/machineset-manually-scaling.adoc @@ -2,7 +2,7 @@ // // * machine_management/manually-scale-machines.adoc -[id='machineset-manually-scaling-{context}'] +[id="machineset-manually-scaling-{context}"] = Scaling a MachineSet manually If you need to add or remove an instance of a machine in a MachineSet, you can diff --git a/modules/managing-memcached-operator-using-olm.adoc b/modules/managing-memcached-operator-using-olm.adoc index f714f9c57f..27fd5e76d9 100644 --- a/modules/managing-memcached-operator-using-olm.adoc +++ b/modules/managing-memcached-operator-using-olm.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-getting-started.adoc -[id='managing-memcached-operator-using-olm-{context}'] +[id="managing-memcached-operator-using-olm-{context}"] = Managing a Memcached Operator using the Operator Lifecycle Manager The previous section has covered manually running an Operator. In the next diff --git a/modules/migrating-custom-types-pkg-apis.adoc b/modules/migrating-custom-types-pkg-apis.adoc index 2e09c8f674..b263234c71 100644 --- a/modules/migrating-custom-types-pkg-apis.adoc +++ b/modules/migrating-custom-types-pkg-apis.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc -[id='migrating-custom-types-from-pkg-apis-{context}'] +[id="migrating-custom-types-from-pkg-apis-{context}"] = Migrating custom types from pkg/apis Migrate your project's custom types to the updated Operator SDK v0.1.0 usage. diff --git a/modules/migrating-reconcile-code.adoc b/modules/migrating-reconcile-code.adoc index 02346e9f42..e20991c655 100644 --- a/modules/migrating-reconcile-code.adoc +++ b/modules/migrating-reconcile-code.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-migrating-to-v0-1-0.adoc -[id='migrating-reconcile-code-{context}'] +[id="migrating-reconcile-code-{context}"] = Migrating reconcile code Migrate your project's reconcile code to the update Operator SDK v0.1.0 usage. diff --git a/modules/mod-docs-ocp-conventions.adoc b/modules/mod-docs-ocp-conventions.adoc index cbe2520051..5cc7ae9bde 100644 --- a/modules/mod-docs-ocp-conventions.adoc +++ b/modules/mod-docs-ocp-conventions.adoc @@ -4,10 +4,10 @@ // Base the file name and the ID on the module title. For example: // * file name: my-reference-a.adoc -// * ID: [id='my-reference-a'] +// * ID: [id="my-reference-a"] // * Title: = My reference A -[id='mod-docs-ocp-conventions-{context}'] +[id="mod-docs-ocp-conventions-{context}"] = Modular docs OpenShift conventions These Modular Docs conventions for OpenShift docs build on top of the CCS @@ -24,7 +24,7 @@ link:https://redhat-documentation.github.io/modular-docs/[modular docs guideline IMPORTANT: If some convention is duplicated, the convention in this guide supersedes all others. -[id='ocp-ccs-conventions-{context}'] +[id="ocp-ccs-conventions-{context}"] == OpenShift CCS conventions * All assemblies must define a context that is unique. @@ -45,7 +45,7 @@ context statement. This file contains the standard attributes for the collection * All anchor ids must follow the format: + ---- -[id='-{context}'] +[id="-{context}"] ---- + Anchor name is _connected_ to the `{context}` using a dash. @@ -53,7 +53,7 @@ Anchor name is _connected_ to the `{context}` using a dash. Example: + ---- -[id='creating-your-first-content-{context}'] +[id="creating-your-first-content-{context}"] ---- * All modules anchor ids must have the `{context}` variable. diff --git a/modules/monitoring-accessing-prometheus-alertmanager-grafana.adoc b/modules/monitoring-accessing-prometheus-alertmanager-grafana.adoc index aa81dd421d..d46cd3ab50 100644 --- a/modules/monitoring-accessing-prometheus-alertmanager-grafana.adoc +++ b/modules/monitoring-accessing-prometheus-alertmanager-grafana.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='accessing-prometheus-alertmanager-and-grafana-{context}'] +[id="accessing-prometheus-alertmanager-and-grafana-{context}"] = Accessing Prometheus, Alertmanager, and Grafana {product-title} Monitoring ships with a Prometheus instance for cluster monitoring and a central Alertmanager cluster. In addition to Prometheus and Alertmanager, {product-title} Monitoring also includes a https://grafana.com/[Grafana] instance as well as pre-built dashboards for cluster monitoring troubleshooting. diff --git a/modules/monitoring-alerting-rules.adoc b/modules/monitoring-alerting-rules.adoc index 6152d9cd20..3fe988fa92 100644 --- a/modules/monitoring-alerting-rules.adoc +++ b/modules/monitoring-alerting-rules.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='alerting-rules-{context}'] +[id="alerting-rules-{context}"] == Alerting rules {product-title} Cluster Monitoring ships with the following alerting rules configured by default. Currently you cannot add custom alerting rules. diff --git a/modules/monitoring-alertmanager-default-configuration.adoc b/modules/monitoring-alertmanager-default-configuration.adoc index b31883426f..6247969bec 100644 --- a/modules/monitoring-alertmanager-default-configuration.adoc +++ b/modules/monitoring-alertmanager-default-configuration.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='alertmanager-default-configuration-{context}'] +[id="alertmanager-default-configuration-{context}"] = Alertmanager default configuration The default configuration of the {product-title} Monitoring Alertmanager cluster is this: diff --git a/modules/monitoring-applying-custom-alertmanager-configuration.adoc b/modules/monitoring-applying-custom-alertmanager-configuration.adoc index a6bb66bfe2..03e91c54cc 100644 --- a/modules/monitoring-applying-custom-alertmanager-configuration.adoc +++ b/modules/monitoring-applying-custom-alertmanager-configuration.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='applying-custom-alertmanager-configuration-{context}'] +[id="applying-custom-alertmanager-configuration-{context}"] = Applying custom Alertmanager configuration This procedure shows how to override the default Alertmanager configuration with your own. diff --git a/modules/monitoring-configuring-etcd-monitoring.adoc b/modules/monitoring-configuring-etcd-monitoring.adoc index e8ca6c0761..88e376278b 100644 --- a/modules/monitoring-configuring-etcd-monitoring.adoc +++ b/modules/monitoring-configuring-etcd-monitoring.adoc @@ -2,7 +2,7 @@ // // * monitoring/prometheus-cluster-monitoring.adoc -[id='configuring-etcd-monitoring-{context}'] +[id="configuring-etcd-monitoring-{context}"] = Configuring etcd monitoring If the `etcd` service does not run correctly, successful operation of the whole {product-title} cluster is in danger. Therefore, it is reasonable to configure monitoring of `etcd`. diff --git a/modules/monitoring-dead-mans-switch-pagerduty.adoc b/modules/monitoring-dead-mans-switch-pagerduty.adoc index 3073b4f7d5..1ad28a120e 100644 --- a/modules/monitoring-dead-mans-switch-pagerduty.adoc +++ b/modules/monitoring-dead-mans-switch-pagerduty.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='dead-mans-switch-pagerduty-{context}'] +[id="dead-mans-switch-pagerduty-{context}"] == Dead man's switch PagerDuty https://www.pagerduty.com/[PagerDuty] supports "Dead man's switch" through an integration called https://deadmanssnitch.com/[Dead Man's Snitch]. You can enable it. diff --git a/modules/monitoring-dead-mans-switch.adoc b/modules/monitoring-dead-mans-switch.adoc index 640cfaf485..322c597710 100644 --- a/modules/monitoring-dead-mans-switch.adoc +++ b/modules/monitoring-dead-mans-switch.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='dead-mans-switch-{context}'] +[id="dead-mans-switch-{context}"] == Dead man's switch {product-title} Monitoring ships with a "Dead man's switch" to ensure the availability of the monitoring infrastructure. diff --git a/modules/monitoring-enabling-dynamically-provisioned-storage.adoc b/modules/monitoring-enabling-dynamically-provisioned-storage.adoc index 460e04f1c5..b39876f41b 100644 --- a/modules/monitoring-enabling-dynamically-provisioned-storage.adoc +++ b/modules/monitoring-enabling-dynamically-provisioned-storage.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='enabling-dynamically-provisioned-storage-{context}'] +[id="enabling-dynamically-provisioned-storage-{context}"] = Enabling dynamically-provisioned storage Instead of statically-provisioned storage, you can use dynamically-provisioned storage. diff --git a/modules/monitoring-enabling-persistent-storage.adoc b/modules/monitoring-enabling-persistent-storage.adoc index 64f0ab2a9e..1b25a4de20 100644 --- a/modules/monitoring-enabling-persistent-storage.adoc +++ b/modules/monitoring-enabling-persistent-storage.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='enabling-persistent-storage-{context}'] +[id="enabling-persistent-storage-{context}"] = Enabling persistent storage By default, persistent storage is disabled for both Prometheus time-series data and for Alertmanager notifications and silences. You can configure the cluster to persistently store any one of them or both. diff --git a/modules/monitoring-full-list-of-configuration-variables.adoc b/modules/monitoring-full-list-of-configuration-variables.adoc index 0b5d5b615a..1fb0aaee5b 100644 --- a/modules/monitoring-full-list-of-configuration-variables.adoc +++ b/modules/monitoring-full-list-of-configuration-variables.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='full-list-of-configuration-variables-{context}'] +[id="full-list-of-configuration-variables-{context}"] = Full list of configuration variables This table contains the full list of the inventory file variables for configuring the Cluster Monitoring Operator: diff --git a/modules/monitoring-grouping-alerts.adoc b/modules/monitoring-grouping-alerts.adoc index 59de7831c1..b47166ff25 100644 --- a/modules/monitoring-grouping-alerts.adoc +++ b/modules/monitoring-grouping-alerts.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='grouping-alerts-{context}'] +[id="grouping-alerts-{context}"] == Grouping alerts Once alerts are firing against the Alertmanager, it must be configured to know how to logically group them. This procedure shows how to configure alert grouping: diff --git a/modules/monitoring-monitoring-overview.adoc b/modules/monitoring-monitoring-overview.adoc index 9a580a5a2d..b3824be8dd 100644 --- a/modules/monitoring-monitoring-overview.adoc +++ b/modules/monitoring-monitoring-overview.adoc @@ -2,7 +2,7 @@ // // * monitoring/prometheus-cluster-monitoring.adoc -[id='monitoring-overview-{context}'] +[id="monitoring-overview-{context}"] = Monitoring overview {product-title} ships with a pre-configured and self-updating monitoring stack that is based on the link:https://prometheus.io/[Prometheus] open source project and its wider eco-system. It provides monitoring of cluster components and ships with a set of alerts to immediately notify the cluster administrator about any occurring problems and a set of link:https://grafana.com/[Grafana] dashboards. diff --git a/modules/monitoring-setting-persistent-storage-size.adoc b/modules/monitoring-setting-persistent-storage-size.adoc index ff25a0b4c9..2334ad1e1f 100644 --- a/modules/monitoring-setting-persistent-storage-size.adoc +++ b/modules/monitoring-setting-persistent-storage-size.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='setting-persistent-storage-size-{context}'] +[id="setting-persistent-storage-size-{context}"] = Setting persistent storage size You can specify the size of the persistent volume claim for Prometheus and Alertmanager. diff --git a/modules/monitoring-supported-configuration.adoc b/modules/monitoring-supported-configuration.adoc index 5d3ccc92a1..f1f3eeb240 100644 --- a/modules/monitoring-supported-configuration.adoc +++ b/modules/monitoring-supported-configuration.adoc @@ -2,7 +2,7 @@ // // * monitoring/installing-monitoring-stack.adoc -[id='supported-configuration-{context}'] +[id="supported-configuration-{context}"] = Supported configuration The supported way of configuring {product-title} Monitoring is by configuring it using the options described in the Configuring OpenShift cluster monitoring section. Beyond those explicit configuration options, it is possible to inject additional configuration into the stack. However this is unsupported, as configuration paradigms might change across Prometheus releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. diff --git a/modules/monitoring-update-and-compatibility-guarantees.adoc b/modules/monitoring-update-and-compatibility-guarantees.adoc index cafb94fea1..9c99b9e40b 100644 --- a/modules/monitoring-update-and-compatibility-guarantees.adoc +++ b/modules/monitoring-update-and-compatibility-guarantees.adoc @@ -2,7 +2,7 @@ // // * monitoring/prometheus-cluster-monitoring.adoc -[id='update-and-compatibility-guarantees-{context}'] +[id="update-and-compatibility-guarantees-{context}"] = Update and compatibility guarantees In order to be able to deliver updates with guaranteed compatibility, configurability of the {product-title} Monitoring stack is limited to the explicitly available options. This document describes known pitfalls of which types of configuration and customization are unsupported, as well as misuse of resources provided by {product-title} Monitoring. All configuration options described in this topic are explicitly supported. diff --git a/modules/mounting-local-volumes.adoc b/modules/mounting-local-volumes.adoc index 1e3dbc1206..4d44c6de8b 100644 --- a/modules/mounting-local-volumes.adoc +++ b/modules/mounting-local-volumes.adoc @@ -1,4 +1,4 @@ -[id='mounting-local-volumes-{context}'] +[id="mounting-local-volumes-{context}"] = Mounting local volumes This paragraph is the procedure module introduction: a short description of the procedure. diff --git a/modules/node-management.adoc b/modules/node-management.adoc index 305c31d130..c8fde17439 100644 --- a/modules/node-management.adoc +++ b/modules/node-management.adoc @@ -2,7 +2,7 @@ // // * architecture/architecture.adoc -[id='node-management-{context}'] +[id="node-management-{context}"] = Node management in {product-title} {product-title} version 4.0 integrates management of @@ -50,7 +50,7 @@ to new nodes when they join the cluster. When you perform node management operations, you will be creating or modifying a KubeletConfig Custom Resource (CR). -[id='machine-configs-and-pools-{context}'] +[id="machine-configs-and-pools-{context}"] == Machine Configs and Machine Config Pools Machine Config Pools manage a cluster of nodes and their corresponding Machine Configs. Machine Configs contain configuration information for a diff --git a/modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc b/modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc index e669d7e37c..34a3d9540c 100644 --- a/modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc +++ b/modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc @@ -2,7 +2,7 @@ // // * scalability_and_performance/using-node-tuning-operator.adoc -[id='supported-tuned-daemon-plug-ins-{context}'] +[id="supported-tuned-daemon-plug-ins-{context}"] = Supported Tuned daemon plug-ins Excluding the `[main]` section, the following Tuned plug-ins are supported when diff --git a/modules/node-tuning-operator.adoc b/modules/node-tuning-operator.adoc index 1c25ec0573..b881b15e43 100644 --- a/modules/node-tuning-operator.adoc +++ b/modules/node-tuning-operator.adoc @@ -2,7 +2,7 @@ // // * scalability_and_performance/using-node-tuning-operator.adoc -[id='about-node-tuning-operator-{context}'] +[id="about-node-tuning-operator-{context}"] = About the Node Tuning Operator The Node Tuning Operator helps you manage node-level tuning by orchestrating the diff --git a/modules/node-types.adoc b/modules/node-types.adoc index 6813d30138..d9bad4e489 100644 --- a/modules/node-types.adoc +++ b/modules/node-types.adoc @@ -2,7 +2,7 @@ // // * architecture/architecture.adoc -[id='node-roles-{context}'] +[id="node-roles-{context}"] = Node roles in {product-title} {product-title} assigns hosts different roles. These roles define the function diff --git a/modules/nodes-cluster-overcommit-about.adoc b/modules/nodes-cluster-overcommit-about.adoc index 19a49e8e45..4e32414f3d 100644 --- a/modules/nodes-cluster-overcommit-about.adoc +++ b/modules/nodes-cluster-overcommit-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='nodes-cluster-overcommit-about-{context}'] +[id="nodes-cluster-overcommit-about-{context}"] = Understanding overcommitment in {product-title} Requests and limits enable administrators to allow and manage the overcommitment of resources on a node. The scheduler uses requests for scheduling your container and providing a minimum service guarantee. Limits constrain the amount of compute resource that may be consumed on your node. diff --git a/modules/nodes-cluster-overcommit-configure-nodes.adoc b/modules/nodes-cluster-overcommit-configure-nodes.adoc index c5f24f6eb4..d19e830d24 100644 --- a/modules/nodes-cluster-overcommit-configure-nodes.adoc +++ b/modules/nodes-cluster-overcommit-configure-nodes.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='nodes-cluster-overcommit-configure-nodes-{context}'] +[id="nodes-cluster-overcommit-configure-nodes-{context}"] = Configuring nodes for overcommitment diff --git a/modules/nodes-cluster-overcommit-master-disabling-swap.adoc b/modules/nodes-cluster-overcommit-master-disabling-swap.adoc index d89a4baa77..0beb5b1a77 100644 --- a/modules/nodes-cluster-overcommit-master-disabling-swap.adoc +++ b/modules/nodes-cluster-overcommit-master-disabling-swap.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='nodes-cluster-overcommit-disabling-swap-{context}'] +[id="nodes-cluster-overcommit-disabling-swap-{context}"] = Understanding swap memory and QOS You can disable swap by across all nodes in your cluster with a single command. diff --git a/modules/nodes-cluster-overcommit-node-enforcing.adoc b/modules/nodes-cluster-overcommit-node-enforcing.adoc index 21d0e6003a..5d8dc0a4c6 100644 --- a/modules/nodes-cluster-overcommit-node-enforcing.adoc +++ b/modules/nodes-cluster-overcommit-node-enforcing.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='nodes-cluster-overcommit-node-enforcing-{context}'] +[id="nodes-cluster-overcommit-node-enforcing-{context}"] = Disabling or enforcing CPU limits using CPU CFS quotas diff --git a/modules/nodes-cluster-overcommit-node-memory.adoc b/modules/nodes-cluster-overcommit-node-memory.adoc index 909e97a82e..37ec2e7ac8 100644 --- a/modules/nodes-cluster-overcommit-node-memory.adoc +++ b/modules/nodes-cluster-overcommit-node-memory.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='nodes-cluster-overcommit-node-memory-{context}'] +[id="nodes-cluster-overcommit-node-memory-{context}"] = Reserving memory across quality of service tiers diff --git a/modules/nodes-cluster-overcommit-node-resources.adoc b/modules/nodes-cluster-overcommit-node-resources.adoc index 6410f6eaba..cf5ff0f987 100644 --- a/modules/nodes-cluster-overcommit-node-resources.adoc +++ b/modules/nodes-cluster-overcommit-node-resources.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='nodes-cluster-overcommit-node-resources-{context}'] +[id="nodes-cluster-overcommit-node-resources-{context}"] = Reserving resources for system processes diff --git a/modules/nodes-cluster-overcommit-project-disable.adoc b/modules/nodes-cluster-overcommit-project-disable.adoc index 3819599b3c..c6538c3dd3 100644 --- a/modules/nodes-cluster-overcommit-project-disable.adoc +++ b/modules/nodes-cluster-overcommit-project-disable.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='nodes-cluster-overcommit-project-disable-{context}'] +[id="nodes-cluster-overcommit-project-disable-{context}"] = Disabling overcommitment for a project When configured, overcommitment can be disabled per-project. diff --git a/modules/nodes-cluster-overcommit-qos-about.adoc b/modules/nodes-cluster-overcommit-qos-about.adoc index 0715a6f689..2a5fe2b720 100644 --- a/modules/nodes-cluster-overcommit-qos-about.adoc +++ b/modules/nodes-cluster-overcommit-qos-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='nodes-cluster-overcommit-qos-about-{context}'] +[id="nodes-cluster-overcommit-qos-about-{context}"] = Understanding overcomitment and quality of service classes A node is _overcommitted_ when it has a pod scheduled that makes no request, or @@ -51,7 +51,7 @@ exist. - *BestEffort* containers are treated with the lowest priority. Processes in these containers are first to be terminated if the system runs out of memory. -[id='qos-about-reserve-{context}'] +[id="qos-about-reserve-{context}"] == Understanding how to reserve memory across quality of service tiers You can use the `qos-reserved` parameter to specify a percentage of memory to be reserved @@ -73,7 +73,7 @@ will allow a `Burstable` and `BestEffort` QoS classes to consume up to the full allocatable amount if available, but increases the risk that a `Guaranteed` workload will not have access to requested memory. This condition effectively disables this feature. -[id='qos-about-swap-{context}'] +[id="qos-about-swap-{context}"] = Understanding swap memory and QOS You can disable swap by default on your nodes in order to preserve quality of diff --git a/modules/nodes-cluster-overcommit-resource-requests.adoc b/modules/nodes-cluster-overcommit-resource-requests.adoc index 034d923ea3..24f2f3662a 100644 --- a/modules/nodes-cluster-overcommit-resource-requests.adoc +++ b/modules/nodes-cluster-overcommit-resource-requests.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='resource-requests-{context}'] +[id="resource-requests-{context}"] = Understanding resource requests and overcommitment in {product-title} For each compute resource, a container may specify a resource request and limit. @@ -25,7 +25,7 @@ for instance, if a container is given a memory request of 1Gi and a memory limit of 2Gi, it is scheduled based on the 1Gi request being available on the node, but could use up to 2Gi; so it is 200% overcommitted. -[id='understandin-fluentd-buffering-{context}''] +[id="understandin-fluentd-buffering-{context}"] == Understanding Fluentd file buffering If the Fluentd logger is unable to keep up with a high number of logs, it will need diff --git a/modules/nodes-cluster-overcommit-resources-containers.adoc b/modules/nodes-cluster-overcommit-resources-containers.adoc index cbf5c46903..c7b02a799a 100644 --- a/modules/nodes-cluster-overcommit-resources-containers.adoc +++ b/modules/nodes-cluster-overcommit-resources-containers.adoc @@ -2,12 +2,12 @@ // // * nodes/nodes-cluster-overcommit.adoc -[id='nodes-cluster-overcommit-reserving-memory-{context}'] +[id="nodes-cluster-overcommit-reserving-memory-{context}"] = Understanding compute resources and containers The node-enforced behavior for compute resources is specific to the resource type. -[id='understanding-container-CPU-requests-{context}'] +[id="understanding-container-CPU-requests-{context}"] == Understanding container CPU requests A container is guaranteed the amount of CPU it requests and is additionally able @@ -23,7 +23,7 @@ CPU requests are enforced using the CFS shares support in the Linux kernel. By default, CPU limits are enforced using the CFS quota support in the Linux kernel over a 100ms measuring interval, though this can be disabled. -[id='understanding-memory-requests-container-{context}'] +[id="understanding-memory-requests-container-{context}"] == Understanding container memory requests A container is guaranteed the amount of memory it requests. A container can use @@ -34,7 +34,7 @@ system tasks or daemons need more memory than was accounted for in the node's resource reservation. If a container specifies a limit on memory, it is immediately terminated if it exceeds the limit amount. -[id='containers-ephemeral-{context}'] +[id="containers-ephemeral-{context}"] == Understanding containers and ephemeral storage [NOTE] diff --git a/modules/nodes-cluster-resource-configure-about.adoc b/modules/nodes-cluster-resource-configure-about.adoc index 69b486f31e..7046114ea6 100644 --- a/modules/nodes-cluster-resource-configure-about.adoc +++ b/modules/nodes-cluster-resource-configure-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-resource-configure.adoc -[id='nodes-cluster-resource-configure-about-{context}'] +[id="nodes-cluster-resource-configure-about-{context}"] = Understanding managing application memory It is recommended to read fully the overview of how {product-title} manages @@ -44,7 +44,7 @@ Note the following about memory requests and memory limits: - The cluster administrator can assign quota or assign default values for the memory limit value. -[id='nodes-cluster-resource-configure-about-memory-{context}'] +[id="nodes-cluster-resource-configure-about-memory-{context}"] == Managing application memory strategy The steps for sizing application memory on {product-title} are as follows: diff --git a/modules/nodes-cluster-resource-configure-evicted.adoc b/modules/nodes-cluster-resource-configure-evicted.adoc index b20e71b394..079df5e1e8 100644 --- a/modules/nodes-cluster-resource-configure-evicted.adoc +++ b/modules/nodes-cluster-resource-configure-evicted.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-resource-configure.adoc -[id='nodes-cluster-resource-configure-evicted-{context}'] +[id="nodes-cluster-resource-configure-evicted-{context}"] = Understanding pod eviction {product-title} may evict a pod from its node when the node’s memory is diff --git a/modules/nodes-cluster-resource-configure-jdk.adoc b/modules/nodes-cluster-resource-configure-jdk.adoc index 02b3723fe3..b13887540f 100644 --- a/modules/nodes-cluster-resource-configure-jdk.adoc +++ b/modules/nodes-cluster-resource-configure-jdk.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-resource-configure.adoc -[id='nodes-cluster-resource-configure-jdk-{context}'] +[id="nodes-cluster-resource-configure-jdk-{context}"] = Understanding OpenJDK settings for {product-title} The default OpenJDK settings do not work well with containerized @@ -24,7 +24,7 @@ tasks are key: Optimally tuning JVM workloads for running in a container is beyond the scope of this documentation, and may involve setting multiple additional JVM options. -[id='nodes-cluster-resource-configure-jdk-heap-{context}'] +[id="nodes-cluster-resource-configure-jdk-heap-{context}"] == Understanding how to override the JVM maximum heap size For many Java workloads, the JVM heap is the largest single consumer of memory. @@ -47,7 +47,7 @@ This sets `-XX:MaxRAM` to the container memory limit, and the maximum heap size This option involves hard-coding a value, but has the advantage of allowing a safety margin to be calculated. -[id='nodes-cluster-resource-configure-jdk-unused-{context}'] +[id="nodes-cluster-resource-configure-jdk-unused-{context}"] == Understanding how to encourage the JVM to release unused memory to the operating system By default, the OpenJDK does not aggressively return unused memory to the @@ -71,7 +71,7 @@ and at link:https://developers.redhat.com/blog/2017/04/04/openjdk-and-containers/[OpenJDK and Containers]. -[id='nodes-cluster-resource-configure-jdk-proc-{context}'] +[id="nodes-cluster-resource-configure-jdk-proc-{context}"] == Understanding how to ensure all JVM processes within a container are appropriately configured In the case that multiple JVMs run in the same container, it is essential to diff --git a/modules/nodes-cluster-resource-configure-oom.adoc b/modules/nodes-cluster-resource-configure-oom.adoc index c3e97a121d..d78b74a1a3 100644 --- a/modules/nodes-cluster-resource-configure-oom.adoc +++ b/modules/nodes-cluster-resource-configure-oom.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-resource-configure.adoc -[id='nodes-cluster-resource-configure-oom-{context}'] +[id="nodes-cluster-resource-configure-oom-{context}"] = Understanding OOM kill policy in {product-title} {product-title} may kill a process in a container if the total memory usage of diff --git a/modules/nodes-cluster-resource-configure-request-limit.adoc b/modules/nodes-cluster-resource-configure-request-limit.adoc index 7cb0f93add..bd76f4e467 100644 --- a/modules/nodes-cluster-resource-configure-request-limit.adoc +++ b/modules/nodes-cluster-resource-configure-request-limit.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-resource-configure.adoc -[id='nodes-cluster-resource-configure-request-limit-{context}'] +[id="nodes-cluster-resource-configure-request-limit-{context}"] = Finding the memory request and limit from within a pod An application wishing to dynamically discover its memory request and limit from diff --git a/modules/nodes-cluster-resource-levels-about.adoc b/modules/nodes-cluster-resource-levels-about.adoc index c0235ddc0a..08a383fe1e 100644 --- a/modules/nodes-cluster-resource-levels-about.adoc +++ b/modules/nodes-cluster-resource-levels-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-resource-about.adoc -[id='nodes-cluster-resource-levels-about-{context}'] +[id="nodes-cluster-resource-levels-about-{context}"] = Understanding the {product-title} cluster capacity tool The cluster capacity tool simulates a sequence of scheduling decisions to diff --git a/modules/nodes-cluster-resource-levels-command.adoc b/modules/nodes-cluster-resource-levels-command.adoc index 4cb011eff8..14387876d9 100644 --- a/modules/nodes-cluster-resource-levels-command.adoc +++ b/modules/nodes-cluster-resource-levels-command.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-resource-levels.adoc -[id='nodes-cluster-resource-levels-command-{context}'] +[id="nodes-cluster-resource-levels-command-{context}"] = Running the cluster capacity tool on the command line You can run the {product-title} capacity tool from the command line diff --git a/modules/nodes-cluster-resource-levels-job.adoc b/modules/nodes-cluster-resource-levels-job.adoc index 5ea19e84c8..d88a804241 100644 --- a/modules/nodes-cluster-resource-levels-job.adoc +++ b/modules/nodes-cluster-resource-levels-job.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-cluster-resource-levels.adoc -[id='nodes-cluster-resource-levels-job-{context}'] +[id="nodes-cluster-resource-levels-job-{context}"] = Running the cluster capacity tool as a job inside a pod Running the cluster capacity tool as a job inside of a pod has the advantage of diff --git a/modules/nodes-containers-copying-files-about.adoc b/modules/nodes-containers-copying-files-about.adoc index add1ab8cd7..c76f3fdeb5 100644 --- a/modules/nodes-containers-copying-files-about.adoc +++ b/modules/nodes-containers-copying-files-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-copying-files.adoc -[id='nodes-containers-copying-files-about-{context}'] +[id="nodes-containers-copying-files-about-{context}"] = Understanding how to copy files The `oc rsync` command, or remote sync, is a useful tool for copying database archives to and from your pods for backup and restore purposes. diff --git a/modules/nodes-containers-copying-files-procedure.adoc b/modules/nodes-containers-copying-files-procedure.adoc index aedabb7b2f..f1497d4d7c 100644 --- a/modules/nodes-containers-copying-files-procedure.adoc +++ b/modules/nodes-containers-copying-files-procedure.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-copying-files.adoc -[id='nodes-containers-copying-files-procedure-{context}'] +[id="nodes-containers-copying-files-procedure-{context}"] = Copying files to and from containers Support for copying local files to or from a container is built into the CLI. diff --git a/modules/nodes-containers-copying-files-rsync.adoc b/modules/nodes-containers-copying-files-rsync.adoc index 00bba0127f..28e65cd94b 100644 --- a/modules/nodes-containers-copying-files-rsync.adoc +++ b/modules/nodes-containers-copying-files-rsync.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-copying-files.adoc -[id='nodes-containers-copying-files-rsync-{context}'] +[id="nodes-containers-copying-files-rsync-{context}"] = Using advanced Rsync features in {product-title} The `oc rsync` command exposes fewer command line options than standard `rsync`. diff --git a/modules/nodes-containers-downward-api-about.adoc b/modules/nodes-containers-downward-api-about.adoc index 471401f74a..a3ff5c38ad 100644 --- a/modules/nodes-containers-downward-api-about.adoc +++ b/modules/nodes-containers-downward-api-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-projected-volumes-about-{context}'] +[id="nodes-containers-projected-volumes-about-{context}"] = Expose Pod information to Containers using the Downward API The Downward API contains such information as the pod's name, project, and resource values. Containers can consume diff --git a/modules/nodes-containers-downward-api-container-configmaps.adoc b/modules/nodes-containers-downward-api-container-configmaps.adoc index a9b4d32b35..4a9e801623 100644 --- a/modules/nodes-containers-downward-api-container-configmaps.adoc +++ b/modules/nodes-containers-downward-api-container-configmaps.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-configmaps-{context}'] +[id="nodes-containers-downward-api-container-configmaps-{context}"] = Consuming configuration maps using the downward API When creating pods, you can use the downward API to inject configuration map values diff --git a/modules/nodes-containers-downward-api-container-envars.adoc b/modules/nodes-containers-downward-api-container-envars.adoc index 2f5b9b9fe4..8d470ec252 100644 --- a/modules/nodes-containers-downward-api-container-envars.adoc +++ b/modules/nodes-containers-downward-api-container-envars.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-envars-{context}'] +[id="nodes-containers-downward-api-container-envars-{context}"] = Referencing environment variables When creating pods, you can reference the value of a previously defined diff --git a/modules/nodes-containers-downward-api-container-escaping.adoc b/modules/nodes-containers-downward-api-container-escaping.adoc index 056f28242b..0e99111c48 100644 --- a/modules/nodes-containers-downward-api-container-escaping.adoc +++ b/modules/nodes-containers-downward-api-container-escaping.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-escaping-{context}'] +[id="nodes-containers-downward-api-container-escaping-{context}"] = Escaping environment variable references When creating a pod, you can escape an environment variable reference by using diff --git a/modules/nodes-containers-downward-api-container-resources-envars.adoc b/modules/nodes-containers-downward-api-container-resources-envars.adoc index 19ff71803c..3dd3be8029 100644 --- a/modules/nodes-containers-downward-api-container-resources-envars.adoc +++ b/modules/nodes-containers-downward-api-container-resources-envars.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-resources-envars-{context}'] +[id="nodes-containers-downward-api-container-resources-envars-{context}"] = Consuming container resources using environment variables When creating pods, you can use the downward API to inject information about diff --git a/modules/nodes-containers-downward-api-container-resources-plugin.adoc b/modules/nodes-containers-downward-api-container-resources-plugin.adoc index 8ac969c245..1ffacb1a0c 100644 --- a/modules/nodes-containers-downward-api-container-resources-plugin.adoc +++ b/modules/nodes-containers-downward-api-container-resources-plugin.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-resources-plugin-{context}'] +[id="nodes-containers-downward-api-container-resources-plugin-{context}"] = Consuming container resources using a volume plug-in When creating pods, you can use the downward API to inject information about diff --git a/modules/nodes-containers-downward-api-container-resources.adoc b/modules/nodes-containers-downward-api-container-resources.adoc index c5dd746064..97d58c204a 100644 --- a/modules/nodes-containers-downward-api-container-resources.adoc +++ b/modules/nodes-containers-downward-api-container-resources.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-resources-api-{context}'] +[id="nodes-containers-downward-api-container-resources-api-{context}"] = Understanding how to consume container resources using the downward API When creating pods, you can use the downward API to inject information about diff --git a/modules/nodes-containers-downward-api-container-secrets.adoc b/modules/nodes-containers-downward-api-container-secrets.adoc index 32950ac7a7..0d14c1bc1e 100644 --- a/modules/nodes-containers-downward-api-container-secrets.adoc +++ b/modules/nodes-containers-downward-api-container-secrets.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-secrets-{context}'] +[id="nodes-containers-downward-api-container-secrets-{context}"] = Consuming secrets using the downward API When creating pods, you can use the downward API to inject Secrets diff --git a/modules/nodes-containers-downward-api-container-values-envars.adoc b/modules/nodes-containers-downward-api-container-values-envars.adoc index d3e311d4b0..bd7094f414 100644 --- a/modules/nodes-containers-downward-api-container-values-envars.adoc +++ b/modules/nodes-containers-downward-api-container-values-envars.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-values-envars-{context}'] +[id="nodes-containers-downward-api-container-values-envars-{context}"] = Consuming container values using environment variables When using a container's environment variables, use the `*EnvVar*` type's `*valueFrom*` field (of type `*EnvVarSource*`) diff --git a/modules/nodes-containers-downward-api-container-values-plugin.adoc b/modules/nodes-containers-downward-api-container-values-plugin.adoc index f56e35d60d..2200cff2a1 100644 --- a/modules/nodes-containers-downward-api-container-values-plugin.adoc +++ b/modules/nodes-containers-downward-api-container-values-plugin.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-values-plugin-{context}'] +[id="nodes-containers-downward-api-container-values-plugin-{context}"] = Consuming container values using a volume plug-in You containers can consume API values using a volume plug-in. diff --git a/modules/nodes-containers-downward-api-container-values.adoc b/modules/nodes-containers-downward-api-container-values.adoc index 797f520c55..fb0b0d4e59 100644 --- a/modules/nodes-containers-downward-api-container-values.adoc +++ b/modules/nodes-containers-downward-api-container-values.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc -[id='nodes-containers-downward-api-container-values-{context}'] +[id="nodes-containers-downward-api-container-values-{context}"] = Understanding how to consume container values using the downward API You containers can consume API values using environment variables or a volume plug-in. diff --git a/modules/nodes-containers-events-about.adoc b/modules/nodes-containers-events-about.adoc index 0f24db3451..8824703461 100644 --- a/modules/nodes-containers-events-about.adoc +++ b/modules/nodes-containers-events-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-events.adoc -[id='nodes-containers-events-about-{context}'] +[id="nodes-containers-events-about-{context}"] = Understanding events in {product-title} Events allow {product-title} to record @@ -11,7 +11,7 @@ allow developers and administrators to consume information about system components in a unified way. ifdef::openshift-online[] -[id='event-failure-notifications-{context}'] +[id="event-failure-notifications-{context}"] == Failure Notifications For each of your projects, you can choose to receive email notifications diff --git a/modules/nodes-containers-events-list.adoc b/modules/nodes-containers-events-list.adoc index 4101ccae63..7a9a9a6ab4 100644 --- a/modules/nodes-containers-events-list.adoc +++ b/modules/nodes-containers-events-list.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-events.adoc -[id='nodes-containers-events-list-{context}'] +[id="nodes-containers-events-list-{context}"] = List of events This section describes the events of {product-title}. diff --git a/modules/nodes-containers-events-viewing.adoc b/modules/nodes-containers-events-viewing.adoc index e81e5ef3f6..ad17ff77b2 100644 --- a/modules/nodes-containers-events-viewing.adoc +++ b/modules/nodes-containers-events-viewing.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-events.adoc -[id='nodes-containers-events-viewing-cli-{context}'] +[id="nodes-containers-events-viewing-cli-{context}"] = Viewing events using the CLI You can get a list of events in a given project using the CLI. diff --git a/modules/nodes-containers-health-about.adoc b/modules/nodes-containers-health-about.adoc index 5000287e2f..16c2b20dd9 100644 --- a/modules/nodes-containers-health-about.adoc +++ b/modules/nodes-containers-health-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-health.adoc -[id='nodes-containers-health-about-{context}'] +[id="nodes-containers-health-about-{context}"] = Understanding health checks A probe is a Kubernetes action that periodically performs diagnostics on a @@ -16,15 +16,15 @@ container has its IP address removed from the endpoints of all services. A readiness probe can be used to signal to the endpoints controller that even though a container is running, it should not receive any traffic from a proxy. -For example, a Readiness check can control which Pods are used. When a Pod is not ready, +For example, a Readiness check can control which Pods are used. When a Pod is not ready, it is removed. Liveness Probe:: A Liveness checks determines if the container in which it is scheduled is still running. If the liveness probe fails due to a condition such as a deadlock, the kubelet kills the container The container then -responds based on its restart policy. +responds based on its restart policy. -For example, a liveness probe with on a node with a `restartPolicy` of `Always` or `OnFailure` +For example, a liveness probe with on a node with a `restartPolicy` of `Always` or `OnFailure` kills and restarts the Container on the node. .Sample Liveness Check @@ -44,7 +44,7 @@ spec: - /server livenessProbe: <2> httpGet: <3> - # host: my-host + # host: my-host # scheme: HTTPS path: /healthz port: 8080 @@ -62,7 +62,7 @@ spec: * Container Execution Checks. Specify `exec`. * TCP Socket Check. Specify `tcpSocket`. <4> Specifies the number of seconds before performing the first probe after the container starts. -<5> Specifies the number of seconds between probes. +<5> Specifies the number of seconds between probes. .Sample Liveness check output wth unhealthy container @@ -82,21 +82,21 @@ FirstSeen LastSeen Count From SubobjectPath Type ---- -[id='nodes-containers-health-about_types'] +[id="nodes-containers-health-about_types-{context}"] == Understanding the types of health checks Liveness checks and Readiness checks can be configured in three ways: HTTP Checks:: The kubelet uses a web hook to determine the healthiness of the container. The -check is deemed successful if the HTTP response code is between 200 and 399. +check is deemed successful if the HTTP response code is between 200 and 399. A HTTP check is ideal for applications that return HTTP status codes when completely initialized. Container Execution Checks:: The kubelet executes a command inside the container. Exiting the check with -status 0 is considered a success. +status 0 is considered a success. TCP Socket Checks:: The kubelet attempts to open a socket to the container. The container is only diff --git a/modules/nodes-containers-health-configuring.adoc b/modules/nodes-containers-health-configuring.adoc index 3e3d7c604a..e807cc79b5 100644 --- a/modules/nodes-containers-health-configuring.adoc +++ b/modules/nodes-containers-health-configuring.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-health.adoc -[id='nodes-containers-health-configuring-{context}'] +[id="nodes-containers-health-configuring-{context}"] = Configuring health checks To configure health checks, create a pod for each type of check you want. diff --git a/modules/nodes-containers-init-about.adoc b/modules/nodes-containers-init-about.adoc index 04b5871f74..2251ca8508 100644 --- a/modules/nodes-containers-init-about.adoc +++ b/modules/nodes-containers-init-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-init.adoc -[id='nodes-containers-init-about-{context}'] +[id="nodes-containers-init-about-{context}"] = Understanding Init Containers You can use an Init Container resource to perform tasks before the rest of a pod is deployed. diff --git a/modules/nodes-containers-init-creating.adoc b/modules/nodes-containers-init-creating.adoc index 0efc0b353e..f628c27c7b 100644 --- a/modules/nodes-containers-init-creating.adoc +++ b/modules/nodes-containers-init-creating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-init.adoc -[id='nodes-containers-init-creating-{context}'] +[id="nodes-containers-init-creating-{context}"] = Creating Init Containers The following example outlines a simple Pod which has two Init Containers. The first waits for `myservice` and the second waits for `mydb`. Once both containers complete, the Pod begins. diff --git a/modules/nodes-containers-port-forwarding-about.adoc b/modules/nodes-containers-port-forwarding-about.adoc index b08740636e..cccd93cc28 100644 --- a/modules/nodes-containers-port-forwarding-about.adoc +++ b/modules/nodes-containers-port-forwarding-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-port-forwarding.adoc -[id='nodes-containers-port-forwarding-about-{context}'] +[id="nodes-containers-port-forwarding-about-{context}"] = Understanding port forwarding You can use the CLI to forward one or more local ports to a pod. This allows you diff --git a/modules/nodes-containers-port-forwarding-protocol.adoc b/modules/nodes-containers-port-forwarding-protocol.adoc index 8997770182..5373f9cbe6 100644 --- a/modules/nodes-containers-port-forwarding-protocol.adoc +++ b/modules/nodes-containers-port-forwarding-protocol.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-port-forwarding.adoc -[id='nodes-containers-port-forwarding-protocol-{context}'] +[id="nodes-containers-port-forwarding-protocol-{context}"] = Protocol for initiating port forwarding from a client Clients initiate port forwarding to a pod by issuing a request to the diff --git a/modules/nodes-containers-port-forwarding-using.adoc b/modules/nodes-containers-port-forwarding-using.adoc index f08edd858c..3bd9f4a6a1 100644 --- a/modules/nodes-containers-port-forwarding-using.adoc +++ b/modules/nodes-containers-port-forwarding-using.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-port-forwarding.adoc -[id='nodes-containers-port-forwarding-using-{context}'] +[id="nodes-containers-port-forwarding-using-{context}"] = Using port forwarding You can use the CLI to port-forward one or more local ports to a pod. diff --git a/modules/nodes-containers-projected-volumes-about.adoc b/modules/nodes-containers-projected-volumes-about.adoc index b3979384b1..caea2b8cd0 100644 --- a/modules/nodes-containers-projected-volumes-about.adoc +++ b/modules/nodes-containers-projected-volumes-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-projected-volumes.adoc -[id='nodes-containers-projected-volumes-about-{context}'] +[id="nodes-containers-projected-volumes-about-{context}"] = Understanding projected volumes Projected volumes can map any combination of these volume sources into a single directory, allowing the user to: @@ -29,7 +29,7 @@ Projected volumes allow you to generate a config including the pod name (availab Projected volumes allow you to use a secret as a public key to encrypt the namespace of the pod (available via the `metadata.namespace` selector). This example allows the operator to use the application to deliver the namespace information securely without using an encrypted transport. -[id='projected-volumes-examples-{context}'] +[id="projected-volumes-examples-{context}"] == Example Pod Specifications The following are examples of pod specifications for creating projected volumes. @@ -136,7 +136,7 @@ volume source. However, as illustrated above, you can explicitly set the `mode` for each individual projection. ==== -[id='projected-volumes-pathing-{context}'] +[id="projected-volumes-pathing-{context}"] == Pathing Considerations *Collisions Between Keys when Configured Paths are Identical*:: If you configure any keys with the same path, the pod spec will not be accepted as valid. diff --git a/modules/nodes-containers-projected-volumes-creating.adoc b/modules/nodes-containers-projected-volumes-creating.adoc index 4a18ae1c76..8ac6f03e73 100644 --- a/modules/nodes-containers-projected-volumes-creating.adoc +++ b/modules/nodes-containers-projected-volumes-creating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-projected-volumes.adoc -[id='nodes-containers-projected-volumes-creating-{context}'] +[id="nodes-containers-projected-volumes-creating-{context}"] = Configuring a Projected Volume for a Pod When creating projected volumes, consider the volume file path situations described in _Understanding projected vol`umes_. diff --git a/modules/nodes-containers-remote-commands-about.adoc b/modules/nodes-containers-remote-commands-about.adoc index a495125361..2c7eefb399 100644 --- a/modules/nodes-containers-remote-commands-about.adoc +++ b/modules/nodes-containers-remote-commands-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-remote-commands.adoc -[id='nodes-containers-remote-commands-about-{context}'] +[id="nodes-containers-remote-commands-about-{context}"] = Executing remote commands in containers Support for remote container command execution is built into the CLI. diff --git a/modules/nodes-containers-remote-commands-protocol.adoc b/modules/nodes-containers-remote-commands-protocol.adoc index e6a5213a2f..d068af4688 100644 --- a/modules/nodes-containers-remote-commands-protocol.adoc +++ b/modules/nodes-containers-remote-commands-protocol.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-remote-commands.adoc -[id='nodes-containers-remote-commands-protocol-{context}'] +[id="nodes-containers-remote-commands-protocol-{context}"] = Protocol for initiating a remote command from a client Clients initiate the execution of a remote command in a container by issuing a diff --git a/modules/nodes-containers-using-about.adoc b/modules/nodes-containers-using-about.adoc index 1fe0c6bc2b..4d85cd18a6 100644 --- a/modules/nodes-containers-using-about.adoc +++ b/modules/nodes-containers-using-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-using.adoc -[id='nodes-containers-using-about-{context}'] +[id="nodes-containers-using-about-{context}"] = Understanding Containers in {product-title} The basic units of {product-title} applications are called _containers_. diff --git a/modules/nodes-containers-using-ssh.adoc b/modules/nodes-containers-using-ssh.adoc index 389454c7a4..51a9525218 100644 --- a/modules/nodes-containers-using-ssh.adoc +++ b/modules/nodes-containers-using-ssh.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-using.adoc -[id='nodes-containers-using-ssh-{context}'] +[id="nodes-containers-using-ssh-{context}"] = Opening a Remote Shell to Containers The `oc rsh` command allows you to locally access and manage tools that are on diff --git a/modules/nodes-containers-volumes-about.adoc b/modules/nodes-containers-volumes-about.adoc index 7a64036bfa..74b4d84bd0 100644 --- a/modules/nodes-containers-volumes-about.adoc +++ b/modules/nodes-containers-volumes-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-volumes.adoc -[id='nodes-containers-volumes-about-{context}'] +[id="nodes-containers-volumes-about-{context}"] = Understanding volumes Volumes are mounted file systems available to pods and their diff --git a/modules/nodes-containers-volumes-adding.adoc b/modules/nodes-containers-volumes-adding.adoc index 39144221ea..d4a4fe9c0c 100644 --- a/modules/nodes-containers-volumes-adding.adoc +++ b/modules/nodes-containers-volumes-adding.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-volumes.adoc -[id='nodes-containers-volumes-adding-{context}'] +[id="nodes-containers-volumes-adding-{context}"] = Adding volumes to a pod You can add volumes and volume mounts to a pod. diff --git a/modules/nodes-containers-volumes-cli.adoc b/modules/nodes-containers-volumes-cli.adoc index cce173d74d..704f06aa55 100644 --- a/modules/nodes-containers-volumes-cli.adoc +++ b/modules/nodes-containers-volumes-cli.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-volumes.adoc -[id='nodes-containers-volumes-cli-{context}'] +[id="nodes-containers-volumes-cli-{context}"] = Working with volumes using the {product-title} CLI You can use the CLI command `oc set volume` to add and remove volumes and @@ -20,7 +20,7 @@ $ oc set volume Object selection:: Specify one of the following for `object_seletion` in the `oc set volume` command: -[id='vol-object-selection-{context}'] +[id="vol-object-selection-{context}"] .Object Selection [cols="3a*",options="header"] |=== diff --git a/modules/nodes-containers-volumes-listing.adoc b/modules/nodes-containers-volumes-listing.adoc index c1e1a2a849..db04599d1f 100644 --- a/modules/nodes-containers-volumes-listing.adoc +++ b/modules/nodes-containers-volumes-listing.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-volumes.adoc -[id='nodes-containers-volumes-listing-{context}'] +[id="nodes-containers-volumes-listing-{context}"] = Listing volumes and volume mounts in a pod You can list volumes and volume mounts in pods or pod templates: diff --git a/modules/nodes-containers-volumes-removing.adoc b/modules/nodes-containers-volumes-removing.adoc index cf66629afa..59a5cec146 100644 --- a/modules/nodes-containers-volumes-removing.adoc +++ b/modules/nodes-containers-volumes-removing.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-volumes.adoc -[id='nodes-containers-volumes-removing-{context}'] +[id="nodes-containers-volumes-removing-{context}"] = Removing volumes and volume mounts from a pod You can remove a volume or volume mount from a pod. diff --git a/modules/nodes-containers-volumes-subpath.adoc b/modules/nodes-containers-volumes-subpath.adoc index eacdb39533..360aa94988 100644 --- a/modules/nodes-containers-volumes-subpath.adoc +++ b/modules/nodes-containers-volumes-subpath.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-volumes.adoc -[id='nodes-containers-volumes-subpath-{context}'] +[id="nodes-containers-volumes-subpath-{context}"] = Configuring volumes for multiple uses in a pod You can configure a volume to allows you to share one volume for diff --git a/modules/nodes-containers-volumes-updating.adoc b/modules/nodes-containers-volumes-updating.adoc index 5553632e20..8a0eb5d85e 100644 --- a/modules/nodes-containers-volumes-updating.adoc +++ b/modules/nodes-containers-volumes-updating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-containers-volumes.adoc -[id='nodes-containers-volumes-updating-{context}'] +[id="nodes-containers-volumes-updating-{context}"] = Updating volumes and volume mounts in a pod You can modify the volumes and volume mounts in a pod. diff --git a/modules/nodes-nodes-garbage-collection-configuring.adoc b/modules/nodes-nodes-garbage-collection-configuring.adoc index ae87afca5f..945d708b0b 100644 --- a/modules/nodes-nodes-garbage-collection-configuring.adoc +++ b/modules/nodes-nodes-garbage-collection-configuring.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-garbage-collection.adoc -[id='nodes-nodes-garbage-collection-configuring-{context}'] +[id="nodes-nodes-garbage-collection-configuring-{context}"] = Configuring garbage collection for containers and images As an administrator, you can configure how {product-title} performs garbage collection. diff --git a/modules/nodes-nodes-garbage-collection-containers.adoc b/modules/nodes-nodes-garbage-collection-containers.adoc index cc0d7e7bef..064a56b290 100644 --- a/modules/nodes-nodes-garbage-collection-containers.adoc +++ b/modules/nodes-nodes-garbage-collection-containers.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-garbage-collection.adoc -[id='nodes-nodes-garbage-collection-containers-{context}'] +[id="nodes-nodes-garbage-collection-containers-{context}"] = Understanding how terminated containers are removed though garbage collection Container garbage collection is enabled by default and happens automatically in diff --git a/modules/nodes-nodes-garbage-collection-images.adoc b/modules/nodes-nodes-garbage-collection-images.adoc index e23bd212db..e05f80a090 100644 --- a/modules/nodes-nodes-garbage-collection-images.adoc +++ b/modules/nodes-nodes-garbage-collection-images.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-garbage-collection.adoc -[id='nodes-nodes-garbage-collection-images-{context}'] +[id="nodes-nodes-garbage-collection-images-{context}"] = Understanding how images are removed though garbage collection Image garbage collection relies on disk usage as reported by *cAdvisor* on the diff --git a/modules/nodes-nodes-jobs-about.adoc b/modules/nodes-nodes-jobs-about.adoc index eee219ba6f..361982a440 100644 --- a/modules/nodes-nodes-jobs-about.adoc +++ b/modules/nodes-nodes-jobs-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-jobs.adoc -[id='nodes-nodes-jobs-about-{context}'] +[id="nodes-nodes-jobs-about-{context}"] = Understanding jobs and CronJobs in {product-title} A job tracks the overall progress of a task and updates its status with information @@ -44,7 +44,7 @@ two jobs might be created. Therefore, jobs must be idempotent and you must configure history limits. ==== -[id='jobs-create-{context}'] +[id="jobs-create-{context}"] = Understanding how to create jobs Both resource types require a job configuration that consists of the following key parts: @@ -54,7 +54,7 @@ Both resource types require a job configuration that consists of the following k the value in the `completions` parameter. - An optional `completions` parameter, specifying how many successful pod completions are needed to finish a job. If not specified, this value defaults to one. -[id='jobs-set-max-{context}'] +[id="jobs-set-max-{context}"] == Understanding how to set a maximum duration for jobs When defining a job, you can define its maximum duration by setting @@ -65,7 +65,7 @@ The maximum duration is counted from the time when a first pod gets scheduled in the system, and defines how long a job can be active. It tracks overall time of an execution. After reaching the specified timeout, the job is terminated by {product-title}. -[id='jobs-set-backoff-{context}'] +[id="jobs-set-backoff-{context}"] == Understanding how to set a job back off policy for pod failure A Job can be considered failed, after a set amount of retries due to a @@ -75,7 +75,7 @@ limit is reset if no new failed pods appear between controller checks. Use the `spec.backoffLimit` parameter to set the number of retries for a job. -[id='jobs-artifacts-{context}'] +[id="jobs-artifacts-{context}"] == Understanding how to configure a CronJob to remove artifacts CronJobs can leave behind artifact resources such as jobs or pods. As a user it is important @@ -98,7 +98,7 @@ Doing this prevents them from generating unnecessary artifacts. * You can suspend further executions by setting the `spec.suspend` to true. All subsequent executions are suspended until you reset to `false`. ==== -[id='jobs-limits-{context}'] +[id="jobs-limits-{context}"] = Known limitations The job specification restart policy only applies to the _pods_, and not the _job controller_. However, the job controller is hard-coded to keep retrying jobs to completion. diff --git a/modules/nodes-nodes-jobs-creating-cron.adoc b/modules/nodes-nodes-jobs-creating-cron.adoc index e26e3ca5da..0f802d9cc0 100644 --- a/modules/nodes-nodes-jobs-creating-cron.adoc +++ b/modules/nodes-nodes-jobs-creating-cron.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-jobs.adoc -[id='nodes-nodes-jobs-creating-cron-{context}'] +[id="nodes-nodes-jobs-creating-cron-{context}"] = Creating CronJobs You create a CronJob in {product-title} by creating a job object. diff --git a/modules/nodes-nodes-jobs-creating.adoc b/modules/nodes-nodes-jobs-creating.adoc index 277a333b2f..848ca4977e 100644 --- a/modules/nodes-nodes-jobs-creating.adoc +++ b/modules/nodes-nodes-jobs-creating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-jobs.adoc -[id='nodes-nodes-jobs-creating-{context}'] +[id="nodes-nodes-jobs-creating-{context}"] = Creating jobs You create a job in {product-title} by creating a job object. diff --git a/modules/nodes-nodes-managing-about.adoc b/modules/nodes-nodes-managing-about.adoc index 6231fbab17..5e9fafe17a 100644 --- a/modules/nodes-nodes-managing-about.adoc +++ b/modules/nodes-nodes-managing-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-managing.adoc -[id='nodes-nodes-managing-about-{context}'] +[id="nodes-nodes-managing-about-{context}"] = Modifying Nodes To make configuration changes to a cluster, or MachinePool, you need to create a Custom Resource Definition, or KubeletConfig instance. {product-title} uses the Machine Config Controller to watch for changes introduced through the CRD applies the changes to the cluster. diff --git a/modules/nodes-nodes-managing-max-pods-proc.adoc b/modules/nodes-nodes-managing-max-pods-proc.adoc index aca1b52437..b95cb09c5b 100644 --- a/modules/nodes-nodes-managing-max-pods-proc.adoc +++ b/modules/nodes-nodes-managing-max-pods-proc.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-managing-max-pods.adoc -[id='nodes-nodes-managing-max-pods-about-{context}'] +[id="nodes-nodes-managing-max-pods-about-{context}"] = Configuring the maximum number of Pods per Node //// diff --git a/modules/nodes-nodes-opaque-resources-about.adoc b/modules/nodes-nodes-opaque-resources-about.adoc index 99ffa4b29b..75bb7e83fd 100644 --- a/modules/nodes-nodes-opaque-resources-about.adoc +++ b/modules/nodes-nodes-opaque-resources-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-opaque-resources.adoc -[id='nodes-nodes-opaque-resources-about-{context}'] +[id="nodes-nodes-opaque-resources-about-{context}"] = Understanding opaque resources Opaque integer resources are called _opaque_ because {product-title} diff --git a/modules/nodes-nodes-opaque-resources-consuming.adoc b/modules/nodes-nodes-opaque-resources-consuming.adoc index 27798f6099..93c4cb2fc6 100644 --- a/modules/nodes-nodes-opaque-resources-consuming.adoc +++ b/modules/nodes-nodes-opaque-resources-consuming.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-opaque-resources.adoc -[id='nodes-nodes-opaque-resources-consuming-{context}'] +[id="nodes-nodes-opaque-resources-consuming-{context}"] = Consuming Opaque Integer Resources An application developer can consume the opaque resources by editing the pod configuration. diff --git a/modules/nodes-nodes-opaque-resources-creating.adoc b/modules/nodes-nodes-opaque-resources-creating.adoc index b814415388..28329ac4de 100644 --- a/modules/nodes-nodes-opaque-resources-creating.adoc +++ b/modules/nodes-nodes-opaque-resources-creating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-opaque-resources.adoc -[id='nodes-nodes-opaque-resources-creating-{context}'] +[id="nodes-nodes-opaque-resources-creating-{context}"] = Creating Opaque Integer Resources There are two steps required to use opaque integer resources. First, the cluster diff --git a/modules/nodes-nodes-problem-detector-about.adoc b/modules/nodes-nodes-problem-detector-about.adoc index 4e6ad6a6bb..1d047efe94 100644 --- a/modules/nodes-nodes-problem-detector-about.adoc +++ b/modules/nodes-nodes-problem-detector-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-problem-detector.adoc -[id='nodes-nodes-problem-detector-about-{context}'] +[id="nodes-nodes-problem-detector-about-{context}"] = Understanding the {product-title} node problem detector The Node Problem Detector reads system logs and watches for specific entries and makes these problems visible to the control plane, @@ -34,7 +34,7 @@ The Node Problem Detector can detect: * infrastructure daemon issues: ** NTP service outages -[id='nodes-nodes-problem-detector-about-example-{context}'] +[id="nodes-nodes-problem-detector-about-example-{context}"] == Example Node Problem Detector Output The following examples show output from the Node Problem Detector watching for kernel deadlock node condition on a specific node. The command diff --git a/modules/nodes-nodes-problem-detector-customizing.adoc b/modules/nodes-nodes-problem-detector-customizing.adoc index 94149c54a0..704d87afb5 100644 --- a/modules/nodes-nodes-problem-detector-customizing.adoc +++ b/modules/nodes-nodes-problem-detector-customizing.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-problem-detector.adoc -[id='nodes-nodes-problem-detector-customizing-{context}'] +[id="nodes-nodes-problem-detector-customizing-{context}"] = Customizing Node Problem Detector conditions You can configure the Node Problem Detector to watch for any log string by editing the Node Problem Detector custom resource (CR). diff --git a/modules/nodes-nodes-problem-detector-installing.adoc b/modules/nodes-nodes-problem-detector-installing.adoc index 336f3646c1..ec49e20b7e 100644 --- a/modules/nodes-nodes-problem-detector-installing.adoc +++ b/modules/nodes-nodes-problem-detector-installing.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-problem-detector.adoc -[id='nodes-nodes-problem-detector-installing-{context}'] +[id="nodes-nodes-problem-detector-installing-{context}"] = Installing the {product-title} Node Problem Detector You can use the {product-title} console to install the Node Problem Detector Operator. diff --git a/modules/nodes-nodes-problem-detector-uninstalling.adoc b/modules/nodes-nodes-problem-detector-uninstalling.adoc index f7cb65239b..b9349a9702 100644 --- a/modules/nodes-nodes-problem-detector-uninstalling.adoc +++ b/modules/nodes-nodes-problem-detector-uninstalling.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-problem-detector.adoc -[id='nodes-nodes-problem-detector-uninstalling-{context}'] +[id="nodes-nodes-problem-detector-uninstalling-{context}"] = Uninstall the Node Problem Detector You can use the {product-title} console to uninstall the Node Problem Detector. diff --git a/modules/nodes-nodes-problem-detector-verifying.adoc b/modules/nodes-nodes-problem-detector-verifying.adoc index a961cbc3d4..2b97f2b401 100644 --- a/modules/nodes-nodes-problem-detector-verifying.adoc +++ b/modules/nodes-nodes-problem-detector-verifying.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-problem-detector.adoc -[id='nodes-nodes-problem-detector-verifying-{context}'] +[id="nodes-nodes-problem-detector-verifying-{context}"] = Verifying that the Node Problem Detector is Running You can use the steps in this section to verify that the Node Problem Detector is running and generate typical problems to ensure that the Node problem Detector responds properly. diff --git a/modules/nodes-nodes-rebooting-affinity.adoc b/modules/nodes-nodes-rebooting-affinity.adoc index c4e3b4100e..38b38e736c 100644 --- a/modules/nodes-nodes-rebooting-affinity.adoc +++ b/modules/nodes-nodes-rebooting-affinity.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-rebooting.adoc -[id='nodes-nodes-rebooting-affinity-{context}'] +[id="nodes-nodes-rebooting-affinity-{context}"] = Rebooting a node using pod anti-affinity Pod anti-affinity is slightly different than node anti-affinity. Node anti-affinity can be diff --git a/modules/nodes-nodes-rebooting-infrastructure.adoc b/modules/nodes-nodes-rebooting-infrastructure.adoc index 4aeaa35c5d..586a75e8c6 100644 --- a/modules/nodes-nodes-rebooting-infrastructure.adoc +++ b/modules/nodes-nodes-rebooting-infrastructure.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-rebooting.adoc -[id='nodes-nodes-rebooting-infrastructure-{context}'] +[id="nodes-nodes-rebooting-infrastructure-{context}"] = Understanding infrastructire node rebooting in {product-title} Infrastructure nodes are nodes that are labeled to run pieces of the diff --git a/modules/nodes-nodes-rebooting-router.adoc b/modules/nodes-nodes-rebooting-router.adoc index ea3f4bc94f..f79e3c4be3 100644 --- a/modules/nodes-nodes-rebooting-router.adoc +++ b/modules/nodes-nodes-rebooting-router.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-rebooting.adoc -[id='nodes-nodes-rebooting-router-{context}'] +[id="nodes-nodes-rebooting-router-{context}"] = Understanding how to reboot nodes running routers In most cases, a pod running an {product-title} router exposes a host port. diff --git a/modules/nodes-nodes-resources-configuring-about.adoc b/modules/nodes-nodes-resources-configuring-about.adoc index 131d3e1e6f..8a35afb329 100644 --- a/modules/nodes-nodes-resources-configuring-about.adoc +++ b/modules/nodes-nodes-resources-configuring-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-resources-configuring.adoc -[id='nodes-nodes-resources-configuring-about-{context}'] +[id="nodes-nodes-resources-configuring-about-{context}"] = Understanding how to allocate resources for nodes CPU and memory resources reserved for node components in {product-title} are based on two node settings: @@ -23,7 +23,7 @@ If a flag is not set, it defaults to *0*. If none of the flags are set, the allocated resource is set to the node's capacity as it was before the introduction of allocatable resources. -[id='computing-allocated-resources-{context}'] +[id="computing-allocated-resources-{context}"] == How {product-title} computes allocated resources An allocated amount of a resource is computed based on the following formula: @@ -47,7 +47,7 @@ To better aid your ability to configure `*--system-reserved*` and `*--kube-reser you can introspect corresponding node's resource usage using the node summary API, which is accessible at *_/api/v1/nodes//proxy/stats/summary_*. -[id='allocate-node-enforcement-{context}'] +[id="allocate-node-enforcement-{context}"] == How nodes enforce resource constraints The node is able to limit the total amount of resources that pods @@ -81,7 +81,7 @@ As a result, we strongly recommended that users only enforce node allocatable fo `pods` by default, and set aside appropriate reservations for system daemons to maintain overall node reliability. -[id='allocate-eviction-thresholds-{context}'] +[id="allocate-eviction-thresholds-{context}"] == Understanding Eviction Thresholds If a node is under memory pressure, it can impact the entire node and all pods running on @@ -118,7 +118,7 @@ If system daemons do not use up all their reservation, the node will evict pods they consume more than `28.9Gi` of memory. If eviction does not occur in time, a pod will be OOM killed if pods consume `29Gi` of memory. -[id='allocate-scheduler-policy-{context}'] +[id="allocate-scheduler-policy-{context}"] == How the scheduler determines resource availability The scheduler uses the value of `*node.Status.Allocatable*` instead of diff --git a/modules/nodes-nodes-resources-configuring-setting.adoc b/modules/nodes-nodes-resources-configuring-setting.adoc index 4e866d150f..7378c8ecdd 100644 --- a/modules/nodes-nodes-resources-configuring-setting.adoc +++ b/modules/nodes-nodes-resources-configuring-setting.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-resources-configuring.adoc -[id='nodes-nodes-resources-configuring-setting-{context}'] +[id="nodes-nodes-resources-configuring-setting-{context}"] = Configuring allocated resources for nodes {product-title} supports the CPU and memory resource types for allocation. If diff --git a/modules/nodes-nodes-resources-configuring-viewing.adoc b/modules/nodes-nodes-resources-configuring-viewing.adoc index ba4c821ccb..ed72f4a91f 100644 --- a/modules/nodes-nodes-resources-configuring-viewing.adoc +++ b/modules/nodes-nodes-resources-configuring-viewing.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-resources-configuring.adoc -[id='nodes-nodes-resources-configuring-setting-{context}'] +[id="nodes-nodes-resources-configuring-setting-{context}"] = Viewing Node Allocatable Resources and Capacity As an administrator, you can view the current capacity and allocatable resources of a specific node. diff --git a/modules/nodes-nodes-viewing-listing-pods.adoc b/modules/nodes-nodes-viewing-listing-pods.adoc index 20198ee5cd..78ce122bc3 100644 --- a/modules/nodes-nodes-viewing-listing-pods.adoc +++ b/modules/nodes-nodes-viewing-listing-pods.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-viewing.adoc -[id='nodes-nodes-viewing-listing-pods-{context}'] +[id="nodes-nodes-viewing-listing-pods-{context}"] = Listing pods on a node in your cluster You can list all the pods on a specific node. diff --git a/modules/nodes-nodes-viewing-listing.adoc b/modules/nodes-nodes-viewing-listing.adoc index f9195b5d65..432523081d 100644 --- a/modules/nodes-nodes-viewing-listing.adoc +++ b/modules/nodes-nodes-viewing-listing.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-viewing.adoc -[id='nodes-nodes-viewing-listing-{context}'] +[id="nodes-nodes-viewing-listing-{context}"] = About listing all the nodes in a cluster You can get detailed information on the nodes in the cluster. diff --git a/modules/nodes-nodes-viewing-memory.adoc b/modules/nodes-nodes-viewing-memory.adoc index 9288d2d229..f1ceccb94b 100644 --- a/modules/nodes-nodes-viewing-memory.adoc +++ b/modules/nodes-nodes-viewing-memory.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-viewing.adoc -[id='nodes-nodes-viewing-memory-{context}'] +[id="nodes-nodes-viewing-memory-{context}"] = Viewing memory and CPU usage statistics on your nodes You can display usage statistics about nodes, which provide the runtime diff --git a/modules/nodes-nodes-working-adding.adoc b/modules/nodes-nodes-working-adding.adoc index 0f7316d12e..b6182178a1 100644 --- a/modules/nodes-nodes-working-adding.adoc +++ b/modules/nodes-nodes-working-adding.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-working.adoc -[id='nodes-nodes-working-adding-{context}'] +[id="nodes-nodes-working-adding-{context}"] = Adding new nodes to your cluster //// diff --git a/modules/nodes-nodes-working-deleting.adoc b/modules/nodes-nodes-working-deleting.adoc index e7c8aac657..a43032e85f 100644 --- a/modules/nodes-nodes-working-deleting.adoc +++ b/modules/nodes-nodes-working-deleting.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-working.adoc -[id='nodes-nodes-working-deleting-{context}'] +[id="nodes-nodes-working-deleting-{context}"] = Deleting nodes from a cluster When you delete a node using the CLI, the node object is deleted in Kubernetes, diff --git a/modules/nodes-nodes-working-evacuating.adoc b/modules/nodes-nodes-working-evacuating.adoc index b8856a14d2..9dee33d400 100644 --- a/modules/nodes-nodes-working-evacuating.adoc +++ b/modules/nodes-nodes-working-evacuating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-working.adoc -[id='nodes-nodes-working-evacuating-{context}'] +[id="nodes-nodes-working-evacuating-{context}"] = Understanding how to evacuate pods on nodes Evacuating pods allows you to migrate all or selected pods from a given node or diff --git a/modules/nodes-nodes-working-marking.adoc b/modules/nodes-nodes-working-marking.adoc index b8bbdca63d..c8ab62158b 100644 --- a/modules/nodes-nodes-working-marking.adoc +++ b/modules/nodes-nodes-working-marking.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-working.adoc -[id='nodes-nodes-working-marking-{context}'] +[id="nodes-nodes-working-marking-{context}"] = Understanding how to marking nodes as unschedulable or schedulable By default, healthy nodes with a `Ready` status are diff --git a/modules/nodes-nodes-working-updating.adoc b/modules/nodes-nodes-working-updating.adoc index 7f82204476..43c8812f64 100644 --- a/modules/nodes-nodes-working-updating.adoc +++ b/modules/nodes-nodes-working-updating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-nodes-working.adoc -[id='nodes-nodes-working-updating-{context}'] +[id="nodes-nodes-working-updating-{context}"] = Understanding how to update labels on nodes You can update any label on a node. diff --git a/modules/nodes-pods-about.adoc b/modules/nodes-pods-about.adoc index 4947a9b669..25fe0bc84a 100644 --- a/modules/nodes-pods-about.adoc +++ b/modules/nodes-pods-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-using.adoc -[id='nodes-pods-about-{context}'] +[id="nodes-pods-about-{context}"] = About pods in {product-title} {product-title} leverages the Kubernetes concept of a _pod_, which is one or more containers deployed diff --git a/modules/nodes-pods-configuring-bandwidth.adoc b/modules/nodes-pods-configuring-bandwidth.adoc index 7b945404b9..49a33efd11 100644 --- a/modules/nodes-pods-configuring-bandwidth.adoc +++ b/modules/nodes-pods-configuring-bandwidth.adoc @@ -3,7 +3,7 @@ // * nodes/nodes-pods-configuring.adoc // * nodes/nodes-cluster-pods-configuring -[id='nodes-pods-configuring-bandwidth-{context}'] +[id="nodes-pods-configuring-bandwidth-{context}"] = Limiting the bandwidth available to pods You can apply quality-of-service traffic shaping to a pod and effectively limit diff --git a/modules/nodes-pods-configuring-pod-critical.adoc b/modules/nodes-pods-configuring-pod-critical.adoc index 8c2ffab03b..8acb05f66f 100644 --- a/modules/nodes-pods-configuring-pod-critical.adoc +++ b/modules/nodes-pods-configuring-pod-critical.adoc @@ -3,7 +3,7 @@ // * nodes/nodes-pods-configuring.adoc // * nodes/nodes-cluster-pods-configuring -[id='nodes-pods-configuring-critical-{context}'] +[id="nodes-pods-configuring-critical-{context}"] = Preventing pod removal using critical pods There are a number of core components that are critical to a fully functional cluster, diff --git a/modules/nodes-pods-configuring-restart.adoc b/modules/nodes-pods-configuring-restart.adoc index 8a7740a009..5badf05b6f 100644 --- a/modules/nodes-pods-configuring-restart.adoc +++ b/modules/nodes-pods-configuring-restart.adoc @@ -3,7 +3,7 @@ // * nodes/nodes-pods-configuring.adoc // * nodes/nodes-cluster-pods-configuring -[id='nodes-pods-configuring-restart-{context}'] +[id="nodes-pods-configuring-restart-{context}"] = Configuring how pods behave after restart A pod restart policy determines how {product-title} responds when Containers in that pod exit. diff --git a/modules/nodes-pods-configuring-run-once.adoc b/modules/nodes-pods-configuring-run-once.adoc index f67c436fdc..a67487d355 100644 --- a/modules/nodes-pods-configuring-run-once.adoc +++ b/modules/nodes-pods-configuring-run-once.adoc @@ -3,7 +3,7 @@ // * nodes/nodes-pods-configuring.adoc // * nodes/nodes-cluster-pods-configuring -[id='nodes-pods-configuring-run-once-{context}'] +[id="nodes-pods-configuring-run-once-{context}"] = Limiting the duration of run-once pods {product-title} relies on run-once pods to perform tasks such as deploying a pod diff --git a/modules/nodes-pods-daemonsets-creating.adoc b/modules/nodes-pods-daemonsets-creating.adoc index 14a7b3ed1a..df24bead90 100644 --- a/modules/nodes-pods-daemonsets-creating.adoc +++ b/modules/nodes-pods-daemonsets-creating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-daemonsets.adoc -[id='nodes-pods-daemonsets-creating-{context}'] +[id="nodes-pods-daemonsets-creating-{context}"] = Creating daemonsets When creating daemonsets, the `*nodeSelector*` field is used to indicate the diff --git a/modules/nodes-pods-disabling-features-about.adoc b/modules/nodes-pods-disabling-features-about.adoc index b1905604cd..0811d0e7bd 100644 --- a/modules/nodes-pods-disabling-features-about.adoc +++ b/modules/nodes-pods-disabling-features-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-disabling-features.adoc -[id='nodes-pods-disabling-features-about-{context}'] +[id="nodes-pods-disabling-features-about-{context}"] = Understanding how to disable features As an administrator, you can turn off new features for production clusters while leaving the features on for test clusters where you can diff --git a/modules/nodes-pods-disabling-features-cluster.adoc b/modules/nodes-pods-disabling-features-cluster.adoc index 60dab1c2e8..b20aa0001c 100644 --- a/modules/nodes-pods-disabling-features-cluster.adoc +++ b/modules/nodes-pods-disabling-features-cluster.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-disabling-features.adoc -[id='nodes-pods-disabling-features-cluster-{context}'] +[id="nodes-pods-disabling-features-cluster-{context}"] = Disabling features for a cluster You can turn off a feature for all nodes in the cluster. diff --git a/modules/nodes-pods-disabling-features-list.adoc b/modules/nodes-pods-disabling-features-list.adoc index 90861565ed..86917937b4 100644 --- a/modules/nodes-pods-disabling-features-list.adoc +++ b/modules/nodes-pods-disabling-features-list.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-disabling-features.adoc -[id='nodes-pods-disabling-features-list-{context}'] +[id="nodes-pods-disabling-features-list-{context}"] = List of feature gates Use the following list to determine the name of the feature you want to disable: diff --git a/modules/nodes-pods-plugins-about.adoc b/modules/nodes-pods-plugins-about.adoc index 213350e9b9..90132aa999 100644 --- a/modules/nodes-pods-plugins-about.adoc +++ b/modules/nodes-pods-plugins-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-plugin.adoc -[id='nodes-pods-plugins-about-{context}'] +[id="nodes-pods-plugins-about-{context}"] = Understanding device plug-ins The device plug-in provides a consistent and portable solution to consume hardware diff --git a/modules/nodes-pods-plugins-device-mgr.adoc b/modules/nodes-pods-plugins-device-mgr.adoc index 6af3041015..7f06541ea8 100644 --- a/modules/nodes-pods-plugins-device-mgr.adoc +++ b/modules/nodes-pods-plugins-device-mgr.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-plugins.adoc -[id='nodes-pods-plugins-device-mgr-{context}'] +[id="nodes-pods-plugins-device-mgr-{context}"] = Understanding the Device Manager Device Manager provides a mechanism for advertising specialized node hardware resources diff --git a/modules/nodes-pods-plugins-install.adoc b/modules/nodes-pods-plugins-install.adoc index c534ddf4b7..59f885df4e 100644 --- a/modules/nodes-pods-plugins-install.adoc +++ b/modules/nodes-pods-plugins-install.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-plugins.adoc -[id='nodes-pods-plugins-install-{context}'] +[id="nodes-pods-plugins-install-{context}"] = Enabling Device Manager Enable Device Manager to implement a device plug-in to advertise specialized diff --git a/modules/nodes-pods-pod-disruption-about.adoc b/modules/nodes-pods-pod-disruption-about.adoc index 5a1f586eae..cc50879b0b 100644 --- a/modules/nodes-pods-pod-disruption-about.adoc +++ b/modules/nodes-pods-pod-disruption-about.adoc @@ -3,7 +3,7 @@ // * nodes/nodes-pods-configuring.adoc // * nodes/nodes-cluster-pods-configuring -[id='nodes-pods-configuring-pod-distruption-about-{context}'] +[id="nodes-pods-configuring-pod-distruption-about-{context}"] = Understanding how to use pod disruption budgets to specify the number of pods that must be up A _pod disruption budget_ is part of the diff --git a/modules/nodes-pods-pod-disruption-configuring.adoc b/modules/nodes-pods-pod-disruption-configuring.adoc index 2bbb55b0d2..c47efa9d53 100644 --- a/modules/nodes-pods-pod-disruption-configuring.adoc +++ b/modules/nodes-pods-pod-disruption-configuring.adoc @@ -3,7 +3,7 @@ // * nodes/nodes-pods-configuring.adoc // * nodes/nodes-cluster-pods-configuring -[id='nodes-pods-configuring-pod-distruption-configuring-{context}'] +[id="nodes-pods-configuring-pod-distruption-configuring-{context}"] = Specifying the number of pods that must be up with pod disruption budgets You can use a `PodDisruptionBudget` object to specify the minimum number or diff --git a/modules/nodes-pods-priority-about.adoc b/modules/nodes-pods-priority-about.adoc index 8f9cf68486..5f68e400c7 100644 --- a/modules/nodes-pods-priority-about.adoc +++ b/modules/nodes-pods-priority-about.adoc @@ -2,12 +2,12 @@ // // * nodes/nodes-pods-priority.adoc -[id='nodes-pods-priority-about-{context}'] +[id="nodes-pods-priority-about-{context}"] = Understanding pod priority in {product-title} When the Pod Priority and Preemption feature is enabled, the scheduler orders pending pods by their priority, and a pending pod is placed ahead of other pending pods with lower priority in the scheduling queue. As a result, the higher priority pod might be scheduled sooner than pods with lower priority if its scheduling requirements are met. If a pod cannot be scheduled, scheduler continues to schedule other lower priority pods. -[id='admin-guide-priority-preemption-priority-class-{context}'] +[id="admin-guide-priority-preemption-priority-class-{context}"] == Pod priority classes You can assign pods a priority class, which is a non-namespaced object that defines a mapping from a name to the integer value of the priority. The higher the value, the higher the priority. @@ -37,7 +37,7 @@ the `scheduler.alpha.kubernetes.io/critical-pod` annotation are automatically co Fluentd cluster logging pods with the annotation are converted to the `cluster-logging` priority class. ==== -[id='admin-guide-priority-preemption-names-{context}'] +[id="admin-guide-priority-preemption-names-{context}"] == Pod priority names After you have one or more priority classes, you can create pods that specify a priority class name in a pod specification. The priority admission controller uses the priority class name field to populate the integer value of the priority. If the named priority class is not found, the pod is rejected. diff --git a/modules/nodes-pods-priority-configuring.adoc b/modules/nodes-pods-priority-configuring.adoc index f84dbf0d82..38c0d81d25 100644 --- a/modules/nodes-pods-priority-configuring.adoc +++ b/modules/nodes-pods-priority-configuring.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-priority.adoc -[id='nodes-pods-priority-configuring-{context}'] +[id="nodes-pods-priority-configuring-{context}"] = Configuring priority and preemption You apply pod priority and preemption by creating a priority class objects and associating pods to the priority using the diff --git a/modules/nodes-pods-priority-disabling.adoc b/modules/nodes-pods-priority-disabling.adoc index 7c2c00e422..017766a7b0 100644 --- a/modules/nodes-pods-priority-disabling.adoc +++ b/modules/nodes-pods-priority-disabling.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-priority.adoc -[id='nodes-pods-priority-disabling-{context}'] +[id="nodes-pods-priority-disabling-{context}"] = Disabling priority and preemption You can disable the pod priority and preemption feature. diff --git a/modules/nodes-pods-priority-examples.adoc b/modules/nodes-pods-priority-examples.adoc index 74e93d0898..def6368c1d 100644 --- a/modules/nodes-pods-priority-examples.adoc +++ b/modules/nodes-pods-priority-examples.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-priority.adoc -[id='nodes-pods-priority-examples-{context}'] +[id="nodes-pods-priority-examples-{context}"] = Pod priority example scenarios Pod priority and preemption assigns a priority to pods for scheduling. The scheduler will preempt (evict) lower-priority pods in order to schedule higher-priority pods. diff --git a/modules/nodes-pods-priority-preempt-about.adoc b/modules/nodes-pods-priority-preempt-about.adoc index 0e16d008c5..608b87b313 100644 --- a/modules/nodes-pods-priority-preempt-about.adoc +++ b/modules/nodes-pods-priority-preempt-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-priority.adoc -[id='nodes-pods-priority-preempt-about-{context}'] +[id="nodes-pods-priority-preempt-about-{context}"] = Understanding pod preemption in {product-title} When a developer creates a pod, the pod goes into a queue. When the Pod Priority and Preemption feature is enabled, the scheduler picks a pod from the queue and tries to schedule the pod on a node. If the scheduler cannot find space on an appropriate node that satisfies all the specified requirements of the pod, preemption logic is triggered for the pending pod. @@ -17,7 +17,7 @@ Preemption does not necessarily remove all lower-priority pods from a node. The The scheduler considers a node for pod preemption only if the pending pod can be scheduled on the node. -[id='priority-preemption-other-{context}'] +[id="priority-preemption-other-{context}"] == Pod preemption and other scheduler settings If you enable pod priority and preemption, consider your other scheduler settings: @@ -38,7 +38,7 @@ Pod priority and cross-node preemption:: If the scheduler is considering preempting pods on a node so that a pending pod can be scheduled, the scheduler can preempt a pod on different node in order to schedule the pending pod. //// -[id='priority-preemption-graceful-{context}'] +[id="priority-preemption-graceful-{context}"] == Graceful termination of preempted pods When preempting a pod, the scheduler waits for the pod graceful termination period to expire, allowing the pod to finish working and exit. If the pod does not exit after the period, the scheduler kills the pod. This graceful termination period creates a time gap between the point that the scheduler preempts the pod and the time when the pending pod can be scheduled on the node. diff --git a/modules/nodes-pods-secrets-about.adoc b/modules/nodes-pods-secrets-about.adoc index ca6c3a21c1..036409623b 100644 --- a/modules/nodes-pods-secrets-about.adoc +++ b/modules/nodes-pods-secrets-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-secrets.adoc -[id='nodes-pods-secrets-about-{context}'] +[id="nodes-pods-secrets-about-{context}"] = Understanding secrets The `Secret` object type provides a mechanism to hold sensitive information such @@ -55,7 +55,7 @@ When creating secrets: (using a `secret` volume). -[id='nodes-pods-secrets-about-types-{context}'] +[id="nodes-pods-secrets-about-types-{context}"] == Types of secrets The value in the `type` field indicates the structure of the secret's key names and values. The type can be used to @@ -80,7 +80,7 @@ but indicate that the creator of the secret intended to conform to the key/value For examples of differet secret types, see the code samples in _Using Secrets_. -[id='nodes-pods-secrets-about-examples-{context}'] +[id="nodes-pods-secrets-about-examples-{context}"] == Example secret configurations The following are sample secret configuration files. @@ -173,7 +173,7 @@ spec: key: username ---- -[id='nodes-pods-secrets-about-keys-{context}'] +[id="nodes-pods-secrets-about-keys-{context}"] == Secret data keys Secret keys must be in a DNS subdomain. diff --git a/modules/nodes-pods-secrets-certificates-about.adoc b/modules/nodes-pods-secrets-certificates-about.adoc index feac3d8e98..dad1926996 100644 --- a/modules/nodes-pods-secrets-certificates-about.adoc +++ b/modules/nodes-pods-secrets-certificates-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-secrets.adoc -[id='nodes-pods-secrets-certificates-about-{context}'] +[id="nodes-pods-secrets-certificates-about-{context}"] = About using signed certificates with secrets To secure communication to your service, you can configure {product-title} to generate a signed diff --git a/modules/nodes-pods-secrets-certificates-creating.adoc b/modules/nodes-pods-secrets-certificates-creating.adoc index aac399898b..2ffd3b744a 100644 --- a/modules/nodes-pods-secrets-certificates-creating.adoc +++ b/modules/nodes-pods-secrets-certificates-creating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-secrets.adoc -[id='nodes-pods-secrets-certificates-creating-{context}'] +[id="nodes-pods-secrets-certificates-creating-{context}"] = Generating signed certificates for use with secrets To use a signed serving certificate/key pair with a pod, create or edit the service to add diff --git a/modules/nodes-pods-secrets-creating-opaque.adoc b/modules/nodes-pods-secrets-creating-opaque.adoc index cd067e0e0b..0054d0c6e4 100644 --- a/modules/nodes-pods-secrets-creating-opaque.adoc +++ b/modules/nodes-pods-secrets-creating-opaque.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-secrets.adoc -[id='nodes-pods-secrets-creating-opaque-{context}'] +[id="nodes-pods-secrets-creating-opaque-{context}"] = Creating an opaque secret As an administrator, you can create a opaque secret, which allows for unstructured `key:value` pairs that can contain arbitrary values. diff --git a/modules/nodes-pods-secrets-creating.adoc b/modules/nodes-pods-secrets-creating.adoc index c26926edca..13162deaed 100644 --- a/modules/nodes-pods-secrets-creating.adoc +++ b/modules/nodes-pods-secrets-creating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-secrets.adoc -[id='nodes-pods-secrets-creating-{context}'] +[id="nodes-pods-secrets-creating-{context}"] = Understanding how to create secrets As an administrator you must create a secret before developers can create the pods that depend on that secret. diff --git a/modules/nodes-pods-secrets-troubleshooting.adoc b/modules/nodes-pods-secrets-troubleshooting.adoc index 792d1a6efb..3989e79c9b 100644 --- a/modules/nodes-pods-secrets-troubleshooting.adoc +++ b/modules/nodes-pods-secrets-troubleshooting.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-secrets.adoc -[id='nodes-pods-secrets-troubleshooting-{context}'] +[id="nodes-pods-secrets-troubleshooting-{context}"] = Troubleshooting secrets If a service certificate generation fails with (service's diff --git a/modules/nodes-pods-secrets-updating.adoc b/modules/nodes-pods-secrets-updating.adoc index 8f58ff9daf..36de2d15fc 100644 --- a/modules/nodes-pods-secrets-updating.adoc +++ b/modules/nodes-pods-secrets-updating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-secrets.adoc -[id='nodes-pods-secrets-updating-{context}'] +[id="nodes-pods-secrets-updating-{context}"] = Understanding how to update secrets When you modify the value of a secret, the value (used by an already running diff --git a/modules/nodes-pods-using-about.adoc b/modules/nodes-pods-using-about.adoc index 2dd8888644..83bdd924f3 100644 --- a/modules/nodes-pods-using-about.adoc +++ b/modules/nodes-pods-using-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-using.adoc -[id='nodes-pods-using-about-{context}'] +[id="nodes-pods-using-about-{context}"] = Understanding pods in {product-title} Pods are the rough equivalent of a machine instance (physical or virtual) to a Container. Each pod is allocated its own internal IP address, therefore owning its entire port space, and Containers within pods can share their local storage and networking. diff --git a/modules/nodes-pods-using-example.adoc b/modules/nodes-pods-using-example.adoc index 2861fa8eb4..8bd3def840 100644 --- a/modules/nodes-pods-using-example.adoc +++ b/modules/nodes-pods-using-example.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-using.adoc -[id='nodes-pods-using-example-{context}'] +[id="nodes-pods-using-example-{context}"] = Example pod configurations in {product-title} {product-title} leverages the Kubernetes concept of a _pod_, which is one or more Containers deployed @@ -14,7 +14,7 @@ service, which is actually a part of the {product-title} infrastructure: the integrated Container image registry. It demonstrates many features of pods, most of which are discussed in other topics and thus only briefly mentioned here: -[id='example-pod-definition-{context}'] +[id="example-pod-definition-{context}"] .Pod Object Definition (YAML) [source,yaml] diff --git a/modules/nodes-pods-viewing-project.adoc b/modules/nodes-pods-viewing-project.adoc index b6365066a1..542f2145e2 100644 --- a/modules/nodes-pods-viewing-project.adoc +++ b/modules/nodes-pods-viewing-project.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-viewing.adoc -[id='nodes-pods-viewing-project-{context}'] +[id="nodes-pods-viewing-project-{context}"] = Viewing pods in a project You can view a list of pods associated with the current project, including the number of replica, the current status, number or restarts and the age of the pod. diff --git a/modules/nodes-pods-viewing-usage.adoc b/modules/nodes-pods-viewing-usage.adoc index f3b5bc3c37..ad05ef00eb 100644 --- a/modules/nodes-pods-viewing-usage.adoc +++ b/modules/nodes-pods-viewing-usage.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-pods-viewing.adoc -[id='nodes-pods-viewing-usage-{context}'] +[id="nodes-pods-viewing-usage-{context}"] = Viewing pod usage statistics You can display usage statistics about pods, which provide the runtime diff --git a/modules/nodes-scheduler-default-about.adoc b/modules/nodes-scheduler-default-about.adoc index a5091d414a..d87b68d6f4 100644 --- a/modules/nodes-scheduler-default-about.adoc +++ b/modules/nodes-scheduler-default-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-default.adoc -[id='nodes-scheduler-default-about-{context}'] +[id="nodes-scheduler-default-about-{context}"] = Understanding default scheduling in {product-title} The existing generic scheduler is the default platform-provided scheduler @@ -29,7 +29,7 @@ The nodes are sorted based on their scores and the node with the highest score is selected to host the pod. If multiple nodes have the same high score, then one of them is selected at random. -[id='nodes-scheduler-default-about-understanding-{context}'] +[id="nodes-scheduler-default-about-understanding-{context}"] == Understanding Scheduler Policy The selection of the predicate and priorities defines the policy for the scheduler. @@ -140,14 +140,14 @@ you must explicitly specify the functions in the policy configuration. } ---- -[id='nodes-scheduler-default-about-use-cases-{context}'] +[id="nodes-scheduler-default-about-use-cases-{context}"] == Scheduler Use Cases One of the important use cases for scheduling within {product-title} is to support flexible affinity and anti-affinity policies. ifdef::openshift-enterprise,openshift-origin[] -[id='infrastructure-topological-levels-{context}'] +[id="infrastructure-topological-levels-{context}"] === Infrastructure Topological Levels Administrators can define multiple topological levels for their infrastructure @@ -161,7 +161,7 @@ for their infrastructure topology, with three levels usually being adequate and anti-affinity rules at each of these levels in any combination. endif::openshift-enterprise,openshift-origin[] -[id='affinity-{context}'] +[id="affinity-{context}"] === Affinity Administrators should be able to configure the scheduler to specify affinity at @@ -179,7 +179,7 @@ These advanced scheduling features allow administrators to specify which node a pod can be scheduled on and to force or reject scheduling relative to other pods. -[id='anti-affinity-{context}'] +[id="anti-affinity-{context}"] === Anti-Affinity Administrators should be able to configure the scheduler to specify diff --git a/modules/nodes-scheduler-default-modifying.adoc b/modules/nodes-scheduler-default-modifying.adoc index 6dc042a47c..bd939d6e25 100644 --- a/modules/nodes-scheduler-default-modifying.adoc +++ b/modules/nodes-scheduler-default-modifying.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-default.adoc -[id='nodes-scheduler-default-modifying-{context}'] +[id="nodes-scheduler-default-modifying-{context}"] = Modifying scheduler policies //Made changes to this file to match https://github.com/openshift/openshift-docs/pull/13626/files#diff-ba6ab177a3e2867eaefe07f48bd6e158 diff --git a/modules/nodes-scheduler-default-predicates.adoc b/modules/nodes-scheduler-default-predicates.adoc index 1645390dc4..75db2e29f7 100644 --- a/modules/nodes-scheduler-default-predicates.adoc +++ b/modules/nodes-scheduler-default-predicates.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-default.adoc -[id='nodes-scheduler-default-predicates-{context}'] +[id="nodes-scheduler-default-predicates-{context}"] = Understanding the scheduler predicates Predicates are rules that filter out unqualified nodes. @@ -11,13 +11,13 @@ There are several predicates provided by default in {product-title}. Some of these predicates can be customized by providing certain parameters. Multiple predicates can be combined to provide additional filtering of nodes. -[id='static-predicates-{context}'] +[id="static-predicates-{context}"] == Static Predicates These predicates do not take any configuration parameters or inputs from the user. These are specified in the scheduler configuration using their exact name. -[id='default-predicates-{context}'] +[id="default-predicates-{context}"] === Default Predicates The default scheduler policy includes the following predicates: @@ -58,7 +58,7 @@ are available in the zone. {"name" : "CheckNodeMemoryPressure"} ---- -[id='other-predicates-{context}'] +[id="other-predicates-{context}"] === Other Static Predicates {product-title} also supports the following predicates: @@ -105,7 +105,7 @@ The `CheckVolumeBinding` predicate must be enabled in non-default schedulers. {"name" : "MaxAzureDiskVolumeCount"} ---- -[id='admin-guide-scheduler-general-predicates-{context}'] +[id="admin-guide-scheduler-general-predicates-{context}"] == General Predicates The following general predicates check whether non-critical predicates and essential predicates pass. Non-critical predicates are the predicates @@ -145,7 +145,7 @@ defined in the pod. {"name" : "MatchNodeSelector"} ---- -[id='configurable-predicates-{context}'] +[id="configurable-predicates-{context}"] == Configurable Predicates // per sjenning Nope diff --git a/modules/nodes-scheduler-default-priorities.adoc b/modules/nodes-scheduler-default-priorities.adoc index 3085cbeefb..f8c2755e4b 100644 --- a/modules/nodes-scheduler-default-priorities.adoc +++ b/modules/nodes-scheduler-default-priorities.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-default.adoc -[id='nodes-scheduler-default-priorities-{context}'] +[id="nodes-scheduler-default-priorities-{context}"] = Understanding the scheduler priorities Priorities are rules that rank nodes according to preferences. @@ -13,7 +13,7 @@ Other priorities can be customized by providing certain parameters. Multiple priorities can be combined and different weights can be given to each in order to impact the prioritization. -[id='static-priority-functions-{context}'] +[id="static-priority-functions-{context}"] == Static Priorities Static priorities do not take any configuration parameters from @@ -22,7 +22,7 @@ the user, except weight. A weight is required to be specified and cannot be 0 or These are specified in the scheduler policy Configmap, `policy-configmap` in the `openshift-config` project. -[id='default-priorities-{context}'] +[id="default-priorities-{context}"] === Default Priorities The default scheduler policy includes the following priorities. Each of @@ -74,7 +74,7 @@ each other. This should always be used together with `LeastRequestedPriority`. {"name" : "TaintTolerationPriority", "weight" : 1} ---- -[id='other-priorities-{context}'] +[id="other-priorities-{context}"] === Other Static Priorities {product-title} also supports the following priorities: @@ -104,7 +104,7 @@ belonging to the same service onto the same machine. {"name" : "ServiceSpreadingPriority", "weight" : 1} ---- -[id='configurable-priority-functions-{context}'] +[id="configurable-priority-functions-{context}"] == Configurable Priorities You can configure these priorities in the scheduler policy Configmap, diff --git a/modules/nodes-scheduler-default-sample.adoc b/modules/nodes-scheduler-default-sample.adoc index 814fdde943..7839dfc3f9 100644 --- a/modules/nodes-scheduler-default-sample.adoc +++ b/modules/nodes-scheduler-default-sample.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-default.adoc -[id='nodes-scheduler-default-sample-{context}'] +[id="nodes-scheduler-default-sample-{context}"] = Sample Policy Configurations The configuration below specifies the default scheduler configuration, if it diff --git a/modules/nodes-scheduler-descheduler-about.adoc b/modules/nodes-scheduler-descheduler-about.adoc index 9a2f1b1175..73b744aa22 100644 --- a/modules/nodes-scheduler-descheduler-about.adoc +++ b/modules/nodes-scheduler-descheduler-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-descheduler.adoc -[id='nodes-scheduler-descheduling-about-{context}'] +[id="nodes-scheduler-descheduling-about-{context}"] = Understanding how to evict pods with the descheduler Because {product-title} clusters are highly dynamic and their state changes over time diff --git a/modules/nodes-scheduler-descheduler-create-role.adoc b/modules/nodes-scheduler-descheduler-create-role.adoc index ba4cbb6088..d62ec8a5f1 100644 --- a/modules/nodes-scheduler-descheduler-create-role.adoc +++ b/modules/nodes-scheduler-descheduler-create-role.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-descheduler.adoc -[id='nodes-scheduler-descheduler-create-role-{context}'] +[id="nodes-scheduler-descheduler-create-role-{context}"] = Creating a cluster role for descheduling in {product-title} In order for the Descheduler Operator to remove pods from nodes and replace them on other nodes, you first need a specific cluster role diff --git a/modules/nodes-scheduler-descheduler-installing.adoc b/modules/nodes-scheduler-descheduler-installing.adoc index adfebe2fcd..2355a029ab 100644 --- a/modules/nodes-scheduler-descheduler-installing.adoc +++ b/modules/nodes-scheduler-descheduler-installing.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-descheduler.adoc -[id='nodes-scheduler-descheduler-install-{context}'] +[id="nodes-scheduler-descheduler-install-{context}"] = Installing the Descheduler Operator You can use the {product-title} web console to install the Descheduler Operator. diff --git a/modules/nodes-scheduler-descheduler-modifying.adoc b/modules/nodes-scheduler-descheduler-modifying.adoc index c0af62f4f2..15b8408938 100644 --- a/modules/nodes-scheduler-descheduler-modifying.adoc +++ b/modules/nodes-scheduler-descheduler-modifying.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-descheduler.adoc -[id='nodes-scheduler-descheduler-m-{context}'] +[id="nodes-scheduler-descheduler-m-{context}"] = Modifying the Descheduler policy You can change the descheduler policy by editing the descheduler custom resource (CR). diff --git a/modules/nodes-scheduler-descheduler-policy.adoc b/modules/nodes-scheduler-descheduler-policy.adoc index a4b6fb4c0a..ecbb04ee9b 100644 --- a/modules/nodes-scheduler-descheduler-policy.adoc +++ b/modules/nodes-scheduler-descheduler-policy.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-descheduler.adoc -[id='nodes-scheduler-descheduling-policy-{context}'] +[id="nodes-scheduler-descheduling-policy-{context}"] = Understanding descheduler policies The Descheduler Operator creates a descheduler custom resource which you can use to specify the descheduling policy to implement. diff --git a/modules/nodes-scheduler-descheduler-running.adoc b/modules/nodes-scheduler-descheduler-running.adoc index e10fec6651..da7f0e33b8 100644 --- a/modules/nodes-scheduler-descheduler-running.adoc +++ b/modules/nodes-scheduler-descheduler-running.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-descheduler.adoc -[id='nodes-scheduler-descheduler-running-{context}'] +[id="nodes-scheduler-descheduler-running-{context}"] = Running the Descheduler After you have created all of the components required for the descheduler, create the job object to run the descheduler. diff --git a/modules/nodes-scheduler-node-affinity-about.adoc b/modules/nodes-scheduler-node-affinity-about.adoc index 847abe3c48..b846c49db2 100644 --- a/modules/nodes-scheduler-node-affinity-about.adoc +++ b/modules/nodes-scheduler-node-affinity-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-node-affinity.adoc -[id='nodes-scheduler-node-affinity-about-{context}'] +[id="nodes-scheduler-node-affinity-about-{context}"] = Understanding node affinity Node affinity allows a pod to specify an affinity towards a group of nodes it can be placed on. The node does not have control over the placement. diff --git a/modules/nodes-scheduler-node-affinity-configuring-preferred.adoc b/modules/nodes-scheduler-node-affinity-configuring-preferred.adoc index 69b76a8582..05a671b106 100644 --- a/modules/nodes-scheduler-node-affinity-configuring-preferred.adoc +++ b/modules/nodes-scheduler-node-affinity-configuring-preferred.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-node-affinity.adoc -[id='nodes-scheduler-node-affinity-configuring-preferred-{context}'] +[id="nodes-scheduler-node-affinity-configuring-preferred-{context}"] = Configuring a Preferred Node Affinity Rule Preferred rules specify that, if the rule is met, the scheduler tries to enforce the rules, but does not guarantee enforcement. diff --git a/modules/nodes-scheduler-node-affinity-configuring-required.adoc b/modules/nodes-scheduler-node-affinity-configuring-required.adoc index 011fa56a3a..cf5a20db7f 100644 --- a/modules/nodes-scheduler-node-affinity-configuring-required.adoc +++ b/modules/nodes-scheduler-node-affinity-configuring-required.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-node-affinity.adoc -[id='nodes-scheduler-node-affinity-configuring-required-{context}'] +[id="nodes-scheduler-node-affinity-configuring-required-{context}"] = Configuring a required node affinity rule Required rules *must* be met before a pod can be scheduled on a node. diff --git a/modules/nodes-scheduler-node-affinity-example.adoc b/modules/nodes-scheduler-node-affinity-example.adoc index b436c7021a..9e8945d2c6 100644 --- a/modules/nodes-scheduler-node-affinity-example.adoc +++ b/modules/nodes-scheduler-node-affinity-example.adoc @@ -2,12 +2,12 @@ // // * nodes/nodes-scheduler-node-affinity.adoc -[id='nodes-scheduler-node-affinity-examples-{context}'] +[id="nodes-scheduler-node-affinity-examples-{context}"] = Sample node affinity rules The following examples demonstrate node affinity. -[id='admin-guide-sched-affinity-examples1-{context}'] +[id="admin-guide-sched-affinity-examples1-{context}"] == Node Affinity with Matching Labels The following example demonstrates node affinity for a node and pod with matching labels: @@ -49,7 +49,7 @@ NAME READY STATUS RESTARTS AGE IP NODE pod-s1 1/1 Running 0 4m IP1 node1 ---- -[id='admin-guide-sched-affinity-examples2-{context}'] +[id="admin-guide-sched-affinity-examples2-{context}"] == Node Affinity with No Matching Labels The following example demonstrates node affinity for a node and pod without matching labels: diff --git a/modules/nodes-scheduler-node-antiaffinity-configuring.adoc b/modules/nodes-scheduler-node-antiaffinity-configuring.adoc index 55c7c945cf..d8771c3c43 100644 --- a/modules/nodes-scheduler-node-antiaffinity-configuring.adoc +++ b/modules/nodes-scheduler-node-antiaffinity-configuring.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-node-affinity.adoc -[id='nodes-scheduler-node-affinity-configuring-{context}'] +[id="nodes-scheduler-node-affinity-configuring-{context}"] = Configuring node affinity rules You can configure two types of node affinity rules: required and preferred. diff --git a/modules/nodes-scheduler-node-names-configuring.adoc b/modules/nodes-scheduler-node-names-configuring.adoc index 4933cba8c9..3c1ab822da 100644 --- a/modules/nodes-scheduler-node-names-configuring.adoc +++ b/modules/nodes-scheduler-node-names-configuring.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-node-names.adoc -[id='nodes-scheduler-node-name-configuring-{context}'] +[id="nodes-scheduler-node-name-configuring-{context}"] = Configuring the Pod Node Constraints admission controller to use names in {product-title} You can configure the Pod Node Constraints admission controller to ensure that pods are only placed onto nodes with a specific name. diff --git a/modules/nodes-scheduler-node-projects-about.adoc b/modules/nodes-scheduler-node-projects-about.adoc index 6a37ca1985..967d4e77f0 100644 --- a/modules/nodes-scheduler-node-projects-about.adoc +++ b/modules/nodes-scheduler-node-projects-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-node-projects.adoc -[id='nodes-scheduler-node-projects-about-{context}'] +[id="nodes-scheduler-node-projects-about-{context}"] = Understanding how to constrain pods by project name in {product-title} The Pod Node Selector admission controller determines where a pod can be placed using labels on projects and node selectors specified in pods. A new pod will be placed on a node associated with a project only if the node selectors in the pod match the labels in the project. diff --git a/modules/nodes-scheduler-node-projects-configuring.adoc b/modules/nodes-scheduler-node-projects-configuring.adoc index d4218bab98..e91f6ec6ed 100644 --- a/modules/nodes-scheduler-node-projects-configuring.adoc +++ b/modules/nodes-scheduler-node-projects-configuring.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-node-projects.adoc -[id='nodes-scheduler-node-projects-configuring-{context}'] +[id="nodes-scheduler-node-projects-configuring-{context}"] = Configuring the Pod Node Selector admission controller to use projects in {product-title} You can configure the Pod Node Selector admission controller to ensure that pods are only placed onto nodes in specific projects. diff --git a/modules/nodes-scheduler-node-selectors-about.adoc b/modules/nodes-scheduler-node-selectors-about.adoc index 8761564186..1e1c8de8be 100644 --- a/modules/nodes-scheduler-node-selectors-about.adoc +++ b/modules/nodes-scheduler-node-selectors-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-node-selector.adoc -[id='nodes-scheduler-node-selector-about-{context}'] +[id="nodes-scheduler-node-selector-about-{context}"] = Understanding node selectors in {product-title} Using _node selectors_, you can ensure that pods are only placed onto nodes with specific labels. As a cluster administrator, you can diff --git a/modules/nodes-scheduler-node-selectors-configuring.adoc b/modules/nodes-scheduler-node-selectors-configuring.adoc index 80230d53f3..fd6f301f38 100644 --- a/modules/nodes-scheduler-node-selectors-configuring.adoc +++ b/modules/nodes-scheduler-node-selectors-configuring.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-node-selector.adoc -[id='nodes-scheduler-node-selectors-configuring-{context}'] +[id="nodes-scheduler-node-selectors-configuring-{context}"] = Configuring the Pod Node Constraints admission controller to use node selectors in {product-title} You can configure the Pod Node Constraints admission controller to ensure that pods are only placed onto nodes with specific labels. diff --git a/modules/nodes-scheduler-pod-affinity-about.adoc b/modules/nodes-scheduler-pod-affinity-about.adoc index d1c5f89fce..aba03b08cc 100644 --- a/modules/nodes-scheduler-pod-affinity-about.adoc +++ b/modules/nodes-scheduler-pod-affinity-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-pod-affinity.adoc -[id='nodes-scheduler-pod-affinity-about-{context}'] +[id="nodes-scheduler-pod-affinity-about-{context}"] = Understanding pod affinity in {product-title} _Pod affinity_ and _pod anti-affinity_ allow you to constrain which nodes your pod is eligible to be scheduled on based on the key/value labels on other pods. diff --git a/modules/nodes-scheduler-pod-affinity-configuring.adoc b/modules/nodes-scheduler-pod-affinity-configuring.adoc index cab344b437..c8483f1ea1 100644 --- a/modules/nodes-scheduler-pod-affinity-configuring.adoc +++ b/modules/nodes-scheduler-pod-affinity-configuring.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-pod-affinity.adoc -[id='nodes-scheduler-pod-affinity-configuring-{context}'] +[id="nodes-scheduler-pod-affinity-configuring-{context}"] = Configuring a pod affinity rule The following steps demonstrate a simple two-pod configuration that creates pod with a label and a pod that uses affinity to allow scheduling with that pod. diff --git a/modules/nodes-scheduler-pod-affinity-example.adoc b/modules/nodes-scheduler-pod-affinity-example.adoc index 90a01e741f..615cde00ed 100644 --- a/modules/nodes-scheduler-pod-affinity-example.adoc +++ b/modules/nodes-scheduler-pod-affinity-example.adoc @@ -2,12 +2,12 @@ // // * nodes/nodes-scheduler-node-affinity.adoc -[id='nodes-scheduler-pod-affinity-example-{context}'] +[id="nodes-scheduler-pod-affinity-example-{context}"] = Sample pod affinity and anti-affinity rules The following examples demonstrate pod affinity and pod anti-affinity. -[id='nodes-scheduler-pod-affinity-example-affinity-{context}'] +[id="nodes-scheduler-pod-affinity-example-affinity-{context}"] == Pod Affinity The following example demonstrates pod affinity for pods with matching labels and label selectors. @@ -56,7 +56,7 @@ spec: * The *team4a* pod is scheduled on the same node as the *team4* pod. -[id='nodes-scheduler-pod-affinity-example-antiaffinity-{context}'] +[id="nodes-scheduler-pod-affinity-example-antiaffinity-{context}"] == Pod Anti-affinity The following example demonstrates pod anti-affinity for pods with matching labels and label selectors. @@ -110,7 +110,7 @@ NAME READY STATUS RESTARTS AGE IP NODE pod-s2 0/1 Pending 0 32s ---- -[id='nodes-scheduler-pod-affinity-example-no-labels-{context}'] +[id="nodes-scheduler-pod-affinity-example-no-labels-{context}"] == Pod Affinity with no Matching Labels The following example demonstrates pod affinity for pods without matching labels and label selectors. diff --git a/modules/nodes-scheduler-pod-anti-affinity-configuring.adoc b/modules/nodes-scheduler-pod-anti-affinity-configuring.adoc index 9f36b6c483..86a270ba68 100644 --- a/modules/nodes-scheduler-pod-anti-affinity-configuring.adoc +++ b/modules/nodes-scheduler-pod-anti-affinity-configuring.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-pod-affinity.adoc -[id='nodes-scheduler-pod-anti-affinity-configuring-{context}'] +[id="nodes-scheduler-pod-anti-affinity-configuring-{context}"] = Configuring a pod anti-affinity rule The following steps demonstrate a simple two-pod configuration that creates pod with a label and a pod that uses an anti-affinity preferred rule to attempt to prevent scheduling with that pod. diff --git a/modules/nodes-scheduler-taints-tolerations-about.adoc b/modules/nodes-scheduler-taints-tolerations-about.adoc index eb8fc8a478..308421a3f9 100644 --- a/modules/nodes-scheduler-taints-tolerations-about.adoc +++ b/modules/nodes-scheduler-taints-tolerations-about.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-taints-tolerations.adoc -[id='nodes-scheduler-taints-tolerations-about-{context}'] +[id="nodes-scheduler-taints-tolerations-about-{context}"] = Understanding taints and tolerations in {product-title} A _taint_ allows a node to refuse pod to be scheduled unless that pod has a matching _toleration_. @@ -11,7 +11,7 @@ You apply taints to a node through the node specification (`NodeSpec`) and apply Taints and tolerations consist of a key, value, and effect. An operator allows you to leave one of these parameters empty. -[id='taint-components-table-{context}'] +[id="taint-components-table-{context}"] .Taint and toleration components [cols="3a,8a",options="header"] |=== @@ -64,7 +64,7 @@ A toleration matches a taint: ** the `key` parameters are the same; ** the `effect` parameters are the same. -[id='nodes-scheduler-taints-tolerations-about-seconds-{context}'] +[id="nodes-scheduler-taints-tolerations-about-seconds-{context}"] == Understanding how to use toleration seconds to delay pod evictions You can specify how long a pod can remain bound to a node before being evicted by specifying the `tolerationSeconds` parameter in the pod specification. If a taint with the `NoExecute` effect is added to a node, any pods that do not tolerate the taint are evicted immediately (pods that do tolerate the taint are not evicted). However, if a pod that to be evicted has the `tolerationSeconds` parameter, the pod is not evicted until that time period expires. @@ -82,7 +82,7 @@ tolerations: Here, if this pod is running but does not have a matching taint, the pod stays bound to the node for 3,600 seconds and then be evicted. If the taint is removed before that time, the pod is not evicted. -[id='nodes-scheduler-taints-tolerations-about-multiple-{context}'] +[id="nodes-scheduler-taints-tolerations-about-multiple-{context}"] == Understanding how to use multiple taints You can put multiple taints on the same node and multiple tolerations on the same pod. {product-title} processes multiple taints and tolerations as follows: @@ -128,7 +128,7 @@ tolerations: In this case, the pod cannot be scheduled onto the node, because there is no toleration matching the third taint. The pod continues running if it is already running on the node when the taint is added, because the third taint is the only one of the three that is not tolerated by the pod. -[id='nodes-scheduler-taints-tolerations-about-prevent-{context}'] +[id="nodes-scheduler-taints-tolerations-about-prevent-{context}"] == Preventing pod eviction for node problems {product-title} can be configured to represent *node unreachable* and *node not ready* conditions as taints. This allows per-pod specification of how long to remain bound to a node that becomes unreachable or not ready, rather than using the default of five minutes. diff --git a/modules/nodes-scheduler-taints-tolerations-adding.adoc b/modules/nodes-scheduler-taints-tolerations-adding.adoc index 1f3e0dd599..2ff237e11d 100644 --- a/modules/nodes-scheduler-taints-tolerations-adding.adoc +++ b/modules/nodes-scheduler-taints-tolerations-adding.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-taints-tolerations.adoc -[id='nodes-scheduler-taints-tolerations-adding-{context}'] +[id="nodes-scheduler-taints-tolerations-adding-{context}"] = Adding taints and tolerations in {product-title} You add taints to nodes and tolerations to pods allow the node to control which pods should (or should not) be scheduled on them. diff --git a/modules/nodes-scheduler-taints-tolerations-binding.adoc b/modules/nodes-scheduler-taints-tolerations-binding.adoc index 37d3717944..43fd85c16a 100644 --- a/modules/nodes-scheduler-taints-tolerations-binding.adoc +++ b/modules/nodes-scheduler-taints-tolerations-binding.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-taints-tolerations.adoc -[id='nodes-scheduler-taints-tolerations-bindings-{context}'] +[id="nodes-scheduler-taints-tolerations-bindings-{context}"] = Binding a user to a Node using taints and tolerations You can configure a node so that particular users can use only the dedicated nodes. diff --git a/modules/nodes-scheduler-taints-tolerations-dedicating.adoc b/modules/nodes-scheduler-taints-tolerations-dedicating.adoc index bf198e20c4..fa6921957c 100644 --- a/modules/nodes-scheduler-taints-tolerations-dedicating.adoc +++ b/modules/nodes-scheduler-taints-tolerations-dedicating.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-taints-tolerations.adoc -[id='nodes-scheduler-taints-tolerations_dedicating-{context}'] +[id="nodes-scheduler-taints-tolerations_dedicating-{context}"] = Dedicating a Node for a User using taints and tolerations You can specify a set of nodes for exclusive use by a particular set of users. diff --git a/modules/nodes-scheduler-taints-tolerations-examples.adoc b/modules/nodes-scheduler-taints-tolerations-examples.adoc index 0dbefd5416..98ccd84bdd 100644 --- a/modules/nodes-scheduler-taints-tolerations-examples.adoc +++ b/modules/nodes-scheduler-taints-tolerations-examples.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-taints-tolerations.adoc -[id='nodes-scheduler-taints-tolerations-examples-{context}'] +[id="nodes-scheduler-taints-tolerations-examples-{context}"] = Example taint and toleration scenarios in {product-title} Taints and tolerations are a flexible way to steer pods away from nodes or evict pods that should not be running on a node. A few of typical scenarios are: @@ -11,7 +11,7 @@ Taints and tolerations are a flexible way to steer pods away from nodes or evict * Binding a user to a node * Dedicating nodes with special hardware -[id='nodes-scheduler-taints-tolerations-examples-user-{context}'] +[id="nodes-scheduler-taints-tolerations-examples-user-{context}"] == Dedicating a Node for a User You can specify a set of nodes for exclusive use by a particular set of users. @@ -32,7 +32,7 @@ $ oc adm taint nodes node1 dedicated=groupName:NoSchedule + Only the pods with the tolerations are allowed to use the dedicated nodes. -[id='nodes-scheduler-taints-tolerations-examples-binding-{context}'] +[id="nodes-scheduler-taints-tolerations-examples-binding-{context}"] == Binding a User to a Node You can configure a node so that particular users can use only the dedicated nodes. @@ -55,7 +55,7 @@ The admission controller should add a node affinity to require that the pods can . Add a label similar to the taint (such as the `key:value` label) to the dedicated nodes. -[id='nodes-scheduler-taints-tolerations-examples-special-{context}'] +[id="nodes-scheduler-taints-tolerations-examples-special-{context}"] == Nodes with Special Hardware In a cluster where a small subset of nodes have specialized hardware (for example GPUs), you can use taints and tolerations to keep pods that do not need the specialized hardware off of those nodes, leaving the nodes for pods that do need the specialized hardware. You can also require pods that need specialized hardware to use specific nodes. diff --git a/modules/nodes-scheduler-taints-tolerations-seconds.adoc b/modules/nodes-scheduler-taints-tolerations-seconds.adoc index 4ccd5fecf5..3d7ffca1f9 100644 --- a/modules/nodes-scheduler-taints-tolerations-seconds.adoc +++ b/modules/nodes-scheduler-taints-tolerations-seconds.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-taints-tolerations.adoc -[id='nodes-scheduler-taints-tolerations-seconds-{context}'] +[id="nodes-scheduler-taints-tolerations-seconds-{context}"] = Setting a default value for toleration seconds in {product-title} When using taints and tolerations, if taints are added to an existing node, non-matching pods on that node will be evicted. You can modify the time allowed before pods are evicted using the toleration seconds plug-in, which sets the eviction period at five minutes, by default. diff --git a/modules/nodes-scheduler-taints-tolerations-special.adoc b/modules/nodes-scheduler-taints-tolerations-special.adoc index 86d865f1a0..18b484d6fe 100644 --- a/modules/nodes-scheduler-taints-tolerations-special.adoc +++ b/modules/nodes-scheduler-taints-tolerations-special.adoc @@ -2,7 +2,7 @@ // // * nodes/nodes-scheduler-taints-tolerations.adoc -[id='nodes-scheduler-taints-tolerations-special-{context}'] +[id="nodes-scheduler-taints-tolerations-special-{context}"] = Controlling Nodes with special hardware using taints and tolerations In a cluster where a small subset of nodes have specialized hardware (for example GPUs), you can use taints and tolerations to keep pods that do not need the specialized hardware off of those nodes, leaving the nodes for pods that do need the specialized hardware. You can also require pods that need specialized hardware to use specific nodes. diff --git a/modules/nw-annotating-a-route-with-a-cookie-name.adoc b/modules/nw-annotating-a-route-with-a-cookie-name.adoc index 6a79a32dad..1aac88c7a1 100644 --- a/modules/nw-annotating-a-route-with-a-cookie-name.adoc +++ b/modules/nw-annotating-a-route-with-a-cookie-name.adoc @@ -6,7 +6,7 @@ // // * networking/configuring-routing.adoc -[id='nw-annotating-a-route-with-a-cookie-name-{context}'] +[id="nw-annotating-a-route-with-a-cookie-name-{context}"] = Annotating a route with a cookie You can set a cookie name to overwrite the default, auto-generated one for the diff --git a/modules/nw-configuring-route-timeouts.adoc b/modules/nw-configuring-route-timeouts.adoc index 4cc29bfaa7..9ca6a5f64d 100644 --- a/modules/nw-configuring-route-timeouts.adoc +++ b/modules/nw-configuring-route-timeouts.adoc @@ -2,7 +2,7 @@ // Module included in the following assemblies: // * networking/configuring-routing.adoc -[id='nw-configuring-route-timeouts-{context}'] +[id="nw-configuring-route-timeouts-{context}"] = Configuring route timeouts You can configure the default timeouts for an existing route when you diff --git a/modules/nw-creating-secured-routes.adoc b/modules/nw-creating-secured-routes.adoc index fab95bd590..e59e48615a 100644 --- a/modules/nw-creating-secured-routes.adoc +++ b/modules/nw-creating-secured-routes.adoc @@ -2,7 +2,7 @@ // Module included in the following assemblies: // * networking/configuring-routing.adoc -[id='nw-creating-secure-routes-{context}'] +[id="nw-creating-secure-routes-{context}"] = Creating secured edge terminated routes You can create a secure edge terminated route where TLS diff --git a/modules/nw-enabling-hsts.adoc b/modules/nw-enabling-hsts.adoc index 7991f2c8b5..f4392b8585 100644 --- a/modules/nw-enabling-hsts.adoc +++ b/modules/nw-enabling-hsts.adoc @@ -2,7 +2,7 @@ // Module included in the following assemblies: // * networking/configuring-routing.adoc -[id='nw-enabling-hsts-{context}'] +[id="nw-enabling-hsts-{context}"] = Enabling HTTP strict transport security HTTP Strict Transport Security (HSTS) policy is a security enhancement, which diff --git a/modules/nw-ne-openshift-dns.adoc b/modules/nw-ne-openshift-dns.adoc index 50626bc6b2..d5d00a18f3 100644 --- a/modules/nw-ne-openshift-dns.adoc +++ b/modules/nw-ne-openshift-dns.adoc @@ -2,7 +2,7 @@ // * understanding-networking.adoc -[id='nw-ne-openshift-dns-{context}'] +[id="nw-ne-openshift-dns-{context}"] = {product-title} DNS If you are running multiple services, such as front-end and back-end services for diff --git a/modules/nw-throughput-troubleshoot.adoc b/modules/nw-throughput-troubleshoot.adoc index 3568fe0228..bf26f5e40a 100644 --- a/modules/nw-throughput-troubleshoot.adoc +++ b/modules/nw-throughput-troubleshoot.adoc @@ -2,7 +2,7 @@ // Module included in the following assemblies: // * networking/configuring-routing.adoc -[id='nw-throughput-troubleshoot-{context}'] +[id="nw-throughput-troubleshoot-{context}"] = Troubleshooting throughput issues Sometimes applications deployed through {product-title} can cause network throughput issues such as unusually high latency between diff --git a/modules/nw-using-cookies-keep-route-statefulness.adoc b/modules/nw-using-cookies-keep-route-statefulness.adoc index 50b2e58ec0..77c519f384 100644 --- a/modules/nw-using-cookies-keep-route-statefulness.adoc +++ b/modules/nw-using-cookies-keep-route-statefulness.adoc @@ -5,7 +5,7 @@ // Module included in the following assemblies: // // * networking/configuring-routing.adoc -[id='nw-using-cookies-keep-route-statefulness-{context}'] +[id="nw-using-cookies-keep-route-statefulness-{context}"] = Using cookies to keep route statefulness {product-title} provides sticky sessions, which enables stateful application diff --git a/modules/nw_multinetwork-creating-first-attachments.adoc b/modules/nw_multinetwork-creating-first-attachments.adoc index 298194ad97..5ec828339d 100644 --- a/modules/nw_multinetwork-creating-first-attachments.adoc +++ b/modules/nw_multinetwork-creating-first-attachments.adoc @@ -2,7 +2,7 @@ // // * networking/managing_multinetworking.adoc -[id='multinetwork-creating-first-attachments-{context}'] +[id="multinetwork-creating-first-attachments-{context}"] = Creating additional network interfaces for the first time Additional interfaces for pods are defined in CNI configurations that are stored as Custom Resources (CRs). diff --git a/modules/nw_multinetwork-host-device.adoc b/modules/nw_multinetwork-host-device.adoc index b620b5e41d..87f30fef64 100644 --- a/modules/nw_multinetwork-host-device.adoc +++ b/modules/nw_multinetwork-host-device.adoc @@ -2,7 +2,7 @@ // Module included in the following assemblies: // * networking/managing_multinetworking.adoc -[id='multinetwork-host-device-{context}'] +[id="multinetwork-host-device-{context}"] = Configuring additional interfaces using host devices The host-device plug-in connects an existing network device on a node directly to a pod. diff --git a/modules/nw_multinetwork-sriov.adoc b/modules/nw_multinetwork-sriov.adoc index 2bd562f243..d973710f6b 100644 --- a/modules/nw_multinetwork-sriov.adoc +++ b/modules/nw_multinetwork-sriov.adoc @@ -3,7 +3,7 @@ // // * networking/managing_multinetworking.adoc -[id='multinetwork-sriov-{context}'] +[id="multinetwork-sriov-{context}"] = Configuring SR-IOV {product-title} includes the capability to use SR-IOV hardware on {product-title} nodes, which enables you to attach SR-IOV virtual function (VF) interfaces to pods in addition to other network interfaces. diff --git a/modules/oauth-configuring-internal-oauth.adoc b/modules/oauth-configuring-internal-oauth.adoc index 9f95f9bd60..a73831bebb 100644 --- a/modules/oauth-configuring-internal-oauth.adoc +++ b/modules/oauth-configuring-internal-oauth.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-internal-oauth.adoc -[id='oauth-configuring-internal-oauth-{context}'] +[id="oauth-configuring-internal-oauth-{context}"] = Configuring options for the internal OAuth server You can configure default options for the internal OAuth server's session, diff --git a/modules/oauth-internal-options.adoc b/modules/oauth-internal-options.adoc index 5d80e1888f..b6464d501a 100644 --- a/modules/oauth-internal-options.adoc +++ b/modules/oauth-internal-options.adoc @@ -2,12 +2,12 @@ // // * authentication/configuring-internal-oauth.adoc -[id='oauth-internal-options-{context}'] +[id="oauth-internal-options-{context}"] = Options for the internal OAuth server Several configuration options are available for the internal OAuth server. -[id='oauth-token-duration-{context}'] +[id="oauth-token-duration-{context}"] == OAuth token duration options The internal OAuth server generates two kinds of tokens: @@ -21,7 +21,7 @@ You can configure the default duration for both types of token. If necessary, you can override the duration of the access token by using an `OAuthClient` object definition. -[id='oauth-grant-options-{context}'] +[id="oauth-grant-options-{context}"] == OAuth grant options When the OAuth server receives token requests for a client to which the user @@ -37,7 +37,7 @@ methods: `prompt`:: Prompt the user to approve or deny the grant. `deny`:: Auto-deny the grant and return a failure error to the client. -[id='oauth-session-options-{context}'] +[id="oauth-session-options-{context}"] == OAuth session options The OAuth server uses a signed and encrypted cookie-based session during login diff --git a/modules/oauth-internal-tokens.adoc b/modules/oauth-internal-tokens.adoc index cb8335ca50..d6aa7f5c44 100644 --- a/modules/oauth-internal-tokens.adoc +++ b/modules/oauth-internal-tokens.adoc @@ -2,7 +2,7 @@ // // * authentication/understanding-internal-oauth.adoc -[id='oauth-token-request-flows-{context}'] +[id="oauth-token-request-flows-{context}"] = OAuth token request flows and responses The OAuth server supports standard diff --git a/modules/oauth-register-additional-server.adoc b/modules/oauth-register-additional-server.adoc index 6ee095000c..2465f88be1 100644 --- a/modules/oauth-register-additional-server.adoc +++ b/modules/oauth-register-additional-server.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-internal-oauth.adoc -[id='oauth-register-additional-server-{context}'] +[id="oauth-register-additional-server-{context}"] = Register an additional OAuth server If you need an additional OAuth server to manage authentication for your diff --git a/modules/oauth-server-metadata.adoc b/modules/oauth-server-metadata.adoc index 4264aa72b9..635b85486e 100644 --- a/modules/oauth-server-metadata.adoc +++ b/modules/oauth-server-metadata.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-internal-oauth.adoc -[id='oauth-server-metadata-{context}'] +[id="oauth-server-metadata-{context}"] = OAuth server metadata Applications running in {product-title} may need to discover information about diff --git a/modules/oauth-server-overview.adoc b/modules/oauth-server-overview.adoc index 55a7df4e86..74e53b4bc0 100644 --- a/modules/oauth-server-overview.adoc +++ b/modules/oauth-server-overview.adoc @@ -4,7 +4,7 @@ // * authentication/configuring-internal-oauth.adoc -[id='oauth-server-overview-{context}'] +[id="oauth-server-overview-{context}"] = {product-title} OAuth server The {product-title} master includes a built-in OAuth server. Users obtain OAuth diff --git a/modules/oauth-token-requests.adoc b/modules/oauth-token-requests.adoc index 0f3fb4dd52..853a57db73 100644 --- a/modules/oauth-token-requests.adoc +++ b/modules/oauth-token-requests.adoc @@ -2,7 +2,7 @@ // // * authentication/understanding-authentication.adoc -[id='oauth-token-requests-{context}'] +[id="oauth-token-requests-{context}"] == OAuth token requests Every request for an OAuth token must specify the OAuth client that will diff --git a/modules/oauth-troubleshooting-api-events.adoc b/modules/oauth-troubleshooting-api-events.adoc index 03e5812da5..c2bcc54f63 100644 --- a/modules/oauth-troubleshooting-api-events.adoc +++ b/modules/oauth-troubleshooting-api-events.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring-internal-oauth.adoc -[id='oauth-troubleshooting-api-events-{context}'] +[id="oauth-troubleshooting-api-events-{context}"] = Troubleshooting OAuth API events In some cases the API server returns an `unexpected condition` error message diff --git a/modules/olm-creating-etcd-cluster-from-operator.adoc b/modules/olm-creating-etcd-cluster-from-operator.adoc index b8d4d54d57..4936f66cf4 100644 --- a/modules/olm-creating-etcd-cluster-from-operator.adoc +++ b/modules/olm-creating-etcd-cluster-from-operator.adoc @@ -2,7 +2,7 @@ // // * applications/operators/olm-creating-apps-from-installed-operators.adoc -[id='olm-creating-etcd-cluster-from-operator-{context}'] +[id="olm-creating-etcd-cluster-from-operator-{context}"] = Creating an etcd cluster using an Operator This procedure walks through creating a new etcd cluster using the etcd diff --git a/modules/olm-installing-from-operatorhub-using-cli.adoc b/modules/olm-installing-from-operatorhub-using-cli.adoc index a0237727da..e3b8f6d57c 100644 --- a/modules/olm-installing-from-operatorhub-using-cli.adoc +++ b/modules/olm-installing-from-operatorhub-using-cli.adoc @@ -2,7 +2,7 @@ // // * applications/operators/olm-adding-operators-to-cluster.adoc -[id='olm-installing-operator-from-operatorhub-using-cli-{context}'] +[id="olm-installing-operator-from-operatorhub-using-cli-{context}"] = Installing from the OperatorHub using the CLI Instead of using the {product-title} web console, you can install an Operator diff --git a/modules/olm-installing-from-operatorhub-using-web-console.adoc b/modules/olm-installing-from-operatorhub-using-web-console.adoc index 9d5daa840b..a2567574fa 100644 --- a/modules/olm-installing-from-operatorhub-using-web-console.adoc +++ b/modules/olm-installing-from-operatorhub-using-web-console.adoc @@ -2,7 +2,7 @@ // // * applications/operators/olm-adding-operators-to-cluster.adoc -[id='olm-installing-from-operatorhub-using-web-console-{context}'] +[id="olm-installing-from-operatorhub-using-web-console-{context}"] = Installing from the OperatorHub using the web console This procedure uses the etcd Operator as an example to install and subscribe to diff --git a/modules/olm-operator-framework.adoc b/modules/olm-operator-framework.adoc index f20aa15b14..832efffa7b 100644 --- a/modules/olm-operator-framework.adoc +++ b/modules/olm-operator-framework.adoc @@ -2,7 +2,7 @@ // // * applications/operators/olm-what-operators-are.adoc -[id='olm-operator-framework-{context}'] +[id="olm-operator-framework-{context}"] = Operator Framework The Operator Framework is a family of tools and capabilities to deliver on the diff --git a/modules/olm-operator-lifecycle-manager.adoc b/modules/olm-operator-lifecycle-manager.adoc index 54575db585..e5bd9600a1 100644 --- a/modules/olm-operator-lifecycle-manager.adoc +++ b/modules/olm-operator-lifecycle-manager.adoc @@ -2,7 +2,7 @@ // // * applications/operators/olm-adding-operators-to-cluster.adoc -[id='olm-operator-lifecycle-manager-{context}'] +[id="olm-operator-lifecycle-manager-{context}"] = Understanding the Operator Lifecycle Manager In {product-title} 4.0, the _Operator Lifecycle Manager_ (OLM) helps users @@ -26,7 +26,7 @@ For developers, a self-service experience allows provisioning and configuring instances of databases, monitoring, and big data services without having to be subject matter experts, because the Operator has that knowledge baked into it. -[id='olm-csv-{context}'] +[id="olm-csv-{context}"] == ClusterServiceVersions (CSVs) A _ClusterServiceVersion_ (CSV) is a YAML manifest created from Operator @@ -54,7 +54,7 @@ CRDs:: * Resources: A list of resources that the Operator interacts with * Descriptors: Annotate CRD spec and status fields to provide semantic information -[id='olm-architecture-{context}'] +[id="olm-architecture-{context}"] == Architecture The Operator Lifecycle Manager is composed of two Operators: the OLM Operator @@ -115,7 +115,7 @@ Each of these Operators are also responsible for creating resources: |ClusterServiceVersions (CSVs) |=== -[id='olm-architecture-olm-operator-{context}'] +[id="olm-architecture-olm-operator-{context}"] === OLM Operator The OLM Operator is responsible for deploying applications defined by CSV @@ -136,7 +136,7 @@ namespaces. * Watches for ClusterServiceVersion (CSVs) in a namespace and checks that requirements are met. If so, runs the install strategy for the CSV. -[id='olm-architecture-catalog-operator-{context}'] +[id="olm-architecture-catalog-operator-{context}"] === Catalog Operator The Catalog Operator is responsible for resolving and installing CSVs and the @@ -165,7 +165,7 @@ the CSVs. * Watches for resolved InstallPlans and creates all of the discovered resources for it (if approved by a user or automatically). * Watches for CatalogSources and Subscriptions and creates InstallPlans based on them. -[id='olm-architecture-catalog-registry-{context}'] +[id="olm-architecture-catalog-registry-{context}"] === Catalog Registry The Catalog Registry stores CSVs and CRDs for creation in a cluster and stores @@ -178,7 +178,7 @@ package manifest provides the Catalog Operator all of the information that is required to update a CSV to the latest version in a channel (stepping through each intermediate version). -[id='olm-architecture-operatorgroups-{context}'] +[id="olm-architecture-operatorgroups-{context}"] === OperatorGroups The goal of _OperatorGroups_ is to bring multitenancy features to running diff --git a/modules/olm-operator-maturity-model.adoc b/modules/olm-operator-maturity-model.adoc index 2bf21d92dd..45e096dedf 100644 --- a/modules/olm-operator-maturity-model.adoc +++ b/modules/olm-operator-maturity-model.adoc @@ -2,7 +2,7 @@ // // * applications/operators/olm-what-operators-are.adoc -[id='olm-maturity-model-{context}'] +[id="olm-maturity-model-{context}"] = Operator maturity model The level of sophistication of the management logic encapsulated within an diff --git a/modules/olm-operatorhub.adoc b/modules/olm-operatorhub.adoc index 84367d3dd2..3f6d78d765 100644 --- a/modules/olm-operatorhub.adoc +++ b/modules/olm-operatorhub.adoc @@ -2,7 +2,7 @@ // // * applications/operators/olm-adding-operators-to-cluster.adoc -[id='olm-operatorhub-{context}'] +[id="olm-operatorhub-{context}"] = Understanding the OperatorHub The _OperatorHub_ is available via the {product-title} web console and is the @@ -35,7 +35,7 @@ GitHub repository. No official support. The OperatorHub component is installed and run as an Operator by default on {product-title} in the `openshift-marketplace` namespace. -[id='olm-operatorhub-arch-{context}'] +[id="olm-operatorhub-arch-{context}"] == Architecture The OperatorHub component's Operator manages two Custom Resource Definitions @@ -51,7 +51,7 @@ through the OperatorHub user interface, those files are only used directly by those who are creating their own Operators. ==== -[id='olm-operatorhub-arch-operatorsource-{context}'] +[id="olm-operatorhub-arch-operatorsource-{context}"] === OperatorSource For each Operator, the OperatorSource is used to define the external data store @@ -85,7 +85,7 @@ can be displayed on the OperatorHub. |=== -[id='olm-operatorhub-arch-catalogsourceconfig-{context}'] +[id="olm-operatorhub-arch-catalogsourceconfig-{context}"] === CatalogSourceConfig An Operator's CatalogSourceConfig is used to enable an Operator present in the diff --git a/modules/olm-why-use-operators.adoc b/modules/olm-why-use-operators.adoc index 2ddba47332..1cb6d9a019 100644 --- a/modules/olm-why-use-operators.adoc +++ b/modules/olm-why-use-operators.adoc @@ -2,7 +2,7 @@ // // * applications/operators/olm-what-operators-are.adoc -[id='olm-why-use-operators-{context}'] +[id="olm-why-use-operators-{context}"] = Why use Operators? Operators provide: diff --git a/modules/openshift-cluster-limits.adoc b/modules/openshift-cluster-limits.adoc index 5aa74c5042..585a1e43c2 100644 --- a/modules/openshift-cluster-limits.adoc +++ b/modules/openshift-cluster-limits.adoc @@ -2,7 +2,7 @@ // // * scalability_and_performance/planning-your-environment-according-to-object-limits.adoc -[id='cluster-limits-{context}'] +[id="cluster-limits-{context}"] = {product-title} cluster limits [options="header",cols="5*"] diff --git a/modules/operators-overview.adoc b/modules/operators-overview.adoc index 9d3e245041..2107bf4b84 100644 --- a/modules/operators-overview.adoc +++ b/modules/operators-overview.adoc @@ -2,13 +2,13 @@ // // * architecture/architecture.adoc -[id='operators-overview-{context}'] +[id="operators-overview-{context}"] = Operators in {product-title} {product-title} 4 uses different classes of Operators to perform cluster operations and run services on the cluster for your applications to use. -[id='platform-operators-{context}'] +[id="platform-operators-{context}"] == Platform Operators in {product-title} In {product-title} 4, all cluster functions are divided into a series @@ -34,7 +34,7 @@ where the `kubelet` could be running as containerized or non-containerized, the always runs as a `systemd` process. -[id='second-level-operators-{context}'] +[id="second-level-operators-{context}"] == Second-level Operators in {product-title} The Cluster Version Operator, when we talk about payload manifests, is a @@ -49,7 +49,7 @@ Second-level Operators write out to a CRD resource called the ClusterOperator that allows the Cluster Version Operator to understand the progress of the managed component's deployment. -[id='OLM-operators-{context}'] +[id="OLM-operators-{context}"] == Operators managed by OLM The Cluster Operator Lifecycle Management (OLM) component manages Operators diff --git a/modules/optimizing-the-MTU-for-your-network.adoc b/modules/optimizing-the-MTU-for-your-network.adoc index d9be1dccec..e1d477ec98 100644 --- a/modules/optimizing-the-MTU-for-your-network.adoc +++ b/modules/optimizing-the-MTU-for-your-network.adoc @@ -2,7 +2,7 @@ // // networking/network-optimization.adoc -[id='optimizing-the-mtu-for-your-network-{context}'] +[id="optimizing-the-mtu-for-your-network-{context}"] = Optimizing the MTU for your network There are two important maximum transmission units (MTUs): the network diff --git a/modules/osdk-ansible-custom-resource-files.adoc b/modules/osdk-ansible-custom-resource-files.adoc index c9ca20927e..11f332174c 100644 --- a/modules/osdk-ansible-custom-resource-files.adoc +++ b/modules/osdk-ansible-custom-resource-files.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-ansible-custom-resource-files-{context}'] +[id="osdk-ansible-custom-resource-files-{context}"] = Custom Resource files Operators use the Kubernetes' extension mechanism, Custom Resource Definitions diff --git a/modules/osdk-ansible-extra-variables.adoc b/modules/osdk-ansible-extra-variables.adoc index cc251e2baf..fbe07907aa 100644 --- a/modules/osdk-ansible-extra-variables.adoc +++ b/modules/osdk-ansible-extra-variables.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-ansible-extra-variables-{context}'] +[id="osdk-ansible-extra-variables-{context}"] = Extra variables sent to Ansible Extra variables can be sent to Ansible, which are then managed by the Operator. diff --git a/modules/osdk-ansible-k8s-module-inside-operator.adoc b/modules/osdk-ansible-k8s-module-inside-operator.adoc index 1339b3fdb6..538caceb8e 100644 --- a/modules/osdk-ansible-k8s-module-inside-operator.adoc +++ b/modules/osdk-ansible-k8s-module-inside-operator.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-ansible-k8s-module-inside-operator-{context}'] +[id="osdk-ansible-k8s-module-inside-operator-{context}"] = Testing the k8s Ansible module inside an Operator After you are familiar using the `k8s` Ansible module locally, you can trigger @@ -10,7 +10,7 @@ the same Ansible logic inside of an Operator when a Custom Resource (CR) changes. This example maps an Ansible role to a specific Kubernetes resource that the Operator watches. This mapping is done in the Watches file. -[id='osdk-ansible-k8s-module-inside-operator-testing-local-{context}'] +[id="osdk-ansible-k8s-module-inside-operator-testing-local-{context}"] == Testing an Ansible-based Operator locally After getting comfortable testing Ansible workflows locally, you can test the @@ -127,7 +127,7 @@ kube-public Active 28d kube-system Active 28d ---- -[id='osdk-ansible-k8s-module-inside-operator-testing-cluster-{context}'] +[id="osdk-ansible-k8s-module-inside-operator-testing-cluster-{context}"] == Testing an Ansible-based Operator on a cluster After getting familiar running Ansible logic inside of an Ansible-based Operator diff --git a/modules/osdk-ansible-k8s-module-installing.adoc b/modules/osdk-ansible-k8s-module-installing.adoc index bcba406f2b..2a9d99998c 100644 --- a/modules/osdk-ansible-k8s-module-installing.adoc +++ b/modules/osdk-ansible-k8s-module-installing.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-ansible-k8s-module-installing-{context}'] +[id="osdk-ansible-k8s-module-installing-{context}"] = Installing the k8s Ansible module To install the `k8s` Ansible module on your local workstation: diff --git a/modules/osdk-ansible-k8s-module-testing-locally.adoc b/modules/osdk-ansible-k8s-module-testing-locally.adoc index 0ed6544c4b..12bc4980a2 100644 --- a/modules/osdk-ansible-k8s-module-testing-locally.adoc +++ b/modules/osdk-ansible-k8s-module-testing-locally.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-ansible-k8s-module-testing-locally-{context}'] +[id="osdk-ansible-k8s-module-testing-locally-{context}"] = Testing the k8s Ansible module locally Sometimes, it is beneficial for a developer to run the Ansible code from their diff --git a/modules/osdk-ansible-managing-cr-status.adoc b/modules/osdk-ansible-managing-cr-status.adoc index 2e0c5262ff..7fea58fad8 100644 --- a/modules/osdk-ansible-managing-cr-status.adoc +++ b/modules/osdk-ansible-managing-cr-status.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-ansible-managing-cr-status-{context}'] +[id="osdk-ansible-managing-cr-status-{context}"] = Managing Custom Resource status using the k8s_status Ansible module Ansible-based Operators automatically update Custom Resource (CR) @@ -79,7 +79,7 @@ shown: Operators, see the link:https://github.com/operator-framework/operator-sdk/blob/master/doc/proposals/ansible-operator-status.md[Ansible Operator Status Proposal]. -[id='osdk-ansible-managing-cr-status-locally-{context}'] +[id="osdk-ansible-managing-cr-status-locally-{context}"] == Using the k8s_status Ansible module when testing locally If your Operator takes advantage of the `k8s_status` Ansible module and you want diff --git a/modules/osdk-ansible-runner-directory.adoc b/modules/osdk-ansible-runner-directory.adoc index ec59cdfc3e..8f7834ec99 100644 --- a/modules/osdk-ansible-runner-directory.adoc +++ b/modules/osdk-ansible-runner-directory.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-ansible-runner-directory-{context}'] +[id="osdk-ansible-runner-directory-{context}"] = Ansible Runner directory Ansible Runner keeps information about Ansible runs in the container. This diff --git a/modules/osdk-ansible-support.adoc b/modules/osdk-ansible-support.adoc index 319ec9fdb2..322f0cb1cf 100644 --- a/modules/osdk-ansible-support.adoc +++ b/modules/osdk-ansible-support.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-ansible-support-{context}'] +[id="osdk-ansible-support-{context}"] = Ansible support in the Operator SDK The link:https://coreos.com/operators/[Operator Framework] is an open source diff --git a/modules/osdk-ansible-watches-file.adoc b/modules/osdk-ansible-watches-file.adoc index 534a030875..1ad457229b 100644 --- a/modules/osdk-ansible-watches-file.adoc +++ b/modules/osdk-ansible-watches-file.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-ansible-watches-file-{context}'] +[id="osdk-ansible-watches-file-{context}"] = Watches file The Watches file contains a list of mappings from Custom Resources (CRs), @@ -71,7 +71,7 @@ the specified role or playbook or in a separate controller. <3> More complex example for the `Baz` kind. Disables re-queuing and managing the CR status in the playbook. -[id='osdk-ansible-watches-file-advanced-{context}'] +[id="osdk-ansible-watches-file-advanced-{context}"] == Advanced options Advanced features can be enabled by adding them to your Watches file per GVK diff --git a/modules/osdk-architecture.adoc b/modules/osdk-architecture.adoc index df552fa947..2554abaa3e 100644 --- a/modules/osdk-architecture.adoc +++ b/modules/osdk-architecture.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-getting-started.adoc -[id='osdk-architecture-{context}'] +[id="osdk-architecture-{context}"] = Architecture of the Operator SDK The link:https://coreos.com/operators/[Operator Framework] is an open source @@ -24,7 +24,7 @@ providing: - Tools for scaffolding and code generation to quickly bootstrap a new project - Extensions to cover common Operator use cases -[id='osdk-architecture-workflow-{context}'] +[id="osdk-architecture-workflow-{context}"] == Workflow The Operator SDK provides the following workflow to develop a new Operator: @@ -42,7 +42,7 @@ At a high level, an Operator using the Operator SDK processes events for watched resources in an Operator author-defined handler and takes actions to reconcile the state of the application. -[id='osdk-architecture-manager-{context}'] +[id="osdk-architecture-manager-{context}"] == Manager file The main program for the Operator is the manager file at `cmd/manager/main.go`. diff --git a/modules/osdk-building-ansible-operator.adoc b/modules/osdk-building-ansible-operator.adoc index 967fdca62d..60c73e8c5e 100644 --- a/modules/osdk-building-ansible-operator.adoc +++ b/modules/osdk-building-ansible-operator.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-ansible.adoc -[id='osdk-building-ansible-operator-{context}'] +[id="osdk-building-ansible-operator-{context}"] = Building an Ansible-based Operator using the Operator SDK This procedure walks through an example of building a simple Memcached Operator diff --git a/modules/osdk-building-helm-operator.adoc b/modules/osdk-building-helm-operator.adoc index c2da2116a8..05032298a0 100644 --- a/modules/osdk-building-helm-operator.adoc +++ b/modules/osdk-building-helm-operator.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-helm.adoc -[id='osdk-building-helm-operator-{context}'] +[id="osdk-building-helm-operator-{context}"] = Building a Helm-based Operator using the Operator SDK This procedure walks through an example of building a simple Nginx Operator diff --git a/modules/osdk-cli-reference-add.adoc b/modules/osdk-cli-reference-add.adoc index 39d5b66dcb..9f6f162826 100644 --- a/modules/osdk-cli-reference-add.adoc +++ b/modules/osdk-cli-reference-add.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference-add-{context}'] +[id="osdk-cli-reference-add-{context}"] = add The `operator-sdk add` command adds a controller or resource to the project. The diff --git a/modules/osdk-cli-reference-build.adoc b/modules/osdk-cli-reference-build.adoc index f8b6bea2ac..bfc3ae7ca1 100644 --- a/modules/osdk-cli-reference-build.adoc +++ b/modules/osdk-cli-reference-build.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference-build-{context}'] +[id="osdk-cli-reference-build-{context}"] = build The `operator-sdk build` command compiles the code and builds the executables. diff --git a/modules/osdk-cli-reference-completion.adoc b/modules/osdk-cli-reference-completion.adoc index 5d830692b3..62ecd769a0 100644 --- a/modules/osdk-cli-reference-completion.adoc +++ b/modules/osdk-cli-reference-completion.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference-completion-{context}'] +[id="osdk-cli-reference-completion-{context}"] = completion The `operator-sdk completion` command generates shell completions to make diff --git a/modules/osdk-cli-reference-generate.adoc b/modules/osdk-cli-reference-generate.adoc index 77229b5fa2..9d526ec633 100644 --- a/modules/osdk-cli-reference-generate.adoc +++ b/modules/osdk-cli-reference-generate.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference-generate-{context}'] +[id="osdk-cli-reference-generate-{context}"] = generate The `operator-sdk generate` command invokes a specific generator to generate diff --git a/modules/osdk-cli-reference-new.adoc b/modules/osdk-cli-reference-new.adoc index 2c2f5e7bb3..054fa571a5 100644 --- a/modules/osdk-cli-reference-new.adoc +++ b/modules/osdk-cli-reference-new.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference-new-{context}'] +[id="osdk-cli-reference-new-{context}"] = new The `operator-sdk new` command creates a new Operator application and generates diff --git a/modules/osdk-cli-reference-olm-catalog.adoc b/modules/osdk-cli-reference-olm-catalog.adoc index 4b927c3598..40426a205e 100644 --- a/modules/osdk-cli-reference-olm-catalog.adoc +++ b/modules/osdk-cli-reference-olm-catalog.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference-olm-catalog-{context}'] +[id="osdk-cli-reference-olm-catalog-{context}"] = olm-catalog The `operator-sdk olm-catalog` is the parent command for all Operator Lifecycle diff --git a/modules/osdk-cli-reference-print-deps.adoc b/modules/osdk-cli-reference-print-deps.adoc index 53fd3af321..09c79cf8d4 100644 --- a/modules/osdk-cli-reference-print-deps.adoc +++ b/modules/osdk-cli-reference-print-deps.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference-print-deps-{context}'] +[id="osdk-cli-reference-print-deps-{context}"] = print-deps The `operator-sdk print-deps` command prints the most recent Golang packages and diff --git a/modules/osdk-cli-reference-test.adoc b/modules/osdk-cli-reference-test.adoc index d3f2760143..de136d898b 100644 --- a/modules/osdk-cli-reference-test.adoc +++ b/modules/osdk-cli-reference-test.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference-test-{context}'] +[id="osdk-cli-reference-test-{context}"] = test The `operator-sdk test` command has subcommands that can test the Operator diff --git a/modules/osdk-cli-reference-up.adoc b/modules/osdk-cli-reference-up.adoc index 6419bded75..5260459644 100644 --- a/modules/osdk-cli-reference-up.adoc +++ b/modules/osdk-cli-reference-up.adoc @@ -1,4 +1,4 @@ -[id='osdk-cli-reference-up-{context}'] +[id="osdk-cli-reference-up-{context}"] = up The `operator-sdk up` command has subcommands that can launch the Operator in diff --git a/modules/osdk-csv-composition-configuration.adoc b/modules/osdk-csv-composition-configuration.adoc index 75e304b0a4..4b43892b32 100644 --- a/modules/osdk-csv-composition-configuration.adoc +++ b/modules/osdk-csv-composition-configuration.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-generating-csvs.adoc -[id='osdk-configuring-csv-composition-{context}'] +[id="osdk-configuring-csv-composition-{context}"] = CSV composition configuration Operator authors can configure CSV composition by populating several fields in diff --git a/modules/osdk-generating-a-csv.adoc b/modules/osdk-generating-a-csv.adoc index c52ecc3ff7..6cebff78d5 100644 --- a/modules/osdk-generating-a-csv.adoc +++ b/modules/osdk-generating-a-csv.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-generating-csvs.adoc -[id='osdk-generating-a-csv-{context}'] +[id="osdk-generating-a-csv-{context}"] = Generating a CSV .Prerequisites diff --git a/modules/osdk-helm-chart-support.adoc b/modules/osdk-helm-chart-support.adoc index f8027526bd..c314163c1c 100644 --- a/modules/osdk-helm-chart-support.adoc +++ b/modules/osdk-helm-chart-support.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-helm.adoc -[id='osdk-helm-chart-support-{context}'] +[id="osdk-helm-chart-support-{context}"] = Helm chart support in the Operator SDK The link:https://coreos.com/operators/[Operator Framework] is an open source diff --git a/modules/osdk-how-csv-gen-works.adoc b/modules/osdk-how-csv-gen-works.adoc index 6028d679d0..f45b878363 100644 --- a/modules/osdk-how-csv-gen-works.adoc +++ b/modules/osdk-how-csv-gen-works.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-generating-csvs.adoc -[id='osdk-how-csv-gen-works-{context}'] +[id="osdk-how-csv-gen-works-{context}"] = How CSV generation works An Operator project's `deploy/` directory is the standard location for all @@ -26,7 +26,7 @@ can configure which specific files are included in the `deploy/olm-catalog/csv-config.yaml` file. [discrete] -[id='osdk-how-csv-gen-works-workflow-{context}'] +[id="osdk-how-csv-gen-works-workflow-{context}"] == Workflow Depending on whether an existing CSV is detected, and assuming all configuration diff --git a/modules/osdk-installing-cli.adoc b/modules/osdk-installing-cli.adoc index 9cc2c05a0b..c6ca30ba8f 100644 --- a/modules/osdk-installing-cli.adoc +++ b/modules/osdk-installing-cli.adoc @@ -4,7 +4,7 @@ // * applications/operator_sdk/osdk-ansible.adoc // * applications/operator_sdk/osdk-helm.adoc -[id='osdk-installing-cli-{context}'] +[id="osdk-installing-cli-{context}"] = Installing the Operator SDK CLI The Operator SDK has a CLI tool that assists developers in creating, building, diff --git a/modules/osdk-manually-defined-csv-fields.adoc b/modules/osdk-manually-defined-csv-fields.adoc index bb5d43b52a..a3bb0f72b8 100644 --- a/modules/osdk-manually-defined-csv-fields.adoc +++ b/modules/osdk-manually-defined-csv-fields.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-generating-csvs.adoc -[id='osdk-manually-defined-csv-fields-{context}'] +[id="osdk-manually-defined-csv-fields-{context}"] = Manually-defined CSV fields Many CSV fields cannot be populated using generated, non-SDK-specific manifests. diff --git a/modules/osdk-monitoring-prometheus-metrics-helper-modifying-port.adoc b/modules/osdk-monitoring-prometheus-metrics-helper-modifying-port.adoc index 22f6b00c26..b7db1e4516 100644 --- a/modules/osdk-monitoring-prometheus-metrics-helper-modifying-port.adoc +++ b/modules/osdk-monitoring-prometheus-metrics-helper-modifying-port.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-monitoring-prometheus.adoc -[id='osdk-monitoring-prometheus-metrics-helper-modifying-port-{context}'] +[id="osdk-monitoring-prometheus-metrics-helper-modifying-port-{context}"] = Modifying metrics port Operator authors can modify the port that metrics are exposed on. diff --git a/modules/osdk-monitoring-prometheus-metrics-helper.adoc b/modules/osdk-monitoring-prometheus-metrics-helper.adoc index 72ed5e86fd..73f7dd7473 100644 --- a/modules/osdk-monitoring-prometheus-metrics-helper.adoc +++ b/modules/osdk-monitoring-prometheus-metrics-helper.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-monitoring-prometheus.adoc -[id='osdk-monitoring-prometheus-metrics-helper-{context}'] +[id="osdk-monitoring-prometheus-metrics-helper-{context}"] = Metrics helper In Go-based Operators generated using the Operator SDK, the following helper diff --git a/modules/osdk-monitoring-prometheus-operator-support.adoc b/modules/osdk-monitoring-prometheus-operator-support.adoc index f91aa16124..a402bfa177 100644 --- a/modules/osdk-monitoring-prometheus-operator-support.adoc +++ b/modules/osdk-monitoring-prometheus-operator-support.adoc @@ -3,7 +3,7 @@ // * applications/operator_sdk/osdk-getting-started.adoc // * applications/operator_sdk/osdk-monitoring-prometheus.adoc -[id='osdk-monitoring-prometheus-operator-support-{context}'] +[id="osdk-monitoring-prometheus-operator-support-{context}"] = Prometheus Operator support link:https://prometheus.io/[Prometheus] is an open-source systems monitoring and diff --git a/modules/osdk-monitoring-prometheus-servicemonitor-creating.adoc b/modules/osdk-monitoring-prometheus-servicemonitor-creating.adoc index 9844ab43a1..49f1ef6349 100644 --- a/modules/osdk-monitoring-prometheus-servicemonitor-creating.adoc +++ b/modules/osdk-monitoring-prometheus-servicemonitor-creating.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-monitoring-prometheus.adoc -[id='osdk-monitoring-prometheus-servicemonitor-creating-{context}'] +[id="osdk-monitoring-prometheus-servicemonitor-creating-{context}"] = Creating ServiceMonitor resources Operator authors can add Service target discovery of created monitoring Services diff --git a/modules/osdk-monitoring-prometheus-servicemonitor.adoc b/modules/osdk-monitoring-prometheus-servicemonitor.adoc index d0638672e0..77fc6d2592 100644 --- a/modules/osdk-monitoring-prometheus-servicemonitor.adoc +++ b/modules/osdk-monitoring-prometheus-servicemonitor.adoc @@ -2,7 +2,7 @@ // // * applications/operator_sdk/osdk-monitoring-prometheus.adoc -[id='osdk-monitoring-prometheus-servicemonitor-{context}'] +[id="osdk-monitoring-prometheus-servicemonitor-{context}"] = ServiceMonitor resources A ServiceMonitor is a Custom Resource Definition (CRD) provided by the diff --git a/modules/osdk-project-staffolding-layout.adoc b/modules/osdk-project-staffolding-layout.adoc index 7c46e50062..f8b9ca6388 100644 --- a/modules/osdk-project-staffolding-layout.adoc +++ b/modules/osdk-project-staffolding-layout.adoc @@ -2,14 +2,14 @@ // // * applications/operator_sdk/osdk-appendices.adoc -[id='osdk-project-scaffolding-layout-{context}'] +[id="osdk-project-scaffolding-layout-{context}"] = Operator project scaffolding layout The `operator-sdk` CLI generates a number of packages for each Operator project. The following sections describes a basic rundown of each generated file and directory. -[id='osdk-project-scaffolding-layout-go-{context}'] +[id="osdk-project-scaffolding-layout-go-{context}"] == Go-based projects Go-based Operator projects (the default type) generated using the `operator-sdk new` @@ -58,7 +58,7 @@ vendor directly. |=== -[id='osdk-project-scaffolding-layout-helm-{context}'] +[id="osdk-project-scaffolding-layout-helm-{context}"] == Helm-based projects Helm-based Operator projects generated using the `operator-sdk new --type helm` diff --git a/modules/pod-using-a-different-service-account.adoc b/modules/pod-using-a-different-service-account.adoc index 401c953c78..657aca1e47 100644 --- a/modules/pod-using-a-different-service-account.adoc +++ b/modules/pod-using-a-different-service-account.adoc @@ -2,7 +2,7 @@ // // * orphaned -[id='pod-using-a-different-service-account-{context}'] +[id="pod-using-a-different-service-account-{context}"] = Running a pod with a different service account You can run a pod with a service account other than the default: diff --git a/modules/prometheus-database-storage-requirements.adoc b/modules/prometheus-database-storage-requirements.adoc index 944bc9d9f2..48b7a408af 100644 --- a/modules/prometheus-database-storage-requirements.adoc +++ b/modules/prometheus-database-storage-requirements.adoc @@ -3,7 +3,7 @@ // * scalability_and_performance/scaling-cluster-monitoring-operator.adoc // * installing-byoh/installing-existing-hosts.adoc -[id='prometheus-database-storage-requirements-{context}'] +[id="prometheus-database-storage-requirements-{context}"] = Prometheus database storage requirements Red Hat performed various tests for different scale sizes. diff --git a/modules/pruning-basic-operations.adoc b/modules/pruning-basic-operations.adoc index ef9dbed6e2..85fa273d6f 100644 --- a/modules/pruning-basic-operations.adoc +++ b/modules/pruning-basic-operations.adoc @@ -2,7 +2,7 @@ // // * applications/pruning-objects.adoc -[id='pruning-basic-operations-{context}'] +[id="pruning-basic-operations-{context}"] = Basic pruning operations The CLI groups prune operations under a common parent command: diff --git a/modules/pruning-builds.adoc b/modules/pruning-builds.adoc index a52e8b5217..0baaf7a63a 100644 --- a/modules/pruning-builds.adoc +++ b/modules/pruning-builds.adoc @@ -2,7 +2,7 @@ // // * applications/pruning-objects.adoc -[id='pruning-builds-{context}'] +[id="pruning-builds-{context}"] = Pruning builds In order to prune builds that are no longer required by the system due to age diff --git a/modules/pruning-cronjobs.adoc b/modules/pruning-cronjobs.adoc index a87f496e49..690c2d4b08 100644 --- a/modules/pruning-cronjobs.adoc +++ b/modules/pruning-cronjobs.adoc @@ -2,7 +2,7 @@ // // * applications/pruning-objects.adoc -[id='pruning-cronjobs-{context}'] +[id="pruning-cronjobs-{context}"] = Pruning cron jobs Cron jobs can perform pruning of successful jobs, but might not properly handle diff --git a/modules/pruning-deployments.adoc b/modules/pruning-deployments.adoc index 88a0fcde3c..e069c5deda 100644 --- a/modules/pruning-deployments.adoc +++ b/modules/pruning-deployments.adoc @@ -2,7 +2,7 @@ // // * applications/pruning-objects.adoc -[id='pruning-deployments-{context}'] +[id="pruning-deployments-{context}"] = Pruning deployments In order to prune deployments that are no longer required by the system due to diff --git a/modules/pruning-groups.adoc b/modules/pruning-groups.adoc index bbdf161366..605bcade0a 100644 --- a/modules/pruning-groups.adoc +++ b/modules/pruning-groups.adoc @@ -2,7 +2,7 @@ // // * applications/pruning-objects.adoc -[id='pruning-groups-{context}'] +[id="pruning-groups-{context}"] = Pruning groups To prune groups records from an external provider, administrators can run the diff --git a/modules/pruning-hard-pruning-registry.adoc b/modules/pruning-hard-pruning-registry.adoc index 398f464c82..15a817da84 100644 --- a/modules/pruning-hard-pruning-registry.adoc +++ b/modules/pruning-hard-pruning-registry.adoc @@ -2,7 +2,7 @@ // // * applications/pruning-objects.adoc -[id='pruning-hard-pruning-registry-{context}'] +[id="pruning-hard-pruning-registry-{context}"] = Hard pruning the registry The OpenShift Container Registry can accumulate blobs that are not referenced by diff --git a/modules/pruning-images.adoc b/modules/pruning-images.adoc index d6016378e7..a183735f64 100644 --- a/modules/pruning-images.adoc +++ b/modules/pruning-images.adoc @@ -2,7 +2,7 @@ // // * applications/pruning-objects.adoc -[id='pruning-images-{context}'] +[id="pruning-images-{context}"] = Pruning images In order to prune images that are no longer required by the system due to age, @@ -102,7 +102,7 @@ intend to do that separately by hard pruning the registry, possibly during an appropriate maintenance window for the registry. |=== -[id='pruning-images-conditions-{context}'] +[id="pruning-images-conditions-{context}"] == Image prune conditions * Remove any image "managed by {product-title}" (images with the annotation @@ -159,7 +159,7 @@ for images previously pruned by `--prune-registry=false`. Any images that were pruned with `--prune-registry=false` can only be deleted from registry storage by hard pruning the registry. -[id='pruning-images-running-operation-{context}'] +[id="pruning-images-running-operation-{context}"] == Running the image prune operation .Procedure @@ -189,7 +189,7 @@ $ oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm $ oc adm prune images --prune-over-size-limit --confirm ---- -[id='pruning-images-secure-insecure-{context}'] +[id="pruning-images-secure-insecure-{context}"] == Using secure or insecure connections The secure connection is the preferred and recommended approach. It is done over @@ -216,11 +216,11 @@ used by {product-title}, it must be specified using the error. ==== -[id='pruning-images-problems-{context}'] +[id="pruning-images-problems-{context}"] == Image pruning problems [discrete] -[id='pruning-images-not-being-pruned-{context}'] +[id="pruning-images-not-being-pruned-{context}"] ==== Images not being pruned If your images keep accumulating and the `prune` command removes just a small @@ -271,7 +271,7 @@ Such tags tend to have just one image in its history, which effectively prevents them from ever being pruned. [discrete] -[id='pruning-images-secure-against-insecure-{context}'] +[id="pruning-images-secure-against-insecure-{context}"] ==== Using a secure connection against insecure registry If you see a message similar to the following in the output of the `oadm prune @@ -287,7 +287,7 @@ client to use an insecure connection by appending `--force-insecure` to the command, however this is not recommended. [discrete] -[id='pruning-images-insecure-against-secure-{context}'] +[id="pruning-images-insecure-against-secure-{context}"] ==== Using an insecure connection against a secured registry If you see one of the following errors in the output of the `oadm prune images` @@ -307,7 +307,7 @@ Use the `--certificate-authority` option to provide the right certificate authority for the container image registry server. [discrete] -[id='pruning-images-wrong-ca-{context}'] +[id="pruning-images-wrong-ca-{context}"] ==== Using the wrong certificate authority The following error means that the certificate authority used to sign the diff --git a/modules/quotas-configuring-quota-sync-period.adoc b/modules/quotas-configuring-quota-sync-period.adoc index 14163ed034..9c5c3f3681 100644 --- a/modules/quotas-configuring-quota-sync-period.adoc +++ b/modules/quotas-configuring-quota-sync-period.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quotas-configuring-quota-sync-period-{context}'] +[id="quotas-configuring-quota-sync-period-{context}"] = Configuring quota synchronization period When a set of resources are deleted, but before quota usage is restored, a user diff --git a/modules/quotas-creating-a-quota.adoc b/modules/quotas-creating-a-quota.adoc index 798d865e29..7cb6110a74 100644 --- a/modules/quotas-creating-a-quota.adoc +++ b/modules/quotas-creating-a-quota.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quotas-creating-a-quota'] +[id="quotas-creating-a-quota-{context}"] = Creating a quota You can create a quota to constrain resource usage in a given project. diff --git a/modules/quotas-creating-object-count-quotas.adoc b/modules/quotas-creating-object-count-quotas.adoc index e79d5e7299..f71ccd8ab2 100644 --- a/modules/quotas-creating-object-count-quotas.adoc +++ b/modules/quotas-creating-object-count-quotas.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quota-creating-object-count-quotas-{context}'] +[id="quota-creating-object-count-quotas-{context}"] = Creating object count quotas You can create an object count quota for all {product-title} standard namespaced diff --git a/modules/quotas-enforcement.adoc b/modules/quotas-enforcement.adoc index c2ccee4533..060a72749f 100644 --- a/modules/quotas-enforcement.adoc +++ b/modules/quotas-enforcement.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quota-enforcement-{context}'] +[id="quota-enforcement-{context}"] = Quota enforcement After a resource quota for a project is first created, the project restricts the diff --git a/modules/quotas-requests-vs-limits.adoc b/modules/quotas-requests-vs-limits.adoc index a78abb538c..7bdea10f95 100644 --- a/modules/quotas-requests-vs-limits.adoc +++ b/modules/quotas-requests-vs-limits.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quotas-requests-vs-limits'] +[id="quotas-requests-vs-limits-{context}"] = Requests versus limits When allocating compute resources, each container might specify a request and a diff --git a/modules/quotas-requiring-explicit-quota.adoc b/modules/quotas-requiring-explicit-quota.adoc index 463f938d49..d85dda34e4 100644 --- a/modules/quotas-requiring-explicit-quota.adoc +++ b/modules/quotas-requiring-explicit-quota.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quota-requiring-explicit-quota-{context}'] +[id="quota-requiring-explicit-quota-{context}"] = Requiring explicit quota to consume a resource If a resource is not managed by quota, a user has no restriction on the amount diff --git a/modules/quotas-resources-managed.adoc b/modules/quotas-resources-managed.adoc index bc1871dd6a..119230d510 100644 --- a/modules/quotas-resources-managed.adoc +++ b/modules/quotas-resources-managed.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quotas-resources-managed-{context}'] +[id="quotas-resources-managed-{context}"] = Resources managed by quotas The following describes the set of compute resources and object types that can @@ -90,7 +90,7 @@ that have a matching storage class, cannot exceed this value. can exist in the project. |=== -[id='quotas-object-counts-managed-{context}'] +[id="quotas-object-counts-managed-{context}"] .Object counts managed by quota [cols="3a,8a",options="header"] |=== diff --git a/modules/quotas-sample-resource-quotas-def.adoc b/modules/quotas-sample-resource-quotas-def.adoc index 54063b2234..a547ceee1a 100644 --- a/modules/quotas-sample-resource-quotas-def.adoc +++ b/modules/quotas-sample-resource-quotas-def.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quotas-sample-resource-quota-definitions'] +[id="quotas-sample-resource-quota-definitions-{context}"] = Sample resource quota definitions .`core-object-counts.yaml` diff --git a/modules/quotas-scopes.adoc b/modules/quotas-scopes.adoc index 6ad64b6499..bb80267ee0 100644 --- a/modules/quotas-scopes.adoc +++ b/modules/quotas-scopes.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quotas-scopes-{context}'] +[id="quotas-scopes-{context}"] = Quota scopes Each quota can have an associated set of _scopes_. A quota only measures usage diff --git a/modules/quotas-selecting-projects.adoc b/modules/quotas-selecting-projects.adoc index aa6fec9b4b..4c7538952d 100644 --- a/modules/quotas-selecting-projects.adoc +++ b/modules/quotas-selecting-projects.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-across-multiple-projects.adoc -[id='quotas-setting-projects-{context}'] +[id="quotas-setting-projects-{context}"] = Selecting multiple projects during quota creation When creating quotas, you can select multiple projects based on annotation diff --git a/modules/quotas-selection-granularity.adoc b/modules/quotas-selection-granularity.adoc index 796bfdbbc8..9164f351a5 100644 --- a/modules/quotas-selection-granularity.adoc +++ b/modules/quotas-selection-granularity.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-across-multiple-projects.adoc -[id='quotas-selection-granularity-{context}'] +[id="quotas-selection-granularity-{context}"] = Selection granularity Because of the locking consideration when claiming quota allocations, the number of diff --git a/modules/quotas-viewing-clusterresourcequotas.adoc b/modules/quotas-viewing-clusterresourcequotas.adoc index ad9b8eff57..3bda6dfd64 100644 --- a/modules/quotas-viewing-clusterresourcequotas.adoc +++ b/modules/quotas-viewing-clusterresourcequotas.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-across-multiple-projects.adoc -[id='quotas-viewing-clusterresourcequotas-{context}'] +[id="quotas-viewing-clusterresourcequotas-{context}"] = Viewing applicable ClusterResourceQuotas A project administrator is not allowed to create or modify the multi-project diff --git a/modules/quotas-viewing-quotas.adoc b/modules/quotas-viewing-quotas.adoc index f5e8a69879..326130898d 100644 --- a/modules/quotas-viewing-quotas.adoc +++ b/modules/quotas-viewing-quotas.adoc @@ -2,7 +2,7 @@ // // * applications/quotas/quotas-setting-per-project.adoc -[id='quota-viewing-quotas-{context}'] +[id="quota-viewing-quotas-{context}"] = Viewing a quota You can view usage statistics related to any hard limits defined in a project's diff --git a/modules/rbac-adding-roles.adoc b/modules/rbac-adding-roles.adoc index ffd14cfc35..715b16b65e 100644 --- a/modules/rbac-adding-roles.adoc +++ b/modules/rbac-adding-roles.adoc @@ -2,7 +2,7 @@ // // * authentication/using-rbac.adoc -[id='adding-roles-{context}'] +[id="adding-roles-{context}"] = Adding roles to users You can use the `oc adm` administrator CLI to manage the roles and bindings. diff --git a/modules/rbac-api-authentication.adoc b/modules/rbac-api-authentication.adoc index 964da7f2b3..c357938f4f 100644 --- a/modules/rbac-api-authentication.adoc +++ b/modules/rbac-api-authentication.adoc @@ -1,4 +1,4 @@ -[id='rbac-api-authentication-{context}'] +[id="rbac-api-authentication-{context}"] = API authentication Requests to the {product-title} API are authenticated using the following methods: diff --git a/modules/rbac-cluster-role-binding-commands.adoc b/modules/rbac-cluster-role-binding-commands.adoc index f65dfdcac2..4752206b3f 100644 --- a/modules/rbac-cluster-role-binding-commands.adoc +++ b/modules/rbac-cluster-role-binding-commands.adoc @@ -4,7 +4,7 @@ ifdef::openshift-enterprise,openshift-origin[] -[id='cluster-role-binding-commands-{context}'] +[id="cluster-role-binding-commands-{context}"] = Cluster role binding commands You can also manage cluster role bindings using the following diff --git a/modules/rbac-creating-cluster-role.adoc b/modules/rbac-creating-cluster-role.adoc index 02cb32d5a3..1279a0926c 100644 --- a/modules/rbac-creating-cluster-role.adoc +++ b/modules/rbac-creating-cluster-role.adoc @@ -3,7 +3,7 @@ // * authentication/using-rbac.adoc ifdef::openshift-enterprise,openshift-origin[] -[id='creating-cluster-role-{context}'] +[id="creating-cluster-role-{context}"] = Creating a cluster role You can create a cluster role. diff --git a/modules/rbac-creating-local-role.adoc b/modules/rbac-creating-local-role.adoc index 8926d906ac..0ab53851d6 100644 --- a/modules/rbac-creating-local-role.adoc +++ b/modules/rbac-creating-local-role.adoc @@ -3,7 +3,7 @@ // * authentication/using-rbac.adoc ifdef::openshift-enterprise,openshift-origin[] -[id='creating-local-role-{context}'] +[id="creating-local-role-{context}"] = Creating a local role You can create a local role for a project and then bind it to a user. diff --git a/modules/rbac-default-projects.adoc b/modules/rbac-default-projects.adoc index 7058ff940d..e0219d9237 100644 --- a/modules/rbac-default-projects.adoc +++ b/modules/rbac-default-projects.adoc @@ -2,7 +2,7 @@ // // * authentication/using-rbac.adoc -[id='rbac-default-projects-{context}'] +[id="rbac-default-projects-{context}"] = Default projects {product-title} comes with a number of default projects, and projects diff --git a/modules/rbac-groups.adoc b/modules/rbac-groups.adoc index eaddfe28c3..1ecd06704f 100644 --- a/modules/rbac-groups.adoc +++ b/modules/rbac-groups.adoc @@ -2,7 +2,7 @@ // // * authentication/understanding-authentication.adoc -[id='rbac-groups-{context}'] +[id="rbac-groups-{context}"] = Groups A user can be assigned to one or more _groups_, each of which represent a diff --git a/modules/rbac-local-role-binding-commands.adoc b/modules/rbac-local-role-binding-commands.adoc index e726b0aa2f..06b07a6497 100644 --- a/modules/rbac-local-role-binding-commands.adoc +++ b/modules/rbac-local-role-binding-commands.adoc @@ -2,7 +2,7 @@ // // * authentication/using-rbac.adoc -[id='local-role-binding-commands-{context}'] +[id="local-role-binding-commands-{context}"] = Local role binding commands When you manage a user or group's associated roles for local role bindings using the diff --git a/modules/rbac-overview.adoc b/modules/rbac-overview.adoc index 9b50fad0c2..c65c0593a8 100644 --- a/modules/rbac-overview.adoc +++ b/modules/rbac-overview.adoc @@ -2,7 +2,7 @@ // // * authentication/using-rbac.adoc -[id='authorization-overview-{context}'] +[id="authorization-overview-{context}"] = RBAC overview Role-based access control (RBAC) objects determine whether a user is allowed to @@ -66,7 +66,7 @@ For example: . Deny by default. -[id='default-roles-{context}'] +[id="default-roles-{context}"] == Default cluster roles {product-title} includes a set of default cluster roles that you can bind to @@ -134,7 +134,7 @@ local role bindings, users, groups and service accounts are illustrated below. image::rbac.png[{product-title} RBAC] -[id='evaluating-authorization-{context}'] +[id="evaluating-authorization-{context}"] == Evaluating authorization {product-title} evaluates authorization by using: @@ -192,7 +192,7 @@ the cluster level or at the project level. endif::openshift-origin,openshift-enterprise,openshift-dedicated[] ifdef::openshift-enterprise,openshift-origin[] -[id='cluster-role-aggregations-{context}'] +[id="cluster-role-aggregations-{context}"] === Cluster Role Aggregation The default admin, edit, view, and cluster-reader cluster roles support link:https://kubernetes.io/docs/admin/authorization/rbac/#aggregated-clusterroles[cluster role aggregation], diff --git a/modules/rbac-projects-namespaces.adoc b/modules/rbac-projects-namespaces.adoc index e5da1e2815..be5f0295b9 100644 --- a/modules/rbac-projects-namespaces.adoc +++ b/modules/rbac-projects-namespaces.adoc @@ -2,7 +2,7 @@ // // * authentication/using-rbac.adoc -[id='rbac-projects-namespaces-{context}'] +[id="rbac-projects-namespaces-{context}"] = Projects and namespaces A Kubernetes _namespace_ provides a mechanism to scope resources in a cluster. diff --git a/modules/rbac-updating-policy-definitions.adoc b/modules/rbac-updating-policy-definitions.adoc index a7571e0174..da55d7fb10 100644 --- a/modules/rbac-updating-policy-definitions.adoc +++ b/modules/rbac-updating-policy-definitions.adoc @@ -3,7 +3,7 @@ // * orphaned ifdef::openshift-enterprise,openshift-origin[] -[id='updating-policy-definitions-{context}'] +[id="updating-policy-definitions-{context}"] = Updating policy definitions During a cluster upgrade, and on every restart of any master, the diff --git a/modules/rbac-users.adoc b/modules/rbac-users.adoc index ccf74670c9..7c293d5a88 100644 --- a/modules/rbac-users.adoc +++ b/modules/rbac-users.adoc @@ -2,7 +2,7 @@ // // * authentication/understanding-authentication.adoc -[id='rbac-users-{context}'] +[id="rbac-users-{context}"] = Users A _user_ in {product-title} is an entity that can make requests to the diff --git a/modules/rbac-viewing-cluster-roles.adoc b/modules/rbac-viewing-cluster-roles.adoc index 0c6677cfe0..485ef00104 100644 --- a/modules/rbac-viewing-cluster-roles.adoc +++ b/modules/rbac-viewing-cluster-roles.adoc @@ -2,7 +2,7 @@ // // * authentication/using-rbac.adoc -[id='viewing-cluster-roles-{context}'] +[id="viewing-cluster-roles-{context}"] = Viewing cluster roles and bindings You can use the `oc` CLI to view cluster roles and bindings by using the diff --git a/modules/rbac-viewing-local-roles.adoc b/modules/rbac-viewing-local-roles.adoc index b1ad991705..d31d2e1ee3 100644 --- a/modules/rbac-viewing-local-roles.adoc +++ b/modules/rbac-viewing-local-roles.adoc @@ -2,7 +2,7 @@ // // * authentication/using-rbac.adoc -[id='viewing-local-roles-{context}'] +[id="viewing-local-roles-{context}"] = Viewing local roles and bindings You can use the `oc` CLI to view local roles and bindings by using the diff --git a/modules/recommended-configurable-storage-technology.adoc b/modules/recommended-configurable-storage-technology.adoc index e7c054b5d8..9ae27678d9 100644 --- a/modules/recommended-configurable-storage-technology.adoc +++ b/modules/recommended-configurable-storage-technology.adoc @@ -14,7 +14,7 @@ ifdef::openshift-enterprise[] :gluster-install-link: https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/html/installation_guide/ :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/ -[id='recommended-configurable-storage-technology-{context}'] +[id="recommended-configurable-storage-technology-{context}"] = Recommended configurable storage technology The following table summarizes the recommended and configurable storage diff --git a/modules/registry-accessing-directly.adoc b/modules/registry-accessing-directly.adoc index d98623bce2..30770cd22e 100644 --- a/modules/registry-accessing-directly.adoc +++ b/modules/registry-accessing-directly.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-accessing-directly-{context}'] +[id="registry-accessing-directly-{context}"] = Accessing registry directly You can access the registry directly to invoke `podman` commands. This allows diff --git a/modules/registry-accessing-metrics.adoc b/modules/registry-accessing-metrics.adoc index fbbd63ae65..6b3084ef27 100644 --- a/modules/registry-accessing-metrics.adoc +++ b/modules/registry-accessing-metrics.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-accessing-metrics-{context}'] +[id="registry-accessing-metrics-{context}"] = Accessing registry metrics The OpenShift Container Registry provides an endpoint for diff --git a/modules/registry-authentication-enabled-registry-overview.adoc b/modules/registry-authentication-enabled-registry-overview.adoc index b6f148bc96..9480ced05c 100644 --- a/modules/registry-authentication-enabled-registry-overview.adoc +++ b/modules/registry-authentication-enabled-registry-overview.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-authentication-enabled-registry-overview-{context}'] +[id="registry-authentication-enabled-registry-overview-{context}"] = Authentication enabled Red Hat registry All container images available through the Red Hat Container Catalog are hosted diff --git a/modules/registry-exposing-non-secure-registry-manually.adoc b/modules/registry-exposing-non-secure-registry-manually.adoc index 3162ef0b93..f8f48eb9b6 100644 --- a/modules/registry-exposing-non-secure-registry-manually.adoc +++ b/modules/registry-exposing-non-secure-registry-manually.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-exposing-non-secure-registry-manually-{context}'] +[id="registry-exposing-non-secure-registry-manually-{context}"] = Exposing a non-secure registry manually Instead of securing the registry in order to expose the registry, you can simply diff --git a/modules/registry-exposing-secure-registry-manually.adoc b/modules/registry-exposing-secure-registry-manually.adoc index 95f69303ce..49faea8f02 100644 --- a/modules/registry-exposing-secure-registry-manually.adoc +++ b/modules/registry-exposing-secure-registry-manually.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-exposing-secure-registry-manually-{context}'] +[id="registry-exposing-secure-registry-manually-{context}"] = Exposing a secure registry manually Instead of logging in to the {product-title} registry from within the diff --git a/modules/registry-integrated-openshift-registry.adoc b/modules/registry-integrated-openshift-registry.adoc index a2f1665b09..6541de3043 100644 --- a/modules/registry-integrated-openshift-registry.adoc +++ b/modules/registry-integrated-openshift-registry.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-integrated-openshift-registry-{context}'] +[id="registry-integrated-openshift-registry-{context}"] = Integrated {product-title} registry {product-title} provides an integrated container image registry called diff --git a/modules/registry-quay-overview.adoc b/modules/registry-quay-overview.adoc index 4d223c0de5..9f003c8f02 100644 --- a/modules/registry-quay-overview.adoc +++ b/modules/registry-quay-overview.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-quay-overview-{context}'] +[id="registry-quay-overview-{context}"] = Red Hat Quay registries If you need an enterprise-quality container image registry, Red Hat Quay is diff --git a/modules/registry-securing-manually.adoc b/modules/registry-securing-manually.adoc index ef7e5277a9..9259e6217d 100644 --- a/modules/registry-securing-manually.adoc +++ b/modules/registry-securing-manually.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-securing-manually-{context}'] +[id="registry-securing-manually-{context}"] = Securing the registry manually If for any reason your registry has not been secured, see the following diff --git a/modules/registry-third-party-registries.adoc b/modules/registry-third-party-registries.adoc index 59e6bb77af..2caaf99032 100644 --- a/modules/registry-third-party-registries.adoc +++ b/modules/registry-third-party-registries.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-third-party-registries-{context}'] +[id="registry-third-party-registries-{context}"] = Third party registries {product-title} can create containers using images from third party registries, diff --git a/modules/registry-viewing-contents.adoc b/modules/registry-viewing-contents.adoc index 30531c7c8f..2384368fc9 100644 --- a/modules/registry-viewing-contents.adoc +++ b/modules/registry-viewing-contents.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-viewing-contents-{context}'] +[id="registry-viewing-contents-{context}"] = Viewing the registry's contents Tag and image metadata is stored in {product-title}, but the registry stores diff --git a/modules/registry-viewing-logs.adoc b/modules/registry-viewing-logs.adoc index 061b614c78..39267aa5fa 100644 --- a/modules/registry-viewing-logs.adoc +++ b/modules/registry-viewing-logs.adoc @@ -2,7 +2,7 @@ // // * assembly/registry -[id='registry-viewing-logs-{context}'] +[id="registry-viewing-logs-{context}"] = Viewing registry logs You can view the logs for the registry by using the `oc logs` command. diff --git a/modules/router-performance-optimizations.adoc b/modules/router-performance-optimizations.adoc index 2c503ae2ed..842a6e7329 100644 --- a/modules/router-performance-optimizations.adoc +++ b/modules/router-performance-optimizations.adoc @@ -1,4 +1,4 @@ -[id='router-performance-optimizations-{context}'] +[id="router-performance-optimizations-{context}"] = Router performance optimizations *Setting the maximum number of connections* diff --git a/modules/running-cluster-loader.adoc b/modules/running-cluster-loader.adoc index 766d5942e4..bd60af7ed0 100644 --- a/modules/running-cluster-loader.adoc +++ b/modules/running-cluster-loader.adoc @@ -2,7 +2,7 @@ // // scalability_and_performance/using-cluster-loader.adoc -[id='running_cluster_loader-{context}'] +[id="running_cluster_loader-{context}"] = Running Cluster Loader .Procedure diff --git a/modules/samples-operator-configuration.adoc b/modules/samples-operator-configuration.adoc index 892c9a1063..3d8720d00a 100644 --- a/modules/samples-operator-configuration.adoc +++ b/modules/samples-operator-configuration.adoc @@ -4,7 +4,7 @@ // * openshift_images/configuring_samples_operator.adoc -[id='samples-operator-configuration-{context}'] +[id="samples-operator-configuration-{context}"] = Samples Operator configuration The samples resource offers the following configuration fields: diff --git a/modules/samples-operator-overview.adoc b/modules/samples-operator-overview.adoc index 892b1a17f9..d0692aa076 100644 --- a/modules/samples-operator-overview.adoc +++ b/modules/samples-operator-overview.adoc @@ -4,7 +4,7 @@ // * openshift_images/configuring_samples_operator.adoc -[id='samples-operator-overview-{context}'] +[id="samples-operator-overview-{context}"] = Understanding the Samples Operator On initial startup, the operator creates the default configuration object for diff --git a/modules/sb-about-ansible-service-broker.adoc b/modules/sb-about-ansible-service-broker.adoc index 0445445277..964c9047c1 100644 --- a/modules/sb-about-ansible-service-broker.adoc +++ b/modules/sb-about-ansible-service-broker.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/installing-ansible-service-broker.adoc -[id='sb-about-ansible-service-broker-{context}'] +[id="sb-about-ansible-service-broker-{context}"] = About the {asb-name} The _{asb-name}_ is an implementation of the Open Service Broker (OSB) API that @@ -25,7 +25,7 @@ method on the APB. The {asb-name} is not installed by default in {product-title} 4. -[id='sb-ansible-playbook-bundles-{context}'] +[id="sb-ansible-playbook-bundles-{context}"] == Ansible playbook bundles An Ansible playbook bundle (APB) is a lightweight application definition that diff --git a/modules/sb-about-service-catalog.adoc b/modules/sb-about-service-catalog.adoc index 3ee2d0c133..18ccc8ed82 100644 --- a/modules/sb-about-service-catalog.adoc +++ b/modules/sb-about-service-catalog.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/installing-service-catalog.adoc -[id='sb-about-service-catalog-{context}'] +[id="sb-about-service-catalog-{context}"] = About the service catalog When developing microservices-based applications to run on cloud native diff --git a/modules/sb-about-template-service-broker.adoc b/modules/sb-about-template-service-broker.adoc index 416797625b..e4aa5f2b80 100644 --- a/modules/sb-about-template-service-broker.adoc +++ b/modules/sb-about-template-service-broker.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/installing-template-service-broker.adoc -[id='sb-about-template-service-broker-{context}'] +[id="sb-about-template-service-broker-{context}"] = About the template service broker The _template service broker_ gives the service catalog visibility into the diff --git a/modules/sb-configuring-ansible-service-broker-options.adoc b/modules/sb-configuring-ansible-service-broker-options.adoc index 2413371ae9..f89abbfb8e 100644 --- a/modules/sb-configuring-ansible-service-broker-options.adoc +++ b/modules/sb-configuring-ansible-service-broker-options.adoc @@ -3,7 +3,7 @@ // * applications/service_brokers/installing-ansible-service-broker.adoc // * applications/service_brokers/configuring-ansible-service-broker.adoc -[id='sb-ansible-service-broker-config-options-{context}'] +[id="sb-ansible-service-broker-config-options-{context}"] = {asb-name} configuration options You can set the following options for your {asb-name}. @@ -79,7 +79,7 @@ You can set the following options for your {asb-name}. |=== -[id='sb-default-registries-array-{context}'] +[id="sb-default-registries-array-{context}"] .Default array for `registries` [source,yaml] ---- diff --git a/modules/sb-configuring-ansible-service-broker.adoc b/modules/sb-configuring-ansible-service-broker.adoc index 3b1de850b1..df5098fb26 100644 --- a/modules/sb-configuring-ansible-service-broker.adoc +++ b/modules/sb-configuring-ansible-service-broker.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/installing-ansible-service-broker.adoc -[id='sb-configuring-ansible-service-broker-{context}'] +[id="sb-configuring-ansible-service-broker-{context}"] = Configuring the {asb-name} The following procedure customizes the settings for your {asb-name}. diff --git a/modules/sb-install-asb-operator.adoc b/modules/sb-install-asb-operator.adoc index 510c4179c5..7c9cce2156 100644 --- a/modules/sb-install-asb-operator.adoc +++ b/modules/sb-install-asb-operator.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/installing-ansible-service-broker.adoc -[id='sb-install-asb-operator-{context}'] +[id="sb-install-asb-operator-{context}"] = Installing the {asb-name} Operator .Prerequisites diff --git a/modules/sb-install-service-catalog.adoc b/modules/sb-install-service-catalog.adoc index 4a3d6b99ea..b38438ca85 100644 --- a/modules/sb-install-service-catalog.adoc +++ b/modules/sb-install-service-catalog.adoc @@ -2,8 +2,8 @@ // // * applications/service_brokers/installing-service-catalog.adoc -[id='sb-install-service-catalog-{context}'] -= Installing the service catalog +[id="sb-install-service-catalog-{context}"] += Installing service catalog You must install the service catalog by completing the following steps if you plan on using any of the services from the {asb-name} or template service broker. diff --git a/modules/sb-install-tsb-operator.adoc b/modules/sb-install-tsb-operator.adoc index 3092687591..41794fe4bd 100644 --- a/modules/sb-install-tsb-operator.adoc +++ b/modules/sb-install-tsb-operator.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/installing-template-service-broker.adoc -[id='sb-install-tsb-operator-{context}'] +[id="sb-install-tsb-operator-{context}"] = Installing the template service broker Operator .Prerequisites diff --git a/modules/sb-provision-service-bundle.adoc b/modules/sb-provision-service-bundle.adoc index d4a33b1a86..1301968386 100644 --- a/modules/sb-provision-service-bundle.adoc +++ b/modules/sb-provision-service-bundle.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/provisioning-service-bundle.adoc -[id='sb-provision-service-bundle-{context}'] +[id="sb-provision-service-bundle-{context}"] = Provisioning service bundles The following procedure provisions an example PostgreSQL service bundle (APB) diff --git a/modules/sb-provision-template-application.adoc b/modules/sb-provision-template-application.adoc index 68a228375c..dff95406f7 100644 --- a/modules/sb-provision-template-application.adoc +++ b/modules/sb-provision-template-application.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/provisioning-template-application-bundle.adoc -[id='sb-provision-template-application-{context}'] +[id="sb-provision-template-application-{context}"] = Provisioning template applications The following procedure provisions an example PostgreSQL template application diff --git a/modules/sb-start-asb.adoc b/modules/sb-start-asb.adoc index 56082f1d03..212b682bf1 100644 --- a/modules/sb-start-asb.adoc +++ b/modules/sb-start-asb.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/installing-ansible-service-broker.adoc -[id='sb-start-asb-{context}'] +[id="sb-start-asb-{context}"] = Starting the {asb-name} After you have installed the {asb-name} Operator, you can start the {asb-name} diff --git a/modules/sb-start-tsb.adoc b/modules/sb-start-tsb.adoc index 59b3feff92..1474bab7b9 100644 --- a/modules/sb-start-tsb.adoc +++ b/modules/sb-start-tsb.adoc @@ -2,7 +2,7 @@ // // * applications/service_brokers/installing-template-service-broker.adoc -[id='sb-start-tsb-{context}'] +[id="sb-start-tsb-{context}"] = Starting the template service broker After you have installed the template service broker Operator, you can start the diff --git a/modules/scaling-prometheus-components.adoc b/modules/scaling-prometheus-components.adoc index cf1570dba7..ba65145b2f 100644 --- a/modules/scaling-prometheus-components.adoc +++ b/modules/scaling-prometheus-components.adoc @@ -2,7 +2,7 @@ // // scalability_and_performance/scaling-cluster-monitoring-operator.adoc -[id='scaling-the-prometheus-components'] +[id="scaling-the-prometheus-components-{context}"] = Scaling the Prometheus components Scale up or down the number of {product-title} Prometheus pods replicas. diff --git a/modules/security-context-constraints-about.adoc b/modules/security-context-constraints-about.adoc index bad45384d7..1a496f8f01 100644 --- a/modules/security-context-constraints-about.adoc +++ b/modules/security-context-constraints-about.adoc @@ -2,7 +2,7 @@ // // * authentication/managing-security-context-constraints.adoc -[id='security-context-constraints-about-{context}'] +[id="security-context-constraints-about-{context}"] = About Security Context Constraints Similar to the way that RBAC resources control user access, administrators can @@ -113,7 +113,7 @@ values. |=== -[id='authorization-SCC-strategies-{context}'] +[id="authorization-SCC-strategies-{context}"] == SCC Strategies .RunAsUser @@ -151,7 +151,7 @@ pre-allocated values. Uses the minimum value of the first range as the default. Validates against the first ID in the first range. . `RunAsAny` - No default provided. Allows any `fsGroup` ID to be specified. -[id='authorization-controlling-volumes-{context}'] +[id="authorization-controlling-volumes-{context}"] == Controlling volumes The usage of specific volume types can be controlled by setting the `volumes` @@ -206,7 +206,7 @@ value will be removed from `volumes`. ==== -[id='admission-{context}'] +[id="admission-{context}"] == Admission _Admission control_ with SCCs allows for control over the creation of resources based on the capabilities granted to a user. @@ -265,7 +265,7 @@ then this field is considered valid. Note that it is possible that during validation, other SCC settings will reject other pod fields and thus cause the pod to fail. -[id='scc-prioritization-{context}'] +[id="scc-prioritization-{context}"] == SCC prioritization SCCs have a priority field that affects the ordering when attempting to diff --git a/modules/security-context-constraints-command-reference.adoc b/modules/security-context-constraints-command-reference.adoc index 8666e4689f..6a7482ba9f 100644 --- a/modules/security-context-constraints-command-reference.adoc +++ b/modules/security-context-constraints-command-reference.adoc @@ -2,7 +2,7 @@ // // * authentication/managing-security-context-constraints.adoc -[id='security-context-constraints-command-reference-{context}'] +[id="security-context-constraints-command-reference-{context}"] = Security Context Constraints reference commands You can manage SCCs in your instance as normal API objects using the CLI. @@ -26,7 +26,7 @@ SCCs, but cannot edit or delete the default SCCs. endif::openshift-dedicated[] -[id='listing-security-context-constraints-{context}'] +[id="listing-security-context-constraints-{context}"] == Listing SCCs To get a current list of SCCs: @@ -45,7 +45,7 @@ privileged true [*] RunAsAny RunAsAny RunAsAny Run restricted false [] MustRunAs MustRunAsRange MustRunAs RunAsAny false [configMap downwardAPI emptyDir persistentVolumeClaim projected secret] ---- -[id='examining-a-security-context-constraints-object-{context}'] +[id="examining-a-security-context-constraints-object-{context}"] == Examining an SCC To examine a particular SCC, use `oc get`, `oc describe`, or `oc @@ -93,7 +93,7 @@ the default SCCs. //other than priority, users, groups, labels, and annotations. ==== -[id='deleting-security-context-constraints-{context}'] +[id="deleting-security-context-constraints-{context}"] == Deleting an SCC To delete an SCC: @@ -107,7 +107,7 @@ $ oc delete scc If you delete a default SCC, it will regenerate when you restart the cluster. ==== -[id='updating-security-context-constraints-{context}'] +[id="updating-security-context-constraints-{context}"] == Updating an SCC diff --git a/modules/security-context-constraints-creating.adoc b/modules/security-context-constraints-creating.adoc index 0f8e4f8dfa..b4b69f5abd 100644 --- a/modules/security-context-constraints-creating.adoc +++ b/modules/security-context-constraints-creating.adoc @@ -2,7 +2,7 @@ // // * authentication/managing-security-context-constraints.adoc -[id='security-context-constraints-creating-{context}'] +[id="security-context-constraints-creating-{context}"] = Creating Security Context Constraints You can create a Security Context Constraint (SCC) by using the CLI. diff --git a/modules/security-context-constraints-example.adoc b/modules/security-context-constraints-example.adoc index c69cf3648c..7bceae0570 100644 --- a/modules/security-context-constraints-example.adoc +++ b/modules/security-context-constraints-example.adoc @@ -2,7 +2,7 @@ // // * authentication/managing-security-context-constraints.adoc -[id='security-context-constraints-example-{context}'] +[id="security-context-constraints-example-{context}"] = Example Security Context Constraints The following examples show the Security Context Constraint (SCC) format and diff --git a/modules/security-context-constraints-pre-allocated-values.adoc b/modules/security-context-constraints-pre-allocated-values.adoc index d1e3d9dfd8..104df053bf 100644 --- a/modules/security-context-constraints-pre-allocated-values.adoc +++ b/modules/security-context-constraints-pre-allocated-values.adoc @@ -3,7 +3,7 @@ // * authentication/managing-security-context-constraints.adoc ifdef::openshift-origin,openshift-enterprise,openshift-dedicated[] -[id='security-context-constraints-pre-allocated-values-{context}'] +[id="security-context-constraints-pre-allocated-values-{context}"] = About pre-allocated Security Context Constraints values The admission controller is aware of certain conditions in the Security Context diff --git a/modules/security-context-constraints-rbac.adoc b/modules/security-context-constraints-rbac.adoc index 64deab54d9..6b411a541b 100644 --- a/modules/security-context-constraints-rbac.adoc +++ b/modules/security-context-constraints-rbac.adoc @@ -2,7 +2,7 @@ // // * authentication/managing-security-context-constraints.adoc -[id='role-based-access-to-ssc-{context}'] +[id="role-based-access-to-ssc-{context}"] = Role-based access to Security Context Constraints You can specify SCCs as resources that are handled by RBAC. This allows diff --git a/modules/security-context-constraints-restore-defaults.adoc b/modules/security-context-constraints-restore-defaults.adoc index 8e0f14285b..f79b0d5228 100644 --- a/modules/security-context-constraints-restore-defaults.adoc +++ b/modules/security-context-constraints-restore-defaults.adoc @@ -2,7 +2,7 @@ // // * orphaned -[id='security-context-constraints-restore-defaults-{context}'] +[id="security-context-constraints-restore-defaults-{context}"] = Restoring the default Security Context Constraints If the default Security Context Constraints (SCCs) are not present when the diff --git a/modules/security-overview.adoc b/modules/security-overview.adoc index 3064df1e9e..0bea1c4564 100644 --- a/modules/security-overview.adoc +++ b/modules/security-overview.adoc @@ -2,7 +2,7 @@ // // * orphaned -[id='security-overview-{context}'] +[id="security-overview-{context}"] = Security in {product-title} The {product-title} and Kubernetes APIs authenticate users who present @@ -34,7 +34,7 @@ manage secrets for pulling and pushing images, builds, and the deployment components and also allows application code to use those secrets. endif::[] -[id='architecture-overview-tls-support-{context}'] +[id="architecture-overview-tls-support-{context}"] == TLS Support All communication channels with the REST API, as well as between master diff --git a/modules/service-accounts-adding-secrets.adoc b/modules/service-accounts-adding-secrets.adoc index 87596035b1..62f7d4251a 100644 --- a/modules/service-accounts-adding-secrets.adoc +++ b/modules/service-accounts-adding-secrets.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-managing-secrets-{context}'] +[id="service-accounts-managing-secrets-{context}"] == Managing secrets on a service account's pod In addition to providing API credentials, a pod's service account determines diff --git a/modules/service-accounts-as-oauth-clients.adoc b/modules/service-accounts-as-oauth-clients.adoc index 833d813067..7d055e8f32 100644 --- a/modules/service-accounts-as-oauth-clients.adoc +++ b/modules/service-accounts-as-oauth-clients.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts-as-oauth-client.adoc -[id='service-accounts-as-oauth-clients-{context}'] +[id="service-accounts-as-oauth-clients-{context}"] = Service accounts as OAuth clients You can use a service account as a constrained form of OAuth client. @@ -30,7 +30,7 @@ account to `true`. * `redirect_uri` must match an annotation on the service account. -[id='redirect-uris-for-service-accounts-{context}'] +[id="redirect-uris-for-service-accounts-{context}"] == Redirect URIs for Service Accounts as OAuth Clients Annotation keys must have the prefix diff --git a/modules/service-accounts-configuration-parameters.adoc b/modules/service-accounts-configuration-parameters.adoc index 0c6e68d324..f08fc88401 100644 --- a/modules/service-accounts-configuration-parameters.adoc +++ b/modules/service-accounts-configuration-parameters.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-configuration-parameters-{context}'] +[id="service-accounts-configuration-parameters-{context}"] = Service account configuration parameters You can provide values for the following service account parameters in the diff --git a/modules/service-accounts-creating.adoc b/modules/service-accounts-creating.adoc index ce8fc66e8d..252e1dfb23 100644 --- a/modules/service-accounts-creating.adoc +++ b/modules/service-accounts-creating.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-managing-{context}'] +[id="service-accounts-managing-{context}"] = Creating service accounts You can create a service account in a project and grant it permissions by diff --git a/modules/service-accounts-dedicated-admin-role.adoc b/modules/service-accounts-dedicated-admin-role.adoc index 31b3e3c5a0..4a07fe257a 100644 --- a/modules/service-accounts-dedicated-admin-role.adoc +++ b/modules/service-accounts-dedicated-admin-role.adoc @@ -3,7 +3,7 @@ // * authentication/using-service-accounts.adoc -[id='service-accounts-dedicated-admin-role-{context}'] +[id="service-accounts-dedicated-admin-role-{context}"] ifdef::openshift-dedicated[] = Service accounts in {product-title} diff --git a/modules/service-accounts-default.adoc b/modules/service-accounts-default.adoc index 9e604995c0..2c4af21815 100644 --- a/modules/service-accounts-default.adoc +++ b/modules/service-accounts-default.adoc @@ -2,13 +2,13 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-default-{context}'] +[id="service-accounts-default-{context}"] = Default service accounts Your {product-title} cluster contains default service accounts for cluster management and generates more service accounts for each project. -[id='default-cluster-service-accounts{context}'] +[id="default-cluster-service-accounts{context}"] == Default cluster service accounts Several infrastructure controllers run using service account credentials. The @@ -46,7 +46,7 @@ policyConfig: ---- //// -[id='default-service-accounts-and-roles-{context}'] +[id="default-service-accounts-and-roles-{context}"] == Default project service accounts and roles Three service accounts are automatically created in each project: diff --git a/modules/service-accounts-enabling-authentication.adoc b/modules/service-accounts-enabling-authentication.adoc index 618f22363f..4a87a1b563 100644 --- a/modules/service-accounts-enabling-authentication.adoc +++ b/modules/service-accounts-enabling-authentication.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-enabling-authentication-{context}'] +[id="service-accounts-enabling-authentication-{context}"] = Enabling service account authentication Service accounts authenticate to the API using tokens signed by a private RSA diff --git a/modules/service-accounts-granting-roles.adoc b/modules/service-accounts-granting-roles.adoc index 6f8c45e00a..a851abe0d7 100644 --- a/modules/service-accounts-granting-roles.adoc +++ b/modules/service-accounts-granting-roles.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-granting-roles-{context}'] +[id="service-accounts-granting-roles-{context}"] = Examples of granting roles to service accounts You can grant roles to service accounts in the same way that you grant roles diff --git a/modules/service-accounts-managing-secrets.adoc b/modules/service-accounts-managing-secrets.adoc index 485d25e8ab..5d7235c736 100644 --- a/modules/service-accounts-managing-secrets.adoc +++ b/modules/service-accounts-managing-secrets.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-managing-secrets-{context}'] +[id="service-accounts-managing-secrets-{context}"] = Managing allowed secrets You can use the service account's secrets in your application's pods for: diff --git a/modules/service-accounts-overview.adoc b/modules/service-accounts-overview.adoc index e9f2869f38..6022cd316f 100644 --- a/modules/service-accounts-overview.adoc +++ b/modules/service-accounts-overview.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-overview-{context}'] +[id="service-accounts-overview-{context}"] = Service accounts overview A service account is an {product-title} account that allows a component to diff --git a/modules/service-accounts-using-credentials-externally.adoc b/modules/service-accounts-using-credentials-externally.adoc index a33a8bf455..85731a53b0 100644 --- a/modules/service-accounts-using-credentials-externally.adoc +++ b/modules/service-accounts-using-credentials-externally.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-using-credentials-externally-{context}'] +[id="service-accounts-using-credentials-externally-{context}"] = Using a service account's credentials externally You can distribute a service account's token to external applications that need to diff --git a/modules/service-accounts-using-credentials-inside-a-container.adoc b/modules/service-accounts-using-credentials-inside-a-container.adoc index 6022e64755..535af550d2 100644 --- a/modules/service-accounts-using-credentials-inside-a-container.adoc +++ b/modules/service-accounts-using-credentials-inside-a-container.adoc @@ -2,7 +2,7 @@ // // * authentication/using-service-accounts.adoc -[id='service-accounts-using-credentials-inside-a-container-{context}'] +[id="service-accounts-using-credentials-inside-a-container-{context}"] = Using a service account's credentials inside a container When a pod is created, it specifies a service account (or uses the default diff --git a/modules/setting-resource-quota-for-extended-resources.adoc b/modules/setting-resource-quota-for-extended-resources.adoc index a61a5b6edc..e581245155 100644 --- a/modules/setting-resource-quota-for-extended-resources.adoc +++ b/modules/setting-resource-quota-for-extended-resources.adoc @@ -2,7 +2,7 @@ // // * applications/quotas-setting-per-project.adoc -[id='setting-resource-quota-for-extended-resources-{context}'] +[id="setting-resource-quota-for-extended-resources-{context}"] = Setting resource quota for extended resources Overcommitment of resources is not allowed for extended resources, so you must diff --git a/modules/storage-create-storage-class.adoc b/modules/storage-create-storage-class.adoc index d1ed0b6b85..18ebced703 100644 --- a/modules/storage-create-storage-class.adoc +++ b/modules/storage-create-storage-class.adoc @@ -9,7 +9,7 @@ -[id='storage-create-{StorageClass}-storage-class'] +[id="storage-create-{StorageClass}-storage-class-{context}"] = Creating the {StorageClass} Storage Class StorageClasses are used to differentiate and delineate storage levels and diff --git a/modules/storage-persistent-storage-aws-maximum-volumes.adoc b/modules/storage-persistent-storage-aws-maximum-volumes.adoc index 9b40ea9672..79bbb6ef2c 100644 --- a/modules/storage-persistent-storage-aws-maximum-volumes.adoc +++ b/modules/storage-persistent-storage-aws-maximum-volumes.adoc @@ -2,7 +2,7 @@ // // * storage/persistent-storage-aws.adoc -[id='maximum-number-of-ebs-volumes-on-a-node-{context}'] +[id="maximum-number-of-ebs-volumes-on-a-node-{context}"] = Maximum Number of EBS Volumes on a Node By default, {product-title} supports a maximum of 39 EBS volumes attached to one diff --git a/modules/storage-persistent-storage-aws-volume-format.adoc b/modules/storage-persistent-storage-aws-volume-format.adoc index 84ed65239d..8b1f957587 100644 --- a/modules/storage-persistent-storage-aws-volume-format.adoc +++ b/modules/storage-persistent-storage-aws-volume-format.adoc @@ -2,7 +2,7 @@ // // * storage/persistent-storage-aws.adoc -[id='volume-format-aws-{context}'] +[id="volume-format-aws-{context}"] = Volume Format Before {product-title} mounts the volume and passes it to a container, it checks that it contains a file system as specified by the `fsType` parameter in the diff --git a/modules/storage-persistent-storage-block-volume-examples.adoc b/modules/storage-persistent-storage-block-volume-examples.adoc index 26d0f5149a..50e46d1b40 100644 --- a/modules/storage-persistent-storage-block-volume-examples.adoc +++ b/modules/storage-persistent-storage-block-volume-examples.adoc @@ -5,7 +5,7 @@ // This module should only be present in openshift-enterprise and // openshift-origin distributions. -[id='block-volume-examples-{context}'] +[id="block-volume-examples-{context}"] = Block volume examples .PV example diff --git a/modules/storage-persistent-storage-block-volume.adoc b/modules/storage-persistent-storage-block-volume.adoc index 7bfe7b0cf5..58c9fab9dc 100644 --- a/modules/storage-persistent-storage-block-volume.adoc +++ b/modules/storage-persistent-storage-block-volume.adoc @@ -5,7 +5,7 @@ // This module should only be present in openshift-enterprise and // openshift-origin distributions. -[id='block-volume-support-{context}'] +[id="block-volume-support-{context}"] = Block volume support You can statically provision raw block volumes by including API fields diff --git a/modules/storage-persistent-storage-iscsi-custom-initiator.adoc b/modules/storage-persistent-storage-iscsi-custom-initiator.adoc index ba6714eebb..355d43ce76 100644 --- a/modules/storage-persistent-storage-iscsi-custom-initiator.adoc +++ b/modules/storage-persistent-storage-iscsi-custom-initiator.adoc @@ -2,7 +2,7 @@ // // * storage/persistent-storage-iscsi.adoc -[id='iscsi-custom-iqn-{context}'] +[id="iscsi-custom-iqn-{context}"] = iSCSI Custom Initiator IQN Configure the custom initiator iSCSI Qualified Name (IQN) if the iSCSI targets are restricted to certain IQNs, but the nodes that the iSCSI PVs diff --git a/modules/storage-persistent-storage-iscsi-enforcing-disk-quota.adoc b/modules/storage-persistent-storage-iscsi-enforcing-disk-quota.adoc index 5363558f3f..95e502ed35 100644 --- a/modules/storage-persistent-storage-iscsi-enforcing-disk-quota.adoc +++ b/modules/storage-persistent-storage-iscsi-enforcing-disk-quota.adoc @@ -2,7 +2,7 @@ // // * storage/persistent-storage-iscsi.adoc -[id='enforcing-disk-quotas-iscsi-{context}'] +[id="enforcing-disk-quotas-iscsi-{context}"] = Enforcing Disk Quotas Use LUN partitions to enforce disk quotas and size constraints. Each LUN is one persistent volume. Kubernetes enforces unique names for persistent diff --git a/modules/storage-persistent-storage-iscsi-multipath.adoc b/modules/storage-persistent-storage-iscsi-multipath.adoc index 2f4b041ec1..9364debb74 100644 --- a/modules/storage-persistent-storage-iscsi-multipath.adoc +++ b/modules/storage-persistent-storage-iscsi-multipath.adoc @@ -2,7 +2,7 @@ // // * storage/persistent-storage-iscsi.adoc -[id='iscsi-multipath-{context}'] +[id="iscsi-multipath-{context}"] = iSCSI Multipathing For iSCSI-based storage, you can configure multiple paths by using the same IQN for more than one target portal IP address. Multipathing ensures diff --git a/modules/storage-persistent-storage-iscsi-provisioning.adoc b/modules/storage-persistent-storage-iscsi-provisioning.adoc index 516f3c3179..2447321661 100644 --- a/modules/storage-persistent-storage-iscsi-provisioning.adoc +++ b/modules/storage-persistent-storage-iscsi-provisioning.adoc @@ -2,7 +2,7 @@ // // * storage/persistent-storage-iscsi.adoc -[id='persistent-storage-iscsi-provisioning-{context}'] +[id="persistent-storage-iscsi-provisioning-{context}"] = Provisioning Verify that the storage exists in the underlying infrastructure before mounting it as a volume in {product-title}. All that is required for the diff --git a/modules/storage-persistent-storage-iscsi-volume-security.adoc b/modules/storage-persistent-storage-iscsi-volume-security.adoc index 0066929058..53a5c4f26f 100644 --- a/modules/storage-persistent-storage-iscsi-volume-security.adoc +++ b/modules/storage-persistent-storage-iscsi-volume-security.adoc @@ -2,7 +2,7 @@ // // * storage/persistent-storage-iscsi.adoc -[id='volume-security-iscsi-{context}'] +[id="volume-security-iscsi-{context}"] = iSCSI Volume Security Users request storage with a `PersistentVolumeClaim`. This claim only lives in the user's namespace and can only be referenced by a pod within diff --git a/modules/storage-persistent-storage-lifecycle.adoc b/modules/storage-persistent-storage-lifecycle.adoc index f04dba034b..656ef61948 100644 --- a/modules/storage-persistent-storage-lifecycle.adoc +++ b/modules/storage-persistent-storage-lifecycle.adoc @@ -9,7 +9,7 @@ PVs are resources in the cluster. PVCs are requests for those resources and also act as claim checks to the resource. The interaction between PVs and PVCs have the following lifecycle. -[id='provisioning-{context}'] +[id="provisioning-{context}"] == Provision storage In response to requests from a developer defined in a PVC, a cluster @@ -20,7 +20,7 @@ Alternatively, a cluster administrator can create a number of PVs in advance that carry the details of the real storage that is available for use. PVs exist in the API and are available for use. -[id='binding-{context}'] +[id="binding-{context}"] == Bind claims When you create a PVC, you request a specific amount of storage, specify the @@ -40,7 +40,7 @@ a cluster with many manually provisioned 50Gi volumes would not match a PVC requesting 100Gi. The PVC can be bound when a 100Gi PV is added to the cluster. -[id='using-pods-{context}'] +[id="using-pods-{context}"] == Use Pods and claimed PVs Pods use claims as volumes. The cluster inspects the claim to find the bound @@ -54,14 +54,14 @@ PVs by including `persistentVolumeClaim` in the Pod's volumes block. ifdef::openshift-origin,openshift-enterprise[] -[id='pvcprotection-{context}'] +[id="pvcprotection-{context}"] == PVC protection PVC protection is enabled by default. endif::openshift-origin,openshift-enterprise[] -[id='releasing-{context}'] +[id="releasing-{context}"] == Release volumes When you are finished with a volume, you can delete the PVC object from @@ -70,7 +70,7 @@ considered released when the claim is deleted, but it is not yet available for another claim. The previous claimant's data remains on the volume and must be handled according to policy. -[id='reclaiming-{context}'] +[id="reclaiming-{context}"] == Reclaim volumes The reclaim policy of a `PersistentVolume` tells the cluster what to do with diff --git a/modules/storage-persistent-storage-pv.adoc b/modules/storage-persistent-storage-pv.adoc index cdd64dce0d..17f6131888 100644 --- a/modules/storage-persistent-storage-pv.adoc +++ b/modules/storage-persistent-storage-pv.adoc @@ -2,7 +2,7 @@ // // * storage/understanding-persistent-storage.adoc -[id='persistent-volumes-{context}'] +[id="persistent-volumes-{context}"] = Persistent volumes Each PV contains a `spec` and `status`, which is the specification and @@ -31,7 +31,7 @@ status: <4> The reclaim policy, indicating how the resource should be handled once it is released. -[id='types-of-persistent-volumes-{context}'] +[id="types-of-persistent-volumes-{context}"] == Types of PVs {product-title} supports the following `PersistentVolume` plug-ins: @@ -50,7 +50,7 @@ once it is released. // - VMWare vSphere // - Local -[id='pv-capacity-{context}'] +[id="pv-capacity-{context}"] == Capacity Generally, a PV has a specific storage capacity. This is set by using the @@ -59,7 +59,7 @@ PV's `capacity` attribute. Currently, storage capacity is the only resource that can be set or requested. Future attributes may include IOPS, throughput, and so on. -[id='pv-access-modes-{context}'] +[id="pv-access-modes-{context}"] == Access modes A `PersistentVolume` can be mounted on a host in any way supported by the @@ -148,7 +148,7 @@ Use a recreate deployment strategy for Pods that rely on AWS EBS. ifdef::openshift-dedicated,openshift-online[] -[id='pv-restrictions-{context}'] +[id="pv-restrictions-{context}"] == Restrictions The following restrictions apply when using PVs with {product-title}: @@ -182,7 +182,7 @@ of *emptyDir* storage. ** *emptyDir* volumes are deleted when the Pod is deleted. endif::[] -[id='pv-reclaim-policy-{context}'] +[id="pv-reclaim-policy-{context}"] == Reclaim policy The following table lists the current reclaim policy: @@ -204,7 +204,7 @@ The following table lists the current reclaim policy: If you do not want to retain all Pods, use dynamic provisioning. ==== -[id='pv-phase-{context}'] +[id="pv-phase-{context}"] == Phase Volumes can be found in one of the following phases: @@ -234,7 +234,7 @@ cluster. The CLI shows the name of the PVC bound to the PV. ifdef::openshift-enterprise,openshift-origin[] -[id='pv-mount-options-{context}'] +[id="pv-mount-options-{context}"] === Mount options You can specify mount options while mounting a PV by using the annotation diff --git a/modules/storage-persistent-storage-pvc.adoc b/modules/storage-persistent-storage-pvc.adoc index ff0a2ac76f..9f9bc1294f 100644 --- a/modules/storage-persistent-storage-pvc.adoc +++ b/modules/storage-persistent-storage-pvc.adoc @@ -2,7 +2,7 @@ // // * storage/understanding-persistent-storage.adoc -[id='persistent-volume-claims-{context}'] +[id="persistent-volume-claims-{context}"] = Persistent volume claims Each persistent volume claim (PVC) contains a `spec` and `status`, which @@ -30,7 +30,7 @@ status: <3> The amount of storage available to the PVC <4> Name of the `StorageClass` required by the claim -[id='pvc-storage-class-{context}'] +[id="pvc-storage-class-{context}"] == Storage classes Claims can optionally request a specific storage class by specifying the @@ -46,20 +46,20 @@ When a default storage class is configured, the PVC must explicitly ask for `StorageClass` or `storageClassName` annotations set to `""` to be bound to a PV without a storage class. -[id='pvc-access-modes-{context}'] +[id="pvc-access-modes-{context}"] == Access modes Claims use the same conventions as volumes when requesting storage with specific access modes. -[id='pvc-resources-{context}'] +[id="pvc-resources-{context}"] == Resources Claims, such as Pods, can request specific quantities of a resource. In this case, the request is for storage. The same resource model applies to volumes and claims. -[id='pvc-claims-as-volumes-{context}'] +[id="pvc-claims-as-volumes-{context}"] == Claims as volumes Pods access storage by using the claim as a volume. Claims must exist in the diff --git a/modules/telemetry-service-overview.adoc b/modules/telemetry-service-overview.adoc index 46be09825e..961c26da2e 100644 --- a/modules/telemetry-service-overview.adoc +++ b/modules/telemetry-service-overview.adoc @@ -2,7 +2,7 @@ // // * architecture/architecture.adoc -[id='telemetry-service-overview-{context}'] +[id="telemetry-service-overview-{context}"] = The Telemetry service In a managed Red Hat environment, Telemetry is the component that provides diff --git a/modules/templates-cli-generating-list-of-objects.adoc b/modules/templates-cli-generating-list-of-objects.adoc index 5cc49610b1..ba0d36be81 100644 --- a/modules/templates-cli-generating-list-of-objects.adoc +++ b/modules/templates-cli-generating-list-of-objects.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-cli-generating-list-of-objects-{context}'] +[id="templates-cli-generating-list-of-objects-{context}"] = Generating a list of objects Using the CLI, you can process a file defining a template to return the list of diff --git a/modules/templates-cli-labels.adoc b/modules/templates-cli-labels.adoc index 8146e78172..a5d09f35ba 100644 --- a/modules/templates-cli-labels.adoc +++ b/modules/templates-cli-labels.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-cli-labels-{context}'] +[id="templates-cli-labels-{context}"] = Adding labels Labels are used to manage and organize generated objects, such as pods. The diff --git a/modules/templates-cli-parameters.adoc b/modules/templates-cli-parameters.adoc index 65aed606f2..a4a47854d5 100644 --- a/modules/templates-cli-parameters.adoc +++ b/modules/templates-cli-parameters.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-cli-parameters-{context}'] +[id="templates-cli-parameters-{context}"] = Listing parameters The list of parameters that you can override are listed in the `parameters` diff --git a/modules/templates-create-from-existing-object.adoc b/modules/templates-create-from-existing-object.adoc index 08a46037e1..5dffe8887c 100644 --- a/modules/templates-create-from-existing-object.adoc +++ b/modules/templates-create-from-existing-object.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-create-from-existing-object-{context}'] +[id="templates-create-from-existing-object-{context}"] = Creating a template from existing objects Rather than writing an entire template from scratch, you can export existing diff --git a/modules/templates-creating-from-console.adoc b/modules/templates-creating-from-console.adoc index 9a19523085..aedb6dea8a 100644 --- a/modules/templates-creating-from-console.adoc +++ b/modules/templates-creating-from-console.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-creating-from-console-{context}'] +[id="templates-creating-from-console-{context}"] = Creating an application using the web console You can use the web console to create an application from a template. diff --git a/modules/templates-exposing-object-fields.adoc b/modules/templates-exposing-object-fields.adoc index c29f8a908c..ca19b9df16 100644 --- a/modules/templates-exposing-object-fields.adoc +++ b/modules/templates-exposing-object-fields.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-exposing-object-fields-{context}'] +[id="templates-exposing-object-fields-{context}"] = Exposing template object fields Template authors can indicate that fields of particular objects in a template diff --git a/modules/templates-marking-as-bindable.adoc b/modules/templates-marking-as-bindable.adoc index 659d66ed45..064d942d88 100644 --- a/modules/templates-marking-as-bindable.adoc +++ b/modules/templates-marking-as-bindable.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-marking-as-bindable-{context}'] +[id="templates-marking-as-bindable-{context}"] = Marking a template as bindable The template service broker advertises one service in its catalog for each diff --git a/modules/templates-modifying-uploaded-template.adoc b/modules/templates-modifying-uploaded-template.adoc index 609c64cdf7..42f6a43bc8 100644 --- a/modules/templates-modifying-uploaded-template.adoc +++ b/modules/templates-modifying-uploaded-template.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-modifying-uploaded-templates-{context}'] +[id="templates-modifying-uploaded-templates-{context}"] = Modifying uploaded templates You can edit a template that has already been uploaded to your project. diff --git a/modules/templates-overview.adoc b/modules/templates-overview.adoc index 2da5838ffc..eb0e350442 100644 --- a/modules/templates-overview.adoc +++ b/modules/templates-overview.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-overview-{context}'] +[id="templates-overview-{context}"] = Understanding templates A template describes a set of objects that can be parameterized and processed to diff --git a/modules/templates-quickstart.adoc b/modules/templates-quickstart.adoc index 1fc664c8dc..b6f3bab71a 100644 --- a/modules/templates-quickstart.adoc +++ b/modules/templates-quickstart.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-quickstart-{context}'] +[id="templates-quickstart-{context}"] = Quickstart templates A Quickstart is a basic example of an application running on {product-title}. diff --git a/modules/templates-rails-configuring-application.adoc b/modules/templates-rails-configuring-application.adoc index 13a8898ef5..75fdaa48ec 100644 --- a/modules/templates-rails-configuring-application.adoc +++ b/modules/templates-rails-configuring-application.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/images -[id='templates-rails-configuring-application-{context}'] +[id="templates-rails-configuring-application-{context}"] = Configuring application for {product-title} To have your application communicate with the PostgreSQL database diff --git a/modules/templates-rails-creating-database-service.adoc b/modules/templates-rails-creating-database-service.adoc index 3e09cc6196..d634adb529 100644 --- a/modules/templates-rails-creating-database-service.adoc +++ b/modules/templates-rails-creating-database-service.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/images -[id='templates-rails-creating-database-service-{context}'] +[id="templates-rails-creating-database-service-{context}"] = Creating the database service Your Rails application expects a running database service. For this service use diff --git a/modules/templates-rails-creating-frontend-service.adoc b/modules/templates-rails-creating-frontend-service.adoc index 962979e0cf..052968db91 100644 --- a/modules/templates-rails-creating-frontend-service.adoc +++ b/modules/templates-rails-creating-frontend-service.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/images -[id='templates-rails-creating-frontend-service-{context}'] +[id="templates-rails-creating-frontend-service-{context}"] = Creating the frontend service To bring your application to {product-title}, you need to specify a repository diff --git a/modules/templates-rails-creating-route-for-application.adoc b/modules/templates-rails-creating-route-for-application.adoc index 7fab261335..196a8eefcf 100644 --- a/modules/templates-rails-creating-route-for-application.adoc +++ b/modules/templates-rails-creating-route-for-application.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/images -[id='templates-rails-creating-route-for-application-{context}'] +[id="templates-rails-creating-route-for-application-{context}"] = Creating a route for your application You can expose a service to create a route for your application. diff --git a/modules/templates-rails-creating-welcome-page.adoc b/modules/templates-rails-creating-welcome-page.adoc index ac733c6449..4f8b3d053a 100644 --- a/modules/templates-rails-creating-welcome-page.adoc +++ b/modules/templates-rails-creating-welcome-page.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/images -[id='templates-rails-creating-welcome-page-{context}'] +[id="templates-rails-creating-welcome-page-{context}"] = Creating a welcome page Since Rails 4 no longer serves a static `public/index.html` page in production, diff --git a/modules/templates-rails-deploying-application.adoc b/modules/templates-rails-deploying-application.adoc index c149b142f8..24e3a40c16 100644 --- a/modules/templates-rails-deploying-application.adoc +++ b/modules/templates-rails-deploying-application.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/images -[id='templates-rails-deploying-application-{context}'] +[id="templates-rails-deploying-application-{context}"] = Deploying your application to {product-title} You can deploy you application to {product-title}. diff --git a/modules/templates-rails-setting-up-database.adoc b/modules/templates-rails-setting-up-database.adoc index 23e7141f07..b27b172d6b 100644 --- a/modules/templates-rails-setting-up-database.adoc +++ b/modules/templates-rails-setting-up-database.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/images -[id='templates-rails-setting-up-database-{context}'] +[id="templates-rails-setting-up-database-{context}"] = Setting up the database Rails applications are almost always used with a database. For the local diff --git a/modules/templates-rails-storing-application-in-git.adoc b/modules/templates-rails-storing-application-in-git.adoc index a92279e4a5..5cb13408fd 100644 --- a/modules/templates-rails-storing-application-in-git.adoc +++ b/modules/templates-rails-storing-application-in-git.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/images -[id='templates-rails-storing-application-in-git-{context}'] +[id="templates-rails-storing-application-in-git-{context}"] = Storing your application in Git Building an application in {product-title} usually requires that the source code diff --git a/modules/templates-rails-writing-application.adoc b/modules/templates-rails-writing-application.adoc index 109df488a6..35d62ea396 100644 --- a/modules/templates-rails-writing-application.adoc +++ b/modules/templates-rails-writing-application.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/images -[id='templates-rails-writing-application-{context}'] +[id="templates-rails-writing-application-{context}"] = Writing your application If you are starting your Rails application from scratch, you need to install the diff --git a/modules/templates-uploading.adoc b/modules/templates-uploading.adoc index 15c814b552..1efa638e6e 100644 --- a/modules/templates-uploading.adoc +++ b/modules/templates-uploading.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-uploading-{context}'] +[id="templates-uploading-{context}"] = Uploading a template If you have a JSON or YAML file that defines a template, for example as seen in diff --git a/modules/templates-using-instant-app-quickstart.adoc b/modules/templates-using-instant-app-quickstart.adoc index c656dd63d0..0936832efe 100644 --- a/modules/templates-using-instant-app-quickstart.adoc +++ b/modules/templates-using-instant-app-quickstart.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-using-instant-app-quickstart-{context}'] +[id="templates-using-instant-app-quickstart-{context}"] = Using Instant App and Quickstart templates {product-title} provides a number of default Instant App and Quickstart diff --git a/modules/templates-using-the-cli.adoc b/modules/templates-using-the-cli.adoc index 550171af41..34cbd55e34 100644 --- a/modules/templates-using-the-cli.adoc +++ b/modules/templates-using-the-cli.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-using-the-cli-{context}'] +[id="templates-using-the-cli-{context}"] = Creating objects from templates using the CLI You can use the CLI to process templates and use the configuration that is diff --git a/modules/templates-waiting-for-readiness.adoc b/modules/templates-waiting-for-readiness.adoc index 167de07495..d262eeef3d 100644 --- a/modules/templates-waiting-for-readiness.adoc +++ b/modules/templates-waiting-for-readiness.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-waiting-for-readiness-{context}'] +[id="templates-waiting-for-readiness-{context}"] = Waiting for template readiness Template authors can indicate that certain objects within a template diff --git a/modules/templates-writing-description.adoc b/modules/templates-writing-description.adoc index 2dd0bdb29c..2e2313a042 100644 --- a/modules/templates-writing-description.adoc +++ b/modules/templates-writing-description.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-writing-description-{context}'] +[id="templates-writing-description-{context}"] = Writing the template description The template description informs users what the template does and helps them diff --git a/modules/templates-writing-labels.adoc b/modules/templates-writing-labels.adoc index e0fdc453a4..234606f46d 100644 --- a/modules/templates-writing-labels.adoc +++ b/modules/templates-writing-labels.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-writing-label-{context}'] +[id="templates-writing-label-{context}"] = Writing template labels Templates can include a set of labels. These labels will be added to each object diff --git a/modules/templates-writing-object-list.adoc b/modules/templates-writing-object-list.adoc index d7d40605ab..7b46b810e1 100644 --- a/modules/templates-writing-object-list.adoc +++ b/modules/templates-writing-object-list.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-writing-object-list-{context}'] +[id="templates-writing-object-list-{context}"] = Writing the template object list The main portion of the template is the list of objects which will be created diff --git a/modules/templates-writing-parameters.adoc b/modules/templates-writing-parameters.adoc index 6e1c5f9a11..14cd7d8005 100644 --- a/modules/templates-writing-parameters.adoc +++ b/modules/templates-writing-parameters.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-writing-parameters-{context}'] +[id="templates-writing-parameters-{context}"] = Writing template parameters Parameters allow a value to be supplied by the user or generated when the diff --git a/modules/templates-writing.adoc b/modules/templates-writing.adoc index 63d241dd8a..ac21bcf24e 100644 --- a/modules/templates-writing.adoc +++ b/modules/templates-writing.adoc @@ -2,7 +2,7 @@ // // * assembly/images -[id='templates-writing-{context}'] +[id="templates-writing-{context}"] = Writing templates You can define new templates to make it easy to recreate all the objects of your diff --git a/modules/tokens-scoping-about.adoc b/modules/tokens-scoping-about.adoc index 565c80256a..cab18f2937 100644 --- a/modules/tokens-scoping-about.adoc +++ b/modules/tokens-scoping-about.adoc @@ -2,7 +2,7 @@ // // * authentication/tokens-scoping.adoc -[id='tokens-scoping-about-{context}'] +[id="tokens-scoping-about-{context}"] = About scoping tokens You can created scoped tokens to delegate some of your permissions to another @@ -19,7 +19,7 @@ Scopes are evaluated by converting the set of scopes for a token into a set of attributes must match at least one of the scope rules to be passed to the "normal" authorizer for further authorization checks. -[id='scoping-tokens-user-scopes-{context}'] +[id="scoping-tokens-user-scopes-{context}"] == User scopes User scopes are focused on getting information about a given user. They are @@ -32,7 +32,7 @@ intent-based, so the rules are automatically created for you: * `user:list-projects` - Allows read-only access to list the projects the user has access to. -[id='scoping-tokens-role-scope-{context}'] +[id="scoping-tokens-role-scope-{context}"] == Role scope The role scope allows you to have the same level of access as a given role filtered by namespace. diff --git a/modules/update-service-overview.adoc b/modules/update-service-overview.adoc index 5bb20e7832..007220a4f8 100644 --- a/modules/update-service-overview.adoc +++ b/modules/update-service-overview.adoc @@ -2,7 +2,7 @@ // // * architecture/architecture.adoc -[id='update-service-overview-{context}'] +[id="update-service-overview-{context}"] == The {product-title} update service The {product-title} update service is the hosted service that provides over the air updates to both diff --git a/modules/user-agent-configuring.adoc b/modules/user-agent-configuring.adoc index 2f3d96b943..30b246bf25 100644 --- a/modules/user-agent-configuring.adoc +++ b/modules/user-agent-configuring.adoc @@ -2,7 +2,7 @@ // // * authentication/configuring_user_agent.adoc -[id='user-agent-configuring-{context}'] +[id="user-agent-configuring-{context}"] = Configuring the user agent As an {product-title} administrator, you can prevent clients from accessing the diff --git a/modules/user-agent-overview.adoc b/modules/user-agent-overview.adoc index 9575904d6a..56ce1c61fd 100644 --- a/modules/user-agent-overview.adoc +++ b/modules/user-agent-overview.adoc @@ -3,7 +3,7 @@ // * authentication/configuring_user_agent.adoc -[id='user-agent-overview-{context}'] +[id="user-agent-overview-{context}"] = About the user agent {product-title} implements a user agent that can be used to prevent an diff --git a/modules/using-a-pre-deployed-image-to-improve-efficiency.adoc b/modules/using-a-pre-deployed-image-to-improve-efficiency.adoc index eaf2ef6245..00a898244d 100644 --- a/modules/using-a-pre-deployed-image-to-improve-efficiency.adoc +++ b/modules/using-a-pre-deployed-image-to-improve-efficiency.adoc @@ -2,7 +2,7 @@ // // scalability_and_performance/optimizing-compute-resources.adoc -[id='using-a-pre-deployed-image-to-improve-efficiency-{context}'] +[id="using-a-pre-deployed-image-to-improve-efficiency-{context}"] = Using a pre-deployed image to improve efficiency You can create a base {product-title} image with a number of tasks built-in to diff --git a/modules/viewing-a-project-using-the-CLI.adoc b/modules/viewing-a-project-using-the-CLI.adoc index 8c2d739b72..713474b07d 100644 --- a/modules/viewing-a-project-using-the-CLI.adoc +++ b/modules/viewing-a-project-using-the-CLI.adoc @@ -2,7 +2,7 @@ // // applications_and_projects/working-with-projects.adoc -[id='viewing-a-project-using-the-CLI-{context}'] +[id="viewing-a-project-using-the-CLI-{context}"] = Viewing a project using the CLI When viewing projects, you are restricted to seeing only the projects you have diff --git a/modules/viewing-a-project-using-the-web-console.adoc b/modules/viewing-a-project-using-the-web-console.adoc index 169a055412..c4db2e98ea 100644 --- a/modules/viewing-a-project-using-the-web-console.adoc +++ b/modules/viewing-a-project-using-the-web-console.adoc @@ -2,7 +2,7 @@ // // applications_and_projects/working-with-projects.adoc -[id='viewing-a-project-using-the-web-console-{context}'] +[id="viewing-a-project-using-the-web-console-{context}"] = Viewing a project using the web console .Procedure diff --git a/modules/web-console-overview.adoc b/modules/web-console-overview.adoc index 7e6766f883..d1fa2ab451 100644 --- a/modules/web-console-overview.adoc +++ b/modules/web-console-overview.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * assembly/architecture -[id='web-console-overview-{context}'] +[id="web-console-overview-{context}"] = Understanding and accessing the web console The web console runs as a pod on the master. The static assets required to run diff --git a/modules/wildcard-dns-configuring.adoc b/modules/wildcard-dns-configuring.adoc index 96130d377d..b64d9fc703 100644 --- a/modules/wildcard-dns-configuring.adoc +++ b/modules/wildcard-dns-configuring.adoc @@ -2,7 +2,7 @@ // // * installing-byoh/installing-existing-hosts.adoc -[id='wildcard-dns-configuring-{context}'] +[id="wildcard-dns-configuring-{context}"] = Configuring a DNS wildcard Optionally, configure a wildcard for the router to use, so that you do not need diff --git a/monitoring/installing-monitoring-stack.adoc b/monitoring/installing-monitoring-stack.adoc index f83610896e..9c03e346b2 100644 --- a/monitoring/installing-monitoring-stack.adoc +++ b/monitoring/installing-monitoring-stack.adoc @@ -1,4 +1,4 @@ -[id='installing-monitoring-stack'] +[id="installing-monitoring-stack"] = Installing monitoring stack include::modules/common-attributes.adoc[] @@ -8,7 +8,7 @@ The Cluster Monitoring Operator is installed with OpenShift. It is configured an * The monitoring stack imposes additional resource requirements. Consult the computing resources recommendations in xref:../scalability_and_performance/scaling-cluster-monitoring-operator.adoc#scaling-cluster-monitoring-operator[Scaling the Cluster Monitoring Operator] and verify that you have sufficient resources. -[id='configuring-persistent-storage'] +[id="configuring-persistent-storage"] == Configuring persistent storage Running cluster monitoring with persistent storage means that your metrics are stored to a persistent volume and can survive a pod being restarted or recreated. This is ideal if you require your metrics or alerting data to be guarded from data loss. For production environments it is highly recommended to configure persistent storage. @@ -29,7 +29,7 @@ include::modules/monitoring-enabling-persistent-storage.adoc[leveloffset=+2] include::modules/monitoring-setting-persistent-storage-size.adoc[leveloffset=+2] include::modules/monitoring-enabling-dynamically-provisioned-storage.adoc[leveloffset=+2] -[id='configuring-alertmanager'] +[id="configuring-alertmanager"] == Configuring Alertmanager The Alertmanager manages incoming alerts, including silencing, inhibition, aggregation, and sending out notifications through methods such as email, PagerDuty, and HipChat. diff --git a/monitoring/prometheus-cluster-monitoring.adoc b/monitoring/prometheus-cluster-monitoring.adoc index 2a89141629..9701290b76 100644 --- a/monitoring/prometheus-cluster-monitoring.adoc +++ b/monitoring/prometheus-cluster-monitoring.adoc @@ -1,4 +1,4 @@ -[id='prometheus-cluster-monitoring'] +[id="prometheus-cluster-monitoring"] = Prometheus Cluster Monitoring include::modules/common-attributes.adoc[] :context: prometheus-cluster-monitoring diff --git a/networking/configuring-routing.adoc b/networking/configuring-routing.adoc index 34ac51b1fd..98cc03eb65 100644 --- a/networking/configuring-routing.adoc +++ b/networking/configuring-routing.adoc @@ -1,6 +1,6 @@ // Assembly filename: configuring-routing.adoc // Explains Router configuration. -[id='configuring-routing'] +[id="configuring-routing"] = Configuring routing include::modules/common-attributes.adoc[] :context: configuring-routing diff --git a/networking/managing_multinetworking.adoc b/networking/managing_multinetworking.adoc index 98ae6c5974..62912720fb 100644 --- a/networking/managing_multinetworking.adoc +++ b/networking/managing_multinetworking.adoc @@ -1,5 +1,5 @@ ifdef::context[:parent-context: {context}] -[id='managing-multiple-networks-{context}'] +[id="managing-multiple-networks-{context}"] = Managing Multiple Networks toc::[] :context: managing-multiple-networks diff --git a/networking/understanding-networking.adoc b/networking/understanding-networking.adoc index 1aed831c9b..5701aec81d 100644 --- a/networking/understanding-networking.adoc +++ b/networking/understanding-networking.adoc @@ -1,4 +1,4 @@ -[id='understanding-networking'] +[id="understanding-networking"] = Understanding networking include::modules/common-attributes.adoc[] :context: understanding-networking diff --git a/networking/using-cookies-to-keep-route-statefulness.adoc b/networking/using-cookies-to-keep-route-statefulness.adoc index 33fe49a953..e5786ebfc9 100644 --- a/networking/using-cookies-to-keep-route-statefulness.adoc +++ b/networking/using-cookies-to-keep-route-statefulness.adoc @@ -1,4 +1,4 @@ -[id='using-cookies-to-keep-route-statefulness'] +[id="using-cookies-to-keep-route-statefulness"] = Using cookies to keep route statefulness {product-author} {product-version} diff --git a/nodes/clusters/nodes-cluster-overcommit.adoc b/nodes/clusters/nodes-cluster-overcommit.adoc index 664535e793..eced27dad4 100644 --- a/nodes/clusters/nodes-cluster-overcommit.adoc +++ b/nodes/clusters/nodes-cluster-overcommit.adoc @@ -1,5 +1,5 @@ :context: nodes-cluster-overcommit -[id='nodes-cluster-overcommit-{context}'] +[id="nodes-cluster-overcommit-{context}"] = Configuring your cluster to place pods on overcommited nodes in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/clusters/nodes-cluster-pods-configuring.adoc b/nodes/clusters/nodes-cluster-pods-configuring.adoc index 8f4ef8cc03..63cb89a58c 100644 --- a/nodes/clusters/nodes-cluster-pods-configuring.adoc +++ b/nodes/clusters/nodes-cluster-pods-configuring.adoc @@ -1,5 +1,5 @@ :context: nodes-cluster-pods -[id='nodes-cluster-pods-configuring'] +[id="nodes-cluster-pods-configuring"] = Configuring an {product-title} cluster for pods include::modules/common-attributes.adoc[] diff --git a/nodes/clusters/nodes-cluster-resource-configure.adoc b/nodes/clusters/nodes-cluster-resource-configure.adoc index af677dbd7a..1c879940ba 100644 --- a/nodes/clusters/nodes-cluster-resource-configure.adoc +++ b/nodes/clusters/nodes-cluster-resource-configure.adoc @@ -1,5 +1,5 @@ :context: nodes-cluster-resource-configure -[id='nodes-cluster-resource-configure-{context}'] +[id="nodes-cluster-resource-configure-{context}"] = Configuring cluster memory to meet container memory and risk requirements in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/clusters/nodes-cluster-resource-levels.adoc b/nodes/clusters/nodes-cluster-resource-levels.adoc index 383d05ffe6..cec57b7523 100644 --- a/nodes/clusters/nodes-cluster-resource-levels.adoc +++ b/nodes/clusters/nodes-cluster-resource-levels.adoc @@ -1,5 +1,5 @@ :context: nodes-cluster-resource-levels -[id='nodes-cluster-resource-levels-{context}'] +[id="nodes-cluster-resource-levels-{context}"] = Estimating the number of pods your {product-title} nodes can hold include::modules/common-attributes.adoc[] diff --git a/nodes/clusters/nodes-containers-events.adoc b/nodes/clusters/nodes-containers-events.adoc index aaf88ec3fd..8e200b43ce 100644 --- a/nodes/clusters/nodes-containers-events.adoc +++ b/nodes/clusters/nodes-containers-events.adoc @@ -1,5 +1,5 @@ :context: nodes-containers-events -[id='nodes-containers-events-{context}'] +[id="nodes-containers-events-{context}"] = Viewing system event information in a {product-title} cluster include::modules/common-attributes.adoc[] diff --git a/nodes/clusters/nodes-pods-disabling-features.adoc b/nodes/clusters/nodes-pods-disabling-features.adoc index 7c24e53d15..f168e46c28 100644 --- a/nodes/clusters/nodes-pods-disabling-features.adoc +++ b/nodes/clusters/nodes-pods-disabling-features.adoc @@ -1,5 +1,5 @@ :context: nodes-pods-disabling -[id='nodes-pods-disabling'] +[id="nodes-pods-disabling"] = Disabling {product-title} features using feature gates include::modules/common-attributes.adoc[] diff --git a/nodes/containers/nodes-containers-copying-files.adoc b/nodes/containers/nodes-containers-copying-files.adoc index 1ce59bc27f..c513bc99f9 100644 --- a/nodes/containers/nodes-containers-copying-files.adoc +++ b/nodes/containers/nodes-containers-copying-files.adoc @@ -1,5 +1,5 @@ :context: nodes-containers-copying-files -[id='nodes-containers-copying-files-{context}'] +[id="nodes-containers-copying-files-{context}"] = Copying files to or from an {product-title} container include::modules/common-attributes.adoc[] diff --git a/nodes/containers/nodes-containers-downward-api.adoc b/nodes/containers/nodes-containers-downward-api.adoc index 4557bd4970..980bdacf13 100644 --- a/nodes/containers/nodes-containers-downward-api.adoc +++ b/nodes/containers/nodes-containers-downward-api.adoc @@ -1,5 +1,5 @@ :context: nodes-containers-downward-api -[id='nodes-containers-downward-api-{context}'] +[id="nodes-containers-downward-api-{context}"] = Allowing containers to consume API objects include::modules/common-attributes.adoc[] diff --git a/nodes/containers/nodes-containers-health.adoc b/nodes/containers/nodes-containers-health.adoc index 8abf4431c5..14bb908cc1 100644 --- a/nodes/containers/nodes-containers-health.adoc +++ b/nodes/containers/nodes-containers-health.adoc @@ -1,6 +1,6 @@ :context: nodes-containers-health -[id='nodes-nodes-health-{context}'] +[id="nodes-nodes-health-{context}"] = Monitoring container health include::modules/common-attributes.adoc[] diff --git a/nodes/containers/nodes-containers-init.adoc b/nodes/containers/nodes-containers-init.adoc index 830d3db1aa..4e89cdc5ee 100644 --- a/nodes/containers/nodes-containers-init.adoc +++ b/nodes/containers/nodes-containers-init.adoc @@ -1,5 +1,5 @@ :context: nodes-containers-init -[id='nodes-containers-init-{context}'] +[id="nodes-containers-init-{context}"] = Using Init Containers to perform tasks before a pod is deployed include::modules/common-attributes.adoc[] diff --git a/nodes/containers/nodes-containers-port-forwarding.adoc b/nodes/containers/nodes-containers-port-forwarding.adoc index fc23082bcb..ce3a97d40a 100644 --- a/nodes/containers/nodes-containers-port-forwarding.adoc +++ b/nodes/containers/nodes-containers-port-forwarding.adoc @@ -1,5 +1,5 @@ :context: nodes-containers-port-forwarding -[id='nodes-containers-port-forwarding-{context}'] +[id="nodes-containers-port-forwarding-{context}"] = Using port forwarding to access applications in a container include::modules/common-attributes.adoc[] diff --git a/nodes/containers/nodes-containers-projected-volumes.adoc b/nodes/containers/nodes-containers-projected-volumes.adoc index 788ba0b138..977c4ca2c8 100644 --- a/nodes/containers/nodes-containers-projected-volumes.adoc +++ b/nodes/containers/nodes-containers-projected-volumes.adoc @@ -1,5 +1,5 @@ :context: nodes-containers-projected-volumes -[id='nodes-containers-projected-volumes-{context}'] +[id="nodes-containers-projected-volumes-{context}"] = Mapping volumes using projected volumes include::modules/common-attributes.adoc[] diff --git a/nodes/containers/nodes-containers-remote-commands.adoc b/nodes/containers/nodes-containers-remote-commands.adoc index 095122519b..c4fdd0e5f6 100644 --- a/nodes/containers/nodes-containers-remote-commands.adoc +++ b/nodes/containers/nodes-containers-remote-commands.adoc @@ -1,5 +1,5 @@ :context: nodes-containers-remote-commands -[id='nodes-containers-remote-commands-{context}'] +[id="nodes-containers-remote-commands-{context}"] = Executing remote commands in a {product-title} container include::modules/common-attributes.adoc[] diff --git a/nodes/containers/nodes-containers-using.adoc b/nodes/containers/nodes-containers-using.adoc index 67a0df1be9..a2ea6c373c 100644 --- a/nodes/containers/nodes-containers-using.adoc +++ b/nodes/containers/nodes-containers-using.adoc @@ -1,5 +1,5 @@ :context: nodes-containers-using -[id='nodes-containers-using-{context}'] +[id="nodes-containers-using-{context}"] = Understanding Containers in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/containers/nodes-containers-volumes.adoc b/nodes/containers/nodes-containers-volumes.adoc index 0679d589a4..a498012c23 100644 --- a/nodes/containers/nodes-containers-volumes.adoc +++ b/nodes/containers/nodes-containers-volumes.adoc @@ -1,5 +1,5 @@ :context: nodes-containers-volumes -[id='nodes-containers-volumes-{context}'] +[id="nodes-containers-volumes-{context}"] = Using volumes to persist container data include::modules/common-attributes.adoc[] diff --git a/nodes/jobs/nodes-nodes-jobs.adoc b/nodes/jobs/nodes-nodes-jobs.adoc index d29c0e1317..bea169e39a 100644 --- a/nodes/jobs/nodes-nodes-jobs.adoc +++ b/nodes/jobs/nodes-nodes-jobs.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-jobs -[id='nodes-nodes-jobs-{context}'] +[id="nodes-nodes-jobs-{context}"] = Running tasks in pods using jobs in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/jobs/nodes-pods-daemonsets.adoc b/nodes/jobs/nodes-pods-daemonsets.adoc index d4c8029ba3..8e0c13e126 100644 --- a/nodes/jobs/nodes-pods-daemonsets.adoc +++ b/nodes/jobs/nodes-pods-daemonsets.adoc @@ -1,5 +1,5 @@ :context: nodes-pods-daemonsets -[id='nodes-pods-daemonsets'] +[id="nodes-pods-daemonsets"] = Running background tasks on nodes automatically with daemonsets in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-node-tuning-operator.adoc b/nodes/nodes/nodes-node-tuning-operator.adoc index 53824eb183..8b4cb8f11a 100644 --- a/nodes/nodes/nodes-node-tuning-operator.adoc +++ b/nodes/nodes/nodes-node-tuning-operator.adoc @@ -1,4 +1,4 @@ -[id='nodes-node-tuning-operator'] +[id="nodes-node-tuning-operator"] = Using the Node Tuning Operator include::modules/common-attributes.adoc[] :context: nodes-node-tuning-operator diff --git a/nodes/nodes/nodes-nodes-garbage-collection.adoc b/nodes/nodes/nodes-nodes-garbage-collection.adoc index f73f44f961..c7d35c0437 100644 --- a/nodes/nodes/nodes-nodes-garbage-collection.adoc +++ b/nodes/nodes/nodes-nodes-garbage-collection.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-configuring -[id='nodes-nodes-garbage-collection'] +[id="nodes-nodes-garbage-collection"] = Freeing node resources using garbage collection include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-nodes-managing-max-pods.adoc b/nodes/nodes/nodes-nodes-managing-max-pods.adoc index fd45c7c340..a81ba47064 100644 --- a/nodes/nodes/nodes-nodes-managing-max-pods.adoc +++ b/nodes/nodes/nodes-nodes-managing-max-pods.adoc @@ -1,5 +1,5 @@ :context: nodes-nodes-jobs -[id='nodes-nodes-managing-max-pods-{context}'] +[id="nodes-nodes-managing-max-pods-{context}"] = Managing the maximum number of Pods per Node include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-nodes-managing.adoc b/nodes/nodes/nodes-nodes-managing.adoc index 5fd85176fd..64c74405cf 100644 --- a/nodes/nodes/nodes-nodes-managing.adoc +++ b/nodes/nodes/nodes-nodes-managing.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-jobs -[id='nodes-nodes-managing-{context}'] +[id="nodes-nodes-managing-{context}"] = Managing Nodes include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-nodes-modifying.adoc b/nodes/nodes/nodes-nodes-modifying.adoc index e7ffe0302d..9f363664c3 100644 --- a/nodes/nodes/nodes-nodes-modifying.adoc +++ b/nodes/nodes/nodes-nodes-modifying.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-modifying -[id='nodes-nodes-modifying-{context}'] +[id="nodes-nodes-modifying-{context}"] = Modifying existing nodes in your {product-title} cluster include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-nodes-opaque-resources.adoc b/nodes/nodes/nodes-nodes-opaque-resources.adoc index 0bc311342f..adfeff4cf7 100644 --- a/nodes/nodes/nodes-nodes-opaque-resources.adoc +++ b/nodes/nodes/nodes-nodes-opaque-resources.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-opaque-resources -[id='nodes-nodes-opaque-resources-{context}'] +[id="nodes-nodes-opaque-resources-{context}"] = Advertising hidden resources for nodes in an {product-title} cluster include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-nodes-problem-detector.adoc b/nodes/nodes/nodes-nodes-problem-detector.adoc index bf051f4f0c..6960023057 100644 --- a/nodes/nodes/nodes-nodes-problem-detector.adoc +++ b/nodes/nodes/nodes-nodes-problem-detector.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-problem-detector -[id='nodes-nodes-problem-detector-{context}'] +[id="nodes-nodes-problem-detector-{context}"] = Monitoring for problems in your {product-title} nodes include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-nodes-rebooting.adoc b/nodes/nodes/nodes-nodes-rebooting.adoc index f264ed53ee..d97e5a912e 100644 --- a/nodes/nodes/nodes-nodes-rebooting.adoc +++ b/nodes/nodes/nodes-nodes-rebooting.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-rebooting -[id='nodes-nodes-rebooting-{context}'] +[id="nodes-nodes-rebooting-{context}"] = Understanding node rebooting in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-nodes-resources-configuring.adoc b/nodes/nodes/nodes-nodes-resources-configuring.adoc index c6ea3ffae0..29150b472b 100644 --- a/nodes/nodes/nodes-nodes-resources-configuring.adoc +++ b/nodes/nodes/nodes-nodes-resources-configuring.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-resources-configuring -[id='nodes-nodes-resources-configuring-{context}'] +[id="nodes-nodes-resources-configuring-{context}"] = Allocating resources for nodes in an {product-title} cluster include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-nodes-viewing.adoc b/nodes/nodes/nodes-nodes-viewing.adoc index 210da8fef8..ea080e6ed9 100644 --- a/nodes/nodes/nodes-nodes-viewing.adoc +++ b/nodes/nodes/nodes-nodes-viewing.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-viewing -[id='nodes-nodes-viewing-{context}'] +[id="nodes-nodes-viewing-{context}"] = Viewing and listing the nodes in your {product-title} cluster include::modules/common-attributes.adoc[] diff --git a/nodes/nodes/nodes-nodes-working.adoc b/nodes/nodes/nodes-nodes-working.adoc index ac749c6d2b..0dd4ce314d 100644 --- a/nodes/nodes/nodes-nodes-working.adoc +++ b/nodes/nodes/nodes-nodes-working.adoc @@ -1,6 +1,6 @@ :context: nodes-nodes-working -[id='nodes-nodes-working-{context}'] +[id="nodes-nodes-working-{context}"] = Working with nodes in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/pods/nodes-pods-configuring.adoc b/nodes/pods/nodes-pods-configuring.adoc index 60dd97a4a5..4351c0a69b 100644 --- a/nodes/pods/nodes-pods-configuring.adoc +++ b/nodes/pods/nodes-pods-configuring.adoc @@ -1,5 +1,5 @@ :context: nodes-pods-configuring -[id='nodes-pods-configuring'] +[id="nodes-pods-configuring"] = Configuring an {product-title} cluster for pods include::modules/common-attributes.adoc[] diff --git a/nodes/pods/nodes-pods-plugins.adoc b/nodes/pods/nodes-pods-plugins.adoc index a7841c5724..eed2be821b 100644 --- a/nodes/pods/nodes-pods-plugins.adoc +++ b/nodes/pods/nodes-pods-plugins.adoc @@ -1,5 +1,5 @@ :context: nodes-pods-device -[id='nodes-pods-device'] +[id="nodes-pods-device"] = Using device plug-ins to access external resouces with pods in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/pods/nodes-pods-priority.adoc b/nodes/pods/nodes-pods-priority.adoc index b3eefdc71e..ddc3b4bb79 100644 --- a/nodes/pods/nodes-pods-priority.adoc +++ b/nodes/pods/nodes-pods-priority.adoc @@ -1,5 +1,5 @@ :context: nodes-pods-priority -[id='nodes-pods-priority'] +[id="nodes-pods-priority"] = Including pod priority in pod scheduling decisions in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/pods/nodes-pods-secrets.adoc b/nodes/pods/nodes-pods-secrets.adoc index 9f569034c9..be898cc75d 100644 --- a/nodes/pods/nodes-pods-secrets.adoc +++ b/nodes/pods/nodes-pods-secrets.adoc @@ -1,5 +1,5 @@ :context: nodes-pods-secrets -[id='nodes-pods-secrets'] +[id="nodes-pods-secrets"] = Providing sensitive data to pods in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/pods/nodes-pods-using.adoc b/nodes/pods/nodes-pods-using.adoc index deb34d94df..d4baf9cdcf 100644 --- a/nodes/pods/nodes-pods-using.adoc +++ b/nodes/pods/nodes-pods-using.adoc @@ -1,5 +1,5 @@ :context: nodes-pods-using -[id='nodes-pods-using'] +[id="nodes-pods-using"] = Using pods in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/pods/nodes-pods-viewing.adoc b/nodes/pods/nodes-pods-viewing.adoc index 21b2c7eba5..28cfcb1789 100644 --- a/nodes/pods/nodes-pods-viewing.adoc +++ b/nodes/pods/nodes-pods-viewing.adoc @@ -1,5 +1,5 @@ :context: nodes-pods-viewing -[id='nodes-pods-viewing'] +[id="nodes-pods-viewing"] = Viewing pods in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/scheduling/nodes-scheduler-about.adoc b/nodes/scheduling/nodes-scheduler-about.adoc index e7333ea85e..bf748f1681 100644 --- a/nodes/scheduling/nodes-scheduler-about.adoc +++ b/nodes/scheduling/nodes-scheduler-about.adoc @@ -1,5 +1,5 @@ :context: nodes-scheduler-about -[id='nodes-scheduler-about-{context}'] +[id="nodes-scheduler-about-{context}"] = Controlling pod placement using the {product-title} scheduler include::modules/common-attributes.adoc[] diff --git a/nodes/scheduling/nodes-scheduler-default.adoc b/nodes/scheduling/nodes-scheduler-default.adoc index f6ad13c0c7..1b60458c80 100644 --- a/nodes/scheduling/nodes-scheduler-default.adoc +++ b/nodes/scheduling/nodes-scheduler-default.adoc @@ -1,5 +1,5 @@ :context: nodes-scheduler-default -[id='nodes-scheduler-default-{context}'] +[id="nodes-scheduler-default-{context}"] = Configuring the default scheduler to control pod placement in {product-title} include::modules/common-attributes.adoc[] :relfileprefix: ../ diff --git a/nodes/scheduling/nodes-scheduler-descheduler.adoc b/nodes/scheduling/nodes-scheduler-descheduler.adoc index 2116ba0468..5d612183bf 100644 --- a/nodes/scheduling/nodes-scheduler-descheduler.adoc +++ b/nodes/scheduling/nodes-scheduler-descheduler.adoc @@ -1,5 +1,5 @@ :context: nodes-scheduler-descheduler -[id='nodes-scheduler-descheduler-{context}'] +[id="nodes-scheduler-descheduler-{context}"] = Keeping your cluster balanced using the descheduler include::modules/common-attributes.adoc[] :relfileprefix: ../ diff --git a/nodes/scheduling/nodes-scheduler-node-affinity.adoc b/nodes/scheduling/nodes-scheduler-node-affinity.adoc index aa54bef463..ad3fd2b7fe 100644 --- a/nodes/scheduling/nodes-scheduler-node-affinity.adoc +++ b/nodes/scheduling/nodes-scheduler-node-affinity.adoc @@ -1,5 +1,5 @@ :context: nodes-scheduler-node-affinity -[id='nodes-scheduler-node-affinity-{context}'] +[id="nodes-scheduler-node-affinity-{context}"] = Controlling pod placement on nodes using node affinity rules in {product-title} include::modules/common-attributes.adoc[] :relfileprefix: ../ diff --git a/nodes/scheduling/nodes-scheduler-node-names.adoc b/nodes/scheduling/nodes-scheduler-node-names.adoc index 8e4305acd2..e276010c99 100644 --- a/nodes/scheduling/nodes-scheduler-node-names.adoc +++ b/nodes/scheduling/nodes-scheduler-node-names.adoc @@ -1,5 +1,5 @@ :context: nodes-scheduler-node-names -[id='nodes-scheduler-node-names-{context}'] +[id="nodes-scheduler-node-names-{context}"] = Placing a pod on a specific node by name in {product-title} include::modules/common-attributes.adoc[] :relfileprefix: ../ @@ -24,7 +24,7 @@ and prevents users without a specific role from using the include::modules/nodes-scheduler-node-names-configuring.adoc[leveloffset=+1] -[id='nodes-scheduler-node-names-addtl-resources-{context}'] +[id="nodes-scheduler-node-names-addtl-resources-{context}"] == Additional resources For information about changing node labels, see xref:../../nodes/nodes/nodes-nodes-working.html#nodes-nodes-working-updating-nodes-nodes-working[Understanding how to update labels on nodes]. diff --git a/nodes/scheduling/nodes-scheduler-node-projects.adoc b/nodes/scheduling/nodes-scheduler-node-projects.adoc index 7e180789ef..b1f4262e9e 100644 --- a/nodes/scheduling/nodes-scheduler-node-projects.adoc +++ b/nodes/scheduling/nodes-scheduler-node-projects.adoc @@ -1,5 +1,5 @@ :context: nodes-scheduler-node-project -[id='nodes-scheduler-node-project-{context}'] +[id="nodes-scheduler-node-project-{context}"] = Placing a pod in a specific project in {product-title} include::modules/common-attributes.adoc[] :relfileprefix: ../ diff --git a/nodes/scheduling/nodes-scheduler-node-selectors.adoc b/nodes/scheduling/nodes-scheduler-node-selectors.adoc index 9be06fb631..c488e7479d 100644 --- a/nodes/scheduling/nodes-scheduler-node-selectors.adoc +++ b/nodes/scheduling/nodes-scheduler-node-selectors.adoc @@ -1,5 +1,5 @@ :context: nodes-scheduler-node-selectors -[id='nodes-scheduler-node-selectors-{context}'] +[id="nodes-scheduler-node-selectors-{context}"] = Constraining pod placement using node selectors in {product-title} include::modules/common-attributes.adoc[] :relfileprefix: ../ diff --git a/nodes/scheduling/nodes-scheduler-overcommit.adoc b/nodes/scheduling/nodes-scheduler-overcommit.adoc index b8b6e5c1f8..155aac5651 100644 --- a/nodes/scheduling/nodes-scheduler-overcommit.adoc +++ b/nodes/scheduling/nodes-scheduler-overcommit.adoc @@ -1,5 +1,5 @@ :context: nodes-sceduler-overcommit -[id='nodes-scheduler-overcommit-{context}'] +[id="nodes-scheduler-overcommit-{context}"] = Placing pods onto overcommited nodes in {product-title} include::modules/common-attributes.adoc[] diff --git a/nodes/scheduling/nodes-scheduler-pod-affinity.adoc b/nodes/scheduling/nodes-scheduler-pod-affinity.adoc index c4896cbc81..bdfa64b853 100644 --- a/nodes/scheduling/nodes-scheduler-pod-affinity.adoc +++ b/nodes/scheduling/nodes-scheduler-pod-affinity.adoc @@ -1,5 +1,5 @@ :context: nodes-scheduler-pod-affinity -[id='nodes-scheduler-pod-affinity-{context}'] +[id="nodes-scheduler-pod-affinity-{context}"] = Placing pods relative to other pods using affinity/anti-affinity rules in {product-title} include::modules/common-attributes.adoc[] :relfileprefix: ../ diff --git a/nodes/scheduling/nodes-scheduler-taints-tolerations.adoc b/nodes/scheduling/nodes-scheduler-taints-tolerations.adoc index 8367334642..027281a199 100644 --- a/nodes/scheduling/nodes-scheduler-taints-tolerations.adoc +++ b/nodes/scheduling/nodes-scheduler-taints-tolerations.adoc @@ -1,5 +1,5 @@ :context: nodes-scheduler-taints-tolerations -[id='nodes-scheduler-taints-tolerations-{context}'] +[id="nodes-scheduler-taints-tolerations-{context}"] = Controlling pod placement using node taints in {product-title} include::modules/common-attributes.adoc[] :relfileprefix: ../ diff --git a/nw-configuring-timeouts.adoc b/nw-configuring-timeouts.adoc index 2bb81eaab6..bdc64504b6 100644 --- a/nw-configuring-timeouts.adoc +++ b/nw-configuring-timeouts.adoc @@ -2,7 +2,7 @@ // // -[id='networking-configuring-timeouts-{context}'] +[id="networking-configuring-timeouts-{context}"] = Configuring Route Timeouts You can configure the existing routes in your environment to have different diff --git a/openshift_images/configuring-samples-operator.adoc b/openshift_images/configuring-samples-operator.adoc index b8522aadf9..f50818427f 100644 --- a/openshift_images/configuring-samples-operator.adoc +++ b/openshift_images/configuring-samples-operator.adoc @@ -1,4 +1,4 @@ -[id=configuring-samples-operator’] +[id="configuring-samples-operator"] = Configuring the Samples Operator include::modules/common-attributes.adoc[] :context: configuring-samples-operator diff --git a/openshift_images/create-images.adoc b/openshift_images/create-images.adoc index e90b466925..636476df0c 100644 --- a/openshift_images/create-images.adoc +++ b/openshift_images/create-images.adoc @@ -1,4 +1,5 @@ :context: create-images +[id="creating_images"] = Creating images include::modules/common-attributes.adoc[] diff --git a/openshift_images/image-streams-manage.adoc b/openshift_images/image-streams-manage.adoc index 51ca24bba1..8c70d57125 100644 --- a/openshift_images/image-streams-manage.adoc +++ b/openshift_images/image-streams-manage.adoc @@ -1,4 +1,5 @@ :context: image-streams-managing +[id="managing-image-streams"] = Managing image streams include::modules/common-attributes.adoc[] diff --git a/openshift_images/images-understand.adoc b/openshift_images/images-understand.adoc index 786ad142aa..344a82fa67 100644 --- a/openshift_images/images-understand.adoc +++ b/openshift_images/images-understand.adoc @@ -1,4 +1,5 @@ :context: images-understand +[id="understanding-images"] = Understanding containers, images, and image streams include::modules/common-attributes.adoc[] diff --git a/openshift_images/templates-using-ruby-on-rails.adoc b/openshift_images/templates-using-ruby-on-rails.adoc index 6edb1346f4..b371c66928 100644 --- a/openshift_images/templates-using-ruby-on-rails.adoc +++ b/openshift_images/templates-using-ruby-on-rails.adoc @@ -1,4 +1,5 @@ :context: templates-ruby-on-rails +[id="templates-using-ruby-on-rails"] = Using Ruby on Rails include::modules/common-attributes.adoc[] diff --git a/openshift_images/using-templates.adoc b/openshift_images/using-templates.adoc index 3c7b27e7c0..eb51c62d8e 100644 --- a/openshift_images/using-templates.adoc +++ b/openshift_images/using-templates.adoc @@ -1,4 +1,5 @@ :context: using-templates +[id="using-templates"] = Using templates include::modules/common-attributes.adoc[] diff --git a/registry/accessing-the-registry.adoc b/registry/accessing-the-registry.adoc index d3f39d95b3..064e936900 100644 --- a/registry/accessing-the-registry.adoc +++ b/registry/accessing-the-registry.adoc @@ -1,5 +1,5 @@ :context: accessing-the-registry -[id='accessing-the-registry'] +[id="accessing-the-registry"] = Accessing the registry include::modules/common-attributes.adoc[] toc::[] diff --git a/registry/securing-exposing-registry.adoc b/registry/securing-exposing-registry.adoc index a93348cb30..95c96d233b 100644 --- a/registry/securing-exposing-registry.adoc +++ b/registry/securing-exposing-registry.adoc @@ -1,5 +1,5 @@ :context: securing-exposing-registry -[id='securing-exposing-registry'] +[id="securing-exposing-registry"] = Securing and exposing the registry include::modules/common-attributes.adoc[] toc::[] diff --git a/release_notes/comparing_3_4.adoc b/release_notes/comparing_3_4.adoc index 0be322ca0d..ecc1af3491 100644 --- a/release_notes/comparing_3_4.adoc +++ b/release_notes/comparing_3_4.adoc @@ -1,4 +1,4 @@ -[id='architecture'] +[id="comparing_3_4"] = Comparing {product-title} 3 and 4 include::modules/common-attributes.adoc[] :context: comparing_v3_v4 diff --git a/scalability_and_performance/network-optimization.adoc b/scalability_and_performance/network-optimization.adoc index a7b4286dc3..8f80b2768f 100644 --- a/scalability_and_performance/network-optimization.adoc +++ b/scalability_and_performance/network-optimization.adoc @@ -1,4 +1,4 @@ -[id='network-optimization'] +[id="network-optimization"] = Network optimization include::modules/common-attributes.adoc[] :context: networking diff --git a/scalability_and_performance/optimizing-compute-resources.adoc b/scalability_and_performance/optimizing-compute-resources.adoc index d73f75dd0e..eff40f445a 100644 --- a/scalability_and_performance/optimizing-compute-resources.adoc +++ b/scalability_and_performance/optimizing-compute-resources.adoc @@ -1,4 +1,4 @@ -[id='optimizing-compute-resources'] +[id="optimizing-compute-resources"] = Optimizing compute resources include::modules/common-attributes.adoc[] :context: diff --git a/scalability_and_performance/optimizing-storage.adoc b/scalability_and_performance/optimizing-storage.adoc index 3839423155..4c8761ee28 100644 --- a/scalability_and_performance/optimizing-storage.adoc +++ b/scalability_and_performance/optimizing-storage.adoc @@ -1,4 +1,4 @@ -[id='optimizing-storage'] +[id="optimizing-storage"] = Optimizing storage include::modules/common-attributes.adoc[] :gluster: GlusterFS diff --git a/scalability_and_performance/planning-your-environment-according-to-object-limits.adoc b/scalability_and_performance/planning-your-environment-according-to-object-limits.adoc index 499a58d49e..5562b4986c 100644 --- a/scalability_and_performance/planning-your-environment-according-to-object-limits.adoc +++ b/scalability_and_performance/planning-your-environment-according-to-object-limits.adoc @@ -1,4 +1,4 @@ -[id='planning-your-environment-according-to-object-limits'] +[id="planning-your-environment-according-to-object-limits"] = Planning your environment according to object limits include::modules/common-attributes.adoc[] :context: object-limits diff --git a/scalability_and_performance/recommended-host-practices.adoc b/scalability_and_performance/recommended-host-practices.adoc index 355101a901..603357a7e5 100644 --- a/scalability_and_performance/recommended-host-practices.adoc +++ b/scalability_and_performance/recommended-host-practices.adoc @@ -1,4 +1,4 @@ -[id='recommended-host-practices'] +[id="recommended-host-practices"] = Recommended host practices include::modules/common-attributes.adoc[] :context: diff --git a/scalability_and_performance/routing-optimization.adoc b/scalability_and_performance/routing-optimization.adoc index 48868be75c..23e357a4a7 100644 --- a/scalability_and_performance/routing-optimization.adoc +++ b/scalability_and_performance/routing-optimization.adoc @@ -1,4 +1,4 @@ -[id='routing-optimization'] +[id="routing-optimization"] = Routing optimization include::modules/common-attributes.adoc[] :context: routing-optimization diff --git a/scalability_and_performance/scaling-cluster-monitoring-operator.adoc b/scalability_and_performance/scaling-cluster-monitoring-operator.adoc index fee8b5767e..8c82c33822 100644 --- a/scalability_and_performance/scaling-cluster-monitoring-operator.adoc +++ b/scalability_and_performance/scaling-cluster-monitoring-operator.adoc @@ -1,4 +1,4 @@ -[id='scaling-cluster-monitoring-operator'] +[id="scaling-cluster-monitoring-operator"] = Scaling the Cluster Monitoring Operator include::modules/common-attributes.adoc[] :context: cluster-monitoring-operator diff --git a/scalability_and_performance/using-cluster-loader.adoc b/scalability_and_performance/using-cluster-loader.adoc index 698fad18c4..8120596067 100644 --- a/scalability_and_performance/using-cluster-loader.adoc +++ b/scalability_and_performance/using-cluster-loader.adoc @@ -1,4 +1,4 @@ -[id='using_cluster_loader{context}'] +[id="using_cluster_loader{context}"] = Using cluster loader include::modules/common-attributes.adoc[] :context: diff --git a/scalability_and_performance/using-node-tuning-operator.adoc b/scalability_and_performance/using-node-tuning-operator.adoc index abe6e26205..873fb7cb38 100644 --- a/scalability_and_performance/using-node-tuning-operator.adoc +++ b/scalability_and_performance/using-node-tuning-operator.adoc @@ -1,4 +1,4 @@ -[id='using-node-tuning-operator'] +[id="using-node-tuning-operator"] = Using the Node Tuning Operator include::modules/common-attributes.adoc[] :context: node-tuning-operator diff --git a/storage/persistent-storage/persistent-storage-aws.adoc b/storage/persistent-storage/persistent-storage-aws.adoc index d4474f8fad..e2ba976157 100644 --- a/storage/persistent-storage/persistent-storage-aws.adoc +++ b/storage/persistent-storage/persistent-storage-aws.adoc @@ -1,4 +1,4 @@ -[id='persistent-storage-using-aws-ebs'] +[id="persistent-storage-using-aws-ebs"] = Persistent Storage Using AWS Elastic Block Store include::modules/common-attributes.adoc[] :context: persistent-storage-aws diff --git a/storage/persistent-storage/persistent-storage-iscsi.adoc b/storage/persistent-storage/persistent-storage-iscsi.adoc index 85ab0fdaad..e53d7650cb 100644 --- a/storage/persistent-storage/persistent-storage-iscsi.adoc +++ b/storage/persistent-storage/persistent-storage-iscsi.adoc @@ -1,4 +1,4 @@ -[id='persistent-storage-using-iscsi'] +[id="persistent-storage-using-iscsi"] = Persistent Storage Using iSCSI include::modules/common-attributes.adoc[] :context: persistent-storage-iscsi diff --git a/storage/understanding-persistent-storage.adoc b/storage/understanding-persistent-storage.adoc index a3bbdcf011..a3d6234e7b 100644 --- a/storage/understanding-persistent-storage.adoc +++ b/storage/understanding-persistent-storage.adoc @@ -1,4 +1,4 @@ -[id='understanding-persistent-storage'] +[id="understanding-persistent-storage"] = Understanding persistent storage include::modules/common-attributes.adoc[] :context: understanding-persistent-storage diff --git a/web-console/web-console.adoc b/web-console/web-console.adoc index 929e0ee1df..70c6e58171 100644 --- a/web-console/web-console.adoc +++ b/web-console/web-console.adoc @@ -1,5 +1,5 @@ -[id='web-console'] +[id="web-console"] = Accessing the web console include::modules/common-attributes.adoc[] :context: web-console diff --git a/web-console/working-with-projects.adoc b/web-console/working-with-projects.adoc index a3d2ef4e9b..7118ab5100 100644 --- a/web-console/working-with-projects.adoc +++ b/web-console/working-with-projects.adoc @@ -1,4 +1,4 @@ -[id='working-with-projects'] +[id="working-with-projects"] = Working with projects include::modules/common-attributes.adoc[] :context: projects diff --git a/welcome/index.adoc b/welcome/index.adoc index c70af2d40b..130809dce6 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -1,5 +1,5 @@ :context: welcome-index -[id='welcome-index'] +[id="welcome-index"] = {product-title} {product-version} Documentation include::modules/common-attributes.adoc[]