Move static files into files/ and Jinja2 templates into templates/ #169

samsapti · 2023-07-09T18:31:55Z

samsapti commented

2023-07-09 18:31:55 +00:00

I've moved files around so that they are in the correct folders, and so that it makes more sense (to me at least :D).

This is how it looks now:

files
├── element
│  └── riot.im.conf
├── mastodon
│  └── postgresql.conf
├── matrix
│  └── log.config
├── privatebin
│  └── conf.php
├── sso
│  └── sso.data.coop.pem
└── vhost
   ├── base_domain
   ├── docker_registry
   ├── element
   ├── mastodon
   ├── matrix
   ├── nextcloud
   └── www.base_domain
templates
├── element
│  └── config.json.j2
├── mailu
│  └── env.j2
├── mastodon
│  └── env.j2
├── matrix
│  └── homeserver.yaml.j2
├── rallly
│  └── env.j2
└── restic
   ├── ssh.config.j2
   └── ssh.known_hosts.j2

What do you think?

I've moved files around so that they are in the correct folders, and so that it makes more sense (to me at least :D). This is how it looks now: ```txt files ├── element │ └── riot.im.conf ├── mastodon │ └── postgresql.conf ├── matrix │ └── log.config ├── privatebin │ └── conf.php ├── sso │ └── sso.data.coop.pem └── vhost ├── base_domain ├── docker_registry ├── element ├── mastodon ├── matrix ├── nextcloud └── www.base_domain templates ├── element │ └── config.json.j2 ├── mailu │ └── env.j2 ├── mastodon │ └── env.j2 ├── matrix │ └── homeserver.yaml.j2 ├── rallly │ └── env.j2 └── restic ├── ssh.config.j2 └── ssh.known_hosts.j2 ``` What do you think?

samsapti added the

Refactor

label 2023-07-09 18:31:55 +00:00

samsapti added 2 commits 2023-07-09 18:31:55 +00:00

Don't put unnecessary executables in git c5857d0ba8

Move files to their correct directories (files in files, Jinja2 templates in templates) 863b285b07

valberg reviewed 2023-07-09 18:38:52 +00:00

roles/docker/tasks/services/byro.yml Outdated

					
				@ -20,2 +19,3 @@

				- name: Run byro

				  docker_compose:

				    project_name: "byro member system"

				    project_name: byro_member_system"

valberg commented

2023-07-09 18:38:52 +00:00

will this not break the deployment by creating a new stack with a new name?

samsapti commented

2023-07-09 18:42:55 +00:00

It will, so we will need to take down the old containers first. However, I think it's better to have a project_name without spaces, as the containers are actually named byromembersystem_... if spaces are in the name. Naming with underscores better reflects what the container names will be.

It will, so we will need to take down the old containers first. However, I think it's better to have a `project_name` without spaces, as the containers are actually named `byromembersystem_...` if spaces are in the name. Naming with underscores better reflects what the container names will be.

valberg commented

2023-07-09 18:46:42 +00:00

if you want to do the work it's fine by me - I can live with the non-underscore name ;)

samsapti commented

2023-07-09 19:13:26 +00:00

I can't XD

I'll do the work, no problem!

I can't XD I'll do the work, no problem!

samsapti marked this conversation as resolved

samsapti added 1 commit 2023-07-09 18:39:13 +00:00

Fix quote ef7c00b748

valberg reviewed 2023-07-09 18:42:19 +00:00

roles/docker/tasks/services/docker_registry.yml Outdated

					
				@ -4,3 +4,2 @@

				  copy:

				    src: "files/configs/docker_registry/nginx.conf"

				    dest: "/docker-volumes/nginx/vhost/{{ services.docker_registry.domain }}"

				    src: vhost/docker

valberg commented

2023-07-09 18:42:19 +00:00

can we call this file docker_registry?

samsapti commented

2023-07-09 18:45:15 +00:00

My (undocumented) naming convention here is actually the subdomain the service is hosted on, so the docker registry's domain is docker.data.coop and the vhost file is docker (without .data.coop). But if you insist I can change it.

My (undocumented) naming convention here is actually the subdomain the service is hosted on, so the docker registry's domain is `docker.data.coop` and the vhost file is `docker` (without `.data.coop`). But if you insist I can change it.

valberg commented

2023-07-09 18:47:43 +00:00

can we have the full domain name as the name of the file then? the same with the other comments

samsapti commented

2023-07-09 18:49:23 +00:00

Then I would rather use the service name instead, just for the sake of avoiding code duplication (not hardcoding the base domain). What do you think?

valberg commented

2023-07-09 19:03:59 +00:00

ah yes very good point! let's use the name of the service and not anything related to the domain name

👍 1

samsapti marked this conversation as resolved

valberg reviewed 2023-07-09 18:45:39 +00:00

roles/docker/tasks/services/mastodon.yml Outdated

					
				@ -23,2 +23,2 @@

				  template:

				    src: files/configs/mastodon/vhost-mastodon

				  copy:

				    src: vhost/social

valberg commented

2023-07-09 18:45:37 +00:00

can we call this file mastodon ?

valberg marked this conversation as resolved

roles/docker/tasks/services/nextcloud.yml Outdated

					
				@ -4,2 +4,2 @@

				  template:

				    src: files/configs/nextcloud/vhost

				  copy:

				    src: vhost/cloud

valberg commented

2023-07-09 18:45:02 +00:00

can we call this file nextcloud ?

valberg marked this conversation as resolved

samsapti added 1 commit 2023-07-09 19:08:54 +00:00

Use service names instead of subdomains for vhost file names f6061e1b5e

samsapti force-pushed move_stuff_around from f6061e1b5e to 7d13fc5302

2023-07-09 21:07:35 +00:00

Compare

benjaoming commented

2023-07-14 21:09:05 +00:00

@samsapti what's the reason that there are subfolders for each service in files/ but not in templates/?

(I like the idea of consistently having subfolders for each service, it scales better and the pattern is easier to enforce when it's simple to understand)

@samsapti what's the reason that there are subfolders for each service in `files/` but not in `templates/`? (I like the idea of consistently having subfolders for each service, it scales better and the pattern is easier to enforce when it's simple to understand)

👍 1

samsapti commented

2023-07-18 16:31:34 +00:00

@samsapti what's the reason that there are subfolders for each service in files/ but not in templates/?

Ansible doesn't support it when it comes to referencing the files from a task. If you have subfolders in templates/, you need to reference it as templates/path/to/file.j2 instead of path/to/file.j2 in a template task. This is not the case with files/ in the copy task, subfolders work without the files/ prefix in file paths.

(I haven't actually verified this myself, that's just what I've seen online.)

> @samsapti what's the reason that there are subfolders for each service in `files/` but not in `templates/`? Ansible doesn't support it when it comes to referencing the files from a task. If you have subfolders in `templates/`, you need to reference it as `templates/path/to/file.j2` instead of `path/to/file.j2` in a `template` task. This is not the case with `files/` in the `copy` task, subfolders work without the `files/` prefix in file paths. (I haven't actually verified this myself, that's just what I've seen online.)

samsapti added 1 commit 2023-07-20 16:10:01 +00:00

Merge branch 'main' into move_stuff_around f9946e72ca

valberg commented

2023-07-21 07:14:38 +00:00

@samsapti what's the reason that there are subfolders for each service in files/ but not in templates/?

Ansible doesn't support it when it comes to referencing the files from a task. If you have subfolders in templates/, you need to reference it as templates/path/to/file.j2 instead of path/to/file.j2 in a template task. This is not the case with files/ in the copy task, subfolders work without the files/ prefix in file paths.

(I haven't actually verified this myself, that's just what I've seen online.)

I just tested:

- name: test template
  template:
    src: testdir/test.j2
    dest: /tmp/test
    mode: 0644
  vars:
    foo: "bar"

with the template in docker/templates/testdir/test.j2 works as expected :)

So, I also think we should namespace templates. @samsapti when that is done you have an approve from me :)

> > @samsapti what's the reason that there are subfolders for each service in `files/` but not in `templates/`? > > Ansible doesn't support it when it comes to referencing the files from a task. If you have subfolders in `templates/`, you need to reference it as `templates/path/to/file.j2` instead of `path/to/file.j2` in a `template` task. This is not the case with `files/` in the `copy` task, subfolders work without the `files/` prefix in file paths. > > (I haven't actually verified this myself, that's just what I've seen online.) I just tested: ```yaml - name: test template template: src: testdir/test.j2 dest: /tmp/test mode: 0644 vars: foo: "bar" ``` with the template in `docker/templates/testdir/test.j2` works as expected :) So, I also think we should namespace templates. @samsapti when that is done you have an approve from me :)

👍 1

samsapti added 1 commit 2023-08-05 17:36:05 +00:00

Use subfolders for templates as well 4e6f18311d

samsapti added 1 commit 2023-09-29 21:04:45 +00:00

Merge branch 'main' into move_stuff_around 656fb6baab