forked from pool/rmt-server-image
Accepting request 1186122 from devel:BCI:Tumbleweed
🤖: sync package with devel:BCI:Tumbleweed from OBS OBS-URL: https://build.opensuse.org/request/show/1186122 OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/rmt-server-image?expand=0&rev=13
This commit is contained in:
commit
6c4414a8bb
35
README.md
35
README.md
@ -8,9 +8,8 @@ It is tested on K3s but should work on any Kubernetes distribution.
|
||||
|
||||
## Overview
|
||||
|
||||
To deploy SUSE RMT on top of Kubernetes, each component of the stack is deployed in a dedicated container via a
|
||||
Helm Chart.
|
||||
|
||||
To deploy SUSE RMT on top of Kubernetes, each component of the stack is deployed in a dedicated container using a
|
||||
Helm chart.
|
||||
### Repository Mirroring Tool (SUSE RMT) server
|
||||
|
||||
A containerized version of the SUSE RMT application that can pass its configuration via Helm values. Because persistent storage resides on a persistent volume, you need to adjust the volume size according to the number of repositories you need to mirror.
|
||||
@ -34,10 +33,14 @@ paths handling, as NGINX is configured to do that.
|
||||
- a running Kubernetes cluster
|
||||
- helm command configured to interact with the cluster
|
||||
|
||||
The Helm chart can be obtained using the following command:
|
||||
|
||||
`helm pull oci://registry.suse.com/suse/rmt-helm`
|
||||
|
||||
## Custom mandatory values
|
||||
|
||||
Certain values of the chart do not have any defaults:
|
||||
- SCC mirroring credentials (refer to [more information](https://documentation.suse.com/sles/15-SP4/html/SLES-all/cha-rmt-mirroring.html#sec-rmt-mirroring-credentials) for more information)
|
||||
- SCC mirroring credentials (refer to [more information](https://documentation.suse.com/sles/html/SLES-all/cha-rmt-mirroring.html#sec-rmt-mirroring-credentials) for more information)
|
||||
- list of products to mirror
|
||||
- list of products not to mirror
|
||||
- DNS name used to reach the RMT server
|
||||
@ -45,9 +48,10 @@ Certain values of the chart do not have any defaults:
|
||||
|
||||
Before deploying the chart, you must fill a custom values file.
|
||||
|
||||
The following example enables ingress with TLS.
|
||||
The create-certs.sh can be used to create self-signed certificates and
|
||||
add them to Kubernetes as a usable TLS secret.
|
||||
The following example enables ingress with TLS. The `create-certs.sh` script
|
||||
supplied with the Helm chart can be used
|
||||
to create self-signed certificates and add them to Kubernetes as a usable TLS
|
||||
secret.
|
||||
|
||||
```
|
||||
cat << EOF > myvalues.yaml
|
||||
@ -81,10 +85,27 @@ db:
|
||||
EOF
|
||||
```
|
||||
|
||||
The required values in the custom value file are as follows:
|
||||
|
||||
- `app.scc.password` SUSE Customer Center proxy password. The password string must be in quotes. If the quote character `"` is part of the string, it has to be escaped with `\`.
|
||||
- `app.scc.username` SUSE Customer Center proxy user name. The user name string must be quotes. If the quote character `"` is part of the string, it has to be escaped with `\`.
|
||||
- `app.scc.products_enable` List of products to enable for mirroring.
|
||||
- `app.scc.products_disable` list of products to exclude from mirroring.
|
||||
- `app.storage.class` Kubernetes storageclass.
|
||||
- `db.storage.class` Kubernetes storageclass.
|
||||
- `ingress.enabled` Enable or disable ingress.
|
||||
- `ingress.hosts[0]` DNS name at which the RMT service is be accessible from clients.
|
||||
- `ingress.tls[0].hosts[0]` DNS name at which the RMT service is be accessible from clients.
|
||||
- `ingress.tls[0].secretName` TLS ingress certificate.
|
||||
|
||||
## Deploying
|
||||
|
||||
`helm install rmt ./helm -f myvalues.yaml`
|
||||
|
||||
## Further info
|
||||
|
||||
For more information on using RMT, refer to the [RMT Guide](https://documentation.suse.com/sles/html/SLES-all/book-rmt.html).
|
||||
|
||||
## Licensing
|
||||
|
||||
`SPDX-License-Identifier: MIT`
|
||||
|
@ -1,3 +1,8 @@
|
||||
-------------------------------------------------------------------
|
||||
Mon Jul 8 08:57:27 UTC 2024 - Dmitri Popov <dmitri.popov@suse.com>
|
||||
|
||||
- README update to include helm chart instructions
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Tue Jun 18 17:24:16 UTC 2024 - Dirk Mueller <dmueller@suse.com>
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user