Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync docs from Discourse #476

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -55,6 +55,7 @@ This PgBouncer K8s charm is an official distribution of PgBouncer. It’s an ope
| 3 | h-enable-tracing | [Tracing (COS)](/t/14789) |
| 1 | reference | [Reference]() |
| 2 | r-releases | [Release Notes](/t/12261) |
| 3 | r-revision-359-360 | [Revision 359/360](/t/16124) |
| 3 | r-revision-268-269 | [Revision 268/269](/t/15443) |
| 3 | r-revision-228-229 | [Revision 228/229](/t/15090) |
| 3 | r-revision-144 | [Revision 144/145](/t/14070) |
12 changes: 12 additions & 0 deletions docs/reference/r-releases.md
Original file line number Diff line number Diff line change
@@ -15,6 +15,7 @@ For each release, this table shows:

| Revision | PgBouncer version | Juju version | [TLS encryption](/t/12259) | [COS monitoring](/t/12279) | [Minor version upgrades](/t/12270) |
|:---:|:---:|:---:|:---:|:---:|:---:|
|[359], [360]| `1.21.0` | `3.4.5+` | ![check] | ![check] | ![check]
|[268], [269]| `1.21.0` | `3.4.5+` | ![check] | ![check] | ![check]
|[228], [229]| `1.21.0` | `3.4.5+` | ![check] | ![check] |
|[144], [145]| `1.21.0` | `3.1.8+` | ![check] | ![check] |
@@ -30,11 +31,20 @@ Several [revisions](https://juju.is/docs/sdk/revision) are released simultaneous

> If you deploy a specific revision, **you must make sure it matches your base and architecture** via the tables below or with [`juju info`](https://juju.is/docs/juju/juju-info).

### Release 359/360 (latest)
| Revision | `amd64` | `arm64` | Ubuntu 22.04 (jammy)
|:-----:|:--------:|:--------:|:-----:|
| [360] | | ![check] | ![check] |
| [359] | ![check] | | ![check] |

[details=Release 268/269]

### Release 268/269 (latest)
| Revision | `amd64` | `arm64` | Ubuntu 22.04 (jammy)
|:-----:|:--------:|:--------:|:-----:|
| [268] | | ![check] | ![check] |
| [269] | ![check] | | ![check] |
[/details]

[details=Release 228/229]

@@ -85,6 +95,8 @@ Several [revisions](https://juju.is/docs/sdk/revision) are released simultaneous
[/note]

<!--LINKS-->
[360]: /t/16124
[359]: /t/16124
[268]: /t/15443
[269]: /t/15443
[228]: /t/15090
9 changes: 4 additions & 5 deletions docs/reference/r-requirements.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
## Juju version

The charm supports both [Juju 2.9 LTS](https://github.com/juju/juju/releases) and [Juju 3.1](https://github.com/juju/juju/releases).
The charm supports both [Juju 2.9 LTS](https://github.com/juju/juju/releases) and [Juju 3.x](https://github.com/juju/juju/releases). The supported Juju versions are:

The minimum supported Juju versions are:

* 2.9.32+
* 3.1.7+ (Juju secrets refactored/stabilized in Juju 3.1.7)
* 3.6.1+ LTS (recommended)
* 3.1.7+ (minimal for 3.x: Juju secrets refactored/stabilized in Juju 3.1.7)
* 2.9.32+ (minimal for 2.x)

## Kubernetes requirements

87 changes: 87 additions & 0 deletions docs/reference/r-revision-359-360.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
>Reference > Release Notes > [All revisions] > Revision 359/360

# Revision 359/360
<sub>December 20, 2024</sub>

Dear community,

Canonical's newest Charmed PgBouncer K8s operator has been published in the [1/stable channel].

Due to the newly added support for `arm64` architecture, the PgBouncer K8s charm now releases multiple revisions simultaneously:
* Revision 359 is built for `amd64` on Ubuntu 22.04 LTS
* Revision 360 is built for `arm64` on Ubuntu 22.04 LTS

If you are jumping over several stable revisions, check [previous release notes][All revisions] before upgrading.

---

## Highlights / Features

* Tested [Juju 3.6 LTS](https://juju.is/docs/juju/roadmap#juju-juju-361-11-dec-2024) compatibility. Juju 3.6.1+ is a new [recommended Juju version](/t/12263)!
* Introduced [COS Tracing support](/t/14789) using [Tempo COS coordinator](https://charmhub.io/tempo-coordinator-k8s) ([PR #434](https://github.com/canonical/pgbouncer-k8s-operator/pull/434))

## Bugfixes and maintenance

* Switched to typed charm and fixes for legacy interface `pgsql` ([PR #435](https://github.com/canonical/pgbouncer-k8s-operator/pull/435))
* Quote tox.ini repository paths ([PR #461](https://github.com/canonical/pgbouncer-k8s-operator/pull/461)) ([DPE-6042](https://warthogs.atlassian.net/browse/DPE-6042))
* Fix `test_tls.py` test by installing 1 mattermost unit only ([PR #460](https://github.com/canonical/pgbouncer-k8s-operator/pull/460)) ([DPE-5622](https://warthogs.atlassian.net/browse/DPE-5622))
* Re-enabled cached builds on CI/CD ([PR #456](https://github.com/canonical/pgbouncer-k8s-operator/pull/456))

[details=Libraries, testing, and CI]
* Increased ruff rules ([PR #405](https://github.com/canonical/pgbouncer-k8s-operator/pull/405)) ([DPE-5324](https://warthogs.atlassian.net/browse/DPE-5324))
* Run juju 3.6 nightly tests against 3.6/stable ([PR #465](https://github.com/canonical/pgbouncer-k8s-operator/pull/465))
* Run tests against juju 3.6/candidate on nightly schedule ([PR #452](https://github.com/canonical/pgbouncer-k8s-operator/pull/452)) ([DPE-5622](https://warthogs.atlassian.net/browse/DPE-5622))
* Disabled tox requirements generation for lib release ([PR #426](https://github.com/canonical/pgbouncer-k8s-operator/pull/426))
* Deleted internal_docs directory ([PR #427](https://github.com/canonical/pgbouncer-k8s-operator/pull/427))
* Updated charm libs ([PR #433](https://github.com/canonical/pgbouncer-k8s-operator/pull/433))
* Disabled linting for docs ([PR #437](https://github.com/canonical/pgbouncer-k8s-operator/pull/437))
* Disabled cached builds ([PR #442](https://github.com/canonical/pgbouncer-k8s-operator/pull/442))
* Lock file maintenance Python dependencies ([PR #464](https://github.com/canonical/pgbouncer-k8s-operator/pull/464))
* Migrate `config .github/renovate.json5` ([PR #454](https://github.com/canonical/pgbouncer-k8s-operator/pull/454))
* Switched from tox build wrapper to `charmcraft.yaml` overrides ([PR #423](https://github.com/canonical/pgbouncer-k8s-operator/pull/423))
* Updated codecov/codecov-action action to v5 ([PR #455](https://github.com/canonical/pgbouncer-k8s-operator/pull/455))
* Updated data-platform-workflows to v23.1.1 ([PR #470](https://github.com/canonical/pgbouncer-k8s-operator/pull/470))
* Updated dependency cryptography to v44 ([PR #467](https://github.com/canonical/pgbouncer-k8s-operator/pull/467))
* Updated Juju agents ([PR #429](https://github.com/canonical/pgbouncer-k8s-operator/pull/429))
[/details]

## Requirements and compatibility

See the [system requirements] for more details about Juju versions and other software and hardware prerequisites.


See the [`/lib/charms` directory on GitHub] for more details about all supported libraries.

See the [`metadata.yaml` file on GitHub] for a full list of supported interfaces.

### Packaging

This charm is based on the CharmedPgBouncer K8s [rock image]. It packages:
* [pgbouncer `v.1.21`]
* [prometheus-pgbouncer-exporter `v.0.7.0`]

<!-- Topics -->
[All revisions]: /t/12261
[system requirements]: /t/12263

<!-- GitHub -->
[`/lib/charms` directory on GitHub]: https://github.com/canonical/pgbouncer-k8s-operator/tree/main/lib/charms
[`metadata.yaml` file on GitHub]: https://github.com/canonical/pgbouncer-k8s-operator/blob/main/metadata.yaml

<!-- Charmhub -->
[1/stable channel]: https://charmhub.io/pgbouncer-k8s?channel=1/stable

<!-- Snap/Rock -->
[`charmed-pgbouncer` packaging]: https://github.com/canonical/charmed-pgbouncer-rock

[snap Revision 3/4]: https://github.com/canonical/charmed-pgbouncer-snap/releases/tag/rev4
[rock image]: https://github.com/orgs/canonical/packages?repo_name=charmed-pgbouncer-rock

[pgbouncer `v.1.21`]: https://launchpad.net/~data-platform/+archive/ubuntu/pgbouncer
[prometheus-pgbouncer-exporter `v.0.7.0`]: https://launchpad.net/~data-platform/+archive/ubuntu/pgbouncer-exporter


<!-- Badges -->
[juju-2_amd64]: https://img.shields.io/badge/Juju_2.9.51-amd64-darkgreen?labelColor=ea7d56
[juju-3_amd64]: https://img.shields.io/badge/Juju_3.4.6-amd64-darkgreen?labelColor=E95420
[juju-3_arm64]: https://img.shields.io/badge/Juju_3.4.6-arm64-blue?labelColor=E95420
Loading