Skip to content

Commit efcc5ce

Browse files
authored
Merge branch 'manager-5.1' into 1250451-51-displayEntries
2 parents 888812f + d31d1aa commit efcc5ce

File tree

3 files changed

+83
-15
lines changed

3 files changed

+83
-15
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
- Improved the appearance of Web UI instructions in Administration
22
Guide (bsc#1250451)
3+
- Improved example for proxy bootstrap script in Client Configuration
4+
Guide (bsc#1251117)
35
- Added new workflow for liberating RHEL server in Common Workflows
46
Guides (bsc#1250423)
57
- Fixed the broken link in Specialized Guides (bsc#1249073)

modules/administration/pages/image-management.adoc

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,16 @@ The Kiwi build type is used to build system, virtual, and other images.
2929
// Needs checking
3030
// at later places to be fix accordingly
3131
The image store for the Kiwi build type is pre-defined as a file system directory in the [path]``srv-www`` volume.
32-
{productname} serves the image store over HTTPS from [literal]``https://<SERVER-FQDN>/os-images/``.
33-
The image store location is unique and is not customizable.
3432

35-
Images are stored in an [path]``ORGANIZATION-ID`` directory there.
33+
ifeval::[{mlm-content} == true]
34+
The image files can be downloaded from [path]``https://MANAGER-HOST/os-images/ORGANIZATION-ID/FILE-NAME``.
35+
The exact location can be determined from the image details page.
36+
endif::[]
37+
38+
ifeval::[{uyuni-content} == true]
39+
The image files can be downloaded from [path]``https://UYUNI-HOST/os-images/ORGANIZATION-ID/FILE-NAME``.
40+
The exact location can be determined from the image details page.
41+
endif::[]
3642

3743

3844
[[at.images.docker]]
@@ -630,13 +636,15 @@ By default, the image store is using the [path]``srv-www`` volume.
630636
====
631637
Image stores for Kiwi build type, used to build system, virtual, and other images, are not supported yet.
632638
633-
// FIXME
639+
634640
ifeval::[{mlm-content} == true]
635-
Images are always stored in [path]``.../os-images/ORGANIZATION-ID`` and are accessible via HTTP/HTTPS [url]``https://<susemanager_host>/os-images/ORGANIZATION-ID``.
641+
The image files can be downloaded from [path]``https://MANAGER-HOST/os-images/ORGANIZATION-ID/FILE-NAME``.
642+
The exact location can be determined from the image details page.
636643
endif::[]
637644
638645
ifeval::[{uyuni-content} == true]
639-
Images are always stored in [path]``.../os-images/ORGANIZATION-ID`` and are accessible via HTTP/HTTPS [url]``https://<uyuni_host>/os-images/ORGANIZATION-ID``.
646+
The image files can be downloaded from [path]``https://UYUNI-HOST/os-images/ORGANIZATION-ID/FILE-NAME``.
647+
The exact location can be determined from the image details page.
640648
endif::[]
641649
642650
====

modules/client-configuration/pages/registration-bootstrap.adoc

Lines changed: 67 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ endif::[]
5151

5252

5353
[[registering.clients.bootstrap.mgr-bootstrap]]
54-
== Create a Bootstrap Script with [command]``mgr-bootstrap``
54+
== Create a bootstrap script with [command]``mgr-bootstrap``
5555

5656
The [command]``mgr-bootstrap`` command generates custom bootstrap scripts.
5757
A bootstrap script is used by {productname} client systems for simplifying their initial registration and configuration.
@@ -69,10 +69,24 @@ The [command]``mgr-bootstrap`` command offers several other options, including t
6969
[NOTE]
7070
====
7171
72-
If users wish to create a bootstrap script to register against the Proxy, they can do so using the following command from the Server container:
72+
* If you wish to create a bootstrap script to register against the Proxy, you can do so by using the following command from the Server container:
73+
74+
+
7375
7476
----
75-
mgr-boostrap --hostname $proxyfqdn
77+
mgr-boostrap --hostname <PROXY_FQDN>
78+
----
79+
80+
+
81+
82+
This command will create a new bootstrap script with default name [literal]``bootstrap.sh`` and it will overwrite the existing [literal]``bootstrap.sh`` file which is used for the Server.
83+
84+
* To specify a different script, use the following comamnd:
85+
86+
+
87+
88+
----
89+
mgr-bootstrap --hostname <PROXY_FQDN> --script=boostrap-<PROXY-SCRIPT>.sh
7690
----
7791
7892
====
@@ -81,25 +95,35 @@ For more information, see the [literal]``mgr-bootstrap`` man page, or run [comma
8195

8296

8397

84-
== Create a Bootstrap Script from {webui}
98+
== Create a bootstrap script from {webui}
8599

86100
You can use the {productname} {webui} to create an editable bootstrap script.
87101

88102
// 2022-10-26, ke: In step 2, check whether we can use {productname} macro.
89103

90-
.Procedure: Creating a Bootstrap Script
104+
.Procedure: Creating a bootstrap script
105+
[role=procedure]
106+
_____
107+
91108
. In the {productname} {webui}, navigate to menu:Admin[Manager Configuration > Bootstrap Script].
109+
92110
. The required fields are pre-populated with values derived from previous installation steps.
93111
For details on each setting, see xref:reference:admin/bootstrap-script.adoc[].
112+
94113
. Click btn:[Update] to create the script.
114+
95115
. The bootstrap script is generated and stored on the server in the [path]``/srv/www/htdocs/pub/bootstrap`` directory.
96116
Alternatively, you can access the bootstrap script over HTTPS.
97117
Replace [literal]``<example.com>`` with the host name of your {productname} Server:
118+
98119
+
120+
99121
----
100122
https://<example.com>/pub/bootstrap/bootstrap.sh
101123
----
102124
125+
_____
126+
103127

104128
[IMPORTANT]
105129
====
@@ -113,7 +137,7 @@ For more information about custom certificates, see xref:administration:ssl-cert
113137

114138

115139
[[modify.bootstrap.script]]
116-
== Edit a Bootstrap Script
140+
== Edit a bootstrap script
117141

118142
You can copy and modify the template bootstrap script you created to customize it.
119143
A minimal requirement when modifying a bootstrap script for use with {productname} is the inclusion of an activation key.
@@ -127,24 +151,36 @@ For more information about activation keys, see xref:client-configuration:activa
127151

128152

129153

130-
.Procedure: Modifying a Bootstrap Script
154+
.Procedure: Modifying a bootstrap script
155+
[role=procedure]
156+
_____
157+
158+
131159
. On your {productname} Server, as root at the command line change to the bootstrap directory with:
160+
132161
+
162+
133163
----
134164
cd /srv/www/htdocs/pub/bootstrap/
135165
----
166+
136167
. Create and rename two copies of the template bootstrap script for use with each of your clients.
168+
137169
+
170+
138171
----
139172
cp bootstrap.sh bootstrap-sles12.sh
140173
cp bootstrap.sh bootstrap-sles15.sh
141174
----
175+
142176
. Open [path]``bootstrap-sles15.sh`` for modification.
143177
Scroll down until you can see the text shown below.
144178
If ``exit 1`` exists in the file, comment it out by typing a hash or pound sign (&#35;) at the beginning of the line.
145179
This activates the script.
146180
Enter the name of the key for this script in the ``ACTIVATION_KEYS=`` field:
181+
147182
+
183+
148184
----
149185
echo "Enable this script: comment (with #'s) this block (or, at least just"
150186
echo "the exit below)"
@@ -157,6 +193,8 @@ ACTIVATION_KEYS=1-sles15
157193
ORG_GPG_KEY=
158194
----
159195
196+
+
197+
160198
[NOTE]
161199
====
162200
Instead of editing the script manually, user can pass the following environment variables at runtime:
@@ -169,8 +207,12 @@ Instead of editing the script manually, user can pass the following environment
169207
Using environment variables allows dynamic input at runtime and makes it easier to reuse the same bootstrap script across different systems or environments.
170208
====
171209
210+
+
211+
172212
. When you have finished, save the file, and repeat this procedure for the second bootstrap script.
173213
214+
_____
215+
174216
[NOTE]
175217
====
176218
By default, bootstrap script will try to install [package]``venv-salt-minion`` if it is available in the bootstrap repository and [package]``salt-minion`` if there is no {salt} bundle in the bootstrap repository.
@@ -182,45 +224,58 @@ For more information, see xref:client-configuration:contact-methods-saltbundle.a
182224

183225

184226
[[registering.clients.bootstrap.register]]
185-
== Register Clients Running the Bootstrap Script
227+
== Register clients running the bootstrap script
186228

187229
When you have finished creating your script, you can use it to register clients.
188230

189231

190-
.Procedure: Running the Bootstrap Script
232+
.Procedure: Running the bootstrap script
233+
[role=procedure]
234+
_____
191235
192236
. On the {productname} Server, log in as root.
193237
At the command prompt, and change to the bootstrap directory:
238+
194239
+
195240
196241
----
197242
cd /srv/www/htdocs/pub/bootstrap/
198243
----
244+
199245
+
200246
201247
. Run this command to execute the bootstrap script on the client; replace [systemitem]``EXAMPLE.COM`` with the host name of your client:
248+
202249
+
203250
204251
----
205252
cat bootstrap-sles15.sh | ssh [email protected] /bin/bash
206253
----
254+
207255
+
208256
209257
. Alternatively, on the client, run this command:
258+
210259
+
260+
211261
----
212262
ACTIVATION_KEYS="17-someactivationkey" \
213263
MGR_SERVER_HOSTNAME="proxy.example.com" \
214264
ORG_GPG_KEY="mykey" \
215265
REACTIVATION_KEY=my-reactivation-key \
216266
curl -Sks https://server_hostname/pub/bootstrap/bootstrap.sh | /bin/bash
217267
----
268+
218269
+
270+
219271
If you do not need to override any values, you can omit the environment variables entirely:
272+
220273
+
274+
221275
----
222276
curl -Sks https://server_hostname/pub/bootstrap/bootstrap.sh | /bin/bash
223277
----
278+
224279
+
225280
226281
[IMPORTANT]
@@ -230,12 +285,15 @@ To avoid problems, make sure the bootstrap script is executed using [command]``b
230285
+
231286
232287
This script downloads the required dependencies located in the repositories directory you created earlier.
288+
233289
+
234290
235291
. When the script has finished running, you can check that the client is registered correctly.
236292
Open the {productname} {webui} and navigate to menu:Systems[Overview] to ensure the new client is listed.
237293
If the client is not listed, in the {productname} {webui} navigate to menu:Salt[Keys] and check whether the client key is accepted.
238294
295+
_____
296+
239297
[WARNING]
240298
====
241299
When new packages or updates are installed on the client using {productname}, any end user license agreements (EULAs) are automatically accepted.

0 commit comments

Comments
 (0)