MON-519 update docs to make this public
This commit is contained in:
Quentin Manfroi
parent
a5dcbf02ce
commit
6249907b3b
103
CONTRIBUTING.md
Normal file
103
CONTRIBUTING.md
Normal file
@ -0,0 +1,103 @@
|
||||
# Contributing
|
||||
|
||||
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||||
email, or any other method with the owners of this repository before making a change.
|
||||
|
||||
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
||||
|
||||
## Considerations
|
||||
|
||||
* If you have required permissions, you can create a branch from master else you can fork this repo to be able to submit a Pull Request.
|
||||
|
||||
* [The changelog](../CHANGELOG.md) is generated using issues IDs (Jira & Github) detected in commit messages which must follow `#GithubID My commit message` form.
|
||||
|
||||
* If you would like to work on monitors you must follow our [templating best practices](../TEMPLATING.md) to make this base homogenous and generic.
|
||||
|
||||
* After any change, you will need to run the [auto update scripts](https://github.com/claranet/terraform-datadog-scripts/blob/master/README.md) to make sure all is up to date otherwise the CI pipeline will fail.
|
||||
|
||||
## Pull Request Process
|
||||
|
||||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
|
||||
build.
|
||||
2. Update the README.md with details of changes to the interface, this includes new environment
|
||||
variables, exposed ports, useful file locations and container parameters.
|
||||
3. Increase the version numbers in any examples files and the README.md to the new version that this
|
||||
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
|
||||
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
|
||||
do not have permission to do that, you may request the second reviewer to merge it for you.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
### Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
|
||||
### Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
### Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
### Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
### Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at [FR-CloudPublic-github@fr.clara.net]. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
### Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
|
||||
43
README.md
43
README.md
@ -1,28 +1,19 @@
|
||||
# DataDog Monitors [](https://git.fr.clara.net/claranet/pt-monitoring/projects/datadog/terraform/monitors/commits/master) #
|
||||
# DataDog Monitors [](https://git.fr.clara.net/claranet/pt-monitoring/projects/datadog/terraform/monitors/commits/master)
|
||||
|
||||
This repository is used to store all our monitors templates ready to use for generic purpose.
|
||||
This repository aims to provide a base of generic and pre configured monitors for [Datadog](https://www.datadoghq.com/) templated thanks to [Terraform](https://www.terraform.io/) and the [Datadog Provider](https://github.com/terraform-providers/terraform-provider-datadog).
|
||||
|
||||
## How to contribute ? ##
|
||||
## Important notes
|
||||
|
||||
First, you may refresh your knowledge and look at the [terminology](https://confluence.fr.clara.net/display/DAT/Getting+started).
|
||||
* This repository provide multiple Terraform module which could be imported, you must choose the one(s) you need.
|
||||
* Each of these modules contains the most commons monitors, but they probably do not fulfill all your needs.
|
||||
* You still can create some specific DataDog monitors after importing a module, it's even advisable to complete your needs.
|
||||
* You will find a complete `README.md` on each module, explaining how to use it and its specificities if there.
|
||||
* The `alerting-message` module could be used to easily generate a templating message to re-use and could be used multiple times to suit different use cases.
|
||||
* Some monitors are disabled by default because not generic or "plug and play" enough, if you use them you will need to tweak them or in some cases disabled another one which could "duplicate" the check.
|
||||
|
||||
To contribute you will need to [report an issue](https://confluence.fr.clara.net/display/DAT/Project+and+Workflow) and create a branch with its Jira ID.
|
||||
## Getting started
|
||||
|
||||
If you would like to resolve an issue or implement new monitors you must follow our [best practices](https://confluence.fr.clara.net/display/DAT/Templates+monitors).
|
||||
|
||||
After any change, you will need to run the [auto update scripts](https://git.fr.clara.net/claranet/pt-monitoring/projects/datadog/terraform/scripts/blob/master/README.md) to make sure all is up to date otherwise the CI pipeline will fail.
|
||||
|
||||
## Important notes ##
|
||||
|
||||
* This repository represents a terraform feature and each first level directory could be imported as a terraform module, you must choose the one(s) you need.
|
||||
* Each of these modules contains the most commons monitors, but they probably do not fulfill all your customer needs
|
||||
* You still can create some specific DataDog monitors after importing a module, it's even advisable to complete your needs
|
||||
* You will find a complete `README.md` on each module, explaining how to use it.
|
||||
* The `alerting-message` module could be used to easily generate a templating message to use by default but it could be used also multiple times to generate messages for specific monitors.
|
||||
|
||||
## Getting started ##
|
||||
|
||||
### Terraform ###
|
||||
### Terraform
|
||||
|
||||
Here is the minimum version required to use these modules of integrations.
|
||||
|
||||
@ -33,7 +24,7 @@ terraform {
|
||||
|
||||
```
|
||||
|
||||
### DataDog provider ###
|
||||
### DataDog provider
|
||||
|
||||
Here is the last tester terraform provider version for datadog but next versions should work too.
|
||||
|
||||
@ -54,7 +45,7 @@ datadog_api_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
||||
datadog_app_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
||||
```
|
||||
|
||||
### Variables ###
|
||||
### Variables
|
||||
|
||||
Some variables need to be declared.
|
||||
|
||||
@ -74,7 +65,7 @@ variable "datadog_app_key" {
|
||||
|
||||
```
|
||||
|
||||
## Modules declaration example ##
|
||||
## Modules declaration example
|
||||
|
||||
A quick example of alerting message module declaration:
|
||||
|
||||
@ -120,9 +111,9 @@ module "datadog-monitors-system-generic" {
|
||||
|
||||
```
|
||||
|
||||
Replace `{revision}` to the last git tag available on this repository.
|
||||
The `//` is very important, it's a terraform specific syntax used to separate git url and folder path.
|
||||
`my/monitors/set` represents the path to a monitors set sub directory listed below.
|
||||
* Replace `{revision}` to the last git tag available on this repository.
|
||||
* The `//` is very important, it's a terraform specific syntax used to separate git url and folder path.
|
||||
* `my/monitors/set` represents the path to a monitors set sub directory listed below.
|
||||
|
||||
### Monitors summary ###
|
||||
|
||||
|
||||
10
TEMPLATING.md
Normal file
10
TEMPLATING.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Templating
|
||||
|
||||
This documentation aims to help contributors to build their monitors:
|
||||
* working with datadog and using some tips or advices.
|
||||
* respect guideline to keep this base generic and usable for everybody.
|
||||
* preserve homogeneity over every modules provided on this repository.
|
||||
|
||||
## TODO
|
||||
|
||||
To migrate from confluence
|
||||
Loading…
x
Reference in New Issue
Block a user