From 9e96900c759a8428f6bc564d408cc5d29a2ed1e9 Mon Sep 17 00:00:00 2001 From: Tim Serong Date: Wed, 2 Aug 2023 18:09:42 +1000 Subject: [PATCH 1/2] Add publicDomain settings to example helm invocation If publicDomain and ui.publicDomain aren't specified somehow (whether via `--set ...` or `-f values.yaml`), the installation will fail with "Please provide a value for `.Values.publicDomain`" and "Please provide a value for `.Values.ui.publicDomain`". We can at least hint at this need in advance by suggesting to use YOUR_DOMAIN_NAME in both cases. Signed-off-by: Tim Serong --- src/pages/index.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/pages/index.js b/src/pages/index.js index 0c2c715..5b84a87 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -56,7 +56,9 @@ function Landing() { ` # Helm chart helm repo add s3gw https://aquarist-labs.github.io/s3gw-charts/ -helm install s3gw s3gw/s3gw --namespace s3gw-system --create-namespace +helm install s3gw s3gw/s3gw --namespace s3gw-system --create-namespace \\ + --set publicDomain=YOUR_DOMAIN_NAME \\ + --set ui.publicDomain=YOUR_DOMAIN_NAME # Docker docker pull quay.io/s3gw/s3gw:latest From 12275300f4c4abf63ff127b0dc288b6f9065a4fe Mon Sep 17 00:00:00 2001 From: Tim Serong Date: Wed, 2 Aug 2023 18:10:50 +1000 Subject: [PATCH 2/2] Add explanatory text to Getting Started section This provides a bit more detail about exactly what you're getting yourself into with each of the example deployment methods. Signed-off-by: Tim Serong --- src/pages/index.js | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/pages/index.js b/src/pages/index.js index 5b84a87..232654f 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -69,6 +69,19 @@ podman run --replace --name=s3gw -it -p 7480:7480 quay.io/s3gw/s3gw:latest ` } +

Helm is the preferred deployment method, and will automatically use + your cluster's default storage class for the backing store. If you have + Longhorn installed already, s3gw will thus use a Longhorn PV. The above + assumes cert-manager and traefik are available, but these and other settings + can be overridden via values.yaml.

+

Docker and Podman deployments will use ephemeral storage inside the + container by default, so should only be used for testing on a local system. +

+

In all the above cases, the default Access Key and Secret Key are + set to "test". Please see our documentation for + more details on how to configure s3gw. +

+