1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

fix toc issue

This commit is contained in:
Paul Needle
2021-03-23 10:45:14 +00:00
parent 5822dd815f
commit 9a18fcda83
279 changed files with 268 additions and 21 deletions

View File

@@ -2,6 +2,7 @@
= The cluster-admin role
include::modules/common-attributes.adoc[]
:context: cluster-administrator
toc::[]
As an administrator of {product-title} with Customer Cloud Subscriptions (link:https://www.openshift.com/dedicated/ccs[CCS]), you can request additional permissions and access to the *cluster-admin* role within your organization's cluster. While logged into an account with the cluster-admin role, users have increased permissions to run privileged security contexts and install additional Operators for their environment.

View File

@@ -2,6 +2,7 @@
= The dedicated-admin role
include::modules/common-attributes.adoc[]
:context: dedicated-administrator
toc::[]
As an administrator of an {product-title} cluster, your account has additional

View File

@@ -2,6 +2,7 @@
= Deleting applications
include::modules/common-attributes.adoc[]
:context: odc-deleting-applications
toc::[]
You can delete applications created in your project.

View File

@@ -2,6 +2,7 @@
= Editing applications
include::modules/common-attributes.adoc[]
:context: odc-editing-applications
toc::[]
You can edit the configuration and the source code of the application you create using the *Topology* view.

View File

@@ -2,6 +2,7 @@
= Viewing application composition using the Topology view
include::modules/common-attributes.adoc[]
:context: viewing-application-composition-using-topology-view
toc::[]
The *Topology* view in the *Developer* perspective of the web console provides a visual representation of all the applications within a project, their build status, and the components and services associated with them.

View File

@@ -2,6 +2,7 @@
= Working with Helm charts using the Developer perspective
include::modules/common-attributes.adoc[]
:context: working-with-helm-charts-using-developer-perspective
toc::[]

View File

@@ -2,6 +2,7 @@
= Monitoring project and application metrics using the Developer perspective
include::modules/common-attributes.adoc[]
:context: monitoring-project-and-application-metrics-using-developer-perspective
toc::[]

View File

@@ -2,6 +2,7 @@
= Creating a project as another user
include::modules/common-attributes.adoc[]
:context: creating-project-other-user
toc::[]
Impersonation allows you to create a project as a different user.

View File

@@ -2,6 +2,7 @@
= Admission plug-ins
include::modules/common-attributes.adoc[]
:context: admission-plug-ins
toc::[]
// Concept modules

View File

@@ -2,6 +2,7 @@
= Installation and update
include::modules/common-attributes.adoc[]
:context: architecture-installation
toc::[]
include::modules/installation-overview.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= {op-system-first}
include::modules/common-attributes.adoc[]
:context: architecture-rhcos
toc::[]
include::modules/rhcos-about.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= {product-title} architecture
include::modules/common-attributes.adoc[]
:context: architecture
toc::[]
include::modules/architecture-platform-introduction.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= The {product-title} control plane
include::modules/common-attributes.adoc[]
:context: control-plane
toc::[]
include::modules/understanding-control-plane.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Understanding {product-title} development
include::modules/common-attributes.adoc[]
:context: understanding-development
toc::[]
To fully leverage the capability of containers when developing and running

View File

@@ -2,6 +2,7 @@
= Using bound service account tokens
include::modules/common-attributes.adoc[]
:context: bound-service-account-tokens
toc::[]
You can use bound service account tokens, which improves the ability to integrate with cloud provider identity access management (IAM) services, such as AWS IAM.

View File

@@ -2,6 +2,7 @@
= Configuring the internal OAuth server
include::modules/common-attributes.adoc[]
:context: configuring-internal-oauth
toc::[]
include::modules/oauth-server-overview.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Configuring OAuth clients
include::modules/common-attributes.adoc[]
:context: configuring-oauth-clients
toc::[]
Several OAuth clients are created by default in {product-title}. You can also register and configure additional OAuth clients.

View File

@@ -2,6 +2,7 @@
= Configuring the user agent
include::modules/common-attributes.adoc[]
:context: configuring-user-agent
toc::[]
include::modules/user-agent-overview.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Understanding identity provider configuration
include::modules/common-attributes.adoc[]
:context: understanding-identity-provider
toc::[]
include::modules/identity-provider-parameters.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Configuring a basic authentication identity provider
include::modules/common-attributes.adoc[]
:context: configuring-basic-authentication-identity-provider
toc::[]
Configure a `basic-authentication` identity provider for users to log in to

View File

@@ -2,6 +2,7 @@
= Configuring a GitHub or GitHub Enterprise identity provider
include::modules/common-attributes.adoc[]
:context: configuring-github-identity-provider
toc::[]
Configure a `github` identity provider to validate user names and passwords

View File

@@ -2,6 +2,7 @@
= Configuring a GitLab identity provider
include::modules/common-attributes.adoc[]
:context: configuring-gitlab-identity-provider
toc::[]
Configure a `gitlab` identity provider to use

View File

@@ -2,6 +2,7 @@
= Configuring a Google identity provider
include::modules/common-attributes.adoc[]
:context: configuring-google-identity-provider
toc::[]
Configure a `google` identity provider using

View File

@@ -2,6 +2,7 @@
= Configuring an HTPasswd identity provider
include::modules/common-attributes.adoc[]
:context: configuring-htpasswd-identity-provider
toc::[]
[id="identity-provider-overview_{context}"]

View File

@@ -2,6 +2,7 @@
= Configuring a Keystone identity provider
include::modules/common-attributes.adoc[]
:context: configuring-keystone-identity-provider
toc::[]
Configure the `keystone` identity provider to integrate

View File

@@ -2,6 +2,7 @@
= Configuring an LDAP identity provider
include::modules/common-attributes.adoc[]
:context: configuring-ldap-identity-provider
toc::[]
Configure the `ldap` identity provider to validate user names and passwords

View File

@@ -2,6 +2,7 @@
= Configuring a OpenID Connect identity provider
include::modules/common-attributes.adoc[]
:context: configuring-oidc-identity-provider
toc::[]
Configure an `oidc` identity provider to integrate with an OpenID Connect

View File

@@ -2,6 +2,7 @@
= Configuring a request header identity provider
include::modules/common-attributes.adoc[]
:context: configuring-request-header-identity-provider
toc::[]
Configure a `request-header` identity provider to identify users from request

View File

@@ -2,6 +2,7 @@
= Impersonating the `system:admin` user
include::modules/common-attributes.adoc[]
:context: impersonating-system-admin
toc::[]
include::modules/authentication-api-impersonation.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Syncing LDAP groups
include::modules/common-attributes.adoc[]
:context: ldap-syncing-groups
toc::[]
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]

