Support env upgrading with abra app upgrade #504

New Issue

2025-02-12T14:30:07Z

stevensting commented

2025-02-12 14:30:07 +00:00

From my point of view it would be nice if abra could support the upgrade process also for the env file, e.g.

removing env vars not needed anymore
adding new mandatory env vars from .env.sample
adding new optional env vars

Idea: let the operator choose one of two ways:

create a fresh env file based on the new .env.sample and fill out the values from the existing env file for the available vars
stick with the existing env file (in case special comments were inserted etc) and check which env vars present in .env.sample exist already in env file and add all missing ones. Also removing old ones.

From my point of view it would be nice if abra could support the upgrade process also for the env file, e.g. - removing env vars not needed anymore - adding new mandatory env vars from .env.sample - adding new optional env vars Idea: let the operator choose one of two ways: * create a fresh env file based on the new .env.sample and fill out the values from the existing env file for the available vars * stick with the existing env file (in case special comments were inserted etc) and check which env vars present in .env.sample exist already in env file and add all missing ones. Also removing old ones.

👀 1

decentral1se commented

2025-02-12 14:58:45 +00:00

Sounds like a useful addition! We have something in line with this logic for the second option in abra app check. Do you have a CLI design proposal for this interface @stevensting?

I would probably not implement this now in the current release candidate phase (unless someone really wants it, I won't stop you!) and aim for the next release (we're gonna aim for smaller iterations).

Sounds like a useful addition! We have something in line with this logic for the second option in `abra app check`. Do you have a CLI design proposal for this interface @stevensting? I would probably not implement this now in the current release candidate phase (unless someone really wants it, I won't stop you!) and aim for the next release (we're gonna aim for smaller iterations).

decentral1se added the enhancement design labels 2025-02-12 14:58:56 +00:00

3wordchant commented

2025-03-21 09:15:51 +00:00

Fully agree with the suggestion @stevensting, indeed I think the next step is to design the UI. I wonder if something like apt's "What would you like to do about it" menu could be useful inspiration? (example)

Fully agree with the suggestion @stevensting, indeed I think the next step is to design the UI. I wonder if something like `apt`'s "What would you like to do about it" menu could be useful inspiration? ([example](https://serverfault.com/q/527789))

👍 1

decentral1se commented

2025-03-21 10:09:20 +00:00

@p4u1 (and I) want to focus on improving how abra reports errors and shares options on how to proceed when faced with different scenarios after the current release. any prototype ideas for design / direction is really welcome! i do very much like a lot of what apt does 😁

@p4u1 (and I) want to focus on improving how `abra` reports errors and shares options on how to proceed when faced with different scenarios after the current release. any prototype ideas for design / direction is really welcome! i do very much like a lot of what `apt` does 😁

decentral1se changed title from ~~support env upgrading with ´abra app upgrade´~~ to Support env upgrading with `abra app upgrade`

2025-03-23 09:44:14 +00:00

fauno commented

2025-04-23 18:57:24 +00:00

both initial ideas sound way better than dropping operators into a mergetool :3

👍 1

fauno referenced this issue from coop-cloud/wallabag

2025-04-23 18:59:18 +00:00

sqlite support #4

fauno commented

2025-04-23 19:01:49 +00:00

Alakazam is updating the env files automatically

> [Alakazam is updating the env files automatically](https://git.coopcloud.tech/coop-cloud/wallabag/pulls/4#issuecomment-24072)

👀 1

decentral1se referenced this issue

2025-05-25 20:43:41 +00:00

UX difficulties encountered when working with recipes #563

Ghost referenced this issue

2025-05-26 14:55:33 +00:00

UX difficulties encountered when working with recipes #563

decentral1se added this to the Abra v0.12 project 2025-08-29 11:02:55 +00:00

decentral1se commented

2025-09-01 09:26:30 +00:00

@stevensting and myself have been chatting about this one. We thought about abra app env sync but then it's not clear what version you'd want. It seems mostly useful when running abra app upgrade and automatically receiving the new version env vars. This could be added to the upgrade overview with appropriate info about whether there is a default value, it requires some manual intervention or it's a non-mandatory value (commented out). Not gonna dive into this for the upcoming version (there's a lot going on already...) but would try for the next abra release. Feedback still most welcome!

@stevensting and myself have been chatting about this one. We thought about `abra app env sync` but then it's not clear what version you'd want. It seems mostly useful when running `abra app upgrade` and automatically receiving the new version env vars. This could be added to the upgrade overview with appropriate info about whether there is a default value, it requires some manual intervention or it's a non-mandatory value (commented out). Not gonna dive into this for the upcoming version (there's a lot going on already...) but would try for the next `abra` release. Feedback still most welcome!

simon commented

2025-10-01 12:09:26 +00:00

Yes, that's always a feature I'm missing when working with an app that we didn't integrate in Alakazam 😅

Currently our workflow looks like this:

Set new version in alaka-versions.yaml
Regenerate the .env files
```
alakazam <instances> config -r $RECIPE
```
Verify changes
```
alakazam <instances> diff -r $RECIPE
```
Check if any secrets need to inserted or generated. For this see if the env repo includes any changed lines with SECRET_VERSION.

Run the upgrade

alakazam <instances> upgrade -r $RECIPE

Check for success
[...]

So we first set the version, regenerate envs (with the magic we're doing with alaka-defaults.yaml, validate the changes by checking the git diff, optionally generate secrets and then run the upgrade

So far, this flow works very well for us, I guess abra could do something similar here

Yes, that's always a feature I'm missing when working with an app that we didn't integrate in Alakazam 😅 Currently our workflow looks like this: 1. Set new version in [alaka-versions.yaml](https://git.local-it.org/local-it/kolli-config/src/branch/main/alaka-versions.yml) 2. Regenerate the .env files ```none alakazam <instances> config -r $RECIPE ``` 3. Verify changes ```none alakazam <instances> diff -r $RECIPE ``` 4. Check if any secrets need to inserted or generated. For this see if the env repo includes any changed lines with `SECRET_VERSION`. 5. Run the upgrade ```javascript alakazam <instances> upgrade -r $RECIPE ``` 6. Check for success [...] So we first set the version, regenerate envs (with the magic we're doing with [alaka-defaults.yaml](https://git.local-it.org/local-it/kolli-config/src/branch/main/alaka-defaults.yml), validate the changes by checking the `git diff`, optionally generate secrets and then run the upgrade So far, this flow works very well for us, I guess abra could do something similar here

❤️ 2 🎉 1 🚀 1

decentral1se commented

2025-10-01 13:25:47 +00:00

I am literally mindblown any time I gain any new insight into how alakazam works! And I still have NO IDEA how it works 😆

I am literally mindblown *any* time I gain any new insight into how alakazam works! And I still have NO IDEA how it works 😆

😆 1

decentral1se moved this to Prioritised in Abra v0.12 on 2025-10-03 21:00:15 +00:00

decentral1se moved this to Backlog in Abra v0.12 on 2025-10-15 08:03:25 +00:00

decentral1se modified the project from Abra v0.12 to (deleted)

2025-10-26 09:50:18 +00:00

decentral1se commented

2025-10-31 14:24:05 +00:00

There is a discussion re: the use of deploy -f which might also be useful to see an env diff for 👁️

There is a discussion re: the use of `deploy -f` which might also be useful to see an env diff for 👁️

Sign in to join this conversation.

5 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: toolshed/abra#504

Support env upgrading with abra app upgrade #504

Support env upgrading with `abra app upgrade` #504