aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 31e274c03b03f557a963300bb2e71365cfb11035 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# Infra

This repository contains the infrastructure configuration for Python Discord, the file structure is shown below, with well known files omitted for brevity:

[//]: <> (This structure is generated using https://tree.nathanfriend.io/.)
```
.github/
└── workflows/                           # GitHub Actions Workflows for CI
ansible/
├── host_vars/                           # Host specific Ansible variables
├── inventory/                           # Ansible Inventory files
├── local_testing/                       # Vagrant configuration to test Ansible playbook locally using VMs
├── roles/                               # Directory containing all Ansible roles
├── .ansible-lint                        # Configuration for ansible lint
├── ansible.cfg                          # Ansible Configurartion file
└── playbook.yml                         # Root playbook pulling all roles together
dns/
├── zones/                               # Zone configuration for each supported DNS Zone
└── production.yaml                      # Configuration for OctoDNS planning and deployment
docs/
└── meeting_notes/                       # Minutes for previous devops meetings
kubernetes/
├── cluster-wide-secrets/                # Kubernetes secrets shared by multiple pods across namespaces
├── namespaces/                          # Kubernetes manifests, separated by namespace
└── scripts/                             # Scripts used to lint manifests in CI
.pre-commit-config.yaml                  # pre-commit configuration
server_bootstrap.sh                      # A bash script used to init our bare metal servers
```

## Documentation

Infrastructure-related documentation ("the big picture"), can be found in [`docs/`](./docs/).

Many folders have a `README.md` file within them, which have more detailed explanations on what
that folder, and the files within, is used for.

## Linting

To lint everything with `pre-commit` locally, run the command

```sh
$ uv run task lint
```

Any trivial errors (formatting, minor linting problems) will automatically be fixed.