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

Fixing some typos in main

Browse Source
This commit is contained in:
Andrea Hoffer
2024-02-21 09:59:29 -05:00
committed by openshift-cherrypick-robot
parent a2d268051a
commit 51a1e73f03
13 changed files with 18 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
backup_and_restore/application_backup_and_restore/oadp-rosa/oadp-rosa-backing-up-applications.adoc
View File

@@ -16,7 +16,7 @@ You can subscribe to the service directly from your {aws-short} account.
After you create your clusters, you can operate your clusters with the {product-title} web console or through link:https://docs.openshift.com/dedicated/ocm/ocm-overview.html[{cluster-manager-first}]. You can also use ROSA with OpenShift APIs and command-line interface (CLI) tools.
For additional information about ROSA installation, see link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing Red Hat Openshift Service on AWS (ROSA) interactive walkthrough].
For additional information about ROSA installation, see link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing Red Hat OpenShift Service on AWS (ROSA) interactive walkthrough].
Before installing {oadp-first}, you must set up role and policy credentials for OADP so that it can use the {aws-full} API.
@@ -39,4 +39,3 @@ include::modules/installing-oadp-rosa-sts.adoc[leveloffset=+1]
include::modules/performing-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]
include::modules/cleanup-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]

10
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-setup.adoc
View File

@@ -9,7 +9,7 @@ toc::[]
//rosaworkshop.io content metadata
//Brought into ROSA product docs 2023-11-13
There are currently two supported credential methods when creating a {product-title} (ROSA) cluster. One method uses an IAM user with the `AdministratorAccess` policy. The second and *recommended* method uses Amazon Web Services (AWS) Security Token Service (STS).
There are currently two supported credential methods when creating a {product-title} (ROSA) cluster. One method uses an IAM user with the `AdministratorAccess` policy. The second and *recommended* method uses Amazon Web Services (AWS) Security Token Service (STS).
//To be added when the ROSA with STS Explained tutorial is published:
//For more information, see the xref../cloud_experts_tutorials/cloud_experts_rosa_with_sts_explained.adoc#id[ROSA with STS Explained] tutorial. This workshop uses the STS method.
@@ -69,7 +69,7 @@ There are a few ways to install the OpenShift CLI (`oc`):
* *Option 1: Using the ROSA CLI:*
.. Run `rosa download oc`.
.. Once downloaded, unzip the file and move the executables into a directory in your `PATH`.
* *Option 2: Using the Openshift documentation:*
* *Option 2: Using the OpenShift documentation:*
.. Follow the directions on the xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#installing-openshift-cli[documentation page]
* *Option 3: Using your OpenShift cluster:*
.. If you already have an OpenShift cluster, you can access the CLI tools page by clicking the *Question mark*, then *Command Line Tools*.
@@ -106,7 +106,7 @@ Verify that the configuration is correct by following these steps:
. Run the following command to query the AWS API:
+
[source,terminal]
----
----
aws sts get-caller-identity
----
. You should see a table or JSON file. Verify that the account information is correct.
@@ -188,7 +188,7 @@ OCM Organization External ID: 0000000
. Check the information for accuracy before proceeding.
== Verifying quota
Verify that your AWS account has ample quota in the region in which you will be deploying your cluster.
Verify that your AWS account has ample quota in the region in which you will be deploying your cluster.
* Run the following command:
+
@@ -229,4 +229,4 @@ You have now successfully set up you account and environment. You are ready to d
//*[ROSA]: Red Hat OpenShift Service on AWS
//*[STS]: AWS Security Token Service
//*[OCM]: OpenShift Cluster Manager
//*[OCM]: OpenShift Cluster Manager

2
modules/log-collector-resources-scheduling.adoc
View File

@@ -8,7 +8,7 @@
Administrators can modify the resources or scheduling of the collector by creating a `ClusterLogging` custom resource (CR) that is in the same namespace and has the same name as the `ClusterLogForwarder` CR that it supports.
The applicable stanzas for the `ClusterLogging` CR when using multiple log forwarders in a deployment are `managmentState` and `collection`. All other stanzas are ignored.
The applicable stanzas for the `ClusterLogging` CR when using multiple log forwarders in a deployment are `managementState` and `collection`. All other stanzas are ignored.
.Prerequisites

2
modules/microshift-nw-topology.adoc
View File

@@ -7,7 +7,7 @@
= Network topology
OVN-Kubernetes provides an overlay-based networking implementation. This overlay includes an OVS-based implementation of Service and NetworkPolicy. The overlay network uses the Geneve (Generic Network Virtualization Encapsulation) tunnel protocol. The pod maximum transmission unit (MTU) for the Geneve tunnel is set to the default route MTU if it is not configured.
To configure the MTU, you must must set an equal-to or less-than value than the MTU of the physical interface on the host. A less-than value for the MTU makes room for the required information that is added to the tunnel header before it is transmitted.
To configure the MTU, you must set an equal-to or less-than value than the MTU of the physical interface on the host. A less-than value for the MTU makes room for the required information that is added to the tunnel header before it is transmitted.
OVS runs as a systemd service on the {microshift-short} node. The OVS RPM package is installed as a dependency to the `microshift-networking` RPM package. OVS is started immediately when the `microshift-networking` RPM is installed.

2
modules/nw-secondary-ext-gw-about.adoc
View File

