CI: Deploy Docker Images on remote VM #31

FabianUntermoser · 2024-06-07T09:06:00Z

Description

This PR sets up rudimentary deployment of the development branch to a remote VM preview.vim.org.

Changes:

Adds second docker compose file specifying images that were pushed to the Github Container Registry
Adds Github deploy action to deploy the app on a remote VM
- this action should be triggered after either of the build jobs finish. However this does not seem to work currently. A guess is that the github actions need to be placed in the default branch for it to work.
Nginx configuration has been adjusted, config files were checked into the repo manually
Changes to the VM have been documented in its respective changelog file
Configures CMS Strapi backend to run behind the context_path defined in CMS_URL
- only when not in local development
- for the development environment https://preview.vim.org/cms/admin/ is used in the repository var CMS_URL
- note that the CMS_URL variable is required to be set at build time in order for internal Strapi routes to properly use the context path correctly
Adds cronjob to clean up stale docker images on the remote VM

Not included:

Setup Database Migrations if necessary.
Seems that the Content Manager for single types in Strapi is not reachable
- https://preview.vim.org/cms/admin/content-manager/singleType/api::home.home not reachable
- https://preview.vim.org/cms/admin/content-manager/collectionType/api::newspost.newspost works

What type of PR is this? (check all applicable)

- prepare & copy .env file to server - pull and start container images

- pull,stop,start all containers - show docker logs

ensure configuring DATABASE_PORT in the .env file will reflect in the db port being changed as well as other services using the correct port

[skip ci]

- add Dockerfile arg - set arg in github action through secret

.env.example

.github/workflows/deploy-vm.yml

docker-compose.dev.yml

docker-compose.local.yml

cms/.env.example

Co-authored-by: Johannes Munker <56400587+jomunker@users.noreply.github.com>

CMS_URL var configures the context path for the STRAPI CMS backend. It is required at build time in order to make STRAPI internal routes work. It is not needed in local development, as there no contextpath is required.

Fabian Untermoser added 2 commits June 7, 2024 17:50

feat(ci): init deployment workflow

697c167

feat(ci): enable action for push on dev branch

7295505

FabianUntermoser self-assigned this Jun 7, 2024

FabianUntermoser requested a review from jomunker June 7, 2024 09:06

Fabian Untermoser and others added 15 commits June 7, 2024 18:07

fix(ci): use correct branch name

9bc853d

fix(ci): update github env secret names

2b33be8

feat(ci): test remote ssh command

084017c

refactor(ci): rename dev docker compose file to docker-compose.local.yml

95445a0

feat(ci): add dev docker compose file

6a6c5e7

feat(ci): try to login to ghcrio container reg remotely

cf94b8e

fix(ci): change secret var name

1c91a68

feat(ci): pull latest docker images remotely

4db0569

feat(ci): deploy container images on remote vm

68338b7

- prepare & copy .env file to server - pull and start container images

fix(ci): fix remote working dir

e7b8f36

feat(ci): stop remote script execution on failure

9f81225

fix(ci): fix remote cd cmd

c2d8807

fix(ci): remove redundant docker .env file references

bd8b280

refactor(ci): ensure container startup

42b6d1c

- pull,stop,start all containers - show docker logs

fix(ci): use non-standard db port

af8367b

FabianUntermoser changed the title ~~CI: VM Deployment~~ CI: Deploy Docker Images on remote VM Jun 10, 2024

Fabian Untermoser and others added 10 commits June 10, 2024 17:40

fix(compose): use DATABASE_PORT variable

584ce3b

ensure configuring DATABASE_PORT in the .env file will reflect in the db port being changed as well as other services using the correct port

refactor(ci): update action name

56955ee

feat(ci): deploy based on file changes

fb8f31b

refactor(ci): ensure containers are recreated upon deployment

3307b03

feat(ci): remove build context from web

3e31425

feat(ci): remove unnecessary volumes

185f481

feat(ci): adjust cms secrets

1d4bf1a

feat(ci): update .env.example

3bcf533

feat(ci): scp database files to VM

6169d1c

fix(ci): web crashing because auth secret was missing in production mode

a00d5ac

jomunker and others added 17 commits June 17, 2024 10:48

feat(cms): hardcode url

54b932c

fix(cms): avoid setting strapi url on NODE_ENV=development

9dda23c

refactor: remove unnecessary compose version

446cd91

[skip ci]

feat(cms): set CMS_URL at buildtime

dbccfe4

- add Dockerfile arg - set arg in github action through secret

fix(cms): ensure CMS_URL env var is used

4ec94f5

feat(ci): print CMS_URL in CMS prod build

d29c1b8

fix(ci): convert CMS_URL to env var instead of secret

5d8123b

test(ci): print env var

4fd62ae

fix(ci): access CMS_URL as repo var

0ae9db7

feat(ci): run deployment after images were pushed

a0c742a

feat(ci): allow manual run of deploy

a5f177a

refactor(ci): remove workflow_dispatch

70711b2

refactor(ci): clean up log statement

3b6dc13

refactor(ci): remove branch rule on workflow_run

2682903

feat(ci): deploy on dev branches

279599e

refactor(ci): avoid quotes in workflow_run

df5d60e

refactor(ci): remove temporary branch rules

adbbcb9

jomunker force-pushed the feature/deployment-vm branch from f4675a8 to adbbcb9 Compare June 17, 2024 08:48

chore(ci): add nginx configuration files

37065a2

jomunker reviewed Jun 17, 2024

View reviewed changes

FabianUntermoser force-pushed the feature/deployment-vm branch from d6c46ec to 5c7f0df Compare June 18, 2024 00:40

FabianUntermoser and others added 4 commits June 18, 2024 09:58

feat(build): change NODE_ENV=development

fa07b97

Co-authored-by: Johannes Munker <56400587+jomunker@users.noreply.github.com>

refactor(build): remove CMS_URL env var not needed at runtime

0886094

CMS_URL var configures the context path for the STRAPI CMS backend. It is required at build time in order to make STRAPI internal routes work. It is not needed in local development, as there no contextpath is required.

feat(ci): run actions for 'feature/*' branches

6b30221

feat(ci): add temporary deploy rule

520ab92

FabianUntermoser force-pushed the feature/deployment-vm branch from c63e5f7 to 520ab92 Compare June 18, 2024 00:58

refactor(ci): remove temporary deployment rules

5b7df30

jomunker approved these changes Jun 18, 2024

View reviewed changes

jomunker merged commit e95af58 into development Jun 20, 2024
3 checks passed

jomunker deleted the feature/deployment-vm branch June 20, 2024 20:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CI: Deploy Docker Images on remote VM #31

CI: Deploy Docker Images on remote VM #31

FabianUntermoser commented Jun 7, 2024 •

edited

Loading

CI: Deploy Docker Images on remote VM #31

CI: Deploy Docker Images on remote VM #31

Conversation

FabianUntermoser commented Jun 7, 2024 • edited Loading

Description

What type of PR is this? (check all applicable)

FabianUntermoser commented Jun 7, 2024 •

edited

Loading