Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport 5.0: iau proxy storage #1235567 #3673

Open
wants to merge 3 commits into
base: manager-5.0
Choose a base branch
from
Open

Backport 5.0: iau proxy storage #1235567 #3673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9d3c170
supersede #3654
keichwa Feb 5, 2025
1ff1b85
add forgotten files
keichwa Feb 5, 2025
82792c4
Apply suggestions from code review
keichwa Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions l10n-weblate/installation-and-upgrade.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
[type: asciidoc] modules/installation-and-upgrade/pages/_install-ibmz.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/_install-ibmz.adoc
[type: asciidoc] modules/installation-and-upgrade/pages/client-intro.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/client-intro.adoc
[type: asciidoc] modules/installation-and-upgrade/pages/connect-payg.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/connect-payg.adoc
[type: asciidoc] modules/installation-and-upgrade/pages/container-deployment/actkey-bootstrap-proxy-suma.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-deployment/actkey-bootstrap-proxy-suma.adoc
[type: asciidoc] modules/installation-and-upgrade/pages/container-deployment/generate_proxy_config.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-deployment/generate_proxy_config.adoc
[type: asciidoc] modules/installation-and-upgrade/pages/container-deployment/register-proxy-suma.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-deployment/register-proxy-suma.adoc
[type: asciidoc] modules/installation-and-upgrade/pages/container-deployment/start_proxy.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-deployment/start_proxy.adoc
[type: asciidoc] modules/installation-and-upgrade/pages/container-deployment/suma/proxy-air-gapped-deployment-suma.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-deployment/suma/proxy-air-gapped-deployment-suma.adoc
[type: asciidoc] modules/installation-and-upgrade/pages/container-deployment/suma/proxy-deployment-suma.adoc $lang:translations/$lang/modules/installation-and-upgrade/pages/container-deployment/suma/proxy-deployment-suma.adoc
Expand Down
5 changes: 2 additions & 3 deletions modules/installation-and-upgrade/nav-installation-and-upgrade-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ ifeval::[{suma-content} == true]
**** xref:container-deployment/suma/server-deployment-vmdk-suma.adoc[Server Deployment as Virtual Machine - VMware]
**** xref:container-deployment/suma/server-air-gapped-deployment-suma.adoc[Air-gapped Deployment]
**** xref:install-pubcloud.adoc[Public Cloud Deployment]

*** Proxy
*** xref:install-proxy.adoc[Proxy]
**** xref:container-deployment/suma/proxy-deployment-suma.adoc[{productname} Proxy Deployment on {sle-micro}]
**** xref:container-deployment/suma/proxy-deployment-vm-suma.adoc[Proxy Deployment as Virtual Machine - KVM]
**** xref:container-deployment/suma/proxy-deployment-vmdk-suma.adoc[Proxy Deployment Virtual Machine - VMware]
Expand Down Expand Up @@ -73,7 +72,7 @@ ifeval::[{suma-content} == true]
**** xref:client-intro.adoc[Upgrading Clients]
endif::[]

** Basic Server Management
** Basic Server and Proxy Management
*** xref:container-management/mgradm-yaml-custom-configuration.adoc[Custom YAML Configuration With mgradm]
*** xref:container-management/start-and-stop-containers.adoc[Starting and Stopping Containers]
*** xref:container-management/persistent-container-volumes.adoc[Persistent Container Volumes]
Expand Down
28 changes: 28 additions & 0 deletions ...llation-and-upgrade/pages/container-deployment/actkey-bootstrap-proxy-suma.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
== Create an Activation Key for the Proxy

.Procedure: Creating an Activation Key
. Navigate to menu:Systems[Activation Keys], and click btn:[Create key].
. Create an activation key for the proxy host with {sle-micro} {microversion} as the parent channel.
This key should include all recommended channels and the proxy as an extension child channel.
. Proceed to boostrapping the proxy host as a [systemitem]``default`` client.



== Bootstrap the Proxy Host as a Client

