Skip to content

Commit a7b5d82

Browse files
authored
Merge pull request #81156 from aravipra/OSDOCS-11561
OSDOCS-11561: adding back ticks for user values in microshift
2 parents 7e89c5e + 3f1968a commit a7b5d82

9 files changed

+63
-49
lines changed

modules/microshift-adding-other-packages-to-blueprint.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,28 @@ Add the references for optional RPM packages to your OSTree blueprint to enable
1717
. Edit your OSTree blueprint by running the following command:
1818
+
1919
[source,terminal]
20+
[subs="+quotes"]
2021
----
21-
$ vi <microshift_blueprint.toml> <1>
22+
$ vi __<microshift_blueprint.toml>__ <1>
2223
----
23-
<1> Replace _<microshift_blueprint.toml>_ with the name of the blueprint file used for the {microshift-short} service.
24+
<1> Replace `_<microshift_blueprint.toml>_` with the name of the blueprint file used for the {microshift-short} service.
2425

2526
. Add the following example text to your blueprint:
2627
+
2728
[source,text]
29+
[subs="+quotes"]
2830
----
2931
[[packages]] <1>
30-
name = "<microshift-additional-package-name>" <2>
32+
name = "__<microshift-additional-package-name>__" <2>
3133
version = "*"
3234
----
3335
<1> Include one stanza for each additional service that you want to add.
34-
<2> Replace _<microshift-additional-package-name>_ with the name the RPM for the service you want to include. For example, `microshift-olm`.
36+
<2> Replace `_<microshift-additional-package-name>_` with the name the RPM for the service you want to include. For example, `microshift-olm`.
3537
3638
.Next steps
3739
. Add custom certificate authorities to the blueprint as needed.
3840
. After you are done adding to your blueprint, you can apply the manifests to an active cluster by building a new OSTree system and deploying it on the client:
3941
** Create the ISO.
4042
** Add the blueprint and build the ISO.
4143
** Download the ISO and prepare it for use.
42-
** Do any provisioning that is needed.
44+
** Do any provisioning that is needed.

modules/microshift-adding-service-to-blueprint.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Adding the {microshift-short} RPM package to an Image Builder blueprint enables
1414
+
1515
[IMPORTANT]
1616
====
17-
* Replace _<microshift_blueprint.toml>_ in the following procedures with the name of the TOML file you are using.
18-
* Replace _<microshift_blueprint>_ in the following procedures with the name you want to use for your blueprint.
17+
* Replace `_<microshift_blueprint.toml>_` in the following procedures with the name of the TOML file you are using.
18+
* Replace `_<microshift_blueprint>_` in the following procedures with the name you want to use for your blueprint.
1919
====
2020
2121
.Procedure
@@ -27,8 +27,8 @@ Adding the {microshift-short} RPM package to an Image Builder blueprint enables
2727
[source,text]
2828
[subs="+quotes"]
2929
----
30-
cat > _<microshift_blueprint.toml>_ <<EOF <1>
31-
name = "_<microshift_blueprint>_" <2>
30+
cat > __<microshift_blueprint.toml>__ <<EOF <1>
31+
name = "__<microshift_blueprint>__" <2>
3232

3333
description = ""
3434
version = "0.0.1"
@@ -43,8 +43,8 @@ version = "*"
4343
enabled = ["microshift"]
4444
EOF
4545
----
46-
<1> _<microshift_blueprint.toml>_ is the name of the TOML file.
47-
<2> _<microshift_blueprint>_ is the name of your blueprint.
46+
<1> The name of the TOML file.
47+
<2> The name of the blueprint.
4848
+
4949
[NOTE]
5050
====
@@ -97,7 +97,7 @@ EOF
9797
----
9898
$ sudo composer-cli blueprints push __<microshift_blueprint.toml>__ <1>
9999
----
100-
<1> Replace _<microshift_blueprint.toml>_ with the name of your TOML file.
100+
<1> Replace `_<microshift_blueprint.toml>_` with the name of your TOML file.
101101

102102
.Verification
103103

@@ -108,7 +108,7 @@ $ sudo composer-cli blueprints push __<microshift_blueprint.toml>__ <1>
108108
----
109109
$ sudo composer-cli blueprints depsolve __<microshift_blueprint>__ | grep microshift <1>
110110
----
111-
<1> Replace _<microshift_blueprint>_ with the name of your blueprint.
111+
<1> Replace `_<microshift_blueprint>_` with the name of your blueprint.
112112
+
113113
.Example output
114114
+
@@ -129,4 +129,4 @@ blueprint: microshift_blueprint v0.0.1
129129
----
130130
$ sudo composer-cli blueprints depsolve __<microshift_blueprint>__ <1>
131131
----
132-
<1> Replace _<microshift_blueprint>_ with the name of your blueprint.
132+
<1> Replace `_<microshift_blueprint>_` with the name of your blueprint.

modules/microshift-audit-logs-config-proc.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,24 @@ $ sudo systemctl stop microshift
4242
.. Move the `/var/log/kube-apiserver` directory to your desired location by running the following command:
4343
+
4444
[source,terminal]
45+
[subs="+quotes"]
4546
----
46-
$ sudo mv /var/log/kube-apiserver <~/kube-apiserver> <1>
47+
$ sudo mv /var/log/kube-apiserver __<~/kube-apiserver>__ <1>
4748
----
48-
<1> Replace _<~/kube-apiserver>_ with the path to the directory that you want to use.
49+
<1> Replace `_<~/kube-apiserver>_` with the path to the directory that you want to use.
4950

5051
.. If you specified a new directory for logs, create a symlink to your custom directory at `/var/log/kube-apiserver` by running the following command:
5152
+
5253
[source,terminal]
54+
[subs="+quotes"]
5355
----
54-
$ sudo ln -s <~/kube-apiserver> /var/log/kube-apiserver <1>
56+
$ sudo ln -s __<~/kube-apiserver>__ /var/log/kube-apiserver <1>
5557
----
56-
<1> Replace _<~/kube-apiserver>_ with the path to the directory that you want to use. This enables the collection of logs in sos reports.
58+
<1> Replace `_<~/kube-apiserver>_` with the path to the directory that you want to use. This enables the collection of logs in sos reports.
5759

5860
. If you are configuring audit log policies on a running instance, restart {microshift-short} by entering the following command:
5961
+
6062
[source,terminal]
6163
----
62-
$ sudo systemctl restart microsohift
64+
$ sudo systemctl restart microshift
6365
----

modules/microshift-check-journal-logs-updates.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,18 @@ IDX BOOT ID FIRST ENTRY LAST ENTRY
4949
** Check the journal logs for the specific boot you want by running the following command:
5050
+
5151
[source,terminal]
52+
[subs="+quotes"]
5253
----
53-
$ sudo journalctl --boot <-my_boot_ID> <1>
54+
$ sudo journalctl --boot __<idx_or_boot_id>__ <1>
5455
----
55-
<1> Replace _<-my-boot-ID>_ with the number assigned to the specific boot that you want to check.
56+
<1> Replace `_<idx_or_boot_id>_` with the `IDX` or the `BOOT ID` number assigned to the specific boot that you want to check.
5657

5758
** Check the journal logs for the boot of a specific service by running the following command:
5859
+
5960
[source,terminal]
61+
[subs="+quotes"]
6062
----
61-
$ sudo journalctl --boot <-my_boot_ID> -u <service_name> <1> <2>
63+
$ sudo journalctl --boot __<idx_or_boot_id>__ -u __<service_name>__ <1> <2>
6264
----
63-
<1> Replace _<-my-boot-ID>_ with the number assigned to the specific boot that you want to check.
64-
<2> Replace _<service_name>_ with the name of the service that you want to check.
65+
<1> Replace `_<idx_or_boot_id>_` with the `IDX` or the `BOOT ID` number assigned to the specific boot that you want to check.
66+
<2> Replace `_<service_name>_` with the name of the service that you want to check.

modules/microshift-creating-ostree-iso.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Use the following procedure to create the ISO. The {op-system-ostree} Installer
2323
----
2424
$ BUILDID=$(sudo composer-cli compose start-ostree --ref "rhel/{op-system-version-major}/$(uname -m)/edge" __<microshift_blueprint>__ edge-container | awk '{print $2}') <1>
2525
----
26-
<1> Replace _<microshift_blueprint>_ with the name of your blueprint.
26+
<1> Replace `_<microshift_blueprint>_` with the name of your blueprint.
2727
+
2828
This command also returns the identification (ID) of the build for monitoring.
2929

@@ -107,4 +107,4 @@ modules = []
107107
groups = []
108108
packages = []
109109
EOF
110-
----
110+
----

modules/microshift-gitops-adding-apps.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,11 @@ spec:
6161
. To deploy the applications defined in the YAML file, run the following command:
6262
+
6363
[source,terminal]
64+
[subs="+quotes"]
6465
----
65-
$ oc apply -f <my-app>.yaml <1>
66+
$ oc apply -f __<my_app.yaml>__ <1>
6667
----
67-
<1> Replace _<my-app>_ with the name of your application YAML.
68+
<1> Replace `_<my_app.yaml>_` with the name of your application YAML.
6869

6970
.Verification
7071

modules/microshift-nw-enforcing-hsts-per-domain.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ $ oc annotate route --all --all-namespaces --overwrite=true "haproxy.router.open
3131
* Apply HSTS to all routes in a particular namespace by running the following `oc annotate command`:
3232
+
3333
[source,terminal]
34+
[subs="+quotes"]
3435
----
35-
$ oc annotate route --all -n <my_namespace> --overwrite=true "haproxy.router.openshift.io/hsts_header"="max-age=31536000;preload;includeSubDomains" <1>
36+
$ oc annotate route --all -n __<my_namespace>__ --overwrite=true "haproxy.router.openshift.io/hsts_header"="max-age=31536000;preload;includeSubDomains" <1>
3637
----
37-
<1> Replace _<my_namespace> with the namespace you want to use.
38+
<1> Replace `_<my_namespace>_` with the namespace you want to use.
3839
3940
.Verification
4041
* Review the HSTS annotations on all routes by running the following command:

modules/microshift-nw-multus-add-pod.adoc

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,19 @@ If you want to attach additional networks to a pod that is already running, you
2020

2121
. Add an annotation to a `Pod` YAML file. Only one of the following annotation formats can be used:
2222

23-
.. To attach an additional network without any customization, add an annotation with the following format. Replace `<network>` with the name of the additional network to associate with the pod:
23+
.. To attach an additional network without any customization, add an annotation with the following format. Replace `_<network>_` with the name of the additional network to associate with the pod:
2424
+
2525
[source,yaml]
26+
[subs="+quotes"]
2627
----
2728
apiVersion: v1
2829
kind: Pod
2930
metadata:
3031
annotations:
31-
k8s.v1.cni.cncf.io/networks: <network>[,<network>,...] # <1>
32+
k8s.v1.cni.cncf.io/networks: __<network>__[,__<network>__,...] # <1>
3233
# ...
3334
----
34-
<1> Replace `<network>` with the name of the additional network to associate with the pod. To specify more than one additional network, separate each network with a comma. Do not include whitespace between the comma. If you specify the same additional network multiple times, that pod will have multiple network interfaces attached to that network.
35+
<1> Replace `_<network>_` with the name of the additional network to associate with the pod. To specify more than one additional network, separate each network with a comma. Do not include whitespace between the comma. If you specify the same additional network multiple times, that pod will have multiple network interfaces attached to that network.
3536
+
3637
.Example annotation for a bridge-type additional network
3738
+
@@ -70,28 +71,29 @@ metadata:
7071
. To create a `Pod` YAML file and add the `NetworkAttachmentDefinition` annotation for an additional network, run the following command and use the example YAML:
7172
+
7273
[source,terminal]
74+
[subs="+quotes"]
7375
----
74-
$ oc apply -f ./<test-bridge>.yaml <1>
76+
$ oc apply -f ./__<test_bridge>__.yaml <1>
7577
----
76-
<1> Replace _<test-bridge>_ with the pod name that you want to use.
78+
<1> Replace `_<test_bridge>_` with the pod name that you want to use.
7779
+
7880
.Example output
7981
[source,terminal]
8082
----
81-
pod/test-bridge created
83+
pod/test_bridge created
8284
----
8385
+
84-
.Example `test-bridge` pod YAML
86+
.Example `test_bridge` pod YAML
8587
[source,yaml]
8688
----
8789
apiVersion: v1
8890
kind: Pod
8991
metadata:
90-
name: test-bridge
92+
name: test_bridge
9193
annotations:
9294
k8s.v1.cni.cncf.io/networks: bridge-conf
9395
labels:
94-
app: test-bridge
96+
app: test_bridge
9597
spec:
9698
terminationGracePeriodSeconds: 0
9799
containers:
@@ -128,19 +130,21 @@ metadata:
128130
# ...
129131
----
130132

