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

Adding snippets folder and all required symbolic links

This commit is contained in:
Mike Pytlak
2021-11-23 12:55:33 -05:00
committed by Kathryn Alexander
parent 0db35391f8
commit 742d094e8c
128 changed files with 136 additions and 48 deletions

View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../snippets

1
applications/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
architecture/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
authentication/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -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.

View File

@@ -0,0 +1 @@
../../../snippets/

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -0,0 +1 @@
../../../snippets/

View File

@@ -0,0 +1 @@
../../snippets/

View File

@@ -51,7 +51,7 @@ As a cluster administrator, you can back up and restore applications running on
// ** 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:
//

1
backup_and_restore/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
cicd/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
cli_reference/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../snippets

1
cloud_providers/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets/

View File

@@ -389,8 +389,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

View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../../snippets/

View File

@@ -0,0 +1 @@
../../snippets/

View File

@@ -0,0 +1 @@
../../snippets/

1
distr_tracing/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets/

1
getting_started/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -9,7 +9,7 @@ toc::[]
Learn about the Driver Toolkit and how you can use it as a base image for driver containers for enabling special software and hardware devices on Kubernetes.
:FeatureName: The Driver Toolkit
include::modules/technology-preview.adoc[leveloffset=+0]
include::snippets/technology-preview.adoc[leveloffset=+0]
include::modules/psap-driver-toolkit.adoc[leveloffset=+1]

View File

@@ -10,7 +10,7 @@ Learn about the Special Resource Operator (SRO) and how you can use it to build
:FeatureName: The Special Resource Operator
include::modules/technology-preview.adoc[leveloffset=+0]
include::snippets/technology-preview.adoc[leveloffset=+0]
include::modules/psap-special-resource-operator.adoc[leveloffset=+1]

View File

@@ -0,0 +1 @@
../snippets

1
identity_providers/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
installing/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
jaeger/jaeger_arch/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets/

View File

@@ -0,0 +1 @@
../snippets/

View File

@@ -0,0 +1 @@
../snippets/

1
jaeger/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
kubefed/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets/

View File

@@ -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.

1
logging/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
machine_management/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
metering/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
metrics/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../snippets

1
mod_docs_guide/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
modules/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets/

View File

@@ -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]

View File

@@ -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

View File

@@ -6,8 +6,8 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: Alert routing for user-defined projects
include::modules/technology-preview.adoc[leveloffset=+1]
:FeatureName: Alert routing for user-defined projects
include::snippets/technology-preview.adoc[leveloffset=+1]
[role="_abstract"]
In {product-title} {product-version}, a cluster administrator can enable alert routing for user-defined projects.
@@ -21,7 +21,7 @@ include::modules/monitoring-enabling-alert-routing-for-user-defined-projects.ado
// Granting users permission to configure alert routing for user-defined projects
include::modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc[leveloffset=+1]
// Disabling alert routing for user-defined projects
// Disabling alert routing for user-defined projects
include::modules/monitoring-disabling-alert-routing-for-user-defined-projects.adoc[leveloffset=+1]
.Additional resources
@@ -32,5 +32,3 @@ include::modules/monitoring-disabling-alert-routing-for-user-defined-projects.ad
== Next steps
* xref:../monitoring/managing-alerts.adoc#creating-alert-routing-for-user-defined-projects_managing-alerts[Creating alert routing for user defined projects]

1
monitoring/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../../snippets

View File

@@ -19,7 +19,7 @@ include::modules/nw-sriov-dpdk-example-mellanox.adoc[leveloffset=+1]
== Using a virtual function in RDMA mode with a Mellanox NIC
:FeatureName: RDMA over Converged Ethernet (RoCE)
include::modules/technology-preview.adoc[leveloffset=+0]
include::snippets/technology-preview.adoc[leveloffset=+0]
// Use a tag to skip header and include content only
include::modules/nw-sriov-rdma-example-mellanox.adoc[tag=content]

View File

@@ -8,7 +8,7 @@ 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.
include::modules/technology-preview.adoc[]
include::snippets/technology-preview.adoc[]
Before you can use NMState with {product-title}, you must install the Kubernetes NMState Operator.

View File

@@ -0,0 +1 @@
../../snippets

1
networking/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -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

View File

@@ -14,7 +14,7 @@ xref:../../nodes/nodes/eco-poison-pill-operator.adoc#poison-pill-operator-remedi
:FeatureName: Node Health Check Operator
include::modules/technology-preview.adoc[leveloffset=+1]
include::snippets/technology-preview.adoc[leveloffset=+1]
include::modules/eco-node-health-check-operator-about.adoc[leveloffset=+1]

1
nodes/nodes/snippets Symbolic link
View File

@@ -0,0 +1 @@
../../snippets

1
nodes/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
openshift_images/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
operators/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
osd_architecture/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
osd_cluster_create/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
osd_notifications/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
osd_planning/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
osd_policy/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../snippets

1
osd_quickstart/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
planning/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -15,7 +15,7 @@ A disconnected cluster, also known as a restricted cluster, does not have an act
This topic describes the general process for converting an existing, connected cluster into a disconnected cluster.
:FeatureName: The process for converting a cluster from connected to disconnected
include::modules/technology-preview.adoc[leveloffset=+1]
include::snippets/technology-preview.adoc[leveloffset=+1]
include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]

View File

@@ -0,0 +1 @@
../snippets

1
registry/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
release_notes/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
rosa_architecture/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
rosa_cli/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../snippets

1
rosa_planning/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
rosa_policy/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
rosa_support/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

1
router/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1 @@
../snippets

View File

@@ -10,7 +10,7 @@ toc::[]
Use zero touch provisioning (ZTP) to provision distributed units at new edge sites in a disconnected environment. The workflow starts when the site is connected to the network and ends with the CNF workload deployed and running on the site nodes.
:FeatureName: ZTP for RAN deployments
include::modules/technology-preview.adoc[leveloffset=+1]
include::snippets/technology-preview.adoc[leveloffset=+1]
include::modules/ztp-provisioning-edge-sites-at-scale.adoc[leveloffset=+1]

1
security/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -69,7 +69,7 @@ include::modules/serverless-https-redirect-service.adoc[leveloffset=+1]
== Using kn CLI in offline mode
:FeatureName: The offline mode of the kn CLI
include::modules/technology-preview.adoc[leveloffset=+1]
include::snippets/technology-preview.adoc[leveloffset=+1]
include::modules/kn-service-offline-about.adoc[leveloffset=+2]
include::modules/kn-service-offline-create.adoc[leveloffset=+2]

View File

@@ -8,7 +8,7 @@ include::modules/serverless-document-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
{FunctionsProductName} enables developers to create and deploy stateless, event-driven functions as a Knative service on {product-title}.

View File

@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
After you have xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-create-func-kn_serverless-functions-getting-started[created a Golang function project], you can modify the template files provided to add business logic to your function.

View File

@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
After you have xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-create-func-kn_serverless-functions-getting-started[created a Node.js function project], you can modify the template files provided to add business logic to your function.

View File

@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
After you have xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-create-func-kn_serverless-functions-getting-started[created a Python function project], you can modify the template files provided to add business logic to your function.

View File

@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
After you have xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-create-func-kn_serverless-functions-getting-started[created a Quarkus function project], you can modify the template files provided to add business logic to your function.

View File

@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
After you have xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-create-func-kn_serverless-functions-getting-started[created a TypeScript function project], you can modify the template files provided to add business logic to your function.

View File

@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
Functions are deployed as a Knative service on an {product-title} cluster, and can be connected as a sink to Knative Eventing components.

View File

@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
This guide explains how you can get started with creating, building, and deploying a function on an {ServerlessProductName} installation.

View File

@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
{FunctionsProductName} provides templates that can be used to create basic functions for the following runtimes:

View File

@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[leveloffset=+2]
Before you can develop functions on {ServerlessProductName}, you must complete the set up steps.

View File

@@ -0,0 +1 @@
../../snippets

1
serverless/monitor/snippets Symbolic link
View File

@@ -0,0 +1 @@
../../snippets

1
serverless/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

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