View File

@@ -2,6 +2,7 @@
= Managing security context constraints
include::modules/common-attributes.adoc[]
:context: configuring-internal-oauth
toc::[]
include::modules/security-context-constraints-about.adoc[leveloffset=+1]

View File

@@ -3,6 +3,7 @@
include::modules/common-attributes.adoc[]
:context: about-cloud-credential-operator
:FeatureName: Support for Amazon Web Services Secure Token Service (AWS STS)
toc::[]
The Cloud Credential Operator (CCO) manages cloud provider credentials as custom resource definitions (CRDs). The CCO syncs on `CredentialsRequest` custom resources (CRs) to allow {product-title} components to request cloud provider credentials with the specific permissions that are required for the cluster to run.

View File

@@ -3,6 +3,7 @@
include::modules/common-attributes.adoc[]
:context: cco-mode-manual
:FeatureName: Support for Amazon Web Services Secure Token Service (AWS STS)
toc::[]
Manual mode is supported for Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP).

View File

@@ -2,6 +2,7 @@
= Using mint mode
include::modules/common-attributes.adoc[]
:context: cco-mode-mint
toc::[]
Mint mode is supported for Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP).

View File

@@ -2,6 +2,7 @@
= Using passthrough mode
include::modules/common-attributes.adoc[]
:context: cco-mode-passthrough
toc::[]
Passthrough mode is supported for Amazon Web Services (AWS), Microsoft Azure, Google Cloud Platform (GCP), {rh-openstack-first}, {rh-virtualization-first}, and VMware vSphere.

View File

@@ -2,6 +2,7 @@
= Using manual mode with STS
include::modules/common-attributes.adoc[]
:context: cco-mode-sts
toc::[]
Manual mode with STS is available as a link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] for Amazon Web Services (AWS).

View File

@@ -2,6 +2,7 @@
= Removing the kubeadmin user
include::modules/common-attributes.adoc[]
:context: removing-kubeadmin
toc::[]
include::modules/authentication-kubeadmin.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Scoping tokens
include::modules/common-attributes.adoc[]
:context: configuring-internal-oauth
toc::[]
include::modules/tokens-scoping-about.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Understanding and creating service accounts
include::modules/common-attributes.adoc[]
:context: understanding-service-accounts
toc::[]
include::modules/service-accounts-overview.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Understanding authentication
include::modules/common-attributes.adoc[]
:context: understanding-authentication
toc::[]
For users to interact with {product-title}, they must first authenticate

