Add agent notes, coding standards, and the issue tracker
This commit is contained in:
1 parent
4ddeba5402
commit
a9ac51bd43
4 files changed
+142
-8
No files matched your search
@@ -13,14 +13,12 @@ _\*the Initial Server Setup should be your starting point for fresh servers._
|
||||
|
||||
## Playbook Structure
|
||||
|
||||
The playbooks contained in this repository were created for educational purposes, and should serve as a base for you to create your own playbooks and roles.
|
||||
Each service gets its own directory. A single-container service uses the flat layout below. A service with more than one container, unit, or stateful volume uses `roles/`. [CODING_STANDARDS.md](CODING_STANDARDS.md) states the rule and the naming conventions.
|
||||
|
||||
Although we opt to not use roles, our playbooks follow a distinctive structure to facilitate reuse while keeping them mostly self-contained and straightforward.
|
||||
|
||||
For instance, this is how the `lemp` playbook is structured:
|
||||
For instance, this is the flat layout:
|
||||
|
||||
```
|
||||
lemp_ubuntu1804
|
||||
service
|
||||
├── files
|
||||
│ ├── info.php.j2
|
||||
│ └── nginx.conf.j2
|
||||
@@ -31,10 +29,10 @@ lemp_ubuntu1804
|
||||
```
|
||||
|
||||
|
||||
- `files/`: directory containing templates and other files required by the playbook.
|
||||
- `vars/`: directory to save variable files. A `default.yml` var file is included by default.
|
||||
- `files/`: templates and static files the playbook copies or templates.
|
||||
- `vars/`: variable files. `default.yml` holds the values the operator sets.
|
||||
- `playbook.yml`: the playbook file.
|
||||
- `readme.md`: instructions and links related to this playbook.
|
||||
- `readme.md`: what the playbook deploys, the variables to set, and the command to run it.
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
||||
Reference in new issue
Block a user