Skip to content

README.md

Latest commit

 

History

History
80 lines (50 loc) · 2.46 KB

README.md

File metadata and controls

80 lines (50 loc) · 2.46 KB
Raw

yorkie-monitoring

Installs the yorkie-monitoring, which provides monitoring system with prometheus and grafana for monitoring yorkie cluster.

Prerequisites

  • Kubernetes 1.24+
  • Helm 3+

Get Helm Repository Info

helm repo add yorkie-team https://yorkie-team.github.io/yorkie/helm-charts
helm repo update

See helm repo for command documentation.

Install Helm Chart

# Install yorkie monitoring helm chart
helm install [RELEASE_NAME] yorkie-team/yorkie-monitoring -n monitoring --create-namespace

See configuration below for custom installation

See helm install for command documentation.

Dependencies

By default this chart installs additional, dependent charts:

See helm dependency for command documentation.

Uninstall Helm Chart

helm uninstall [RELEASE_NAME] -n monitoring

This removes all the Kubernetes components associated with the chart and deletes the release.

See helm uninstall for command documentation.

CRDs created by this chart are not removed by default and should be manually cleaned up:

kubectl get crd -oname | grep --color=never 'monitoring.coreos.com' | xargs kubectl delete

Also, ServiceAccounts are not removed by default and shold be manually cleaned up:

kubectl delete serviceaccounts --all -n monitoring

Upgrading Chart

helm upgrade [RELEASE_NAME] yorkie-team/yorkie-monitoring -n monitoring

With Helm v3, CRDs created by this chart are not updated by default and should be manually updated. Consult also the Helm Documentation on CRDs.

See helm upgrade for command documentation.

Configuration

See Customizing the Chart Before Installing. To see all configurable options with detailed comments:

helm show values yorkie-team/yorkie-monitoring

You may also helm show values on this chart's dependencies for additional options.