Skip to content

Commit fd64995

Browse files
authored
Merge pull request #86995 from bergerhoffer/typosweep
Fixing some typos
2 parents 0c7e766 + a3bfd5e commit fd64995

16 files changed

+55
-57
lines changed

edge_computing/day_2_core_cnf_clusters/observability/telco-observability.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ include::_attributes/common-attributes.adoc[]
77

88
toc::[]
99

10-
{product-title} generates a large amount of data, such as performance metrics and logs from both the platform and the the workloads running on it.
11-
As an administrator, you can use various tools to collect and analyze all the data available.
12-
What follows is an outline of best practices for system engineers, architects, and administrators configuring the observability stack.
10+
{product-title} generates a large amount of data, such as performance metrics and logs from both the platform and the workloads running on it.
11+
As an administrator, you can use various tools to collect and analyze all the data available.
12+
What follows is an outline of best practices for system engineers, architects, and administrators configuring the observability stack.
1313

1414
Unless explicitly stated, the material in this document refers to both Edge and Core deployments.
1515

@@ -49,4 +49,4 @@ include::modules/telco-observability-workload-monitoring.adoc[leveloffset=+1]
4949
5050
* xref:../../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
5151
52-
* xref:../../../observability/monitoring/managing-alerts.adoc#managing-alerting-rules-for-user-defined-projects_managing-alerts[Managing alerting rules for user-defined projects]
52+
* xref:../../../observability/monitoring/managing-alerts.adoc#managing-alerting-rules-for-user-defined-projects_managing-alerts[Managing alerting rules for user-defined projects]

modules/ibi-create-config-iso.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
// Module included in the following assemblies:
22
//
3-
// * edge_computing/ibi-edge-image-based-install.adoc
3+
// * edge_computing/ibi-edge-image-based-install.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="ibi-create-config-iso_{context}"]
77
= Deploying a managed {sno} cluster using the IBI Operator
88

9-
Create the site-specific configuration resources in the hub cluster to initiate the image-based deployment of a preinstalled host.
9+
Create the site-specific configuration resources in the hub cluster to initiate the image-based deployment of a preinstalled host.
1010

1111
When you create these configuration resources in the hub cluster, the Image Based Install (IBI) Operator generates a configuration ISO and attaches it to the target host to begin the site-specific configuration process. When the configuration process completes, the {sno} cluster is ready.
1212

@@ -64,7 +64,7 @@ $ oc create -f secret-image-registry.yaml
6464
.Example `host-network-config-secret.yaml` file
6565
[source,yaml]
6666
----
67-
apiVersion: v1
67+
apiVersion: v1
6868
kind: Secret
6969
metadata:
7070
name: host-network-config-secret <1>
@@ -137,7 +137,7 @@ data:
137137
password: <password> <11>
138138
----
139139
<1> Specify the name for the `BareMetalHost` resource.
140-
<2> Specify if the host should be online.
140+
<2> Specify if the host should be online.
141141
<3> Specify the host boot MAC address.
142142
<4> Specify the BMC address. You can only use bare-metal host drivers that support virtual media networking booting, for example redfish-virtualmedia and idrac-virtualmedia.
143143
<5> Specify the name of the bare-metal host `Secret` resource.
@@ -245,7 +245,7 @@ spec:
245245
baseDomain: example.com <3>
246246
clusterInstallRef:
247247
group: extensions.hive.openshift.io
248-
kind: ImageClusterInstall
248+
kind: ImageClusterInstall
249249
name: ibi-image-install <4>
250250
version: v1alpha1
251251
clusterName: ibi-cluster <5>
@@ -283,7 +283,7 @@ spec:
283283
hubAcceptsClient: true <2>
284284
----
285285
<1> Specify the name for the `ManagedCluster` resource.
286-
<2> Specify `true` to enable {rh-rhacm} to mange the cluster.
286+
<2> Specify `true` to enable {rh-rhacm} to manage the cluster.
287287

288288
.. Create the `ManagedCluster` resource by running the following command:
289289
+

modules/microshift-automation-example-bootc-systems.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ As a use case, consider the following example situation in which you want to aut
1515

1616
.Prerequisites
1717

18-
* You have created the `10-auto-recovery.conf` and `microshift-auto-recovery.service` files as explained in the the "Automating the integration process with systemd for RPM systems" section.
19-
* You have created the `microshift-auto-recovery` script as explained in the the "Automating the integration process with systemd for RPM systems" section.
18+
* You have created the `10-auto-recovery.conf` and `microshift-auto-recovery.service` files as explained in the "Automating the integration process with systemd for RPM systems" section.
19+
* You have created the `microshift-auto-recovery` script as explained in the "Automating the integration process with systemd for RPM systems" section.
2020
2121
.Procedure
2222

