Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/claranet/terraform-datadog-scripts
Scripts used for datadog terraform modules for CI and compliant purpose.
https://github.com/claranet/terraform-datadog-scripts
claranet datadog monitoring terraform
Last synced: about 7 hours ago
JSON representation
Scripts used for datadog terraform modules for CI and compliant purpose.
- Host: GitHub
- URL: https://github.com/claranet/terraform-datadog-scripts
- Owner: claranet
- Created: 2019-10-18T12:28:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-28T17:11:33.000Z (2 months ago)
- Last Synced: 2024-08-28T18:57:33.538Z (2 months ago)
- Topics: claranet, datadog, monitoring, terraform
- Language: Shell
- Homepage:
- Size: 30.3 KB
- Stars: 6
- Watchers: 30
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.sh
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Datadog scripts
## Summary
This repository contains a `scripts` directory where there are multiple scripts helping to different things:
- help and automate for some boring and repetitive tasks.
- keep everything up to date and warn if you forget.
- compliant checks and ensure best practices are respected.
- code validation for continuous integration.
## Structure
There are two kinds of scripts naming:
- `[0-9][0-9]_script_name.sh`: will be automatically run by `auto_update.sh` wrapper.
- `script_name.sh`: should be run manually.
Here is a list of scripts and their purpose:
- `auto_update.sh`: is the most important and the one the must used. It is a simple wrapper which will calls every other `[0-9][0-9]*` scripts.
- It should be run by contributor after every change.
- The CI will also run it and it will fail if it detects any change compared to commit.
- "Children" scripts could be run individually if you know exactly what you need to update after a change.
- This script all "children" scripts takes one optional parameter to limit execution to a specific sub path. Else this will run on all directories.
- `00_requirements.sh`: check some requirements like `terraform` command exists before run other scripts.
- `10_update_output.sh`: will generate and update all `outputs.tf`.
- `20_update_global_readme.sh`: will update the main `README.md` file and generate the list of all modules browsing the repository.
- `20_update_modules_readmes.sh`: will create and update `README.md` for each module. It will save all manual changes below `## Related documentation` section.
- `30_update_module.sh`: will create `modules.tf` file per module when does not exist.
- `90_best_practices.sh`: will check compliance and best practices respect.
- `99_terraform.sh`: terraform CI (init & validate only while auto apply is done in another pipeline).
- `utils.sh`: contains useful functions common to multiple scripts. It is not attended to be run.
- `changelog.sh`: helper script to release a new version.
- generate and update `CHANGELOG.md` file from git history.
- filter to list only "done" issues from JIRA.
- close all issues on JIRA.
- fix version for all issues on JIRA.
- create release for current version on JIRA.
## Usage
First, you need to retrieve `scripts` repository by cloning submodules:
```
git submodule update --init
```
After any change on this repo, you will need to run the `./scripts/auto_update.sh [PATH_TO_MODULE]` command to make sure all is up to date otherwise the CI pipeline will fail.
The parameter is optional and it will limit the scripts execution on a specific path on the repository.
On linux system it is possible to run the script directly while `terraform`, `terraform-docs`, `terraform-config-inspect`, `jq` commands are available in your `PATH`.
Otherwise you can use [the same docker image as the CI](https://hub.docker.com/r/claranet/terraform-ci) on every other platforms.
```
# if you already pulled the container once, you will need to update it
$ docker pull claranet/terraform-ci
# then just need to run the script of your choice with optional path parameter or not
$ docker run --rm -v "$PWD:/work" claranet/terraform-ci /work/scripts/auto_update.sh
# else if you run docker in version >= 19.09 (or nightly builds) so you can do it both in one command
$ docker run --pull=always --rm -v "$PWD:/work" claranet/terraform-ci /work/scripts/auto_update.sh
# it is also possible to run the scripts in debug in case of silent fail
$ docker run -e GITLAB_CI=true --rm -v "$PWD:/work" claranet/terraform-ci /work/scripts/auto_update.sh
```