Metrics Prerequisites
Prerequisites
The following is required prior to installing the Crunchy PostgreSQL Operator Monitoring infrastructure using Ansible:
- postgres-operator playbooks source code for the target version
- Ansible 2.9.0+
Kubernetes Installs
- Kubernetes v1.11+
- Cluster admin privileges in Kubernetes
- kubectl configured to communicate with Kubernetes
OpenShift Installs
- OpenShift v3.11+
- Cluster admin privileges in OpenShift
- oc configured to communicate with OpenShift
Installing from a Windows Host
If the Crunchy PostgreSQL Operator is being installed from a Windows host the following are required:
Permissions
The installation of the Crunchy PostgreSQL Operator Monitoring infrastructure requires elevated privileges, as the following objects need to be created:
- RBAC for use by Prometheus and/or Grafana
- The metrics namespace
Obtaining Operator Ansible Role
- Clone the postgres-operator project
GitHub Installation
All necessary files (inventory.yaml, values.yaml, main playbook and roles) can be found in the
installers/metrics/ansible
directory in the source code.
Configuring the Inventory File
The inventory.yaml
file included with the PostgreSQL Operator Monitoring Playbooks allows installers
to configure how Ansible will connect to your Kubernetes cluster. This file
should contain the following connection variables:
kubernetes
or openshift
variables
if you are being using them for your environment. Both sets of variables cannot
be used at the same time. The unused variables should be left commented out or removed.Name | Default | Required | Description |
---|---|---|---|
kubernetes_context |
Required, if deploying to Kubernetes | When deploying to Kubernetes, set to configure the context name of the kubeconfig to be used for authentication. | |
openshift_host |
Required, if deploying to OpenShift | When deploying to OpenShift, set to configure the hostname of the OpenShift cluster to connect to. | |
openshift_password |
Required, if deploying to OpenShift | When deploying to OpenShift, set to configure the password used for login. | |
openshift_skip_tls_verify |
Required, if deploying to OpenShift | When deploying to Openshift, set to ignore the integrity of TLS certificates for the OpenShift cluster. | |
openshift_token |
Required, if deploying to OpenShift | When deploying to OpenShift, set to configure the token used for login (when not using username/password authentication). | |
openshift_user |
Required, if deploying to OpenShift | When deploying to OpenShift, set to configure the username used for login. |
To retrieve the kubernetes_context
value for Kubernetes installs, run the following command:
kubectl config current-context
Configuring - values.yaml
The values.yaml
file contains all of the configuration parameters
for deploying the PostgreSQL Operator Monitoring infrastructure.
The example file
contains defaults that should work in most Kubernetes environments, but it may
require some customization.
For a detailed description of each configuration parameter, please read the PostgreSQL Operator Installer Metrics Configuration Reference