33 lines
2.3 KiB
Markdown
33 lines
2.3 KiB
Markdown
This project will discover and provide inventory intelligence to Sora, Shadowfeed, Geth, and Sharingan. It is named after the fictional Star Wars Imperial Intelligence organization that oversaw the various divisions of Intelligence and orchestrated their operations.
|
|
|
|
*Note*: This project is in progress -- former Makefiles from [ConfigPackages](/AniNIX/ConfigPackages) are being upgraded into Ansible playbooks here.
|
|
|
|
# How to use
|
|
|
|
This project expects that you use an Ansible vault for credentials. Create one and add this to your `.bashrc`.
|
|
```
|
|
export ANSIBLE_VAULT_PASSWORD_FILE=$HOME/password-store/${organization}.vault.password
|
|
export ANSIBLE_VAULT_FILE=$HOME/password-store/${organization}.vault
|
|
```
|
|
|
|
Take a look at `examples/msn0.yml` as an example inventory -- make sure you populate one of your own.
|
|
|
|
Once you have your vault and inventory, use [AniNIX/ShadowArch](/AniNIX/ShadowArch) with your hypervisor to provision the base image for your machines, or [Raspbian](https://www.raspberrypi.org/).
|
|
|
|
Then, use the SSHkey playbook to copy your key and the deploy playbook to set things up.
|
|
```
|
|
ansible-playbook -i your-inventory.yml playbooks/sshkey.yml
|
|
ansible-playbook -i your-inventory.yml playbooks/deploy.yml
|
|
```
|
|
|
|
We've also added two scripts in `./bin` to make your life easier:
|
|
* `full-deploy`: This is the general role. If you are creating an AniNIX replica, once you have your inventory and vault populated, then you can run this script to push everything. This is also optimal when rotating vault secrets or other global tasks. This is effectively standardizing invocation of our overall deployment playbook.
|
|
* `deploy-role`: When you are updating a specific role, use this script to push that role to your group. Ideally, this should only be used to push a role that you have been working on to a target group in your inventory that's already tagged for the role in the deployment playbook.
|
|
|
|
Happy hacking!
|
|
|
|
# Exceptions
|
|
|
|
Some services, such as AniNIX/Sharingan and AniNIX/Geth, store their configuration in internal datastructures and databases such that we cannot easily export our build for others to use. We will document what we have done for each of these as best we can in the README.md files for others to replicate. Backups of these services into AniNIX/Aether are therefore dumps of these databases and not available to share.
|
|
|