coreos/prometheus-operator
1
0
Fork 0
mirror of https://github.com/coreos/prometheus-operator.git synced 2026-02-05 15:46:31 +01:00
Code Issues Releases Wiki Activity

*/README.md: Include 'Contributing' section

Browse Source
This commit is contained in:
Max Leonard Inden
2018-08-01 10:37:31 +02:00
parent 3f27de9047
commit 30ff105ce4
2 changed files with 34 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -126,17 +126,30 @@ kubectl delete --ignore-not-found customresourcedefinitions \
> match. If you're working from a fork, just add the forked repo as a remote and
> pull against your local coreos checkout before running tests.
1. Running *unit tests*:
1. `make test-unit`
1. Running *end-to-end* tests on local minikube cluster:
1. `minikube start --kubernetes-version=v1.10.0 --memory=4096 --extra-config=apiserver.Authorization.Mode=RBAC`
2. `eval $(minikube docker-env) && make image` - build Prometheus Operator docker image on minikube's docker
3. `make test-e2e`
#### Running *unit tests*:
`make test-unit`
#### Running *end-to-end* tests on local minikube cluster:
1. `minikube start --kubernetes-version=v1.10.0 --memory=4096
--extra-config=apiserver.Authorization.Mode=RBAC`
2. `eval $(minikube docker-env) && make image` - build Prometheus Operator
docker image on minikube's docker
3. `make test-e2e`
## Contributing
Many files (documentation, manifests, ...) in this repository are
auto-generated. E.g. `bundle.yaml` originates from the _Jsonnet_ files in
`/jsonnet/prometheus-operator`. Before proposing a pull request:
1. Commit your changes.
2. Run `make generate-in-docker`.
3. Commit the generated changes.
## Security
If you found a security vulnerability related to the Prometheus Operator, please
If you find a security vulnerability related to the Prometheus Operator, please
do not report it by opening a GitHub issue, but instead please send an e-mail to
the maintainers of the project found in the [OWNERS](OWNERS) file.

13
contrib/kube-prometheus/README.md
View File

@@ -32,6 +32,7 @@ This stack is meant for cluster monitoring, so it is pre-configured to collect m
* [Minikube Example](#minikube-example)
* [Troubleshooting](#troubleshooting)
* [Error retrieving kubelet metrics](#error-retrieving-kubelet-metrics)
* [Contributing](#contributing)
## Prerequisites
@@ -391,3 +392,15 @@ config. They default to:
memoryPerNode: '30Mi',
}
```
## Contributing
All `.yaml` files in the `/manifests` folder are generated via
[Jsonnet](https://jsonnet.org/). Contributing changes will most likely include
the following process:
1. Make your changes in the respective `*.jsonnet` file.
2. Commit your changes (This is currently necessary due to our vendoring
process. This is likely to change in the future).
3. Generate dependent `*.yaml` files: `make generate-in-docker`.
4. Commit the generated changes.