Skip to content

Commit

Permalink
OSDOCS-4815: Updating 'plug-in' to 'plugin'
Browse files Browse the repository at this point in the history
  • Loading branch information
bergerhoffer authored and openshift-cherrypick-robot committed Jan 17, 2023
1 parent eab99c7 commit c7fcfb1
Show file tree
Hide file tree
Showing 342 changed files with 862 additions and 869 deletions.
4 changes: 2 additions & 2 deletions architecture/admission-plug-ins.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_content-type: ASSEMBLY
[id="admission-plug-ins"]
= Admission plug-ins
= Admission plugins
include::_attributes/common-attributes.adoc[]
:context: admission-plug-ins

Expand All @@ -23,7 +23,7 @@ include::modules/configuring-dynamic-admission.adoc[leveloffset=+1]
== Additional resources

ifdef::openshift-enterprise,openshift-webscale[]
* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#configuring-sriov-operator[Limiting custom network resources managed by the SR-IOV network device plug-in]
* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#configuring-sriov-operator[Limiting custom network resources managed by the SR-IOV network device plugin]
endif::[]

* xref:../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations_dedicating_nodes-scheduler-taints-tolerations[Defining tolerations that enable taints to qualify which pods should be scheduled on a node]
Expand Down
6 changes: 3 additions & 3 deletions architecture/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,6 @@ During the first boot, Ignition reads its configuration from the installation me
You can learn how xref:../architecture/architecture-rhcos.adoc#architecture-rhcos[Ignition works], the process for a {op-system-first} machine in an {product-title} cluster, view Ignition configuration files, and change Ignition configuration after an installation.

[id="about-admission-plug-ins"]
== About admission plug-ins
You can use xref:../architecture/admission-plug-ins.adoc#admission-plug-ins[admission plug-ins] to regulate how {product-title} functions. After a resource request is authenticated and authorized, admission plug-ins intercept the resource request to the master API to validate resource requests and to ensure that scaling policies are adhered to.
Admission plug-ins are used to enforce security policies, resource limitations, or configuration requirements.
== About admission plugins
You can use xref:../architecture/admission-plug-ins.adoc#admission-plug-ins[admission plugins] to regulate how {product-title} functions. After a resource request is authenticated and authorized, admission plugins intercept the resource request to the master API to validate resource requests and to ensure that scaling policies are adhered to.
Admission plugins are used to enforce security policies, resource limitations, or configuration requirements.
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ include::modules/verifying-the-assumed-iam-role-in-your-pod.adoc[leveloffset=+2]
* For more information about installing and using the AWS Boto3 SDK for Python, see the link:https://boto3.amazonaws.com/v1/documentation/api/latest/index.html[AWS Boto3 documentation].

ifdef::openshift-rosa,openshift-dedicated[]
* For general information about webhook admission plug-ins for OpenShift, see link:https://docs.openshift.com/container-platform/4.11/architecture/admission-plug-ins.html#admission-webhooks-about_admission-plug-ins[Webhook admission plug-ins] in the OpenShift Container Platform documentation.
* For general information about webhook admission plugins for OpenShift, see link:https://docs.openshift.com/container-platform/4.11/architecture/admission-plug-ins.html#admission-webhooks-about_admission-plug-ins[Webhook admission plugins] in the OpenShift Container Platform documentation.
endif::openshift-rosa,openshift-dedicated[]
12 changes: 6 additions & 6 deletions backup_and_restore/application_backup_and_restore/oadp-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,13 @@ link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#Applicat

|`defaultPlugins`
|[] link:https://pkg.go.dev/builtin#string[string]
|The following types of default Velero plug-ins can be installed: `aws`,`azure`, `csi`, `gcp`, `kubevirt`, and `openshift`.
|The following types of default Velero plugins can be installed: `aws`,`azure`, `csi`, `gcp`, `kubevirt`, and `openshift`.

|`customPlugins`
|[]link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#CustomPlugin[CustomPlugin]
|Used for installation of custom Velero plug-ins.
|Used for installation of custom Velero plugins.

Default and custom plug-ins are described in xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins#oadp-features-plugins[OADP plug-ins]
Default and custom plugins are described in xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins#oadp-features-plugins[OADP plugins]

