<a id="index"></a>

# bingo operator

A [Juju](https://juju.is/) [charm](https://canonical.com/juju/docs/juju-cli/3.6/reference/charm/#charm)
deploying and managing [bingo](https://github.com/canonical/bingo) on Kubernetes.
bingo is a Go pastebin application that replaces
[paste.canonical.com](https://paste.canonical.com).

Like any Juju charm, this charm supports one-line deployment, configuration, integration,
scaling, and more. For bingo, this includes:

* Paste creation and retrieval with configurable expiry
* Optional OIDC authentication via the Canonical Identity Platform
* Integration with PostgreSQL for persistent storage
* Ingress support via Traefik
* Observability integrations (Prometheus, Grafana, Loki)

The bingo charm allows for deployment on many different Kubernetes platforms,
from [MicroK8s](https://canonical.com/microk8s) to
[Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes offerings.

This charm will make operating bingo straightforward for DevOps or SRE teams through Juju’s
clean interface.

## In this documentation

|                 |                                                                                                                                                                                                                                                                                   |
|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Get started** | [Guided tutorial](https://canonical.com/juju/docs/bingo-charm/latest/tutorial/index.html.md#tutorial)                                                                                                                                                                                                           |
| **Deployment**  | [Set the base URL](https://canonical.com/juju/docs/bingo-charm/latest/how-to/set-base-url/index.html.md#how-to-set-base-url) | [Limit paste size](https://canonical.com/juju/docs/bingo-charm/latest/how-to/limit-paste-size/index.html.md#how-to-limit-paste-size) | [Serve frontend assets](https://canonical.com/juju/docs/bingo-charm/latest/how-to/serve-frontend-assets/index.html.md#how-to-serve-frontend-assets) |
| **Operations**  | [Configure logging](https://canonical.com/juju/docs/bingo-charm/latest/how-to/configure-logging/index.html.md#how-to-configure-logging)                                                                                                                                                                                         |
| **Design**      | [Charm architecture](https://canonical.com/juju/docs/bingo-charm/latest/reference/charm-architecture/index.html.md#reference-charm-architecture)                                                                                                                                                                                    |
| **Security**    | [Overview](https://canonical.com/juju/docs/bingo-charm/latest/explanation/security/index.html.md#explanation-security) | [Configure OIDC login](https://canonical.com/juju/docs/bingo-charm/latest/how-to/configure-oidc-login/index.html.md#how-to-configure-oidc-login) | [Rotate the secret key](https://canonical.com/juju/docs/bingo-charm/latest/how-to/rotate-secret-key/index.html.md#how-to-rotate-secret-key)    |

## How this documentation is organized

This documentation uses the [Diátaxis documentation structure](https://diataxis.fr/).

- The [Tutorial](https://canonical.com/juju/docs/bingo-charm/latest/tutorial/index.html.md#tutorial) takes you step-by-step through a basic deployment of
  the bingo charm.
- [How-to guides](https://canonical.com/juju/docs/bingo-charm/latest/how-to/index.html.md#how-to-index) assume you have basic familiarity with the bingo
  charm. Learn more about setting up, using, maintaining, and contributing to this charm.
- [Reference](https://canonical.com/juju/docs/bingo-charm/latest/reference/index.html.md#reference-index) provides a guide to actions, configurations,
  relations, and other technical details.
- [Explanation](https://canonical.com/juju/docs/bingo-charm/latest/explanation/index.html.md#explanation-index) includes topic overviews, background and context
  and detailed discussion.
- [Changelog](https://canonical.com/juju/docs/bingo-charm/latest/changelog/index.html.md#changelog) holds all the release history for the charm.

### Contributing to this documentation

Documentation is an important part of this project, and we take the same open-source
approach to the documentation as the code. As such, we welcome community contributions,
suggestions, and constructive feedback on our documentation.
See [How to contribute](https://canonical.com/juju/docs/bingo-charm/latest/how-to/contribute/index.html.md#how-to-contribute) for more information.

If there’s a particular area of documentation that you’d like to see that’s missing,
please [file a bug](https://github.com/canonical/bingo/issues).

## Project and community

The bingo Operator is a member of the Ubuntu family. It’s an open-source project that
warmly welcomes community projects, contributions, suggestions, fixes, and constructive
feedback.

### Governance and policies

- [Code of conduct](https://ubuntu.com/community/code-of-conduct)

### Get involved

- [Get support](https://discourse.charmhub.io/)
- [Join our online chat](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
- [Contribute](https://canonical.com/juju/docs/bingo-charm/latest/how-to/contribute/index.html.md#how-to-contribute)

Thinking about using the bingo Operator for your next project?
[Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)!
