mirror of
https://github.com/bloomberg/goldpinger.git
synced 2026-08-23 21:36:25 +00:00
Update README to address things from the issues
Signed-off-by: Mikolaj Pawlikowski <mikolaj@pawlikowski.pl>
This commit is contained in:
@@ -3,7 +3,7 @@
|
||||
__Goldpinger__ makes calls between its instances for visibility and alerting.
|
||||
It runs as a `DaemonSet` on `Kubernetes` and produces `Prometheus` metrics that can be scaped, visualised and alerted on.
|
||||
|
||||
Oh, and it gives you the graph below for your cluster.
|
||||
Oh, and it gives you the graph below for your cluster. Check out the [video explainer](https://youtu.be/DSFxRz_0TU4).
|
||||
|
||||

|
||||
|
||||
@@ -31,6 +31,8 @@ We built __Goldpinger__ to troubleshoot, visualise and alert on our networking l
|
||||
|
||||
It's small, simple and you'll wonder why you hadn't had it before.
|
||||
|
||||
If you'd like to know more, you can watch [our presentation at Kubecon 2018 Seattle](https://youtu.be/DSFxRz_0TU4).
|
||||
|
||||
|
||||
## Quick start
|
||||
|
||||
@@ -80,7 +82,9 @@ namespace="docker.io/myhandle/" make push
|
||||
### Example YAML
|
||||
|
||||
|
||||
Here's an example of what you can do (using the in-cluster authentication to `Kubernetes` apiserver):
|
||||
Here's an example of what you can do (using the in-cluster authentication to `Kubernetes` apiserver).
|
||||
|
||||
:warning: Replace `docker.io/mynamespace-replaceme/goldpinger:1.0.0` with the actual tag you built.
|
||||
|
||||
```yaml
|
||||
---
|
||||
@@ -137,6 +141,24 @@ spec:
|
||||
app: goldpinger
|
||||
```
|
||||
|
||||
Note, that you will also need to add an RBAC rule to allow `Goldpinger` to list other pods. If you're just playing around, you can consider a view-all default rule:
|
||||
|
||||
```yaml
|
||||
---
|
||||
apiVersion: rbac.authorization.k8s.io/v1beta1
|
||||
kind: ClusterRoleBinding
|
||||
metadata:
|
||||
name: default
|
||||
roleRef:
|
||||
apiGroup: rbac.authorization.k8s.io
|
||||
kind: ClusterRole
|
||||
name: view
|
||||
subjects:
|
||||
- kind: ServiceAccount
|
||||
name: default
|
||||
namespace: default
|
||||
```
|
||||
|
||||
You can also see [an example of using `kubeconfig` in the `./extras`](./extras/example-with-kubeconfig.yaml).
|
||||
|
||||
## Usage
|
||||
|
||||
Reference in New Issue
Block a user