|`restoreResourcesVersionPriority`
|link:https://pkg.go.dev/builtin#string[string]
Expand Down Expand Up @@ -165,11 +165,11 @@ link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#VeleroCo

|`name`
|link:https://pkg.go.dev/builtin#string[string]
|Name of custom plug-in.
|Name of custom plugin.

|`image`
|link:https://pkg.go.dev/builtin#string[string]
|Image of custom plug-in.
|Image of custom plugin.
|===

link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#CustomPlugin[Complete schema definitions for the type `CustomPlugin`].
Expand Down Expand Up @@ -241,7 +241,7 @@ link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#Features

|`enable`
|link:https://pkg.go.dev/builtin#bool[bool]
|If set to `true`, deploys the volume snapshot mover controller and a modified CSI Data Mover plug-in. If set to `false`, these are not deployed.
|If set to `true`, deploys the volume snapshot mover controller and a modified CSI Data Mover plugin. If set to `false`, these are not deployed.

|`credentialName`
|link:https://pkg.go.dev/builtin#string[string]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:_content-type: ASSEMBLY
[id="oadp-features-plugins"]
= OADP features and plug-ins
= OADP features and plugins
include::_attributes/common-attributes.adoc[]
:context: oadp-features-plugins

toc::[]

OpenShift API for Data Protection (OADP) features provide options for backing up and restoring applications.

The default plug-ins enable Velero to integrate with certain cloud providers and to back up and restore {product-title} resources.
The default plugins enable Velero to integrate with certain cloud providers and to back up and restore {product-title} resources.

include::modules/oadp-features.adoc[leveloffset=+1]
include::modules/oadp-plugins.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ include::modules/migration-debugging-velero-resources.adoc[leveloffset=+1]
[id="issues-with-velero-and-admission-workbooks"]
== Issues with Velero and admission webhooks

Velero has limited abilities to resolve admission webhook issues during a restore. If you have workloads with admission webhooks, you might need to use an additional Velero plug-in or make changes to how you restore the workload.
Velero has limited abilities to resolve admission webhook issues during a restore. If you have workloads with admission webhooks, you might need to use an additional Velero plugin or make changes to how you restore the workload.

Typically, workloads with admission webhooks require you to create a resource of a specific kind first. This is especially true if your workload has child resources because admission webhooks typically block child resources.

Expand All @@ -46,9 +46,9 @@ include::modules/migration-debugging-velero-admission-webhooks-ibm-appconnect.ad
[role="_additional-resources"]
.Additional resources

* xref:../../architecture/admission-plug-ins.adoc[Admission plug-ins]
* xref:../../architecture/admission-plug-ins.adoc#admission-webhooks-about_admission-plug-ins[Webhook admission plug-ins]
* xref:../../architecture/admission-plug-ins.adoc#admission-webhook-types_admission-plug-ins[Types of webhook admission plug-ins]
* xref:../../architecture/admission-plug-ins.adoc[Admission plugins]
* xref:../../architecture/admission-plug-ins.adoc#admission-webhooks-about_admission-plug-ins[Webhook admission plugins]
* xref:../../architecture/admission-plug-ins.adoc#admission-webhook-types_admission-plug-ins[Types of webhook admission plugins]

include::modules/oadp-installation-issues.adoc[leveloffset=+1]
include::modules/oadp-backup-restore-cr-issues.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ toc::[]
* {product-title} 4.10 deprecated the OpenShift Jenkins Maven and NodeJS Agent images. {product-title} 4.11 removes these images from its payload. Red Hat no longer produces these images, and they are not available from the `ocp-tools-4` repository at `registry.redhat.io`. Red Hat maintains the 4.10 and earlier versions of these images for any significant bug fixes or security CVEs, following the link:https://access.redhat.com/support/policy/updates/openshift[{product-title} lifecycle policy].
These changes support the {product-title} 4.10 recommendation to use xref:../../cicd/jenkins/images-other-jenkins.adoc#images-other-jenkins-config-kubernetes_images-other-jenkins[multiple container Pod Templates with the Jenkins Kubernetes Plug-in].
These changes support the {product-title} 4.10 recommendation to use xref:../../cicd/jenkins/images-other-jenkins.adoc#images-other-jenkins-config-kubernetes_images-other-jenkins[multiple container Pod Templates with the Jenkins Kubernetes Plugin].

include::modules/relocation-of-openshift-jenkins-images.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion cli_reference/kn-cli-tools.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Key features of the Knative CLI include:
* Manage features of Knative Serving, such as services, revisions, and traffic-splitting.
* Create and manage Knative Eventing components, such as event sources and triggers.
* Create sink bindings to connect existing Kubernetes applications and Knative services.
* Extend the Knative CLI with flexible plug-in architecture, similar to the `kubectl` CLI.
* Extend the Knative CLI with flexible plugin architecture, similar to the `kubectl` CLI.
* Configure autoscaling parameters for Knative services.
* Scripted usage, such as waiting for the results of an operation, or deploying custom rollout and rollback strategies.

Expand Down
8 changes: 4 additions & 4 deletions cli_reference/openshift_cli/extending-cli-plugins.adoc
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
:_content-type: ASSEMBLY
[id="cli-extend-plugins"]
= Extending the OpenShift CLI with plug-ins
= Extending the OpenShift CLI with plugins
include::_attributes/common-attributes.adoc[]
:context: cli-extend-plugins

toc::[]

You can write and install plug-ins to build on the default `oc` commands,
You can write and install plugins to build on the default `oc` commands,
allowing you to perform new and more complex tasks with the {product-title} CLI.

// Writing CLI plug-ins
// Writing CLI plugins
include::modules/cli-extending-plugins-writing.adoc[leveloffset=+1]

// Installing and using CLI plug-ins
// Installing and using CLI plugins
include::modules/cli-extending-plugins-installing.adoc[leveloffset=+1]
14 changes: 7 additions & 7 deletions cli_reference/openshift_cli/managing-cli-plugins-krew.adoc
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
:_content-type: ASSEMBLY
[id="managing-cli-plugin-krew"]
= Managing CLI plug-ins with Krew
= Managing CLI plugins with Krew
include::_attributes/common-attributes.adoc[]
:context: managing-cli-plugins-krew

toc::[]

You can use Krew to install and manage plug-ins for the OpenShift CLI (`oc`).
You can use Krew to install and manage plugins for the OpenShift CLI (`oc`).

:FeatureName: Using Krew to install and manage plug-ins for the OpenShift CLI
:FeatureName: Using Krew to install and manage plugins for the OpenShift CLI
include::snippets/technology-preview.adoc[]

// Installing a CLI plug-in with Krew
// Installing a CLI plugin with Krew
include::modules/cli-krew-install-plugin.adoc[leveloffset=+1]

// Updating a CLI plug-in with Krew
// Updating a CLI plugin with Krew
include::modules/cli-krew-update-plugin.adoc[leveloffset=+1]

// Removing a CLI plug-in with Krew
// Removing a CLI plugin with Krew
include::modules/cli-krew-remove-plugin.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources_managing-cli-plugins-krew"]
== Additional resources

* link:https://krew.sigs.k8s.io/[Krew]
* xref:../../cli_reference/openshift_cli/extending-cli-plugins.adoc#cli-extend-plugins[Extending the OpenShift CLI with plug-ins]
* xref:../../cli_reference/openshift_cli/extending-cli-plugins.adoc#cli-extend-plugins[Extending the OpenShift CLI with plugins]
2 changes: 1 addition & 1 deletion cli_reference/opm/cli-opm-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ include::modules/opm-cli-ref-index.adoc[leveloffset=+1]

* xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format]
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plug-in]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]
2 changes: 1 addition & 1 deletion installing/disconnected_install/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ If you already have a container image registry, such as Red Hat Quay, you can us
You can use one of the following procedures to mirror your {product-title} image repository to your mirror registry:

* xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[Mirroring images for a disconnected installation]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plug-in]
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
:_content-type: ASSEMBLY
[id="installing-mirroring-disconnected"]
= Mirroring images for a disconnected installation using the oc-mirror plug-in
= Mirroring images for a disconnected installation using the oc-mirror plugin
include::_attributes/common-attributes.adoc[]
:context: installing-mirroring-disconnected

toc::[]

Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running at all times as long as the cluster is running. See the xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#prerequisites_installing-mirroring-disconnected[Prerequisites] section for more information.

