smana / cnp-sandbox

Sandbox for Cloud Native PostgreSQL in Kubernetes environments

Sandbox for Cloud Native PostgreSQL

Cloud Native PostgreSQL Sandbox, aka cnp-sandbox, is a Helm chart that sets up the following components inside a Kubernetes cluster:

• Prometheus
• Grafana
• Cloud Native PostgreSQL (CNP) by EDB, a Kubernetes operator for PostgreSQL and EDB Postgres Advanced, with:
  • a selection of PostgreSQL metrics for the native Prometheus exporter in CNP (see the metrics.yaml template file)
  • a custom Grafana dashboard developed by EDB for Cloud Native PostgreSQL

IMPORTANT: cnp-sandbox must be run in a staging or pre-production environment. Do not use cnp-sandbox in a production environment, as we expect that Prometheus and Grafana are already part of that infrastructure: there you can install Cloud Native PostgreSQL, the suggested metrics and the provided Grafana dashboard.

If you are using Openshift then this Helm chart will not work. The installation of the operator is different in Openshift; there it should be installed using OLM. Additionally, the monitoring stack should be installed in Openshift using the associated Openshift installation methods for those applications.

Requirements

• Cloud Native PostgreSQL 1.10.0
• GNU Make 3.8
• Helm 3.7
• A supported Kubernetes cluster with enough RBAC permissions to deploy the required resources

Deployment

Deployment using the latest release:

helm repo add cnp-sandbox https://enterprisedb.github.io/cnp-sandbox/
helm repo update
helm upgrade --install cnp-sandbox \
  cnp-sandbox/cnp-sandbox

Then simply follow the instructions that will appear on the terminal once the installation is completed.

Deployment from local source

You can deploy Cloud Native PostgreSQL Sandbox from local source with:

make sandbox-deploy

You can remove the installed sandbox by running:

make sandbox-uninstall

Monitoring

From the Grafana interface, you can find the dashboard by selecting: Dashboards > Manage > Cloud Native PostgreSQL.

Benchmarking

You can use cnp-sandbox in conjuction with cnp-bench to benchmark your PostgreSQL environment and observe its behaviour in real-time.

Contributing

Please read the code of conduct and the guidelines to contribute to the project.

Disclaimer

cnp-sandbox is open source software and comes "as is". Please carefully read the license before you use this software, in particular the "Disclaimer of Warranty" and "Limitation of Liability" items.

Copyright

cnp-sandbox is distributed under Apache License 2.0.

Copyright (C) 2021 EnterpriseDB Corporation.