toolshed/abra
4
4
Fork 23
Code Issues 82 Pull Requests 11 Packages Releases 45 Activity

Post-deploy abra.sh hooks #292

Merged
moritz merged 5 commits from post_deploy_cmds into main 2023-04-14 14:12:33 +00:00
Conversation 2 Commits 5 Files Changed 6
+183 -97
moritz commented 2023-04-13 17:48:05 +00:00
Member
Copy Link
Copy Source

This solves coop-cloud/organising#235

To execute commands after each abra app deploy add the env:
POST_DEPLOY_CMDS="<container> <command> <arguments>|<container> <command2> <arguments2>|... "
To execute commands after each abra app upgrade add the env:
POST_UPGRADE_CMDS="<container> <command> <arguments>|..."

It is important that the health checks are working correctly and the timeout is high enough, because the commands are only executed after the services converged successfully.

This solves https://git.coopcloud.tech/coop-cloud/organising/issues/235 To execute commands after each `abra app deploy` add the env: `POST_DEPLOY_CMDS="<container> <command> <arguments>|<container> <command2> <arguments2>|... "` To execute commands after each `abra app upgrade` add the env: `POST_UPGRADE_CMDS="<container> <command> <arguments>|..."` It is important that the health checks are working correctly and the timeout is high enough, because the commands are only executed after the services converged successfully.
decentral1se reviewed 2023-04-14 11:38:02 +00:00
decentral1se left a comment
Owner
Copy Link
Copy Source

LGTM! Some minor comments. Can you also throw up some docs for this new functionality as well? Thanks!

