Install Containerized Uyuni Proxy on k3s

Table of Contents

1. Installing k3s
2. Installing tools
3. Generate the Proxy Configuration
4. Deploying the Uyuni proxy helm chart

1. Installing k3s

Uyuni Proxy is supported on k3s running on top of SLE Micro in a single node cluster. If you need to deploy it in any other Kubernetes environment, please contact support for evaluation.

On the container host machine, install k3s (replace <K3S_HOST_FQDN> with the FQDN of your k3s host):

curl -sfL https://get.k3s.io | INSTALL_K3S_EXEC="--tls-san=<K3S_HOST_FQDN>" sh -

2. Installing tools

The installation requires the mgrpxy and helm packages.

The mgrpxy package is available in the container utils repository: pick the one matching the distribution in: https://download.opensuse.org/repositories/systemsmanagement:/Uyuni:/Stable:/ContainerUtils/.

To install them run:
```
transactional-update pkg install mgrpxy
```
Reboot

3. Generate the Proxy Configuration

The configuration archive of the Uyuni Proxy is generated by the Uyuni Server. Each additional Proxy requires its own configuration archive.

2 GB represents the default proxy squid cache size. This will need to be adjusted for your environment.

For Podman deployment, the container host for the Uyuni Proxy must be registered as a client to the Uyuni Server prior to generating this proxy configuration.

If a proxy FQDN is used to generate a proxy container configuration that is not a registered client (as in the Kubernetes use case), a new system entry will appear in system list. This new entry will be shown under previously entered Proxy FQDN value and will be of Foreign system type.

3.1. Generate the Proxy Configuration with Web UI

Procedure: Generating a Proxy Container Configuration using Web UI

In the Web UI, navigate to Systems Proxy Configuration and fill the required data:
In the Proxy FQDN field type fully qualified domain name for the proxy.
In the Parent FQDN field type fully qualified domain name for the Uyuni Server or another Uyuni Proxy.
In the Proxy SSH port field type SSH port on which SSH service is listening on Uyuni Proxy. Recommended is to keep default 8022.
In the Max Squid cache size [MB] field type maximal allowed size for Squid cache. Recommended is to use at most 60% of available storage for the containers.

2 GB represents the default proxy squid cache size. This will need to be adjusted for your environment.
In the SSL certificate selection list choose if new server certificate should be generated for Uyuni Proxy or an existing one should be used. You can consider generated certificates as Uyuni builtin (self signed) certificates.

Depending on the choice then provide either path to signing CA certificate to generate a new certificate or path to an existing certificate and its key to be used as proxy certificate.

The CA certificates generated by the server are stored in the /var/lib/containers/storage/volumes/root/_data/ssl-build directory.

For more information about existing or custom certificates and the concept of corporate and intermediate certificates, see Import SSL Certificates.
Click Generate to register a new proxy FQDN in the Uyuni Server and generate a configuration archive (config.tar.gz) containing details for the container host.
After a few moments you are presented with file to download. Save this file locally.

3.2. Generate the Proxy Configuration with spacecmd and Self-Signed Certificate

Procedure: Generating Proxy Configuration with spacecmd and Self-Signed Certificate

You can generate a Proxy configuration using spacecmd.

SSH into your container host.

Execute the following command replacing the Server and Proxy FQDN:

mgrctl exec -ti 'spacecmd proxy_container_config_generate_cert -- dev-pxy.example.com dev-srv.example.com 2048 email@example.com -o /tmp/config.tar.gz'

Copy the generated configuration from the server container:
```
mgrctl cp server:/tmp/config.tar.gz .
```

3.3. Generate the Proxy Configuration with spacecmd and Custom Certificate

You can generate a Proxy configuration using spacecmd for a custom certificates rather than the default self-signed certificates.

Procedure: Generating Proxy Configuration with spacecmd and Custom Certificate

SSH into your Server container host.

Execute the following command replacing the Server and Proxy FQDN:

for f in ca.crt proxy.crt proxy.key; do
  mgrctl cp $f server:/tmp/$f
done
mgrctl exec -ti 'spacecmd proxy_container_config -- -p 8022 pxy.example.com srv.example.com 2048 email@example.com /tmp/ca.crt /tmp/proxy.crt /tmp/proxy.key -o /tmp/config.tar.gz'

Copy the generated configuration from the server container:
```
mgrctl cp server:/tmp/config.tar.gz .
```

4. Deploying the Uyuni proxy helm chart

To configure the storage of the volumes to be used by the Uyuni Proxy pod, define persistent volumes for the following claims. If you do not customize the storage configuration, k3s will automatically create the storage volumes for you.

The persistent volume claims are named:

squid-cache-pv-claim
package-cache-pv-claim
tftp-boot-pv-claim

Create the configuration for the Uyuni Proxy as documented in Deploy a Uyuni 2024.08 Proxy. Copy the configuration tar.gz file and then install:

mgrpxy install kubernetes /path/to/config.tar.gz

For more information see https://kubernetes.io/docs/concepts/storage/persistent-volumes/ (kubernetes) or https://rancher.com/docs/k3s/latest/en/storage/ (k3s) documentation.