Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.51 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.51 KB
Raw

PgBouncer Kubernetes Operator

Description

The PgBouncer Kubernetes Operator deploys and operates the PgBouncer lightweight connection pooler for PostgreSQL.

Usage

As this charm is not yet published, you need to follow the build and deploy instructions from CONTRIBUTING.md.

Actions

  • reload-pgbouncer
    • Reloads the pgbouncer application.
    • Currently only implemented as a stub.
  • add-user
    • Adds a new pgbouncer user.
    • Params:
      • username
      • password
  • remove-user
    • Removes an existing pgbouncer user.
    • Params:
      • username
  • change-password
    • Updates the password for a given pgbouncer user.
    • Params:
      • username
      • password
  • get-users
    • Lists the existing pgbouncer users.

Relations

Planned

The following relations provide support for the LMA charm bundle, our expected observability stack.

  • prometheus:prometheus_scrape
  • loki:loki_push_api
  • grafana:grafana_dashboards

OCI Images

This charm uses the canonical pgbouncer-container docker image, available here. As this container has not been uploaded anywhere, you will need to build this image locally and import it into your container registry before use, following the instructions in CONTRIBUTING.md.

License

The Charmed PgBouncer Operator is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.

Security

Security issues in the Charmed PgBouncer Operator can be reported through LaunchPad. Please do not file GitHub issues about security issues.

Contributing

Please see the Juju SDK docs for guidelines on enhancements to this charm following best practice guidelines, and CONTRIBUTING.md for developer guidance.