https://github.com/onebeyond/org-infra-template
https://github.com/onebeyond/org-infra-template
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/onebeyond/org-infra-template
- Owner: onebeyond
- License: gpl-3.0
- Created: 2024-01-11T15:14:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-11T17:09:42.000Z (over 2 years ago)
- Last Synced: 2025-04-08T18:49:58.310Z (about 1 year ago)
- Language: HCL
- Size: 24.4 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# org-infra
:warning: Important notice! :warning:
Make sure to contribute this docs before doing it on your repo based on these.
That's something you should keep in mind in case you want to still receive updates from this template on your project.
Same for new variables or resources added by you lately. For example, if you are missing a resource that this template does not currently provide, let's say `repositories/templates/github_dependabot_secret.tf` don't add that to your project directly. Make sure to follow the How to Contribute guide for creating a **Pull Request** including your changes for being reflected on this template before.
In that way, you are always gonna be able to benefit from the updates of this template.
## Terraform state
Terraform states are stored in a backend remotely in an AWS S3 bucket. This bucket must be a non-public one, encrypted and have versioning enabled to prevent data loss.
Feel free to edit the file located at `backend.tf`. That one contains the configuration where you would be able to configure where you desire to store the remote state. Hopefully, a public list of official backends has been published for choosing the one that fits better our needs.
## Configuration
In case our organization does not fit the configuration we should update that value in the section: `main.tf > provider > github > owner`
**Managing teams** it's an easy task. The file is located at `teams/main.tf` and is the one that would contain a module per each team that has been added. The provided example `team-admins`.
The other file you would need to modify for sure is `repositories/main.tf`. That contains a module for each repository managed by our Github provider. The full list of parameters to be configured for each repository can be found at `repositories/templates/variables.tf`. Reviewing this file is crucial after importing an already existing repository since the parameters would need to be adjusted to avoid any different configuration if that's not our intention.
## Requirements
You need to have Terraform >= 1.6 installed on your machine. You can download it from [here](https://www.terraform.io/downloads.html).
It's strongly recommended to use tfenv for running the required **Terraform** version. By having created the file `.terraform-version` this tool would set up the required runtime version immediately.
## Testing locally
You can test the Terraform code locally by running the following commands (you need a valid GitHub token):
```bash
terraform init
terraform plan
```
Since running a plan over all the project resource types may be something slow is strongly recommended to run a plan for your specific desired module.
For running a plan over `module.repositories` a command is available:
```bash
make plan-module-repositories
```
## Importing a repository
For importing an already existent repository we would need to define a module for it first. That one must be created at `repositories/main.tf` with the desired name.
In our case, we are trying to import a repository named `org-infra`, so the first step is to create the module for importing the existing resources onto the new state module.
```tcl
module "org-infra" {
source = "./templates"
github_repository = {
name = "org-infra"
visibility = "public"
}
github_teams_repository = [{
team_id = var.teams-name.team-admins
permission = "admin"
}]
github_repository_topics = ["github"]
}
```
```bash
terraform import module.repositories.module.org-infra.github_repository.repo org-infra
terraform import module.repositories.module.org-infra.github_branch_protection.main org-infra:master
```