External variables and verbosity #6

ksamaschke · 2025-05-17T03:06:45Z

Summary

Removed hardcoded values by introducing environment variables
Make CCM load balancer type configurable through environment variables
Simplify cluster status checking script to be more user-friendly

Changes Made

Configuration Enhancement

Added CS_CCMLB parameter to both cluster-settings-template.env and cluster-settings.env.sample
This parameter allows users to configure the Cloud Controller Manager load balancer type (octavia-ovn or octavia-amphora)
Removed hardcoded OCTOVN setting in 04-cloud-secret.sh, replacing it with dynamic configuration based on CS_CCMLB value

Script Simplification

Refactored 08-wait-cluster.sh to check cluster status once instead of looping
Script now shows current status and saves kubeconfig if cluster is ready
Removed continuous polling logic in favor of a simpler check-and-report approach
Removed .yaml extension from kubeconfig filename to follow Kubernetes conventions

…p script

…ining-kaas-scripts

…ript - Add CS_CCMLB parameter to configuration files for CCM load balancer type - Replace hardcoded OCTOVN setting in cloud-secret script - Simplify wait-cluster script to show status without looping - Remove .yaml extension from kubeconfig filename

Signed-off-by: Karsten Samaschke <[email protected]>

…/SovereignCloudStack/scs-training-kaas-scripts into external_variables_and_verbosity

- Add 99-prepare-files.sh to automate certificate and clouds.yaml setup - Update README with prerequisites and instructions for config preparation - Clarify that only the last certificate from ca-certificates.crt is needed - Remove unused CL_WAIT_TIMEOUT parameter from all configuration files - Document how to obtain and extract Cloud-in-a-Box certificate

berendt · 2025-05-17T12:26:51Z

Since this is to be published as CC-BY-SA, I would prefer to mark code generated with AI as such in the commit messages. For example, we use AI-assisted: Claude Code in the last line of the commit message.

Also I think it makes sense to have the CLAUDE.md file in the repository when working with Claude Code.

garloff · 2025-05-20T09:39:47Z

cluster-settings.env.sample

Why do we need a sample file when we have a template?
And it copies all the comments (which is documentation),
so we now need to adjust one more file when we update them ...

garloff · 2025-05-20T09:43:19Z

clouds.yaml.sample

+    region_name: "RegionOne"
+    interface: "public"
+    identity_api_version: 3
+    verify: false  # Skip TLS verification for self-signed certs


Hmm, let's comment this one out and rather suggest to fill in a valid ca-bundle.crt, hinting that it would be the last cert in /etc/ssl/certs/ca-certificates.crt on the system with self-signed certs typically.
verify: false is an insecure workaround for cases where you lack it.

garloff · 2025-05-20T09:44:58Z

README.md

-
-* 17-delete-cluster.sh: Remove cluster again.
+* `08-wait-cluster.sh`: Check cluster status and save kubeconfig if ready.
+  This script no longer waits in a loop but provides immediate status


It never did.
But that's what's expected from a script with the name wait.
So call it poll or implement waiting ...

garloff · 2025-05-20T09:48:45Z

README.md

+
+### Configuration Parameters
+
+#### Registry and Repository Settings


I like the way you structure the settings in different groups.
We probably should be thinking about new prefixes for the first two categories.
We also need to make sure we don't duplicate information too much, as divergence is otherwise hard to avoid.
We have the main documentation for the parameters in the -template.env file. It would be my preferred place, TBH.
Additional documentation then should NOT repeat the explanations in there, but introduce higher level concepts etc.

garloff · 2025-05-20T09:53:02Z

README.md

+
+### Obtaining the Cloud-in-a-Box Certificate
+
+If you're using SCS Cloud-in-a-Box (CiaB), you'll need to obtain the certificate. The certificates are located on the CiaB manager host at `/etc/ssl/certs/ca-certificates.crt`.


Suggested change

If you're using SCS Cloud-in-a-Box (CiaB), you'll need to obtain the certificate. The certificates are located on the CiaB manager host at `/etc/ssl/certs/ca-certificates.crt`.

If you're using SCS Cloud-in-a-Box (CiaB), you'll need to obtain the certificate. The certificates are located on the CiaB manager host at `/etc/ssl/certs/ca-certificates.crt`.

This step is only required because CiaB uses self-signed certificates -- please skip it on clouds that use TLS certificates that are signed by a proper certificate authority (CA).

garloff · 2025-05-20T09:53:44Z

17-delete-cluster.sh

@@ -16,7 +16,7 @@ if test -z "$CS_MAINVER"; then echo "Configure CS_MAINVER"; exit 2; fi
 if test -z "$CS_VERSION"; then echo "Configure CS_VERSION"; exit 3; fi
 if test -z "$CL_PATCHVER"; then echo "Configure CL_PATCHVER"; exit 4; fi
 if test -z "$CL_NAME"; then echo "Configure CL_NAME"; exit 5; fi
-if test -z "$CL_PODDIDR"; then echo "Configure CL_PODCIDR"; exit 6; fi
+if test -z "$CL_PODCIDR"; then echo "Configure CL_PODCIDR"; exit 6; fi


Thanks for spotting this!

Signed-off-by: Kurt Garloff <[email protected]>

garloff · 2025-05-20T10:08:56Z

Overall comments:

Your scripts seem to be way more verbose than mine.
- This has the advantage of giving the user more information
- It has the disadvantage of hiding information as things scroll out of a single screen
  So my request is to not overdo it.
Let's be careful to avoid duplicating comment/documentation too much. This creates pain down the line
- This in particular refers to documenting all the variables. They are now documented at three places:
  - cluster-settings-template.env (this is where I meant to document them)
  - cluster-settings-sample.env (if we really need this file, we should strip it from comments and make it minimal, IMVHO)
  - README.md has a good structure, but probably should reference the -template file for details and limit itself to the concepts (as we have 4 categories of settings, internal script settings, per NS = target cloud project, per CS and per Cluster settings, which users should really understand to avoid confusion -- I can remember my own confusion)
- I think we will revise the naming of the settings slightly in the future to reflect those four categories (and maybe to connect to the naming of KaaS-v1). So the maintenance burden of three places is real.
It would have been better to have smaller pull requests, so we could review and decide on a more granular basis.
There seems to be DCOs missing.
Please address @berendt's comment on Claude.

Sidenote: #9 adds a lot more robustness to the clouds.yaml handling, one thing that people will stumble upon.

Signed-off-by: Kurt Garloff <[email protected]>

04-cloud-secret.sh can only append auth values to the end. Signed-off-by: Kurt Garloff <[email protected]>

Adjust sample to be consistent. Signed-off-by: Kurt Garloff <[email protected]>

Signed-off-by: Kurt Garloff <[email protected]>

Karsten Samaschke added 10 commits May 15, 2025 08:30

Fixed issues

e9948f1

Fixed issues

9d5a4d0

Made scripts a bit more verbose, added support for Ubuntu in bootstra…

a996635

…p script

Added Linux Support in Bootstrap Script

e08a772

Merge branch 'main' of https://github.com/SovereignCloudStack/scs-tra…

eb0e819

…ining-kaas-scripts

Adjusted .gitignore to allow for cert-sample-files

d9debc6

Adjusted cluster-settings.env.sample to contain a feasible configuration

b4885ef

Merge branch 'main' of https://github.com/SovereignCloudStack/scs-tra…

ca2031b

…ining-kaas-scripts

Merge branch 'main' into external_variables_and_verbosity

6607e68

ksamaschke requested a review from garloff May 17, 2025 03:06

ksamaschke added the enhancement New feature or request label May 17, 2025

ksamaschke and others added 4 commits May 17, 2025 05:09

Removed Claude.md file

1680437

Signed-off-by: Karsten Samaschke <[email protected]>

Remove CLAUDE.md from version control

81d2227

Merge branch 'external_variables_and_verbosity' of https://github.com…

5953ff6

…/SovereignCloudStack/scs-training-kaas-scripts into external_variables_and_verbosity

garloff reviewed May 20, 2025

View reviewed changes

Merge branch 'main' into external_variables_and_verbosity

6506fbe

Signed-off-by: Kurt Garloff <[email protected]>

garloff added 5 commits May 21, 2025 09:27

Merge branch 'main' into external_variables_and_verbosity

2015108

Signed-off-by: Kurt Garloff <[email protected]>

Put auth section at the end, use test domain.

75a97ad

04-cloud-secret.sh can only append auth values to the end. Signed-off-by: Kurt Garloff <[email protected]>

Streamline variable naming. Use LBTYPE and WORKERCLASS.

01be45d

Adjust sample to be consistent. Signed-off-by: Kurt Garloff <[email protected]>

Merge branch 'main' into external_variables_and_verbosity

ee85693

Signed-off-by: Kurt Garloff <[email protected]>

Merge branch 'main' into external_variables_and_verbosity

1e72f93

Signed-off-by: Kurt Garloff <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

External variables and verbosity #6

External variables and verbosity #6

Uh oh!

ksamaschke commented May 17, 2025

Uh oh!

berendt commented May 17, 2025 •

edited

Loading

Uh oh!

garloff May 20, 2025 •

edited

Loading

Uh oh!

garloff May 20, 2025

Uh oh!

garloff May 20, 2025

Uh oh!

garloff May 20, 2025

Uh oh!

garloff May 20, 2025

Uh oh!

garloff May 20, 2025

Uh oh!

garloff commented May 20, 2025

Uh oh!

Uh oh!


		### Configuration Parameters

		#### Registry and Repository Settings


		### Obtaining the Cloud-in-a-Box Certificate

		If you're using SCS Cloud-in-a-Box (CiaB), you'll need to obtain the certificate. The certificates are located on the CiaB manager host at `/etc/ssl/certs/ca-certificates.crt`.

	If you're using SCS Cloud-in-a-Box (CiaB), you'll need to obtain the certificate. The certificates are located on the CiaB manager host at `/etc/ssl/certs/ca-certificates.crt`.
	If you're using SCS Cloud-in-a-Box (CiaB), you'll need to obtain the certificate. The certificates are located on the CiaB manager host at `/etc/ssl/certs/ca-certificates.crt`.
	This step is only required because CiaB uses self-signed certificates -- please skip it on clouds that use TLS certificates that are signed by a proper certificate authority (CA).

External variables and verbosity #6

Are you sure you want to change the base?

External variables and verbosity #6

Uh oh!

Conversation

ksamaschke commented May 17, 2025

Summary

Changes Made

Configuration Enhancement

Script Simplification

Uh oh!

berendt commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

garloff May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

garloff May 20, 2025

Choose a reason for hiding this comment

Uh oh!

garloff May 20, 2025

Choose a reason for hiding this comment

Uh oh!

garloff May 20, 2025

Choose a reason for hiding this comment

Uh oh!

garloff May 20, 2025

Choose a reason for hiding this comment

Uh oh!

garloff May 20, 2025

Choose a reason for hiding this comment

Uh oh!

garloff commented May 20, 2025

Uh oh!

Uh oh!

berendt commented May 17, 2025 •

edited

Loading

garloff May 20, 2025 •

edited

Loading