LGTM! Some minor comments. Can you also throw up some docs for this new functionality as well? Thanks!
cli/app/upgrade.go
@@ -207,1 +207,4 @@
postDeployCmds, ok := app.Env["POST_UPGRADE_CMDS"]
if ok && !internal.DontWaitConverge {
logrus.Debugf("Run the following post-deploy commands: %s", postDeployCmds)
decentral1se commented 2023-04-14 11:33:17 +00:00
Owner
Copy Link
Copy Source

nitpick: Run -> run since the rest of the codebase uses lowercase

nitpick: `Run` -> `run` since the rest of the codebase uses lowercase
moritz marked this conversation as resolved
cli/app/upgrade.go
@@ -208,0 +209,4 @@
if ok && !internal.DontWaitConverge {
logrus.Debugf("Run the following post-deploy commands: %s", postDeployCmds)
if err := internal.PostCmds(cl, app, postDeployCmds); err != nil {
logrus.Fatal(err)
decentral1se commented 2023-04-14 11:32:53 +00:00
Owner
Copy Link
Copy Source

logrus.Fatalf("attempting to run post deploy commands, saw: %s", err)?

`logrus.Fatalf("attempting to run post deploy commands, saw: %s", err)`?
moritz marked this conversation as resolved
cli/internal/command.go
@@ -7,2 +20,4 @@
"github.com/sirupsen/logrus"
)
func RunCmdRemote(cl *dockerClient.Client, app config.App, abraSh, serviceName, cmdName, cmdArgs string) error {
decentral1se commented 2023-04-14 11:33:31 +00:00
Owner
Copy Link
Copy Source

Missing docstring?

Missing docstring?
moritz marked this conversation as resolved
cli/internal/command.go
@@ -8,1 +22,4 @@
func RunCmdRemote(cl *dockerClient.Client, app config.App, abraSh, serviceName, cmdName, cmdArgs string) error {
filters := filters.NewArgs()
filters.Add("name", fmt.Sprintf("^%s_%s", app.StackName(), serviceName))
decentral1se commented 2023-04-14 11:34:59 +00:00
Owner
Copy Link
Copy Source

I'd recommend using the app.Filters if possible due to the often bizarre handling of filters in the Docker API. You'd pass exactMatch = true which I think is more readable for our future selves.

I'd recommend using the `app.Filters` if possible due to the often bizarre handling of filters in the Docker API. You'd pass `exactMatch = true` which I think is more readable for our future selves.
moritz commented 2023-04-14 12:26:58 +00:00
Author
Member
Copy Link
Copy Source

I just moved this function from cli/app/cmd.go without touching it.
I think app.Filters doesn't make sense here, because it filters for all services and in this case only a filter for serviceName is required.

I just moved this function from `cli/app/cmd.go` without touching it. I think `app.Filters` doesn't make sense here, because it filters for all services and in this case only a filter for `serviceName` is required.
👍 1
moritz marked this conversation as resolved
cli/internal/deploy.go
@@ -166,1 +167,4 @@
postDeployCmds, ok := app.Env["POST_DEPLOY_CMDS"]
if ok && !DontWaitConverge {
logrus.Debugf("Run the following post-deploy commands: %s", postDeployCmds)
decentral1se commented 2023-04-14 11:35:59 +00:00
Owner
Copy Link
Copy Source

nitpick: Run -> run since the rest of the codebase uses lowercase

nitpick: Run -> run since the rest of the codebase uses lowercase
moritz marked this conversation as resolved
cli/internal/deploy.go
@@ -167,0 +169,4 @@
if ok && !DontWaitConverge {
logrus.Debugf("Run the following post-deploy commands: %s", postDeployCmds)
if err := PostCmds(cl, app, postDeployCmds); err != nil {
logrus.Fatal(err)
decentral1se commented 2023-04-14 11:36:25 +00:00
Owner
Copy Link
Copy Source

logrus.Fatalf("attempting to run post deploy commands, saw: %s", err)?

logrus.Fatalf("attempting to run post deploy commands, saw: %s", err)?
moritz marked this conversation as resolved
cli/internal/deploy.go
@@ -167,0 +176,4 @@
return nil
}
func PostCmds(cl *dockerClient.Client, app config.App, commands string) error {
decentral1se commented 2023-04-14 11:36:36 +00:00
Owner
Copy Link
Copy Source

Missing doc string?

Missing doc string?
moritz marked this conversation as resolved
cli/internal/deploy.go
@@ -167,0 +196,4 @@
if len(commandParts) > 2 {
parsedCmdArgs = fmt.Sprintf("%s ", strings.Join(commandParts[2:], " "))
}
logrus.Infof("Running post-command '%s %s' in container %s", cmdName, parsedCmdArgs, targetServiceName)
decentral1se commented 2023-04-14 11:37:26 +00:00
Owner
Copy Link
Copy Source

nitpick: Running -> running since the rest of the codebase uses lowercase

nitpick: Running -> running since the rest of the codebase uses lowercase
moritz marked this conversation as resolved
moritz force-pushed post_deploy_cmds from 6c993e812c to 14bdb57ac7 2023-04-14 12:33:42 +00:00 Compare
moritz added 1 commit 2023-04-14 12:37:18 +00:00
resolve PR review
continuous-integration/drone/push Build is failing
Details
continuous-integration/drone/pr Build is failing
Details
0845fcf78c
moritz added 1 commit 2023-04-14 13:30:24 +00:00
fix drone building
continuous-integration/drone/pr Build is failing
Details
continuous-integration/drone/push Build is failing
Details
a96f7d39cb
moritz added 1 commit 2023-04-14 13:54:56 +00:00
fix drone building
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is passing
Details
a0eb70879d
moritz commented 2023-04-14 13:58:55 +00:00
Author
Member
Copy Link
Copy Source

Some docs: https://docs.coopcloud.tech/maintainers/handbook/#global-environment-variables

Some docs: https://docs.coopcloud.tech/maintainers/handbook/#global-environment-variables
moritz merged commit 18615eaaef into main 2023-04-14 14:12:32 +00:00
moritz deleted branch post_deploy_cmds 2023-04-14 14:12:37 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
decentral1se
Labels
Clear labels
bug
Something is not working
 build
go build related issues
 ci/cd
Building things with CI/CD
 critical fix
https://docs.coopcloud.tech/federation/resolutions/passed/010/
 design
UI/UX
 documentation
Documenting all the things
 duplicate
This issue or pull request already exists
 easy-first-issue
Something for new people to get stuck into. We hope it's easy!
 enhancement
New feature
 help wanted
Need some help
 i10n
Everything to do with localisation
 i18n
Everything to do with internationalisation
 installer
Everything to do with the install script.
 invalid
Something is wrong
 question
More information is needed
 release
Release management
 release-candidate
Related to the new release candidate
 security
Security related
 tech-debt
test
Unit/integration testing
 wontfix
This won't be fixed
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
3wordchant aadil (Aadil Ayub) abra-bot (Abra Bot) ammaratef45 amras (Sarma) Apfelwurm BornDeleuze Brooke carla cas (Cassowary) coopcloud cyrnel decentral1se (d1) dede devydave fauno (fauno) iexos jade (Jade Ambrose) jjsfunhouse jmakdah2 (Jackie Makdah) joe-irving (Joe Irving) kawaiipunk (KawaiiPunk) knoflook kolaente lambdabundesverband linnealovespie (April) moosemower moritz notplants oxaliq (sorrel) p4u1 pharaohgraphy (Andrew 🐦‍🔥❤️‍🔥✴️) renovate-bot (Comrade Renovate Bot) ripclap simon sixsmith (Sixsmith) stevensting trav (Trav Fryer) val (val (he/him)) yksflip
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: toolshed/abra#292