Skip to content

Commit ee77fae

Browse files
authored
Point readers to user documentation (#190)
Encourage users to read the user documentation instead of these developer instructions. Another measures to prevent users from accidental charges.
1 parent 7df8d3e commit ee77fae

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

kube/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Kubernetes setup
22

3-
This directory contains patch scripts to inject the Prometheus sidecar into
4-
existing Prometheus installations and to deploy a full example setup.
3+
This directory contains patch scripts to configure the Stackdriver Prometheus integration to work with the Prometheus server. See the [user documentation](https://cloud.google.com/monitoring/kubernetes-engine/prometheus) for more details.
54

65
Required environment variables:
76
* `KUBE_NAMESPACE`: namespace to run the script against
@@ -42,8 +41,7 @@ Injects sidecar into Prometheus deployments controlled by the [prometheus-operat
4241

4342
## `full/deploy.sh`
4443

45-
Deploys a basic Prometheus deployment to monitor Kubernetes components and
46-
custom services that are annotated with the well-known `prometheus.io/*` annotations.
44+
Deploys a basic Prometheus deployment that generates metric data useful for testing. This setup may incur charges and isn't intended for use in production.
4745

4846
```sh
4947
./full/deploy.sh

kube/full/deploy.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
#!/bin/bash
2+
# Deploys a basic Prometheus deployment that generates metric data for testing.
23

34
set -e
45
set -u
@@ -9,7 +10,7 @@ pushd "$(dirname "$0")"
910
export SIDECAR_IMAGE_TAG=${SIDECAR_IMAGE_TAG:-'master'}
1011
export KUBE_NAMESPACE=${KUBE_NAMESPACE:-'default'}
1112

12-
echo "Deploy to namespace ${KUBE_NAMESPACE} for Stackdriver project ${GCP_PROJECT} (location=${GCP_REGION}, cluster=${KUBE_CLUSTER})"
13+
echo "Deploying test environment to namespace ${KUBE_NAMESPACE} for Stackdriver project ${GCP_PROJECT} (location=${GCP_REGION}, cluster=${KUBE_CLUSTER})"
1314

1415
envsubst < prometheus.yaml > _prometheus.yaml.tmp
1516
envsubst < node-exporter.yaml > _node-exporter.yaml.tmp

0 commit comments

Comments
 (0)