Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[enterprise-4.6] Adding snippets folder and all required symbolic links #41470

Merged
merged 1 commit into from
Feb 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions administering_a_cluster/snippets
1 change: 1 addition & 0 deletions applications/application_life_cycle_management/snippets
1 change: 1 addition & 0 deletions applications/snippets
1 change: 1 addition & 0 deletions architecture/snippets
1 change: 1 addition & 0 deletions authentication/snippets
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You back up applications by creating a xref:../../../backup_and_restore/applicat
The `Backup` CR creates backup files for Kubernetes resources and internal images, on S3 object storage, and snapshots for persistent volumes (PVs), if the cloud provider uses a native snapshot API or the xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-backing-up-pvs-csi_backing-up-applications[Container Storage Interface (CSI)] to create snapshots, such as OpenShift Container Storage 4. For more information, see xref:../../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots[CSI volume snapshots].

:FeatureName: The `CloudStorage` API for S3 storage
include::modules/technology-preview.adoc[]
include::snippets/technology-preview.adoc[]

If your cloud provider has a native snapshot API or supports xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-backing-up-pvs-csi_backing-up-applications[Container Storage Interface (CSI) snapshots], the `Backup` CR backs up persistent volumes by creating snapshots. For more information, see the xref:../../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots-overview_persistent-storage-csi-snapshots[Overview of CSI volume snapshots] in the {product-title} documentation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To back up Kubernetes resources and internal images, you must have object storag
* S3-compatible object storage, such as Noobaa or Minio

:FeatureName: The `CloudStorage` API for S3 storage
include::modules/technology-preview.adoc[]
include::snippets/technology-preview.adoc[]

You can back up persistent volumes (PVs) by using snapshots or Restic.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ toc::[]
You install the Openshift API for Data Protection (OADP) with Amazon Web Services (AWS) by installing the OADP Operator, configuring AWS for Velero, and then installing the Data Protection Application.

:FeatureName: The `CloudStorage` API for S3 storage
include::modules/technology-preview.adoc[]
include::snippets/technology-preview.adoc[]

To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ toc::[]
You install the Openshift API for Data Protection (OADP) with Microsoft Azure by installing the OADP Operator, configuring Azure for Velero, and then installing the Data Protection Application.

:FeatureName: The `CloudStorage` API for S3 storage
include::modules/technology-preview.adoc[]
include::snippets/technology-preview.adoc[]

To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ toc::[]
You install the Openshift API for Data Protection (OADP) with Google Cloud Platform (GCP) by installing the OADP Operator, configuring GCP for Velero, and then installing the Data Protection Application.

:FeatureName: The `CloudStorage` API for S3 storage
include::modules/technology-preview.adoc[]
include::snippets/technology-preview.adoc[]

To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You install the Openshift API for Data Protection (OADP) with Multicloud Object
MCG is a component of OpenShift Container Storage (OCS). You configure MCG as a backup location in the `DataProtectionApplication` custom resource (CR).

:FeatureName: The `CloudStorage` API for S3 storage
include::modules/technology-preview.adoc[]
include::snippets/technology-preview.adoc[]

If your cloud provider has a native snapshot API, configure a snapshot location. If your cloud provider does not support snapshots or if your storage is NFS, you can create backups with Restic.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You install the Openshift API for Data Protection (OADP) with OpenShift Containe
You can configure xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway] or any S3-compatible object storage as a backup location in the `DataProtectionApplication` custom resource (CR).

:FeatureName: The `CloudStorage` API for S3 storage
include::modules/technology-preview.adoc[]
include::snippets/technology-preview.adoc[]

If the cloud provider has a native snapshot API, you can configure cloud storage as a snapshot location in the `DataProtectionApplication` CR. You do not need to specify a snapshot location for Restic or Container Storage Interface (CSI) snapshots.

Expand Down
1 change: 1 addition & 0 deletions backup_and_restore/application_backup_and_restore/snippets
2 changes: 1 addition & 1 deletion backup_and_restore/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You can always recover from a disaster situation by xref:../backup_and_restore/c
// ** S3-compatible object storage, such as Noobaa or Minio
//
// :FeatureName: The `CloudStorage` API for S3 storage
// include::modules/technology-preview.adoc[]
// include::snippets/technology-preview.adoc[]
//
// * To back up PVs with snapshots, you must have cloud storage that has a native snapshot API or supports Container Storage Interface (CSI) snapshots, such as the following providers:
//
Expand Down
1 change: 1 addition & 0 deletions backup_and_restore/snippets
1 change: 1 addition & 0 deletions cicd/snippets
1 change: 1 addition & 0 deletions cli_reference/helm_cli/snippets
1 change: 1 addition & 0 deletions cli_reference/snippets
1 change: 1 addition & 0 deletions cloud_infrastructure_access/snippets
1 change: 1 addition & 0 deletions cloud_providers/snippets
10 changes: 8 additions & 2 deletions contributing_to_docs/doc_guidelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -374,8 +374,14 @@ You must use the .adoc extension in order for the link to work correctly and you
== Indicating Technology Preview Features

To indicate that a feature is in Technology Preview, include the
`modules/technology-preview.adoc` file in the feature's assembly to keep the
supportablity wording consistent across Technology Preview features and provide a value for thee :FeatureName: variable before you include this module.
`snippets/technology-preview.adoc` file in the feature's assembly to keep the
supportability wording consistent across Technology Preview features and provide a value for the :FeatureName: variable before you include this module.

See link:https://github.com/openshift/openshift-docs/pull/13878/files#diff-615ba1bf3b09d11a9c2604b775aa32f2[an example] of how this is applied.

== Indicating deprecated features

To indicate that a feature is deprecated, include the `modules/deprecated-feature.adoc` file in the feature's assembly, or to each relevant assembly such as for a deprecated Operator, to keep the supportability wording consistent across deprecated features. Provide a value for the :FeatureName: variable before you include this module.

See
link:https://github.com/openshift/openshift-docs/pull/13878/files#diff-615ba1bf3b09d11a9c2604b775aa32f2[an
Expand Down
1 change: 1 addition & 0 deletions contributing_to_docs/snippets
1 change: 1 addition & 0 deletions distr_tracing/distr_tracing_arch/snippets
1 change: 1 addition & 0 deletions distr_tracing/distr_tracing_config/snippets
1 change: 1 addition & 0 deletions distr_tracing/distr_tracing_install/snippets
1 change: 1 addition & 0 deletions distr_tracing/snippets
1 change: 1 addition & 0 deletions getting_started/snippets
1 change: 1 addition & 0 deletions identity_providers/snippets
1 change: 1 addition & 0 deletions installing/snippets
1 change: 1 addition & 0 deletions jaeger/jaeger_arch/snippets
1 change: 1 addition & 0 deletions jaeger/jaeger_config/snippets
1 change: 1 addition & 0 deletions jaeger/jaeger_install/snippets
1 change: 1 addition & 0 deletions jaeger/snippets
1 change: 1 addition & 0 deletions kubefed/snippets
2 changes: 1 addition & 1 deletion kubefed/understanding-kubefed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::modules/kubefed-document-attributes.adoc[]
:context: understanding-kubefed

:FeatureName: Red Hat OpenShift Kubernetes Cluster Federation (KubeFed)
include::modules/technology-preview.adoc[leveloffset=+1]
include::snippets/technology-preview.adoc[leveloffset=+1]

{KubeFedProductName} is based on the open source Kubernetes Cluster Federation (KubeFed) project.
It enables coordinated and centrally managed configuration for multiple clusters in a federated {product-title} deployment through a single API interface.
Expand Down
1 change: 1 addition & 0 deletions logging/snippets
1 change: 1 addition & 0 deletions machine_management/snippets
1 change: 1 addition & 0 deletions metering/snippets
1 change: 1 addition & 0 deletions metrics/snippets
1 change: 1 addition & 0 deletions migrating_from_ocp_3_to_4/snippets
1 change: 1 addition & 0 deletions migration_toolkit_for_containers/snippets
1 change: 1 addition & 0 deletions mod_docs_guide/snippets
1 change: 1 addition & 0 deletions modules/snippets
2 changes: 1 addition & 1 deletion monitoring/application-monitoring.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ toc::[]
You can configure custom metrics scraping for your applications. For that, you deploy the Prometheus Operator and a custom Prometheus instance and Alertmanager instance in the namespace where your application is.

:FeatureName: Application monitoring
include::modules/technology-preview.adoc[leveloffset=+0]
include::snippets/technology-preview.adoc[leveloffset=+0]

include::modules/monitoring-configuring-cluster-for-application-monitoring.adoc[leveloffset=+1]
include::modules/monitoring-configuring-monitoring-for-an-application.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion monitoring/configuring-hpa-for-an-application.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ toc::[]
You can configure Horizontal Pod Autoscaling (HPA) for an application that exports metrics.

:FeatureName: Horizontal Pod Autoscaling for an application
include::modules/technology-preview.adoc[leveloffset=+0]
include::snippets/technology-preview.adoc[leveloffset=+0]

== Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ toc::[]
You can export custom application metrics for the horizontal pod autoscaler.

:FeatureName: Prometheus Adapter
include::modules/technology-preview.adoc[leveloffset=+0]
include::snippets/technology-preview.adoc[leveloffset=+0]

// Exposing custom application metrics for horizontal pod autoscaling
include::modules/monitoring-exposing-custom-application-metrics-for-horizontal-pod-autoscaling.adoc[leveloffset=+1]
Expand Down
1 change: 1 addition & 0 deletions monitoring/snippets
2 changes: 1 addition & 1 deletion networking/configuring-ptp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::modules/common-attributes.adoc[]
toc::[]

:FeatureName: Precision Time Protocol (PTP) hardware
include::modules/technology-preview.adoc[leveloffset=+1]
include::snippets/technology-preview.adoc[leveloffset=+1]

[id="about-using-ptp-hardware"]
== About PTP hardware
Expand Down
1 change: 1 addition & 0 deletions networking/hardware_networks/snippets
4 changes: 2 additions & 2 deletions networking/hardware_networks/using-dpdk-and-rdma.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ You can use Single Root I/O Virtualization (SR-IOV) network hardware with the Da
== Examples of using virtual functions in DPDK and RDMA modes