View File

@@ -2,6 +2,7 @@
= Understanding identity provider configuration
include::modules/common-attributes.adoc[]
:context: understanding-identity-provider
toc::[]
The {product-title} master includes a built-in OAuth server. Developers and

View File

@@ -2,6 +2,7 @@
= Using a service account as an OAuth client
include::modules/common-attributes.adoc[]
:context: using-service-accounts-as-oauth-client
toc::[]
include::modules/service-accounts-as-oauth-clients.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Using service accounts in applications
include::modules/common-attributes.adoc[]
:context: using-service-accounts
toc::[]
include::modules/service-accounts-overview.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Performing advanced builds
include::modules/common-attributes.adoc[]
:context: advanced-build-operations
toc::[]
The following sections provide instructions for advanced build operations including

View File

@@ -2,6 +2,7 @@
= Performing basic builds
include::modules/common-attributes.adoc[]
:context: basic-build-operations
toc::[]
The following sections provide instructions for basic build operations including starting and canceling builds, deleting BuildConfigs, viewing build details, and accessing build logs.

View File

@@ -2,6 +2,7 @@
= Build configuration resources
include::modules/common-attributes.adoc[]
:context: build-configuration
toc::[]
Use the following procedure to configure build settings.

View File

@@ -2,6 +2,7 @@
= Using build strategies
include::modules/common-attributes.adoc[]
:context: build-strategies
toc::[]
The following sections define the primary supported build strategies, and how to

View File

@@ -2,6 +2,7 @@
= Custom image builds with Buildah
include::modules/common-attributes.adoc[]
:context: custom-builds-buildah
toc::[]

View File

@@ -2,6 +2,7 @@
= Managing build output
include::modules/common-attributes.adoc[]
:context: managing-build-output
toc::[]

View File

@@ -2,6 +2,7 @@
= Using Red Hat subscriptions in builds
include::modules/common-attributes.adoc[]
:context: running-entitled-builds
toc::[]
Use the following sections to run entitled builds on {product-title}.

View File

@@ -2,6 +2,7 @@
= Securing builds by strategy
include::modules/common-attributes.adoc[]
:context: securing-builds-by-strategy
toc::[]
Builds in {product-title} are run in privileged containers. Depending on the build strategy used, if you have privileges, you can run builds to escalate their permissions on the cluster and host nodes. And as a security measure, it limits who can run builds and the strategy that is used for those builds. Custom builds are inherently less safe than source builds, because they can execute any code within a privileged container, and are disabled by default. Grant docker build permissions with caution, because a vulnerability in the Dockerfile processing logic could result in a privileges being granted on the host node.

View File

@@ -2,6 +2,7 @@
= Setting up additional trusted certificate authorities for builds
include::modules/common-attributes.adoc[]
:context: setting-up-trusted-ca
toc::[]
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]

View File

@@ -2,6 +2,7 @@
= Triggering and modifying builds
include::modules/common-attributes.adoc[]
:context: triggering-builds-build-hooks
toc::[]
The following sections outline how to trigger builds and modify builds using build hooks.

View File

@@ -2,6 +2,7 @@
[id="troubleshooting-builds_{context}"]
= Troubleshooting builds
include::modules/common-attributes.adoc[]
toc::[]
Use the following to troubleshoot build issues.

View File

@@ -2,6 +2,7 @@
= Understanding build configurations
include::modules/common-attributes.adoc[]
:context: understanding-builds
toc::[]
The following sections define the concept of a build, build configuration, and outline the primary build strategies available.

View File

@@ -2,6 +2,7 @@
= Understanding image builds
include::modules/common-attributes.adoc[]
:context: understanding-image-builds
toc::[]
include::modules/builds-about.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Getting started with OpenShift GitOps
include::modules/common-attributes.adoc[]
:context: getting-started-with-openshift-gitops
toc::[]
Red Hat OpenShift GitOps uses Argo CD as the core declarative tool and adds other tooling to enable teams to implement GitOps workflows across clusters.

View File

@@ -3,6 +3,7 @@
include::modules/common-attributes.adoc[]
include::modules/gitops-document-attributes.adoc[]
:context: understanding-openshift-gitops
toc::[]
//Concept Module

View File

@@ -3,6 +3,7 @@
include::modules/common-attributes.adoc[]
include::modules/pipelines-document-attributes.adoc[]
:context: creating-applications-with-cicd-pipelines
toc::[]
With {pipelines-title}, you can create a customized CI/CD solution to build, test, and deploy your application.

View File

@@ -3,6 +3,7 @@
include::modules/common-attributes.adoc[]
include::modules/pipelines-document-attributes.adoc[]
:context: understanding-openshift-pipelines
toc::[]
:FeatureName: OpenShift Pipelines

View File

@@ -5,6 +5,7 @@ include::modules/pipelines-document-attributes.adoc[]
:context: working-with-pipelines-using-the-developer-perspective
toc::[]
You can use the *Developer* perspective of the {product-title} web console to create CI/CD Pipelines for your software delivery process.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: configuring-the-odo-cli
toc::[]
include::modules/developer-cli-odo-using-command-completion.adoc[leveloffset=+1]

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: creating-instances-of-services-managed-by-operators
toc::[]
Operators are a method of packaging, deploying, and managing Kubernetes services. With `{odo-title}`, you can create instances of services from the custom resource definitions (CRDs) provided by the Operators. You can then use these instances in your projects and link them to your components.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: creating-a-java-application-with-a-database
toc::[]
This example describes how to deploy a Java application by using devfile and connect it to a database service.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: creating-a-multicomponent-application-with-odo
toc::[]
`{odo-title}` allows you to create a multicomponent application, modify it, and link its components in an easy and automated way.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: creating-a-single-component-application-with-odo
toc::[]
With `{odo-title}`, you can create and deploy applications on clusters.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: creating-an-application-with-a-database
toc::[]
This example describes how to deploy and connect a database to a front-end application.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: debugging-applications-in-odo
toc::[]
With `{odo-title}`, you can attach a debugger to remotely debug your application. This feature is only supported for NodeJS and Java components.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: deleting-applications
toc::[]
You can delete applications and all components associated with the application in your project.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: using-sample-applications
toc::[]
`{odo-title}` offers partial compatibility with any language or runtime listed within the OpenShift catalog of component types. For example:

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: creating-applications-by-using-devfiles
toc::[]
include::modules/developer-cli-odo-about-devfiles-in-odo.adoc[leveloffset=+1]

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: working-with-projects
toc::[]
Project keeps your source code, tests, and libraries organized in a separate single unit.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: working-with-storage
toc::[]
Persistent storage keeps data available between restarts of `{odo-title}`.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: installing-odo
toc::[]
The following section describes how to install `{odo-title}` on different platforms using the CLI or the Visual Studio Code (VS Code) IDE.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: managing-environment-variables
toc::[]
`{odo-title}` stores component-specific configurations and environment variables in the `config` file. You can use the `odo config` command to set, unset, and list environment variables for components without the need to modify the `config` file.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: odo-architecture
toc::[]
This section describes `{odo-title}` architecture and how `{odo-title}` manages resources on a cluster.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: odo-cli-reference
toc::[]
include::modules/developer-cli-odo-basic-odo-cli-commands.adoc[leveloffset=+1]

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: odo-release-notes
toc::[]
[id="odo-notable-improvements_{context}"]

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: understanding-odo
toc::[]
`{odo-title}` is a CLI tool for creating applications on {product-title} and Kubernetes. With `{odo-title}`, you can write, build, and debug applications on a cluster without the need to administer the cluster itself.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: about-odo-in-a-restricted-environment
toc::[]

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: creating-and-deploying-a-component-to-the-disconnected-cluster
toc::[]
After you push the `init` image to a cluster with a mirrored registry, you must mirror a supported builder image for your application with the `oc` tool, overwrite the mirror registry using the environment variable, and then create your component.

View File

@@ -3,6 +3,7 @@
include::modules/developer-cli-odo-attributes.adoc[]
include::modules/common-attributes.adoc[]
:context: pushing-the-odo-init-image-to-the-restricted-cluster-registry
toc::[]
Depending on the configuration of your cluster and your operating system you can either push the `odo` init image to a mirror registry or directly to an internal registry.

View File

@@ -3,6 +3,7 @@
include::modules/common-attributes.adoc[]
include::modules/pipelines-document-attributes.adoc[]
:context: op-tkn-reference
toc::[]

View File

@@ -2,6 +2,7 @@
= Accessing AWS infrastructure
include::modules/common-attributes.adoc[]
:context: dedicated-aws-access
toc::[]
Amazon Web Services (AWS) infrastructure access allows

View File

@@ -2,6 +2,7 @@
= Configuring AWS Direct Connect
include::modules/common-attributes.adoc[]
:context: dedicated-aws-direct-connect
toc::[]
This process describes accepting an AWS Direct Connect virtual interface with

View File

@@ -2,6 +2,7 @@
= Configuring AWS VPC peering
include::modules/common-attributes.adoc[]
:context: dedicated-aws-peering
toc::[]
This sample process configures an Amazon Web Services (AWS) VPC containing an

View File

@@ -2,6 +2,7 @@
= Configuring a private cluster
include::modules/common-attributes.adoc[]
:context: dedicated-private-cluster
toc::[]
An {product-title} cluster can be made private so that internal applications can be hosted inside a corporate network. In addition, private clusters can be configured to have only internal API endpoints for increased security.

View File

@@ -2,6 +2,7 @@
= Configuring AWS VPN
include::modules/common-attributes.adoc[]
:context: dedicated-aws-vpn
toc::[]
This sample process configures an Amazon Web Services (AWS) {product-title}

View File

@@ -2,6 +2,7 @@
= Accessing virtual machine consoles
include::modules/cnv-document-attributes.adoc[]
:context: cnv-accessing-vm-consoles
toc::[]
{CNVProductNameStart} provides different virtual machine consoles that you can

View File

@@ -2,6 +2,7 @@
= {product-title} installation overview
include::modules/common-attributes.adoc[]
:context: ocp-installation-overview
toc::[]
include::modules/installation-overview.adoc[leveloffset=+1]

View File

@@ -5,4 +5,4 @@ include::modules/common-attributes.adoc[]
toc::[]
include::modules/installation-osp-balancing-external-loads.adoc[leveloffset=+1]
include::modules/installation-osp-balancing-external-loads.adoc[leveloffset=+1]

View File

@@ -4,7 +4,6 @@
include::modules/ossm-document-attributes.adoc[]
include::modules/common-attributes.adoc[]
toc::[]
When opening a support case, it is helpful to provide debugging information about your cluster to Red Hat Support.

View File

@@ -14,4 +14,4 @@ include::modules/machineset-yaml-osp.adoc[leveloffset=+1]
include::modules/machineset-creating.adoc[leveloffset=+1]
// Mothballed - re-add when available
// include::modules/machineset-osp-adding-bare-metal.adoc[leveloffset=+1]
// include::modules/machineset-osp-adding-bare-metal.adoc[leveloffset=+1]

View File

@@ -2,6 +2,7 @@
= Deploying machine health checks
include::modules/common-attributes.adoc[]
:context: deploying-machine-health-checks
toc::[]
You can configure and deploy a machine health check to automatically repair damaged machines in a machine pool.

View File

@@ -12,6 +12,7 @@
= Getting started with modular docs on OpenShift
include::modules/common-attributes.adoc[]
:context: assembly-gsg
toc::[]
This is the modular docs getting started guide for the OpenShift documentation

View File

@@ -11,6 +11,7 @@
= Modular docs OpenShift conventions
include::modules/common-attributes.adoc[]
:context: assembly-ocp-conventions
toc::[]
Before you contribute to the OpenShift docs repo, review the following modular docs conventions.

View File

@@ -1,8 +1,6 @@
{product-author}
// The {product-title} attribute provides the context-sensitive name of the relevant OpenShift distribution, for example, "OpenShift Container Platform" or "OKD". The {product-version} attribute provides the product version relative to the distribution, for example "4.8".
// {product-title} and {product-version} are parsed when AsciiBinder queries the _distro_map.yml file in relation to the base branch of a pull request.
// See https://github.com/openshift/openshift-docs/blob/master/contributing_to_docs/doc_guidelines.adoc#product-name-version for more information on this topic.
{product-version}
// Other common attributes are defined in the following lines:
:data-uri:
:icons:

View File

@@ -2,6 +2,7 @@
= About the Kubernetes NMState Operator
:FeatureName: Kubernetes NMState Operator
:context: k8s-nmstate-operator
toc::[]
The Kubernetes NMState Operator provides a Kubernetes API for performing state-driven network configuration across the {product-title} cluster's nodes with NMState. The Kubernetes NMState Operator provides users with functionality to configure various network interface types, DNS, and routing on cluster nodes. Additionally, the daemons on the cluster nodes periodically report on the state of each node's network interfaces to the API server.

View File

@@ -3,6 +3,7 @@
include::modules/virt-document-attributes.adoc[]
:VirtProductName: OpenShift Container Platform
:context: k8s-nmstate-observing-node-network-state
toc::[]
Node network state is the network configuration for all nodes in the cluster.

View File

@@ -3,6 +3,7 @@
include::modules/virt-document-attributes.adoc[]
:VirtProductName: OpenShift Container Platform
:context: k8s-nmstate-troubleshooting-node-network
toc::[]
If the node network configuration encounters an issue, the policy is automatically rolled back and the enactments report failure.

Some files were not shown because too many files have changed in this diff Show More