modules/microshift-ingress-controller-config.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can use detailed ingress control settings by updating the {microshift-short}
2222
.. Update the {microshift-short} `config.yaml` configuration file by making a copy of the provided `config.yaml.default` file in the `/etc/microshift/` directory, naming it `config.yaml` and keeping it in the source directory.
2323
* After you create it, the `config.yaml` file takes precedence over built-in settings. The configuration file is read every time the {microshift-short} service starts.
2424
25-
.. Use a configuration snippet to apply the ingress control settings you want. To do this, create a configuration snippet YAML file and put it in the the `/etc/microshift/config.d/` configuration directory.
25+
.. Use a configuration snippet to apply the ingress control settings you want. To do this, create a configuration snippet YAML file and put it in the `/etc/microshift/config.d/` configuration directory.
2626
* Configuration snippet YAMLs take precedence over both built-in settings and a `config.yaml` configuration file. See the Additional resources links for more information.
2727
2828
. Replace the default values in the `network` section of the {microshift-short} YAML with your valid values, or create a configuration snippet file with the sections you need.
@@ -164,4 +164,4 @@ $ oc get pods -n openshift-ingress
164164
----
165165
NAME READY STATUS RESTARTS AGE
166166
router-default-8649b5bf65-w29cn 1/1 Running 0 6m10s
167-
----
167+
----

modules/network-observability-multitenancy.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-multi-tenancy_{context}"]
77
= Enabling multi-tenancy in Network Observability
8-
Multi-tenancy in the Network Observability Operator allows and restricts individual user access, or group access, to the flows stored in Loki and or or Prometheus. Access is enabled for project administrators. Project administrators who have limited access to some namespaces can access flows for only those namespaces.
8+
Multi-tenancy in the Network Observability Operator allows and restricts individual user access, or group access, to the flows stored in Loki and or Prometheus. Access is enabled for project administrators. Project administrators who have limited access to some namespaces can access flows for only those namespaces.
99

1010
For Developers, multi-tenancy is available for both Loki and Prometheus but requires different access rights.
1111

@@ -42,4 +42,4 @@ $ oc adm policy add-cluster-role-to-user cluster-monitoring-view <user_group_or_
4242
[source,terminal]
4343
----
4444
$ oc adm policy add-cluster-role-to-user netobserv-metrics-reader <user_group_or_name>
45-
----
45+
----

modules/nodes-vsphere-machine-set-scaling-static-ip.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Or:
9494
$ oc edit machineset <machineset> -n openshift-machine-api
9595
----
9696
+
97-
After each machine is scaled up, the machine controller creates an `IPAddresssClaim` resource.
97+
After each machine is scaled up, the machine controller creates an `IPAddressClaim` resource.
9898

9999
. Optional: Check that the `IPAddressClaim` resource exists in the `openshift-machine-api` namespace by entering the following command:
100100
+

modules/nw-bpfman-operator-deploy.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ go-xdp-counter-example xdp_stats {} ReconcileSuccess
8282
$ oc logs <pod_name> -n go-xdp-counter
8383
----
8484
+
85-
Replace `<pod_name>` with the name of a XDP program pod, such as `go-xdp-counter-ds-4m9cw`.
85+
Replace `<pod_name>` with the name of an XDP program pod, such as `go-xdp-counter-ds-4m9cw`.
8686
+
8787
.Example output
8888
[source,text]

modules/nw-external-dns-operator-configuration-parameters.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ domains:
5252
pattern: ".*\\.otherzonedomain\\.com" <5>
5353
----
5454
<1> Ensures that the `ExternalDNS` resource includes the domain name.
55-
<2> Instructs `ExtrnalDNS` that the domain matching has to be exact as opposed to regular expression match.
55+
<2> Instructs `ExternalDNS` that the domain matching has to be exact as opposed to regular expression match.
5656
<3> Defines the name of the domain.
5757
<4> Sets the `regex-domain-filter` flag in the `ExternalDNS` resource. You can limit possible domains by using a Regex filter.
5858
<5> Defines the regex pattern to be used by the `ExternalDNS` resource to filter the domains of the target zones.

modules/nw-sriov-networknodepolicy-object.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ If you want to create virtual function on the default network interface, ensure
7272
+
7373
[NOTE]
7474
====
75-
When `externallyManaged` is set to `true`, you must manually create the Virtual Functions (VFs) on the physical function (PF) before applying the `SriovNetworkNodePolicy` resource. If the VFs are not pre-created, the SR-IOV Network Operator's webhook will block the policy request.
75+
When `externallyManaged` is set to `true`, you must manually create the Virtual Functions (VFs) on the physical function (PF) before applying the `SriovNetworkNodePolicy` resource. If the VFs are not pre-created, the SR-IOV Network Operator's webhook will block the policy request.
7676

7777
When `externallyManaged` is set to `false`, the SR-IOV Network Operator automatically creates and manages the VFs, including resetting them if necessary.
7878

@@ -114,7 +114,7 @@ When `linkType` is set to `ib`, `isRdma` is automatically set to `true` by the S
114114
+
115115
Do not set linkType to `eth` for SriovNetworkNodePolicy, because this can lead to an incorrect number of available devices reported by the device plugin.
116116

117-
<19> Optional: To enable hardware offloading, you must set the `eSwitchMode` field to `"switchdev"`. For more information about hardware offloading , see "Configuring hardware offloading".
117+
<19> Optional: To enable hardware offloading, you must set the `eSwitchMode` field to `"switchdev"`. For more information about hardware offloading, see "Configuring hardware offloading".
118118

119119
<20> Optional: To exclude advertising an SR-IOV network resource's NUMA node to the Topology Manager, set the value to `true`. The default value is `false`.
120120

@@ -168,4 +168,4 @@ spec:
168168

169169
<1> The `numVfs` field is always set to `1` when configuring the node network policy for a virtual machine.
170170

171-
<2> The `netFilter` field must refer to a network ID when the virtual machine is deployed on {rh-openstack}. Valid values for `netFilter` are available from an `SriovNetworkNodeState` object.
171+
<2> The `netFilter` field must refer to a network ID when the virtual machine is deployed on {rh-openstack}. Valid values for `netFilter` are available from an `SriovNetworkNodeState` object.

modules/oadp-usecase-include-ca-cert-backup.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="oadp-usecase-include-ca-cert-backup_{context}"]
77
= Backing up an application and its self-signed CA certificate
88

9-
The `s3.openshift-storage.svc` service, provided by {odf-short}, uses a Transport Layer Security protocol (TLS) certificate that is signed with the self-signed service CA.
9+
The `s3.openshift-storage.svc` service, provided by {odf-short}, uses a Transport Layer Security protocol (TLS) certificate that is signed with the self-signed service CA.
1010

1111
To prevent a `certificate signed by unknown authority` error, you must include a self-signed CA certificate in the backup storage location (BSL) section of `DataProtectionApplication` custom resource (CR). For this situation, you must complete the following tasks:
1212

@@ -71,11 +71,11 @@ backup-c20...41fd
7171
s3.openshift-storage.svc
7272
----
7373

74-
. To get the bucket credentials from the `secret` object , run the following command:
74+
. To get the bucket credentials from the `secret` object, run the following command:
7575
+
7676
[source,terminal]
7777
----
78-
$ oc extract --to=- secret/test-obc
78+
$ oc extract --to=- secret/test-obc
7979
----
8080
+
8181
.Example output
@@ -92,8 +92,8 @@ YXf...+NaCkdyC3QPym
9292
[source,terminal]
9393
----
9494
[default]
95-
aws_access_key_id=<AWS_ACCESS_KEY_ID>
96-
aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
95+
aws_access_key_id=<AWS_ACCESS_KEY_ID>
96+
aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
9797
----
9898

9999
. Create the `cloud-credentials` secret with the `cloud-credentials` file content by running the following command:
@@ -142,20 +142,20 @@ spec:
142142
- aws
143143
- openshift
144144
- csi
145-
defaultSnapshotMoveData: true
145+
defaultSnapshotMoveData: true
146146
backupLocations:
147147
- velero:
148148
config:
149149
profile: "default"
150150
region: noobaa
151-
s3Url: https://s3.openshift-storage.svc
152-
s3ForcePathStyle: "true"
151+
s3Url: https://s3.openshift-storage.svc
152+
s3ForcePathStyle: "true"
153153
insecureSkipTLSVerify: "false" # <1>
154154
provider: aws
155155
default: true
156156
credential:
157157
key: cloud
158-
name: cloud-credentials
158+
name: cloud-credentials
159159
objectStorage:
160160
bucket: <bucket_name> # <2>
161161
prefix: oadp
@@ -169,7 +169,7 @@ spec:
169169
+
170170
[source,terminal]
171171
----
172-
$ oc apply -f <dpa_filename>
172+
$ oc apply -f <dpa_filename>
173173
----
174174

175175
. Verify that the `DataProtectionApplication` CR is created successfully by running the following command:
@@ -211,7 +211,7 @@ metadata:
211211
+
212212
[source,terminal]
213213
----
214-
$ oc get backupstoragelocations.velero.io -n openshift-adp
214+
$ oc get backupstoragelocations.velero.io -n openshift-adp
215215
----
216216
+
217217
.Example output
@@ -241,7 +241,7 @@ spec:
241241
+
242242
[source,terminal]
243243
----
244-
$ oc apply -f <backup_cr_filename>
244+
$ oc apply -f <backup_cr_filename>
245245
----
246246

247247
.Verification
@@ -250,7 +250,7 @@ $ oc apply -f <backup_cr_filename>
250250
+
251251
[source,terminal]
252252
----
253-
$ oc describe backup test-backup -n openshift-adp
253+
$ oc describe backup test-backup -n openshift-adp
254254
----
255255
+
256256
.Example output
@@ -273,4 +273,4 @@ Status:
273273
Start Timestamp: 2024-09-25T10:16:31Z
274274
Version: 1
275275
Events: <none>
276-
----
276+
----

0 commit comments

Comments
 (0)