chore: Add Readme
This commit is contained in:
parent
c8c4c8355b
commit
e16de615d0
1 changed files with 46 additions and 1 deletions
47
README.md
47
README.md
|
|
@ -1,2 +1,47 @@
|
||||||
# infrastructure
|
# Hobbyrack Infrastructure
|
||||||
|
|
||||||
|
This repository contains the infrastructure-as-code configuration for managing Wheatley, a homelab environment within Hobbyrack. The current focus is on deploying a Kubernetes clusters with Talos and Cilium on Proxmox VE using OpenTofu.
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- **modules/**: Contains reusable modules for cluster bootstrap and node provisioning.
|
||||||
|
- **talos-bootstrap/**: Bootstraps the Talos cluster, including templates for machine configuration and Cilium installation.
|
||||||
|
- **talos-node/**: Provisions individual Talos node VMs on Proxmox.
|
||||||
|
- **pve01.wheatley.in/**: Configuration specific to the Proxmox VE host `pve01.wheatley.in`.
|
||||||
|
- **k8s-wheatley/**: Provisions the `k8s-wheatley` Kubernetes cluster.
|
||||||
|
- **templates/**: Provisions VM templates on the PVE host.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- [OpenTofu](https://opentofu.org/) >= 1.0
|
||||||
|
- Access to a Proxmox VE environment
|
||||||
|
- (Optional) talosctl for managing Talos nodes
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
1. **Initialize OpenTofu**
|
||||||
|
```sh
|
||||||
|
tofu init
|
||||||
|
```
|
||||||
|
2. **Review the execution plan**
|
||||||
|
```sh
|
||||||
|
tofu plan
|
||||||
|
```
|
||||||
|
3. **Apply the infrastructure**
|
||||||
|
```sh
|
||||||
|
tofu apply
|
||||||
|
```
|
||||||
|
|
||||||
|
> Adjust variables in `variables.tf` or provide a `terraform.tfvars` file for your environment.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This repository is licensed under the MIT License. See the `LICENSE` file for details.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
For questions or support, open an issue or contact via GitHub.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue