bastian/deploy_home
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added README and LICENSE files

Browse Source
This commit is contained in:
Bastian de Byl
2020-09-25 12:04:21 -04:00
parent 3b4ad7c45c
commit d6c973fa0f
2 changed files with 54 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
LICENSE Normal file
View File

@@ -0,0 +1,22 @@
MIT License
Copyright (c) 2020 bdebyl
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

32
README.md Normal file
View File

@@ -0,0 +1,32 @@
# Deploy Home
There's no place like home!
Just as Dorothy managed the simple task of clicking her heels together, the
desire for an equally simple one-button push deployment was in my heart. Thus,
this repository was made.
## Ansible
Ansible, along with double-encrypted secrets, deploys the necessary
configurations to make the home fit for certain needs and desires. Namely,
having access to my home from anywhere, securely, and a self-hosted CI server
that easily ties into existing workflows.
## Makefile
The makefile is primarily used as a wrapper script to ensure that necessary
files, such as the secret vault password file, are provisioned as part of this.
One such addition to the task is utilizing dependency pinning through the
utilization of Python's `virtualenv` to lock down the specific dependency
versions within the `requirements.txt` file. This, ideally, prevents any
deployment issues with dependency version woes (_e.g. version conflicts, major
updates in newest versions, etc._)
| Target Name | Description |
|-------------|--------------------------------------------------------------------------------------|
| `lint` | (default) Runs `yamllint` and `ansible-lint` on *all* YAML files in `ansible/` |
| `deploy` | Deploys everything, or only tasks specified in `TAGS=` environment variable |
| `check` | Runs `deploy` in a "dry-run", showing diff-style outputs on tasks indicating changes |
| `vault` | Opens the Ansible vault file for editing |