Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create docs for deploy directory #403

Merged
merged 2 commits into from
Apr 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,8 @@ RBAC bindings and roles are included in all configurations.

Kuberhealthy is currently tested on Kubernetes `1.9.x`, to `1.15.x`.

More installation options, including static yaml files are available in the [/deploy](/deploy) directory.

### Prometheus Alerts

A `ServiceMonitor` configuration is available at [deploy/servicemonitor.yaml](https://raw.githubusercontent.com/Comcast/kuberhealthy/master/deploy/servicemonitor.yaml).

### Prometheus Grafana Dashboard

A `Grafana` dashboard is available at [deploy/grafana/dashboard.json](https://raw.githubusercontent.com/Comcast/kuberhealthy/master/deploy/grafana/dashboard.json). To install this dashboard, follow the instructions [here](http://docs.grafana.org/reference/export_import/#importing-a-dashboard).

### Why Are Synthetic Tests Important?

Expand Down
62 changes: 62 additions & 0 deletions deploy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
### Deployment Specs

This directory contains several ways to deploy Kuberhealthy to your cluster. You do not need all of the specs in this directory.

Each flat spec file here requires you to first create the `kuberhealthy` namespace with `kubectl create ns kuberhealthy` before application. Then, simply use `kubectl apply -f` on the file to deploy Kuberhealthy and some basic checks into your cluster.

### Prometheus Operator

`kuberhealthy-prometheus-operator.yaml`

A flat file that includes everything but a namespace for clusters with Prometheus Operator installed. For deploying Kuberhealthy in a cluster that has the [Prometheus Operator](https://github.com/coreos/prometheus-operator) deployed to it.

`servicemonitor.yaml`

A [service monitor](https://github.com/coreos/prometheus-operator#customresourcedefinitions) definition for Prometheus Operator that targets Kuberhealthy.

### Prometheus (Normal Single Instance Deployment)

`kuberhealthy-prometheus.yaml`

A flat file that includes everything but a namespace for clusters with Prometheus installed. Create the Kuberhealthy namespace with `kubectl create ns kuberhealthy` and install with `kubectl apply -f kuberhealthy-prometheus.yaml`


### Non-Prometheus Clusters

`kuberhealthy.yaml`

A flat file that includes everything but a namespace for clusters *without* Prometheus installed. Create the Kuberhealthy namespace with `kubectl create ns kuberhealthy` and install with `kubectl apply -f kuberhealthy.yaml`


### Helm

`helm/kuberhealthy`

A helm chart for deploying Kuberhealthy. This is the same helm chart published in our Helm registry. Install this chart with the following steps:

- Create namespace "kuberhealthy" in the desired Kubernetes cluster/context:
`kubectl create namespace kuberhealthy`

- Set your current namespace to "kuberhealthy":
`kubectl config set-context --current --namespace=kuberhealthy`

- Add the kuberhealthy repo to Helm:
`helm repo add kuberhealthy https://comcast.github.io/kuberhealthy/helm-repos`

- Install kuberhealthy with Helm using one of the following:

- Without Prometheus:
`helm install kuberhealthy kuberhealthy/kuberhealthy`

- With Prometheus:
`helm install kuberhealthy kuberhealthy/kuberhealthy --set prometheus.enabled=true --set prometheus.enableScraping=true --set prometheus.enableAlerting=true`

- With Prometheus Operator:
`helm install kuberhealthy kuberhealthy/kuberhealthy --set prometheus.enabled=true --set prometheus.enableScraping=true --set prometheus.enableAlerting=true --set prometheus.serviceMonitor=true`


### Helm

`grafana/`

An example dashboard for displaying Kuberhealthy checks from Prometheus data sources. Import the json file within to Grafana.