README.md

Hydro-monitoring

Monitoring Platform

Getting Started

Installation

The Hydro-Monitoring platform can be installed in the following orchestrators:

• Docker
• Kubernetes

Docker

Before installing Hydrosphere Monitoring, please install its prerequisites:

• Docker 20+, with BuildKit enabled;
• Docker Compose 1.29+.

Install from releases

1. Download the latest release version from the releases page;

   ### __released_version__
   export HYDRO_MONITORING_RELEASE=0.1.0
   
   wget -O hydro-monitoring-${HYDRO_MONITORING_RELEASE}.tar.gz https://github.com/Hydrospheredata/hydro-monitoring/archive/${HYDRO_MONITORING_RELEASE}.tar.gz

2. Unpack the tar ball:

   tar -xvf hydro-monitoring-${HYDRO_MONITORING_RELEASE}.tar.gz

3. Set up an environment.

   cd hydro-monitoring-${HYDRO_MONITORING_RELEASE}/docker-compose
   docker-compose up -d

4. *To see metrics in Grafana-Prometheus stack:

   docker-compose -f docker-compose.yaml -f docker-compose.metrics.yaml up -d

Install from source

1. Clone the repository locally.

   git clone https://github.com/Hydrospheredata/hydro-monitoring
   cd hydro-monitoring/docker-compose

2. Set up an environment.

   docker-compose up -d

3. *To see metrics in Grafana-Prometheus stack:

   docker-compose -f docker-compose.yaml -f docker-compose.metrics.yaml up -d

Hydro-Monitoring will be available at localhost.

Kubernetes

Before installing Hydrosphere Monitoring, please install its prerequisites:

• Helm 3.0+
• Kubernetes 1.16+ with v1 API with beta APIs enabled.

Install from charts repository

1. Add the Hydrosphere Monitoring charts repository:

   helm repo add hydromonitoring https://hydrospheredata.github.io/hydro-monitoring/helm/

2. Install the chart from repo to the cluster:

   helm install monitoring hydromonitoring/monitoring --namespace hydromonitoring --create-namespace

Install from source

1. Clone the repository:

   git clone https://github.com/Hydrospheredata/hydro-monitoring
   cd hydro-monitoring/helm

2. Build dependencies:

   helm dependency build monitoring

3. Install the chart:

   helm install monitoring monitoring --namespace hydromonitoring --create-namespace

After the chart has been installed, you have to expose the shell-ui component outside of the cluster. For the sake of simplicity, we will just port-forward it locally.

kubectl port-forward svc/monitoring-shell-ui 8080:8080 -n hydromonitoring

Hydro-Monitoring will be available at localhost:8080.

Community

Keep up to date and get Hydrosphere.io support via or contact us directly at [email protected]

Contributing

We'd be glad to receive any help from the community!

Check out our issues for anything labeled with help wanted, they will be the perfect starting point! If you don't see any, just let us know, we would be happy to hear from you.