Skip to content

Commit ad2e64f

Browse files
authored
docs(deployment): gke monitoring (#95)
Signed-off-by: Miguel Martinez Trivino <[email protected]>
1 parent b817df8 commit ad2e64f

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

deployment/chainloop/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This chart bootstraps a [Chainloop](https://github.com/chainloop-dev/chainloop)
1212
- Helm 3.2.0+
1313
- PV provisioner support in the underlying infrastructure (If built-in PostgreSQL is enabled)
1414

15-
Compatibility with the following Ingress Controllers have been checked, others might or might not work.
15+
Compatibility with the following Ingress Controllers has been verified, other controllers might or might not work.
1616

1717
- [Nginx Ingress Controller](https://kubernetes.github.io/ingress-nginx/)
1818
- [Traefik](https://doc.traefik.io/traefik/providers/kubernetes-ingress/)
@@ -236,6 +236,8 @@ cas:
236236
nginx.ingress.kubernetes.io/proxy-body-size: "100m"
237237
```
238238

239+
Remember, once you have set up your domain, make sure you use the [CLI pointing](#configure-chainloop-cli-to-point-to-your-instance) to it instead of the defaults.
240+
239241
### Connect to an external PostgreSQL database
240242

241243
```yaml
@@ -298,6 +300,23 @@ sentry:
298300
dsn: [your secret sentry project DSN URL]
299301
environment: production
300302
```
303+
304+
### Enable Prometheus Monitoring in GKE
305+
306+
Chainloop exposes Prometheus compatible `/metrics` endpoints that can be easily scraped by a Prometheus data collector Server.
307+
308+
Google Cloud has a [managed Prometheus offering](https://cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed) that could be easily enabled by setting `--set GKEMonitoring.enabled=true`. This will inject the required `PodMonitoring` custom resources.
309+
310+
### Configure Chainloop CLI to point to your instance
311+
312+
Once you have your instance of Chainloop deployed, you need to configure the [CLI](https://github.com/chainloop-dev/chainloop/releases) to point to both the CAS and the Control plane gRPC APIs like this.
313+
314+
```
315+
chainloop config save \
316+
--control-plane my-controlplane.acme.com:443 \
317+
--artifact-cas cas.acme.com:443
318+
```
319+
301320
## Parameters
302321
303322
### Common parameters

0 commit comments

Comments
 (0)