You can use the oc-mirror OpenShift CLI (`oc`) plug-in to mirror images to a mirror registry in your fully or partially disconnected environments. You must run oc-mirror from a system with internet connectivity in order to download the required images from the official Red Hat registries.
You can use the oc-mirror OpenShift CLI (`oc`) plugin to mirror images to a mirror registry in your fully or partially disconnected environments. You must run oc-mirror from a system with internet connectivity in order to download the required images from the official Red Hat registries.

The following steps outline the high-level workflow on how to use the oc-mirror plug-in to mirror images to a mirror registry:
The following steps outline the high-level workflow on how to use the oc-mirror plugin to mirror images to a mirror registry:

. Create an image set configuration file.
. Mirror the image set to the mirror registry by using one of the following methods:
Expand All @@ -19,7 +19,7 @@ The following steps outline the high-level workflow on how to use the oc-mirror
. Install the `ImageContentSourcePolicy` and `CatalogSource` resources that were generated by oc-mirror into the cluster.
. Repeat these steps to update your mirror registry as necessary.

// About the oc-mirror plug-in
// About the oc-mirror plugin
include::modules/oc-mirror-about.adoc[leveloffset=+1]

// oc-mirror compatibility and support
Expand All @@ -40,23 +40,23 @@ include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]
+
[NOTE]
====
If you use Red Hat Quay, you must use version 3.6 or later with the oc-mirror plug-in. If you have an entitlement to Red Hat Quay, see the documentation on deploying Red Hat Quay link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.6/html/deploy_red_hat_quay_for_proof-of-concept_non-production_purposes/[for proof-of-concept purposes] or link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.6/html/deploy_red_hat_quay_on_openshift_with_the_quay_operator/[by using the Quay Operator]. If you need additional assistance selecting and installing a registry, contact your sales representative or Red Hat Support.
If you use Red Hat Quay, you must use version 3.6 or later with the oc-mirror plugin. If you have an entitlement to Red Hat Quay, see the documentation on deploying Red Hat Quay link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.6/html/deploy_red_hat_quay_for_proof-of-concept_non-production_purposes/[for proof-of-concept purposes] or link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.6/html/deploy_red_hat_quay_on_openshift_with_the_quay_operator/[by using the Quay Operator]. If you need additional assistance selecting and installing a registry, contact your sales representative or Red Hat Support.
====
+
If you do not already have an existing solution for a container image registry, subscribers of {product-title} are provided a xref:../../installing/disconnected_install/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[mirror registry for Red Hat OpenShift]. The _mirror registry for Red Hat OpenShift_ is included with your subscription and is a small-scale container registry that can be used to mirror the required container images of {product-title} in disconnected installations.

[id="mirroring-preparing-your-hosts"]
== Preparing your mirror hosts

Before you can use the oc-mirror plug-in to mirror images, you must install the plug-in and create a container image registry credentials file to allow the mirroring from Red Hat to your mirror.
Before you can use the oc-mirror plugin to mirror images, you must install the plugin and create a container image registry credentials file to allow the mirroring from Red Hat to your mirror.

// Installing the oc-mirror OpenShift CLI plug-in
// Installing the oc-mirror OpenShift CLI plugin
include::modules/oc-mirror-installing-plugin.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../../cli_reference/openshift_cli/extending-cli-plugins.adoc#cli-installing-plugins_cli-extend-plugins[Installing and using CLI plug-ins]
* xref:../../cli_reference/openshift_cli/extending-cli-plugins.adoc#cli-installing-plugins_cli-extend-plugins[Installing and using CLI plugins]

// Configuring credentials that allow images to be mirrored
include::modules/installation-adding-registry-pull-secret.adoc[leveloffset=+2]
Expand All @@ -74,7 +74,7 @@ include::modules/oc-mirror-creating-image-set-config.adoc[leveloffset=+1]
[id="mirroring-image-set"]
== Mirroring an image set to a mirror registry

You can use the oc-mirror CLI plug-in to mirror images to a mirror registry in a xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-partial[partially disconnected environment] or in a xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-full[fully disconnected environment].
You can use the oc-mirror CLI plugin to mirror images to a mirror registry in a xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-partial[partially disconnected environment] or in a xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#mirroring-image-set-full[fully disconnected environment].

These procedures assume that you already have your mirror registry set up.

Expand Down
Loading

0 comments on commit c7fcfb1

Please sign in to comment.