From dfe74101360d06b0ac526b8731e24f618d50c356 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Sch=C3=B6chlin?= <marc.schoechlin@uhurutec.com>
Date: Tue, 27 Jan 2026 11:27:22 +0100
Subject: [PATCH] improve documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Marc Schöchlin <marc.schoechlin@uhurutec.com>
---
 README.md | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 0dba608..ba71417 100644
--- a/README.md
+++ b/README.md
@@ -62,7 +62,38 @@ options:
 
 # Configuration
 
-The following cnfigurations:
+## Configguring the cloud admin access
+
+This is an example for a yaook based system.
+
+1. Gather openstack admin credentials
+   (example for a Yaook system)
+   ```
+   kubectl get secret -n yaook keystone-admin -o json | jq -r '.data | to_entries[] | "\(.key)=\(.value | @base64d)"'
+   ```
+2. Create a `clouds.yaml` file to access the test cloud
+   ```
+   clouds:
+     ustack-admin:
+       auth:
+         auth_url: https://keystone.my.ustack.cloud:443/v3
+         #
+         password: REDACTED
+         project_domain_name: Default
+         project_name: admin
+         user_domain_name: Default
+         username: yaook-sys-maint
+       verify: false
+   ```
+3. Specify environment variables
+   ```
+   export OS_CLIENT_CONFIG_FILE=$PWD/clouds.yaml
+   export OS_CLOUD="ustack-admin"
+   ```
+
+## Configuring profiles
+
+The following configurations are supported by the file referenced bv the `--config` option:
 
 * `admin_domain_password`
   * the password for the domain users which are created (User `<domain-name>_admin`)
@@ -88,7 +119,7 @@ The following cnfigurations:
 * `admin_vm_ssh_key`:
   * A multiline string which ssh public keys
 
-```
+Predefined profiles are availalable in the [profiles](./profiles) folder.
 
 # Testing Scenarios