Before using this collection, you need to install it with the Ansible Galaxy command-line tool:
ansible-galaxy collection install linkorb.polaris
You can also include it in a requirements.yml
file and install it with ansible-galaxy collection install -r requirements.yml
, using the format:
---
collections:
- name: linkorb.polaris
When importing a playbook from the Polaris collection you need to pass along as a variable the
polaris
dictionary, which can have the following value properties set:
- ansible.builtin.import_playbook: linkorb.polaris.layers
vars:
# All optional variables are commented
polaris:
#admins_active: # create users
# - username: alice
# fullname: Alice
# pubkey: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBZl3lQTRGhD5mdGgFEVuX+CAnTMz9MuY+f4vE2cqk9G alice@host
#admins_removed: # remove users
# - bob
#docker_users: # Sudo-less docker usage
# - alice
docker_swarm_advertise_address: secret
docker_registry_login: alice
docker_registry_pat: secret
#tailscale_args:
#traefik_tls_files:
# - certFile: /path/to/sops/encrypted/cert
# keyFile: /path/to/sops/encrypted/key
# domain: example.com
#traefik_log_level: DEBUG
Refer to the schema for further details.
We welcome contributions to make this repository even better. Whether it's fixing a bug, adding a feature, or improving documentation, your help is highly appreciated. To get started, fork this repository then clone your fork.
Be sure to familiarize yourself with LinkORB's Contribution Guidelines for our standards around commits, branches, and pull requests, as well as our code of conduct before submitting any changes.
If you are unable to implement changes you like yourself, don't hesitate to open a new issue report so that we or others may take care of it.
Check out our other projects at linkorb.com/engineering.
By the way, we're hiring!