Deuxfleurs/albatros
17
2
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity

Update readme file
All checks were successful
Albatros build
Details

Browse source
This commit is contained in:
Quentin 2023-03-15 20:12:52 +01:00
parent 20cd122480
commit c36a4527c0
Signed by: quentin
GPG key ID: E9602264D639FF68
1 changed files with 5 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -22,8 +22,6 @@ nomad run hcl/builder.hcl
go run main.go go run main.go
``` ```
*Note: in the future, Gitea might become optional*.
## Register a build ## Register a build
Add to Consul a key in albatros hierarchy Add to Consul a key in albatros hierarchy
@ -33,7 +31,7 @@ named after your repo URL as base64. Example:
albatros/aHR0cHM6Ly9naXQuZGV1eGZsZXVycy5mci9xdWVudGluL2FsYmF0cm9zLmdpdA== albatros/aHR0cHM6Ly9naXQuZGV1eGZsZXVycy5mci9xdWVudGluL2FsYmF0cm9zLmdpdA==
``` ```
The key must contain a JSON file with your desired token, trust conditions, and secrets: The key must contain a JSON file with your desired token, gitea info, trust conditions, and secrets:
```json ```json
{ {
@ -51,6 +49,10 @@ The key must contain a JSON file with your desired token, trust conditions, and
} }
``` ```
*Register an access token if Gitea for your Albatros by creating an application token.
The URL is `/user/settings/applications`. Name your app `albatros` for example, the token will be displayed once in light blue.
Put it in the JSON file.*
Your secret will be injected in your build environment only Your secret will be injected in your build environment only
when trustig condition are matched. It wil be available in a dedicated when trustig condition are matched. It wil be available in a dedicated
file. Its path is communicated through an environment variable (see below). file. Its path is communicated through an environment variable (see below).
@ -100,14 +102,6 @@ FLAVOR=default
SECRET_PATH=/var/run/secrets/albatros/secret.txt SECRET_PATH=/var/run/secrets/albatros/secret.txt
``` ```
## Gitea integration
Register an access token for your Albatros application in Gitea.
The URL is `/user/settings/applications`.
Name your app `albatros` for example, the token will be displayed once
in light blue. Store it in your vault.
## Security model ## Security model
Albatros only tries to protect your secrets. Albatros only tries to protect your secrets.