.Procedure: Bootstrapping the Proxy Host
. Select menu:Systems[Bootstrapping].
. Fill in the fields for your proxy host.
. Select the activation key created in the previous step from the drop-down.
. Click btn:[Bootstrap].
. Wait for the bootstrap process to complete successfully.
Check the menu:Salt[] menu and confirm the {salt} key is listed and accepted.
. Reboot the proxy host.
. Select the host from the menu:System[] list and trigger a second reboot after all events are finished to conclude the onboarding.


.Procedure: Updating the Proxy Host
. Select the host from the menu:Systems[] list and apply all patches to update it.
. Reboot the proxy host.


61 changes: 61 additions & 0 deletions ...es/installation-and-upgrade/pages/container-deployment/register-proxy-suma.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
== Register {sle-micro} and {productname} {productnumber} Proxy

// Before starting obtain your SUSE Manager Registration Code from SUSE Customer Center - https://scc.suse.com.

.Procedure: Registering {sle-micro} and {productname} {productnumber} Proxy
. Boot the virtual machine.
. Log in as `root`.
. Register {sle-micro} with SCC.
+

----
transactional-update register -r <REGCODE> -e <your_email>
----

. Reboot.

. Register {productname} {productnumber} Proxy with {scclongform}.
+

----
transactional-update register -p SUSE-Manager-Proxy/5.0/x86_64 -r <REGCODE>
----

. Reboot.

. Update the system:
+

----
transactional-update
----

. If updates were applied reboot.

. This step is optional.
However, if custom persistent storage is required for your infrastructure, use the [command]``mgr-storage-proxy`` tool.
** For more information, see [command]``mgr-storage-proxy --help``.
This tool simplifies creating the container volumes.

** Use the command in the following manner:
+

----
mgr-storage-proxy <storage-disk-device>
----
+
For example:
+
----
mgr-storage-proxy /dev/nvme1n1
----
+
[NOTE]
====
This command will move the persistent storage volumes at [path]``/var/lib/containers/storage/volumes`` to the specified storage device.

For more information, see

* xref:installation-and-upgrade:container-management/persistent-container-volumes.adoc[]
* xref:administration:troubleshooting/tshoot-container-full-disk.adoc[]
====
80 changes: 16 additions & 64 deletions ...allation-and-upgrade/pages/container-deployment/suma/proxy-deployment-suma.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To successfully deploy, you will perform the following actions:
. Review hardware requirements.
. Synchronize the {sle-micro} {microversion} parent channel and the proxy extension child channel on the server.
. Install {sle-micro} {microversion} on a bare-metal machine.
. During the installation, register {sle-micro} {microversion} along with the {productname} {productnumber} Proxy extension.
. During the installation, register {sle-micro} {microversion} along with the {productname} Proxy extension.
. Create a {salt} activation key.
. Bootstrap the proxy as a client with the [systemitem]``default`` connection method.
. Generate a proxy configuration.
Expand Down Expand Up @@ -73,18 +73,14 @@ This table shows the hardware requirements for deploying {productname} Proxy.
| Minimum 40 GB

|
| [path]``/var/lib/containers/storage/volumes/srv-www``
| Minimum 100 GB, storage requirements should be calculated for the number of ISO distribution images, containers, and bootstrap repositories you will use.

|
| [path]``/var/lib/containers/storage/volumes/var-cache`` (Squid)
| Minimum 100 GB
| [path]``/var/lib/containers/storage/volumes``
| Minimum 150 GB

|===



== Sync the Parent and Proxy Extension Child Channels
== Synchronize the Parent and Proxy Extension Child Channels

This section presumes that you have already entered your organization credentials under the menu:Admin[Setup Wizard -> Organization Credentials] in the server's {webui}.
Products are listed on the menu:Admin[Setup Wizard -> Products] page.
Expand Down Expand Up @@ -124,7 +120,7 @@ For detailed documentation on preparing your machines OS (virtual or physical),
Click the [systemitem]``checkbox`` to accept the license agreement.
. Click [systemitem]``Next`` to continue.
. Select your registration method.
For this example, we will register the server with {scclongform}.
For this example, we will register the proxy with {scclongform}.
+

