toolshed/docs.coopcloud.tech
toolshed/docs.coopcloud.tech
3
1
Fork 21
Code Issues 4 Pull Requests 1 Packages Releases Activity

docs: v0.10 operators handbook updates
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
decentral1se 2025-04-21 20:02:42 +02:00
parent a87e54a1d1
commit 4bcc5a7f04
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
2 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/operators/handbook.md
View File

@ -486,9 +486,9 @@ abra app secret insert localhost ssl_key v1 localhost.key -f
## Remote recipes ## Remote recipes
!!! warning "This is only available in the currently unreleased version of `abra`" !!! warning "Watch out for old versions of `abra` 🚧"
Please see [this issue](https://git.coopcloud.tech/toolshed/organising/issues/583) to track current progress towards a release. All feedback and testing are welcome on this new feature. The design is not finalised yet. This feature is only available in > 0.10.x series of `abra`.
It is possible to specify a remote recipe in your `.env` file: It is possible to specify a remote recipe in your `.env` file:
@ -506,7 +506,9 @@ $ABRA_DIR/recipes/mygit_org_myorg_cool-recipe
## Saving the version to the app `.env` file ## Saving the version to the app `.env` file
!!! warning "This is only available in the currently unreleased version of `abra`" !!! warning "Watch out for old versions of `abra` 🚧"
This feature is only available in > 0.10.x series of `abra`.
If you `abra app new`/`abra app deploy`/`abra app upgrade`/`abra app rollback`, If you `abra app new`/`abra app deploy`/`abra app upgrade`/`abra app rollback`,
the version that is deployed will be written to your app `.env` file. You can the version that is deployed will be written to your app `.env` file. You can
@ -531,7 +533,9 @@ with `[version]` `--chaos/-C` or `--ignore-env-version/-i`.
## How is the new deployment version determined? ## How is the new deployment version determined?
!!! warning "This is only available in the currently unreleased version of `abra`" !!! warning "Watch out for old versions of `abra` 🚧"
This feature is only available in > 0.10.x series of `abra`.
### `.env` version ### `.env` version
@ -549,10 +553,10 @@ This is the most flexible command so it can be hard to follow. It is possible
to deploy the following kinds of versions with `abra app deploy`: to deploy the following kinds of versions with `abra app deploy`:
1. latest recipe version (standard `abra app deploy`) 1. latest recipe version (standard `abra app deploy`)
2. version retrieved from the app `.env` (`abra app deploy` + `TYPE=custom-html:1.7.1+1.27.2`) 1. version retrieved from the app `.env` (`abra app deploy` + `TYPE=custom-html:1.7.1+1.27.2`)
3. latest commit (`--chaos/-C` / `abra app deploy` + no released recipe versions) 1. latest commit (`--chaos/-C` / `abra app deploy` + no released recipe versions)
4. latest commit with unstaged changes (`abra app deploy --chaos/-C`) 1. latest commit with unstaged changes (`abra app deploy --chaos/-C`)
5. recipe version or Git hash (`abra app deploy 1.7.1+1.27.2`) 1. recipe version or Git hash (`abra app deploy 1.7.1+1.27.2`)
The app `.env` version is always used as the recipe checkout version if The app `.env` version is always used as the recipe checkout version if
present. present.
@ -562,6 +566,13 @@ present, then it will be used. This is the *only time* the app `.env` version
is used using `abra app deploy`. This is done to reduce unwanted upgrades (we is used using `abra app deploy`. This is done to reduce unwanted upgrades (we
do not automatically choose the latest release). do not automatically choose the latest release).
The version is chosen using the following logic.
1. version from cli argument
1. version from .env file
1. version from deployed app
1. version from catalogue (if undeployed)
Use `--ignore-env-version/-i` to deploy the latest release version or commit. Use `--ignore-env-version/-i` to deploy the latest release version or commit.
In all cases 3-5, the app `.env` version is **ignored** as a version candidate. In all cases 3-5, the app `.env` version is **ignored** as a version candidate.

7
docs/operators/tutorial.md
View File

@ -129,16 +129,15 @@ It is important to note that `<server-domain>` here is a publicy accessible doma
??? warning "Can I use arbitrary server names?" ??? warning "Can I use arbitrary server names?"
Yes, this is possible. You need to pass `-D` to `server add` and ensure Yes, this is possible. Snsure that your `Host ...` entry in your SSH
that your `Host ...` entry in your SSH configuration includes the name. configuration includes the name. So, for example:
So, for example:
Host example.com example Host example.com example
... ...
And then: And then:
abra server add -D example abra server add example
You will now have a new `~/.abra/` folder on your local file system which stores all the configuration of your Co-op Cloud instance. You will now have a new `~/.abra/` folder on your local file system which stores all the configuration of your Co-op Cloud instance.