Conversation
367765b to
c1e34e0
Compare
e9c9396 to
722ceb2
Compare
dido18
left a comment
There was a problem hiding this comment.
I would remove the numbers from the headline.
As a general structure, I would adhere to other specifications:
8973f34 to
7a9e5af
Compare
| The `app.yaml` supports the use of **Secrets** within the Brick `variables` map to handle sensitive information, such as database passwords. | ||
|
|
There was a problem hiding this comment.
how to define a secret variable ? we could give example
There was a problem hiding this comment.
variables:
- name: API_KEY
description: API Key
secret: true
There was a problem hiding this comment.
Isn't this struct just for the brick-list?
and in the app.yaml is:
arduino-app-cli/internal/orchestrator/app/testdata/complex-app.yaml at main · arduino/arduino-app-cli
There was a problem hiding this comment.
what do you think?
looking at the code it seems works like this:
Some Bricks define certain variables as secrets. This is declared in the Brick's own definition, not in the app.yaml.
In the app.yaml, the user sets the value of a secret variable exactly like any other variable, using the standard variables map.
Automatic Redaction: When an App is exported, the values of variables marked as secret in the Brick definition (within app.yaml) are automatically redacted (set to empty). This ensures that the App bundle can be safely shared without leaking credentials or private keys.
| variables: | ||
| secret: "secret.db_password" | ||
| ports: "8080" |
There was a problem hiding this comment.
this is not true, secret is a boolen field
| variables: | |
| secret: "secret.db_password" | |
| ports: "8080" | |
| variables: | |
| secret: true |
There was a problem hiding this comment.
from tests:
[arduino-app-cli/internal/orchestrator/app/testdata/complex-app.yaml at main · arduino/arduino-app-cli](https://github.com/arduino/arduino-app-cli/blob/main/internal/orchestrator/app
Motivation
closes #364
The app-specification.md is the single source of truth of the app.
Change description
Additional Notes
Reviewer checklist
main.