.{productname} {productnumber} Proxy as an extension
Expand All @@ -144,7 +140,8 @@ The {productname} {productnumber} Proxy is registered as an extension. Therefore
. Enter your {productname} {productnumber} Proxy extension registration code.
. Click btn:[Next] to continue.
. On the [systemitem]``NTP Configuration`` page click btn:[Next].
. On the [systemitem]``Authentication for the System`` page enter a password for the root user. Click btn:[Next].
. On the [systemitem]``Authentication for the System`` page enter a password for the root user.
Click btn:[Next].
. On the [systemitem]``Installation Settings`` page click btn:[Install].

This finalizes installation of {sle-micro} {microversion} and {productname} {productnumber} Proxy as an extension.
Expand Down Expand Up @@ -182,20 +179,20 @@ transactional-update pkg install mgrpxy mgrpxy-bash-completion
=== Configure Custom Persistent Storage

This step is optional.
However, if custom persistent storage is required for your infrastructure, use the [command]``mgr-storage-proxy`` tool.
However, if custom persistent storage is required for your infrastructure, use the [command]``mgr-storage-proxy`` tool.
This tool simplifies creating the container storage and Squid cache volumes.

Use the command in the following manner:
Use the command in the following manner:
----
mgr-storage-proxy <storage-disk-device>
----

For example:
For example:
----
mgr-storage-proxy /dev/nvme1n1
----

For more information, type:
For more information, type:
----
mgr-storage-proxy --help
----
Expand All @@ -211,68 +208,23 @@ For more information, see
* xref:administration:troubleshooting/tshoot-container-full-disk.adoc[]
====

== Create an Activation Key for the Proxy

.Procedure: Creating an Activation Key
. Select menu:Systems[Activation Keys] then click btn:[Create key].
. Create an activation key for the proxy host with {sle-micro} {microversion} as the parent channel.
This key should include all recommended channels and the proxy as an extension child channel.
. Proceed to boostrapping the proxy host as a [systemitem]``default`` client.



== Bootstrap the Proxy Host as a Client

.Procedure: Bootstrapping the Proxy Host
. Select menu:Systems[Bootstrapping].
. Fill in the fields for your proxy host.
. Select the activation key created in the previous step from the drop-down.
. Click btn:[Bootstrap].
. Wait for the bootstrap process to complete successfully.
Check the menu:Salt[] menu and confirm the {salt} key is listed and accepted.
. Reboot the proxy host.
. Select the host from the menu:System[] list and trigger a second reboot after all events are finished to conclude the onboarding.


.Procedure: Updating the Proxy Host
. Select the host from the menu:Systems[] list and apply all patches to update it.
. Reboot the proxy host.

include::../actkey-bootstrap-proxy-suma.adoc[]

include::../generate_proxy_config.adoc[]


[[proxy-setup-containers-transfer-config]]
== Transfer the Proxy Configuration

The {webui} generates a configuration archive.
This archive needs to be made available on the proxy container host.


.Procedure: Copying the Proxy Configuration

. Copy the configuration archive ([literal]``config.tar.gz``) generated in the previous step to the Proxy host:
+
----
scp config.tar.gz <proxy-FQDN>:/root
----
. Install the Proxy with:
+
----
mgrpxy install podman config.tar.gz
----
include::../transfer_proxy_config.adoc[]



[[proxy-setup-containers-transfer-start]]
== Start the {productname} {productnumber} Proxy
== Start the {productname} Proxy

Container can now be started with the [literal]`mgrpxy` command:

[[proc-setup-containers-setup-start]]
.Procedure: Starting and Checking Proxy Status

. Start the Proxy by calling:
. Start the proxy by calling:
+
----
mgrpxy start
Expand Down Expand Up @@ -319,7 +271,7 @@ To install them run:

----
zypper in helm mgrpxy
----
----
////


Expand Down
Loading
Loading