diff --git a/docs/operators/handbook.md b/docs/operators/handbook.md index b39397c..62b2daa 100644 --- a/docs/operators/handbook.md +++ b/docs/operators/handbook.md @@ -486,9 +486,9 @@ abra app secret insert localhost ssl_key v1 localhost.key -f ## 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: @@ -506,7 +506,9 @@ $ABRA_DIR/recipes/mygit_org_myorg_cool-recipe ## 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`, 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? -!!! 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 @@ -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`: 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`) -3. latest commit (`--chaos/-C` / `abra app deploy` + no released recipe versions) -4. 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. version retrieved from the app `.env` (`abra app deploy` + `TYPE=custom-html:1.7.1+1.27.2`) +1. latest commit (`--chaos/-C` / `abra app deploy` + no released recipe versions) +1. latest commit with unstaged changes (`abra app deploy --chaos/-C`) +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 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 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. In all cases 3-5, the app `.env` version is **ignored** as a version candidate. diff --git a/docs/operators/tutorial.md b/docs/operators/tutorial.md index 9d5ae53..1923ed5 100644 --- a/docs/operators/tutorial.md +++ b/docs/operators/tutorial.md @@ -129,16 +129,15 @@ It is important to note that `` here is a publicy accessible doma ??? warning "Can I use arbitrary server names?" - Yes, this is possible. You need to pass `-D` to `server add` and ensure - that your `Host ...` entry in your SSH configuration includes the name. - So, for example: + Yes, this is possible. Snsure that your `Host ...` entry in your SSH + configuration includes the name. So, for example: Host example.com example ... 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.