Skip to content

docs: document pi-manager-X sister repo with templates#44

Open
MateoLostanlen wants to merge 3 commits into
mainfrom
docs/sister-repo-templates
Open

docs: document pi-manager-X sister repo with templates#44
MateoLostanlen wants to merge 3 commits into
mainfrom
docs/sister-repo-templates

Conversation

@MateoLostanlen

Copy link
Copy Markdown
Member

The sister repo holding inventory and secrets is private, so this repo had no visible record of what it must contain. Adding worked examples and a Readme section so a new operator can stand up a pi-manager-X from scratch.

  • Adds host_vars/template/{engine,pi_zero,alert_server,annotation_server}/ and fills the missing group_vars/template/{envdev,envprod,pi_zero,...} files. vars.vault.yml files ship as plain YAML with CHANGE_ME placeholders; an in-file header reminds to ansible-vault encrypt before commit.
  • Re-scopes the host_vars/group_vars ignore patterns in .gitignore so the new template/ subdirs are trackable (the previous host_vars/ rule excluded the directory entirely, making any ! exception inert).
  • Adds a Readme section describing the sister repo's expected tree and the make prepare copy paths, and noting that .vault_passwrd / id_rsa are referenced in place via .env rather than copied.

Scope the host_vars and group_vars ignore patterns so the template
subdirs can be tracked, and add worked examples covering every file
the private pi-manager-X sister repo is expected to provide.

vars.vault.yml templates ship as plain YAML with CHANGE_ME
placeholders so the expected keys are visible; the in-file header
reminds to ansible-vault encrypt them before commit.
Add a 'sister repo' section showing the expected tree, point readers
to the inventory/group_vars/host_vars templates, and explain the
ansible-vault encrypt workflow before commit.
- Use wifi_connections in templates (the only shape consumed by
  the wifi role); drop the unused wifi_ssid/wifi_password pattern.
- Drop dockerhub_username from the vault template (username is
  hardcoded to pyronear in roles/servers/tasks/main.yml).
- Replace mediamtx_server_ip: 0.0.0.0 with a CHANGE_ME placeholder.
- Readme: clarify that prepare only copies inventory/host_vars/
  group_vars; .vault_passwrd and id_rsa are referenced in place
  via VAULT_PASSWORD_FILE/SSH_PRIVATE_KEY_FILE in .env.

@fe51 fe51 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Matéo, thanks for the PR, a good idea. We will need to keep it up to date now :)

Just a question before accepting your changes, see comment.

S3_REGION: gra

# Public hostnames served by the platform-react server.
platform_react_url_backend: https://alertapi.pyronear.org

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are those url wanted to be exposed ? ( same comment elsewhere whenever they're present)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants