Mirrors/rpi.carlosedp.cluster-monitoring
1
0
Fork 0
mirror of https://github.com/carlosedp/cluster-monitoring.git synced 2024-11-20 19:07:17 +01:00
Code Issues Projects Releases Wiki Activity

Fix change_suffix and improve Readme

Browse Source 
Fix the change_suffix Makefile target allowing the user to just change
the URL suffix of the ingresses for Prometheus, Alertmanager and
Grafana.

This way it's not required to rebuild all manifests from scratch. Also
improved the Readme with this instructions.
This commit is contained in:
Carlos de Paula 2020-06-15 17:06:36 -03:00
parent 40c9318d23
commit 0d032eac7f
2 changed files with 38 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Makefile
View File

@ -29,14 +29,14 @@ fmt: ## Formats all jsonnet and libsonnet files (except on vendor dir)
@echo "Formatting jsonnet files" @echo "Formatting jsonnet files"
@find . -name 'vendor' -prune -o -name '*.libsonnet' -o -name '*.jsonnet' -print | xargs -n 1 -- $(JSONNET_FMT) -i @find . -name 'vendor' -prune -o -name '*.libsonnet' -o -name '*.jsonnet' -print | xargs -n 1 -- $(JSONNET_FMT) -i
deploy: manifests ## Rebuilds manifests and deploy to configured cluster deploy: ## Deploy current manifests to configured cluster
echo "Deploying stack setup manifests..." echo "Deploying stack setup manifests..."
kubectl apply -f ./manifests/setup/ kubectl apply -f ./manifests/setup/
echo "Will wait 10 seconds to deploy the additional manifests.." echo "Will wait 10 seconds to deploy the additional manifests.."
sleep 10 sleep 10
kubectl apply -f ./manifests/ kubectl apply -f ./manifests/
teardown: ## Delete all monitoring stack resources from configured cluster teardown: ## Delete all monitoring stack resources from configured cluster
kubectl delete -f ./manifests/ kubectl delete -f ./manifests/
kubectl delete -f ./manifests/setup/ kubectl delete -f ./manifests/setup/
@ -48,7 +48,7 @@ $(JB_BINARY): ## Installs jsonnet-bundler utility
@echo "Installing jsonnet-bundler" @echo "Installing jsonnet-bundler"
@go get -u github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb @go get -u github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
$(JSONNET_BIN): ## Installs jsonnet and jsonnetfmt utility $(JSONNET_BIN): ## Installs jsonnet and jsonnetfmt utility
@echo "Installing jsonnet" @echo "Installing jsonnet"
@go get -u github.com/google/go-jsonnet/cmd/jsonnet @go get -u github.com/google/go-jsonnet/cmd/jsonnet
@go get -u github.com/google/go-jsonnet/cmd/jsonnetfmt @go get -u github.com/google/go-jsonnet/cmd/jsonnetfmt
@ -61,9 +61,12 @@ update_tools: ## Updates jsonnet, jsonnetfmt and jb utilities
@go get -u github.com/brancz/gojsontoyaml @go get -u github.com/brancz/gojsontoyaml
@go get -u github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb @go get -u github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
change_suffix: ## Changes suffix for the ingress change_suffix: ## Changes suffix for the ingress. Pass suffix=[suffixURL] as argument
@perl -p -i -e 's/^(\s*)\-\ host:.*/\1- host: alertmanager.${IP}.nip.io/g' manifests/ingress-alertmanager.yaml manifests/ingress-prometheus.yaml manifests/ingress-grafana.yaml @sed -i -e "s/\(.*prometheus\.\).*/\1${suffix}/" manifests/ingress-prometheus.yaml
@echo "Ingress IPs changed to [service].${IP}.nip.io" @sed -i -e "s/\(.*alertmanager\.\).*/\1${suffix}/" manifests/ingress-alertmanager.yaml
${K3S} kubectl apply -f manifests/ingress-alertmanager.yaml @sed -i -e "s/\(.*grafana\.\).*/\1${suffix}/" manifests/ingress-grafana.yaml
${K3S} kubectl apply -f manifests/ingress-grafana.yaml @echo "Ingress IPs changed to [service].${suffix}"
${K3S} kubectl apply -f manifests/ingress-prometheus.yaml @echo "Apply to your cluster with:"
@echo ${K3S} kubectl apply -f manifests/ingress-alertmanager.yaml
@echo ${K3S} kubectl apply -f manifests/ingress-grafana.yaml
@echo ${K3S} kubectl apply -f manifests/ingress-prometheus.yaml

38
Readme.md
View File

@ -4,7 +4,7 @@ The Prometheus Operator for Kubernetes provides easy monitoring definitions for
This have been tested on a hybrid ARM64 / X84-64 Kubernetes cluster deployed as [this article](https://medium.com/@carlosedp/building-a-hybrid-x86-64-and-arm-kubernetes-cluster-e7f94ff6e51d). This have been tested on a hybrid ARM64 / X84-64 Kubernetes cluster deployed as [this article](https://medium.com/@carlosedp/building-a-hybrid-x86-64-and-arm-kubernetes-cluster-e7f94ff6e51d).
This repository collects Kubernetes manifests, Grafana dashboards, and Prometheus rules combined with documentation and scripts to provide easy to operate end-to-end Kubernetes cluster monitoring with Prometheus using the Prometheus Operator. This repository collects Kubernetes manifests, Grafana dashboards, and Prometheus rules combined with documentation and scripts to provide easy to operate end-to-end Kubernetes cluster monitoring with Prometheus using the Prometheus Operator. The container images support AMD64, ARM64, ARM and PPC64le architectures.
The content of this project is written in jsonnet and is an extension of the fantastic [kube-prometheus](https://github.com/coreos/prometheus-operator/blob/master/contrib/kube-prometheus) project. The content of this project is written in jsonnet and is an extension of the fantastic [kube-prometheus](https://github.com/coreos/prometheus-operator/blob/master/contrib/kube-prometheus) project.
@ -25,7 +25,7 @@ There are additional modules (disabled by default) to monitor other components o
The additional modules are: The additional modules are:
* arm-exporter to generate temperature metrics (works on some ARM boards like RaspberryPi) * ARM-exporter to generate temperature metrics (works on some ARM boards like RaspberryPi)
* MetalLB metrics * MetalLB metrics
* Traefik metrics * Traefik metrics
* ElasticSearch metrics * ElasticSearch metrics
@ -36,22 +36,32 @@ There are also options to set the ingress domain suffix and enable persistence f
The ingresses can use TLS with the default self-signed certificate from your Ingress controller by setting `TLSingress` to `true` and use a custom certificate by creating the files `server.crt` and `server.key` and enabling the `UseProvidedCerts` parameter at `vars.jsonnet`. The ingresses can use TLS with the default self-signed certificate from your Ingress controller by setting `TLSingress` to `true` and use a custom certificate by creating the files `server.crt` and `server.key` and enabling the `UseProvidedCerts` parameter at `vars.jsonnet`.
After changing these parameters, rebuild the manifests with `make`. Changing these parameters require a rebuild of the manifests with `make`.
## Quickstart (non K3s) ## Quickstart (non K3s)
The repository already provides a set of compiled manifests to be applied into the cluster. The deployment can be customized thru the jsonnet files. The repository already provides a set of compiled manifests to be applied into the cluster or the deployment can be customized thru the jsonnet files.
For the ingresses, edit `suffixDomain` to have your cluster URL suffix. This will be your ingresses will be exposed (ex. grafana.yourcluster.domain.com). If you only need the default features and adjust your cluster URL for the ingress, there is no need to rebuild the manifests(and install all tools). Use the `change_suffix` target with argument `suffix=[suffixURL]` with the URL of your cluster ingress controller. If you have a local cluster, use the nip.io domain resolver passing `your_cluster_ip.nip.io` to the `suffix` argument. After this, just run `make deploy`.
To deploy the stack, run: ```bash
# Update the ingress URLs
make change_suffix suffix=[suffixURL]
# Deploy
make deploy
```
To customize the manifests, edit `vars.jsonnet` and rebuild the manifests.
```bash ```bash
$ make vendor $ make vendor
$ make
$ make deploy $ make deploy
# Or manually: # Or manually:
$ make vendor
$ make $ make
$ kubectl apply -f manifests/setup/ $ kubectl apply -f manifests/setup/
$ kubectl apply -f manifests/ $ kubectl apply -f manifests/
@ -63,9 +73,7 @@ If you enable the SMTP relay for Gmail in `vars.jsonnet`, the pod will be in an
## Quickstart on Minikube ## Quickstart on Minikube
You can also test and develop the monitoring stack on Minikube. First install minikube by following the instructions [here](https://kubernetes.io/docs/tasks/tools/install-minikube/) for your platform. You can also test and develop the monitoring stack on Minikube. First install minikube by following the instructions [here](https://kubernetes.io/docs/tasks/tools/install-minikube/) for your platform. Then, follow the instructions similar to the non-K3s deployment:
Then, adjust and deploy the stack:
```bash ```bash
# Start minikube (if not started) # Start minikube (if not started)
@ -77,9 +85,14 @@ minikube addons enable ingress
# Get the minikube instance IP # Get the minikube instance IP
minikube ip minikube ip
# Adjust the "suffixDomain" line in `vars.jsonnet` to the IP of the minikube instance keeping the "nip.io" # Run the change_suffix target
# Build and deploy the monitoring stack make change_suffix suffix=[minikubeIP.nip.io]
# or customize additional params on vars.jsonnet and rebuild
make vendor make vendor
make
# and deploy the manifests
make deploy make deploy
# Get the URLs for the exposed applications and open in your browser # Get the URLs for the exposed applications and open in your browser
@ -99,6 +112,7 @@ After changing these values to deploy the stack, run:
```bash ```bash
$ make vendor $ make vendor
$ make
$ make deploy $ make deploy
# Or manually: # Or manually:
@ -125,7 +139,7 @@ To list the created ingresses, run `kubectl get ingress --all-namespaces`, if yo
## Updating the ingress suffixes ## Updating the ingress suffixes
To avoid rebuilding all manifests, there is a make target to update the Ingress URL suffix to a different suffix (using nip.io) to match your host IP. Run `make change_suffix IP="[IP-ADDRESS]"` to change the ingress route IP for Grafana, Prometheus and Alertmanager and reapply the manifests. If you have a K3s cluster, run `make change_suffix IP="[IP-ADDRESS] K3S=k3s`. To avoid rebuilding all manifests, there is a make target to update the Ingress URL suffix to a different suffix. Run `make change_suffix suffix="[clusterURL]"` to change the ingress route IP for Grafana, Prometheus and Alertmanager and reapply the manifests.
## Customizing ## Customizing