How to provision kadabra? #395

New Issue

moritz · 2023-02-01T16:40:28Z

moritz commented

2023-02-01 16:40:28 +00:00

Related to #236 I have some design questions about the autoupdater.

How to get the auto updater binary on to the server?
- let the user do it manually?
- abra autoupdater provision?
How to run the autoupdater?
- via cronjob?
- as background daemon?
How to implement email notifications?
- use server utilities?
- build it into the autoupdater?

I would prefer to use cronjobs for the follwing reasons:

less maintenance, easy setup
daemons can crash, which requires extra monitoring
the user can decide to use cron or systemd timer
no need for extra configuration files
build in email notification

I think it would be a nice to provide an installation script that copies the binary, configures the cronjob and email settings.

A simple setup would look like this:

apt install ssmtp

cat > /etc/ssmtp/ssmtp.conf << EOF
mailhub=$MAIL_SERVER:587
hostname=$MAIL_DOMAIN
AuthUser=$USER
AuthPass=$PASSWORD
FromLineOverride=yes
UseSTARTTLS=yes
EOF

cat > /etc/cron.d/abra_updater << EOF
MAILTO=admin@example.com
MAILFROM=noreply@example.com

0  * * * *       root    ~/kadabra notify --major
30 4 * * *       root    ~/kadabra upgrade
EOF

A disadvantage of this approach is that it's not completely independent of the underlying system.

Related to https://git.coopcloud.tech/coop-cloud/organising/issues/236 I have some design questions about the autoupdater. 1. How to get the auto updater binary on to the server? - let the user do it manually? - `abra autoupdater provision`? 2. How to run the autoupdater? - via cronjob? - as background daemon? 3. How to implement email notifications? - use server utilities? - build it into the autoupdater? I would prefer to use cronjobs for the follwing reasons: - less maintenance, easy setup - daemons can crash, which requires extra monitoring - the user can decide to use cron or systemd timer - no need for extra configuration files - build in email notification I think it would be a nice to provide an installation script that copies the binary, configures the cronjob and email settings. A simple setup would look like this: ``` apt install ssmtp cat > /etc/ssmtp/ssmtp.conf << EOF mailhub=$MAIL_SERVER:587 hostname=$MAIL_DOMAIN AuthUser=$USER AuthPass=$PASSWORD FromLineOverride=yes UseSTARTTLS=yes EOF cat > /etc/cron.d/abra_updater << EOF MAILTO=admin@example.com MAILFROM=noreply@example.com 0 * * * * root ~/kadabra notify --major 30 4 * * * root ~/kadabra upgrade EOF ``` A disadvantage of this approach is that it's not completely independent of the underlying system.

decentral1se commented

2023-02-01 16:57:45 +00:00

Incredible!

I'd be up for a curl https://install.kadabra.coopcloud.tech | bash and it seems to be inline with the abra installer. Following coop-cloud/abra#255 there is a proposal to remove provisioning logic, so documenting how to do this with classic *nix tooling seems ideal to me. I think the bash installer script could help people set up the basics?

That could be worked into coop-cloud/abra#268 or in another place, as you like.

Some documentation for the decisions that we make here would be ideal.

Incredible! I'd be up for a `curl https://install.kadabra.coopcloud.tech | bash` and it seems to be inline with the `abra` installer. Following https://git.coopcloud.tech/coop-cloud/abra/pulls/255 there is a proposal to remove provisioning logic, so documenting how to do this with classic `*nix` tooling seems ideal to me. I think the bash installer script could help people set up the basics? That could be worked into https://git.coopcloud.tech/coop-cloud/abra/pulls/268 or in another place, as you like. Some documentation for the decisions that we make here would be ideal.

decentral1se added the

question

label 2023-02-01 16:58:15 +00:00

decentral1se commented

2023-02-08 20:05:23 +00:00

coop-cloud/abra#268 is merged! We can get to the installer script shortly after. I think the releaser logic will publish binaries for the next release.

https://git.coopcloud.tech/coop-cloud/abra/pulls/268 is merged! We can get to the installer script shortly after. I think the releaser logic will publish binaries for the next release.

moritz commented

2023-02-08 20:28:09 +00:00

I pushed some brief docs about setting up the auto-updater:
https://docs.coopcloud.tech/operators/tutorial/#automatic-upgrades
An installer script will follow.

I pushed some brief docs about setting up the auto-updater: https://docs.coopcloud.tech/operators/tutorial/#automatic-upgrades An installer script will follow.

🎉 1

decentral1se changed title from ~~How to provision the autoupdater?~~ to How to provision kadabra?

2023-02-08 23:45:45 +00:00

decentral1se added the

kadabra

label 2023-02-08 23:46:21 +00:00

decentral1se commented

2023-02-09 09:46:17 +00:00

So, #402 is an issue but we're nearly there for being ready to wire up the installer script. Unless you can hack the script to download the correct "abra" binary and renamed it to kadabra as is 🙃

So, https://git.coopcloud.tech/coop-cloud/organising/issues/402 is an issue but we're nearly there for being ready to wire up the installer script. Unless you can hack the script to download the correct "abra" binary and renamed it to `kadabra` as is 🙃

decentral1se commented

2023-02-10 13:33:56 +00:00

Binaries are there

https://git.coopcloud.tech/coop-cloud/abra/releases/tag/0.7.0-rc2-beta

Binaries are there > https://git.coopcloud.tech/coop-cloud/abra/releases/tag/0.7.0-rc2-beta

moritz commented

2023-05-17 17:14:22 +00:00

Another idea would be to create a recipe for kadabra. With access to the docker socket it shouldn't be a problem to run kadabra inside a container I guess.
This would facilitate the deployment and the cron/alert configuration per env file.

Another idea would be to create a recipe for kadabra. With access to the docker socket it shouldn't be a problem to run kadabra inside a container I guess. This would facilitate the deployment and the cron/alert configuration per env file.

~~p4u1 referenced this issue 2024-03-11 12:57:14 +00:00~~

Release abra 0.9.0-beta #573

Sign in to join this conversation.

No Milestone

No project

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: coop-cloud/organising#395