bij1
/
terraform-config
19
0
Fork 0
Code Issues 5 Pull Requests Projects Releases Wiki Activity

Initial configuration 

* Added [GitLab Managed Terraform State](https://docs.gitlab.com/ee/user/infrastructure/iac/terraform_state.html) as a backend
* Configured basic CI/CD for Terraform
* Prepared configuration for GreenHost
This commit is contained in:
Joey den Broeder 2022-01-10 13:53:20 +01:00
parent 1d2bba5bb8
commit 8bc8ccdbc0
9 changed files with 128 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
.gitignore vendored Normal file
View File

@ -0,0 +1,17 @@
# Local .terraform directories
**/.terraform/*
# .tfstate files
*.tfstate
*.tfstate.*
# Crash log files
crash.log
crash.*.log
# Ignore CLI configuration files
.terraformrc
terraform.rc
# Ignore local backend.tfvars
backend.tfvars

53
.gitlab-ci.yml Normal file
View File

@ -0,0 +1,53 @@
image: registry.gitlab.com/gitlab-org/terraform-images/stable:latest
variables:
TF_ROOT: ${CI_PROJECT_DIR}/environments/example/production
TF_ADDRESS: ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/terraform/state/bij1
cache:
key: bij1
paths:
- ${TF_ROOT}/.terraform
before_script:
- cd ${TF_ROOT}
stages:
- prepare
- validate
- build
- deploy
init:
stage: prepare
script:
- gitlab-terraform init
validate:
stage: validate
script:
- gitlab-terraform validate
plan:
stage: build
script:
- gitlab-terraform plan
- gitlab-terraform plan-json
artifacts:
name: plan
paths:
- ${TF_ROOT}/plan.cache
reports:
terraform: ${TF_ROOT}/plan.json
apply:
stage: deploy
environment:
name: production
script:
- gitlab-terraform apply
dependencies:
- plan
when: manual
only:
- master

105
README.md
View File

@ -1,93 +1,46 @@
# terraform
Contains Terraform code used to manage our infrastructure.
## Prerequisites
## Getting started
### Pre-commit hook
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
We want all our Terraform code to be well formatted and adhering to standards,
enforced by `terraform fmt`. Thus there is a pre-commit hook available to
validate this. Unfortunately this cannot be enforced remotely, so there is a
_one time_ manual step needed.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
Run the following command right after cloning the repository:
## Add your files
- [ ] [Create](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.com/bij1/intranet/terraform.git
git branch -M main
git push -uf origin main
```sh
./install_precommit_hook.sh
```
## Integrate with your tools
This will make sure you have the pre-commit hook installed so there is less of
a chance you push something that doesn't match our standards.
- [ ] [Set up project integrations](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://gitlab.com/bij1/intranet/terraform/-/settings/integrations)
### Terraform
## Collaborate with your team
As we're using GitLab's Terraform image for our CI/CD pipeline, we'll stick to
using the latest version of Terraform. Instruction on how to install Terraform
can be found here: <https://www.terraform.io/downloads>
- [ ] [Invite team members and collaborators](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Code-styling
## Test and Deploy
We try to adhere to the
[naming conventions](https://www.terraform-best-practices.com/naming) and
[code-styling](https://www.terraform-best-practices.com/code-styling) best
practices defined at [Terraform best practices](https://www.terraform-best-practices.com/).
Use the built-in continuous integration in GitLab.
## Secrets
- [ ] [Get started with GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://gitlab.com/-/experiment/new_project_readme_content:94e5513cabcd878cbd45fa3cbbbb2b9f?https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
Two steps:
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
1. Create a variable in `variables.tf` with `sensitive = true`, to prevent it
from appearing in the build output.
2. Add the desired variable to the
[Environment Variables](https://www.terraform.io/language/values/variables#environment-variables).
We may want to look at something like
[git-crypt](https://github.com/AGWA/git-crypt) or a central password store.

3
install_precommit_hook.sh Normal file
View File

@ -0,0 +1,3 @@
#!/usr/bin/env bash
cp precommit.sh .git/hooks/pre-commit

4
lint.sh Normal file
View File

@ -0,0 +1,4 @@
#!/usr/bin/env bash
set -e
terraform fmt -recursive -check -diff

11
main.tf Normal file
View File

@ -0,0 +1,11 @@
terraform {
backend "http" {}
required_providers {
digitalocean = {
source = "digitalocean/digitalocean"
version = "~> 2.0"
}
}
}
provider "digitalocean" {}

0
outputs.tf Normal file
View File

11
precommit.sh Normal file
View File

@ -0,0 +1,11 @@
#!/usr/bin/env bash
echo "Checking if pre-commit hook is up to date"
diff precommit.sh .git/hooks/pre-commit
if [[ $? != 0 ]]
then
echo "Pre-commit hook is not up to date, please run ./install_precommit_hook.sh and commit again!"
exit 1
fi
echo "${GIT_DIR}"
./lint.sh

0
variables.tf Normal file
View File