Bug: config file generated by the provision wizard and env variables don't match the documentation

[cdanger]

What were you trying to achieve?

Propeller K8s operator page

Step 5.3 - Export credentials as shell variables

What are the expected results?

TENANT_ID: <UUID>
CHAN_ID:    <UUID>
MGR_ID:    <UUID>
PROP_ID:   <UUID>

What are the received results?

All exported variables are empty except CHAN_ID.

Steps To Reproduce

Copy-paste and run the bash script from step 5.3.

In what environment did you encounter the issue?

Ubuntu 24.04 LTS

Additional information you deem important

The script does not work because the content of the generated docker/config.toml is very different from the one in the documentation, especially the property names.

The documentation shows an example of config file with tenant_id, entity_id, api_key and channel_id properties, and the script in step 5.3 is expecting those.

But the config file generated by the provision wizard in my case has different properties (the only one unchanged is channel_id): domain_id, client_id, client_key.
For example :

# Magistrala Configuration

[manager]
domain_id = "0b79e1ea-6b2f-4938-a42f-a56ea93d6784"
client_id = "d73aedc0-6283-4e18-bffa-c17147be53ba"
client_key = "......(content omitted).............................."
channel_id = "a0bb57b2-a728-416c-9d2c-ee3bc107b0f8"

[proplet]
domain_id = "0b79e1ea-6b2f-4938-a42f-a56ea93d6784"
client_id = "c19b1c23-ded7-4d57-b247-8817a63fb26d"
client_key = "......(content omitted).............................."
channel_id = "a0bb57b2-a728-416c-9d2c-ee3bc107b0f8"

[proxy]
domain_id = "0b79e1ea-6b2f-4938-a42f-a56ea93d6784"
client_id = "61b1fb23-479c-4314-aa32-9ac338b24dc0"
client_key = "......(content omitted).............................."
channel_id = "a0bb57b2-a728-416c-9d2c-ee3bc107b0f8"

As a result, the script to export the shell variables fails (except for CHAN_ID) and therefore the env variables to put in docker/.env at step 6 are incorrect / obsolete. What are the correct variables for that .env file now?

[cdanger]

Well, it seems the new Docker env variables were automatically created in the docker/.env in my case: MANAGER_DOMAIN_ID, MANAGER_CLIENT_ID, MANAGER_CLIENT_KEY, MANAGER_CHANNEL_ID, PROPLET_DOMAIN_ID, PROPLET_CLIENT_ID, etc.
So step 5.3 (Export credentials as shell variables) is no longer needed?

[rodneyosodo]

This was resolved in main shortly after the v0.5.0 tag by commit e7829e1 ("migrate to use atom"). The provision wizard now writes tenant_id, entity_id, api_key, and channel_id in docker/config.toml, matching the docs and the step 5.3 export script, and docker/.env uses the corresponding MANAGER_*/PROPLET_*/PROXY_*_TENANT_ID/ENTITY_ID/API_KEY/CHANNEL_ID variables. I've also updated the stale examples/fl-demo/README.md references from CLIENT_KEY to API_KEY. Please re-test against the latest release (the fix is in v0.6.0). So step 5.3 still works, the export script now succeeds against the current config.toml.

[rodneyosodo]

Hello @cdanger

The docs have been updated https://www.absmach.eu/docs/propeller/k8s/operator/. Kindly let us know if that solves the problem.