131-
. Optional: To confirm that the `NetworkAttachmentDefinition` annotation exists in a `Pod` YAML, run the following command, replacing `<name>` with the name of the pod.
133+
. Optional: To confirm that the `NetworkAttachmentDefinition` annotation exists in a `Pod` YAML, run the following command, replacing `_<name>_` with the name of the pod.
132134
+
133135
[source,terminal]
136+
[subs="+quotes"]
134137
----
135-
$ oc get pod <name> -o yaml <1>
138+
$ oc get pod __<name>__ -o yaml <1>
136139
----
137-
<1> Replace _<name>_ with the pod name you want to use. In the following example, `test-bridge` is used.
140+
<1> Replace `_<name>_` with the pod name you want to use. In the following example, `_<test_bridge>_` is used.
138141
+
139-
In the following example, the `test-bridge` is attached to the `net1` additional network:
142+
In the following example, the `test_bridge` is attached to the `net1` additional network:
140143
+
141144
[source,terminal]
145+
[subs="+quotes"]
142146
----
143-
$ oc get pod test-bridge -o yaml
147+
$ oc get pod __<test_bridge>__ -o yaml
144148
----
145149
+
146150
.Example output
@@ -189,5 +193,5 @@ $ oc get pod
189193
[source,terminal]
190194
----
191195
NAME READY STATUS RESTARTS AGE
192-
test-bridge 1/1 Running 0 81s
196+
test_bridge 1/1 Running 0 81s
193197
----

modules/microshift-olm-deploy-ops-spec-ns.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ metadata:
6464
----
6565
$ oc apply -f _<ns.yaml>_ <1>
6666
----
67-
<1> Replace _<ns.yaml>_ with the name of your namespace configuration file. In this example, `olm-microshift` is used.
67+
<1> Replace `_<ns.yaml>_` with the name of your namespace configuration file. In this example, `olm-microshift` is used.
6868
+
6969
.Example output
7070
[source,terminal]
@@ -94,7 +94,7 @@ spec: <1>
9494
----
9595
$ oc apply -f _<og.yaml>_ <1>
9696
----
97-
<1> Replace _<og.yaml>_ with the name of your operator group configuration file.
97+
<1> Replace `_<og.yaml>_` with the name of your operator group configuration file.
9898
+
9999
.Example output
100100
[source,terminal]
@@ -130,10 +130,11 @@ spec:
130130
. Apply the `CatalogSource` configuration by running the following command:
131131
+
132132
[source,terminal]
133+
[subs="+quotes"]
133134
----
134-
$ oc apply -f _<my-catalog-source.yaml>_ <1>
135+
$ oc apply -f __<my_catalog_source.yaml>__ <1>
135136
----
136-
<1> Replace _<my-catalog-source.yaml>_ with your catalog source configuration file name.
137+
<1> Replace `_<my_catalog_source.yaml>_` with your catalog source configuration file name.
137138

138139
. To verify that the catalog source is applied, check for the `READY` state by using the following command:
139140
+
@@ -217,6 +218,7 @@ spec:
217218
. Apply the Subscription CR configuration by running the following command:
218219
+
219220
[source,terminal]
221+
[subs="+quotes"]
220222
----
221223
$ oc apply -f _<my-subscription-cr.yaml>_
222224
----

0 commit comments

Comments
 (0)