@@ -6,7 +6,7 @@
[id="nw-secondary-ext-gw-about_{context}"]
= How {product-title} determines the external gateway IP address
You configure a secondary external gateway with the `AdminPolicyBasedExternalRoute` custom resource (CR) from the the `k8s.ovn.org` API group. The CR supports static and dynamic approaches to specifying an external gateway's IP address.
You configure a secondary external gateway with the `AdminPolicyBasedExternalRoute` custom resource (CR) from the `k8s.ovn.org` API group. The CR supports static and dynamic approaches to specifying an external gateway's IP address.
Each namespace that a `AdminPolicyBasedExternalRoute` CR targets cannot be selected by any other `AdminPolicyBasedExternalRoute` CR. A namespace cannot have concurrent secondary external gateways.

2
modules/nw-secondary-ext-gw-configure.adoc
View File

@@ -87,7 +87,7 @@ ns1 pod1 1/1 Running 1 (37m ago) 41m 10.130.0.8 node1
. Confirm that the IP address from the previous step is available as an external gateway.
.. To find the the OVN-Kubernetes control plane pod that manages the next hop for the pod, enter the following command:
.. To find the OVN-Kubernetes control plane pod that manages the next hop for the pod, enter the following command:
+
[source,terminal]
----

4
modules/oadp-installing-oadp-rosa-sts.adoc
View File

@@ -61,7 +61,7 @@ $ oc -n openshift-adp create secret generic cloud-credentials \
====
In {product-title} versions 4.15 and later, the OADP Operator supports a new standardized STS workflow through the Operator Lifecycle Manager (OLM)
and Cloud Credentials Operator (CCO). In this workflow, you do not need to create the above
secret, you only need to supply the role ARN during link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html/operators/user-tasks#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[the installation of OLM-managed operators via the the {product-title} web console].
secret, you only need to supply the role ARN during link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html/operators/user-tasks#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[the installation of OLM-managed operators via the {product-title} web console].
The above secret is created automatically via CCO.
====
@@ -162,4 +162,4 @@ restic:
[NOTE]
====
If you want to use two different clusters for backing up and restoring, the two clusters must have identical AWS S3 storage names in both the cloudstorage CR and the OADP `DataProtectionApplication` configuration.
====
====

2
modules/olmv1-adding-a-catalog.adoc
View File

@@ -39,7 +39,7 @@ spec:
----
<1> Specify the catalog's image in the `spec.source.image` field.
<2> If your catalog is hosted on a secure registry, such as `registry.redhat.io`, you must create a pull secret scoped to the `openshift-catalog` namespace.
<3> Specify the interval for polling the remote registry for newer image digests. The default value is `24h`. Valid units include seconds (`s`), minutes (`m`), and and hours (`h`). To disable polling, set a zero value, such as `0s`.
<3> Specify the interval for polling the remote registry for newer image digests. The default value is `24h`. Valid units include seconds (`s`), minutes (`m`), and hours (`h`). To disable polling, set a zero value, such as `0s`.
. Add the catalog to your cluster by running the following command:
+

2
modules/otel-configuring-otelcol-metrics.adoc
View File

@@ -14,7 +14,7 @@ You can enable metrics and alerts of OpenTelemetry Collector instances.
.Procedure
* To enable metrics of a OpenTelemetry Collector instance, set the `spec.observability.metrics.enableMetrics` field to `true`:
* To enable metrics of an OpenTelemetry Collector instance, set the `spec.observability.metrics.enableMetrics` field to `true`:
+
[source,yaml]
----

4
modules/rosa-hcp-aws-privatelink-security-groups.adoc
View File

@@ -56,11 +56,11 @@ $ export SG_ID=$(aws ec2 create-security-group --description "Granting API acces
$ aws ec2 authorize-security-group-ingress --group-id $SG_ID --ip-permissions FromPort=443,ToPort=443,IpProtocol=tcp,IpRanges=[{CidrIp=0.0.0.0/0}]
----
. Add the the new security group to the VPCE by running the following command:
. Add the new security group to the VPCE by running the following command:
+
[source,terminal]
----
$ aws ec2 modify-vpc-endpoint --vpc-endpoint-id $VPCE_ID --add-security-group-ids $SG_ID
----
You now can access the API with your {hcp-title} private cluster.
You now can access the API with your {hcp-title} private cluster.

1
openshift_images/image-configuration.adoc
View File

@@ -39,4 +39,3 @@ endif::openshift-rosa,openshift-dedicated[]
include::modules/images-configuration-registry-mirror-configuring.adoc[leveloffset=+2]
include::modules/images-configuration-registry-mirror-convert.adoc[leveloffset=+2]

2
otel/otel-release-notes.adoc
View File

@@ -62,7 +62,7 @@ This update introduces the following bug fixes:
[id="known-issues_otel-3-0-rn"]
=== Known issues
Curently, the cluster monitoring of the {OTELOperator} is disabled due to a bug (link:https://issues.redhat.com/browse/TRACING-3761[TRACING-3761]). The bug is preventing the cluster monitoring from scraping metrics from the {OTELOperator} due to a missing label `openshift.io/cluster-monitoring=true`
Currently, the cluster monitoring of the {OTELOperator} is disabled due to a bug (link:https://issues.redhat.com/browse/TRACING-3761[TRACING-3761]). The bug is preventing the cluster monitoring from scraping metrics from the {OTELOperator} due to a missing label `openshift.io/cluster-monitoring=true`
that is required for the cluster monitoring and service monitor object.
.Workaround

2
upgrading/rosa-hcp-upgrading.adoc
View File

@@ -16,7 +16,7 @@ Use one of the following methods to upgrade your HCP clusters:
+
[NOTE]
====
If you want to upgrade both your hosted control plane and your machine pool to the same version, you must upgrade the the hosted control plane first.
If you want to upgrade both your hosted control plane and your machine pool to the same version, you must upgrade the hosted control plane first.
====
To plan an upgrade, review the xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{hcp-title} update life cycle] documentation. The life cycle page includes release definitions, support and upgrade requirements, installation policy information, and life cycle dates.