simon/docs.coopcloud.tech
0
0
Fork 0
forked from toolshed/docs.coopcloud.tech
Code Pull Requests Activity

docs: long secret names

Browse Source
This commit is contained in:
decentral1se
2024-04-06 23:57:49 +02:00
parent 6550aa1d1d
commit 064a26e182
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/maintainers/handbook.md
View File

@ -696,6 +696,21 @@ You should be able to deploy this overriden configuration now.
## Linting rules ## Linting rules
### R015: "long secret names"
Due to limitations placed by the Docker runtime, secret names must be < 64
characters long. Due to convetions in recipe configuration and how `abra`
works, several characters are appended to secret names during a deployment.
This means if you have a domain `example.org` and a secret `foo_pass`, you'll
end up with something like `example_org_foo_pass_v1` being used for the secret
name.
Based on a discussion in
[`#463`](https://git.coopcloud.tech/coop-cloud/organising/issues/463) and
looking on what is implemented currently in existing recipes, we came up with a
general rule of thumb that secret names in recipe configurations should be < 12
characters long to avoid errors on deployment.
### R014: "invalid lightweight tag" ### R014: "invalid lightweight tag"
This is an issue related to the way Git/`go-git` handle Git tags internally. We This is an issue related to the way Git/`go-git` handle Git tags internally. We