:FeatureName: The Data Plane Development Kit (DPDK)
include::modules/technology-preview.adoc[leveloffset=+0]
include::snippets/technology-preview.adoc[leveloffset=+0]

:FeatureName: Remote Direct Memory Access (RDMA)
include::modules/technology-preview.adoc[leveloffset=+0]
include::snippets/technology-preview.adoc[leveloffset=+0]

== Prerequisites

Expand Down
1 change: 1 addition & 0 deletions networking/k8s_nmstate/snippets
1 change: 1 addition & 0 deletions networking/multiple_networks/snippets
1 change: 1 addition & 0 deletions networking/ovn_kubernetes_network_provider/snippets
1 change: 1 addition & 0 deletions networking/snippets
1 change: 1 addition & 0 deletions nodes/nodes/snippets
2 changes: 1 addition & 1 deletion nodes/pods/nodes-pods-vertical-autoscaler.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The {product-title} Vertical Pod Autoscaler Operator (VPA) automatically reviews
The VPA helps you to understand the optimal CPU and memory usage for your pods and can automatically maintain pod resources through the pod lifecycle.

:FeatureName: vertical pod autoscaler
include::modules/technology-preview.adoc[leveloffset=+1]
include::snippets/technology-preview.adoc[leveloffset=+1]

// The following include statements pull in the module files that comprise
// the assembly. Include any combination of concept, procedure, or reference
Expand Down
1 change: 1 addition & 0 deletions nodes/pods/snippets
2 changes: 1 addition & 1 deletion nodes/scheduling/nodes-descheduler.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ toc::[]
While the xref:../../nodes/scheduling/nodes-scheduler-about.adoc#nodes-scheduler-about[scheduler] is used to determine the most suitable node to host a new pod, the descheduler can be used to evict a running pod so that the pod can be rescheduled onto a more suitable node.

:FeatureName: The descheduler
include::modules/technology-preview.adoc[leveloffset=+0]
include::snippets/technology-preview.adoc[leveloffset=+0]

// About the descheduler
include::modules/nodes-descheduler-about.adoc[leveloffset=+1]
Expand Down
1 change: 1 addition & 0 deletions nodes/scheduling/snippets
1 change: 1 addition & 0 deletions nodes/snippets
1 change: 1 addition & 0 deletions openshift_images/snippets
1 change: 1 addition & 0 deletions operators/snippets
1 change: 1 addition & 0 deletions osd_architecture/snippets
1 change: 1 addition & 0 deletions osd_cluster_create/snippets
1 change: 1 addition & 0 deletions osd_notifications/snippets
1 change: 1 addition & 0 deletions osd_planning/snippets
1 change: 1 addition & 0 deletions osd_policy/snippets
1 change: 1 addition & 0 deletions osd_private_connections/snippets
1 change: 1 addition & 0 deletions osd_quickstart/snippets
1 change: 1 addition & 0 deletions pipelines/snippets
2 changes: 1 addition & 1 deletion pipelines/understanding-openshift-pipelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ include::modules/pipelines-document-attributes.adoc[]
toc::[]

:FeatureName: OpenShift Pipelines
include::modules/technology-preview.adoc[leveloffset=+1]
include::snippets/technology-preview.adoc[leveloffset=+1]

{pipelines-title} is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. It uses Tekton building blocks to automate deployments across multiple platforms by abstracting away the underlying implementation details. Tekton introduces a number of standard Custom Resource Definitions (CRDs) for defining CI/CD pipelines that are portable across Kubernetes distributions.

Expand Down
1 change: 1 addition & 0 deletions planning/snippets
1 change: 1 addition & 0 deletions post_installation_configuration/snippets
1 change: 1 addition & 0 deletions registry/snippets
1 change: 1 addition & 0 deletions release_notes/snippets
1 change: 1 addition & 0 deletions rosa_architecture/snippets
1 change: 1 addition & 0 deletions rosa_cli/snippets
1 change: 1 addition & 0 deletions rosa_getting_started/snippets
1 change: 1 addition & 0 deletions rosa_getting_started_sts/snippets
1 change: 1 addition & 0 deletions rosa_planning/snippets
1 change: 1 addition & 0 deletions rosa_policy/snippets
1 change: 1 addition & 0 deletions rosa_support/snippets
1 change: 1 addition & 0 deletions router/snippets
1 change: 1 addition & 0 deletions sandboxed_containers/snippets
1 change: 1 addition & 0 deletions scalability_and_performance/snippets
1 change: 1 addition & 0 deletions security/snippets
2 changes: 1 addition & 1 deletion serverless/admin_guide/serverless-kafka-admin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The `KnativeKafka` CR provides users with additional options, such as:
* Kafka broker

:FeatureName: Kafka broker
include::modules/technology-preview.adoc[leveloffset=+1]
include::snippets/technology-preview.adoc[leveloffset=+1]

include::modules/serverless-install-kafka-odc.adoc[leveloffset=+1]

Expand Down
1 change: 1 addition & 0 deletions serverless/admin_guide/snippets
Loading