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 #801

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions docs/how-to/h-restore-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ To restore a backup that was made from a *different* cluster, (i.e. cluster migr
- Access to S3 storage
- [Configured settings for S3 storage](/t/charmed-postgresql-k8s-how-to-configure-s3/9595?channel=14/stable)
- [Existing backups in your S3-storage](/t/charmed-postgresql-k8s-how-to-create-and-list-backups/9596?channel=14/stable)
- [Point-in-time recovery](#point-in-time-recovery) requires the following PostgreSQL charm revisions:
- 435+ for `arm64`
- 436+ for `amd64`
- [Point-in-time recovery](#point-in-time-recovery) requires the following PostgreSQL K8s charm revisions:
- 382+ for `arm64`
- 381+ for `amd64`

## Summary
* [List backups](#list-backups)
Expand Down
39 changes: 18 additions & 21 deletions docs/reference/r-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,16 @@ For a given release, this table shows:
> This charm still supports older versions of Juju down to 2.9. See the [Juju section of the system requirements](/t/) for more details
* Support for specific features

| Revision | PostgreSQL version | Juju version | [TLS encryption](/t/9685)* | [COS monitoring](/t/10600) | [Minor version upgrades](/t/) | [Cross-regional async replication](/t/) | [Point-in-time recovery](/t/)
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
| [444], [445] | 14.12 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] | ![check] |
| [381], [382] | 14.12 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] | ![check] |
| [280], [281] | 14.11 | `3.4.2+` | ![check] | ![check] | ![check] | ![check] |
| [193] | 14.10 | `3.4.2+` | ![check] | ![check] | ![check] | ![check] |
| [177] | 14.9 | `3.1.6+` | | ![check] | ![check] |
| [158] | 14.9 | `3.1.5+` | | ![check] | ![check] |
| [73] | 14.7 | `2.9.32+` | | |

<!--TODO: insert as first row
| [462], [463] | 14.12 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] | ![check] |
-->
| Revision | PostgreSQL version | Juju version | [TLS encryption](/t/9685)* | [COS monitoring](/t/10600) | [Minor version upgrades](/t/) | [Cross-regional async replication](/t/) | [Point-in-time recovery](/t/) | [PITR Timelines](/t/) |
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
| [462], [463] | 14.13 | `3.6.1+` | ![check] | ![check] | ![check] | ![check] | ![check] | ![check] |
| [444], [445] | 14.12 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] | ![check] | |
| [381], [382] | 14.12 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] | ![check] | |
| [280], [281] | 14.11 | `3.4.2+` | ![check] | ![check] | ![check] | ![check] | |
| [193] | 14.10 | `3.4.2+` | ![check] | ![check] | ![check] | ![check] | |
| [177] | 14.9 | `3.1.6+` | | ![check] | ![check] | |
| [158] | 14.9 | `3.1.5+` | | ![check] | ![check] | |
| [73] | 14.7 | `2.9.32+` | | | |

**TLS encryption***: Support for **`v2` or higher** of the [`tls-certificates` interface](https://charmhub.io/tls-certificates-interface/libraries/tls_certificates). This means that you can integrate with [modern TLS charms](https://charmhub.io/topics/security-with-x-509-certificates).

Expand All @@ -40,24 +37,22 @@ 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).

<!-- TODO: Fill in arch columns and remove "14/stable" from previous table
### Release 462-463 (`14/stable`)
### Release 462-463

| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
|:--------:|:-----:|:-----:|:-----:|
|[462] | | | ![check] |
|[463] | | | ![check] |
--->
|[462] | ![check] | | ![check] |
|[463] | | ![check] | ![check] |

### Release 444-445 (`14/stable`)
[details=Older releases]
### Release 444-445

| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
|:--------:|:-----:|:-----:|:-----:|
|[445] | | ![check] | ![check] |
|[444] | ![check] | | ![check] |

[details=Older releases]
### Release 381-382 (`14/stable`)
### Release 381-382

| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
|:--------:|:-----:|:-----:|:-----:|
Expand Down Expand Up @@ -106,6 +101,8 @@ For a list of all plugins supported for each revision, see the reference page [P
[/note]

<!-- LINKS -->
[462]: /t/16008
[463]: /t/16008
[445]: /t/15966
[444]: /t/15966
[382]: /t/15442
Expand Down
28 changes: 14 additions & 14 deletions docs/reference/r-revision-462-463.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
>Reference > Release Notes > [All revisions] > Revision 462/463

[note type=caution]
This page is a work in progress for a **future release**. Please revisit at a later date!
[/note]

# Revision 462/463
<sub><TODO></sub>
<sub>December 18, 2024</sub>

Canonical's newest Charmed PostgreSQL K8s operator has been published in the [14/stable channel].
Canonical's newest Charmed PostgreSQL K8s operator has been published in the `14/stable` channel.

Due to the newly added support for `arm64` architecture, the PostgreSQL charm now releases multiple revisions simultaneously:
* Revision <TODO> is built for `amd64` on Ubuntu 22.04 LTS
* Revision <TODO> is built for `arm64` on Ubuntu 22.04 LTS
* Revision 462 is built for `amd64` on Ubuntu 22.04 LTS
* Revision 463 is built for `arm64` on Ubuntu 22.04 LTS

> See also: [How to perform a minor upgrade]

Expand All @@ -25,13 +21,15 @@ Due to the newly added support for `arm64` architecture, the PostgreSQL charm no
---

## Highlights
* Upgraded PostgreSQL from v.14.12 → v.14.13
* Check the official [PostgreSQL release notes](https://www.postgresql.org/docs/release/14.13/)
* Added timeline management to point-in-time recovery (PITR) ([PR #716](https://github.com/canonical/postgresql-k8s-operator/pull/716)) ([DPE-5581](https://warthogs.atlassian.net/browse/DPE-5581))
* Added pgAudit plugin/extension ([PR #688](https://github.com/canonical/postgresql-k8s-operator/pull/688)) ([DPE-5116](https://warthogs.atlassian.net/browse/DPE-5116))
* Observability stack (COS) improvements
* Polished built-in Grafana dashboard ([PR #733](https://github.com/canonical/postgresql-k8s-operator/pull/733)) ([DPE-4469](https://warthogs.atlassian.net/browse/DPE-4469))
* Improved COS alert rule descriptions ([PR #727](https://github.com/canonical/postgresql-k8s-operator/pull/727)) ([DPE-5658](https://warthogs.atlassian.net/browse/DPE-5658))
* Added fully-featured terraform module ([PR #737](https://github.com/canonical/postgresql-k8s-operator/pull/737)) ([DPE-5627](https://warthogs.atlassian.net/browse/DPE-5627))
* Several S3 improvements ([PR #750](https://github.com/canonical/postgresql-k8s-operator/pull/750))
* S3 backups improvements ([PR #750](https://github.com/canonical/postgresql-k8s-operator/pull/750))

## Features and improvements
* Removed patching of private ops class. ([PR #692](https://github.com/canonical/postgresql-k8s-operator/pull/692))
Expand Down Expand Up @@ -76,19 +74,21 @@ Due to the newly added support for `arm64` architecture, the PostgreSQL charm no
[/details]

## Known limitations
...
<TODO>

* [Juju 3.6.1+](https://discourse.charmhub.io/t/roadmap-releases/5064#juju-juju-361-11-dec-2024-2) is required for [Terraform-Provider-Juju](https://github.com/juju/terraform-provider-juju) consistent usage ([more details here](https://github.com/juju/terraform-provider-juju/issues/608)).

## Requirements and compatibility
* (no change) Minimum Juju 2 version: `v.2.9.49`
* (no change) Minimum Juju 3 version: `v.3.4.3`
* (increased) Recommended Juju 3 version: `v.3.6.1`

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

### Integration tests
Below are some of the charm integrations tested with this revision on different Juju environments and architectures:
* Juju `v.2.9.51` on `amd64`
* Juju `v.3.4.6` on `amd64` and `arm64`
* Juju `v.3.6.1` on `amd64` and `arm64`

| Software | Revision | Tested on | |
|-----|-----|----|---|
Expand All @@ -108,10 +108,10 @@ Below are some of the charm integrations tested with this revision on different
| [discourse-k8s] | `rev 173` | ![juju-2_amd64] ![juju-3_amd64] |

### Packaging
This charm is based on the Charmed PostgreSQL K8s [ROCK <TODO>]. It packages:
* [postgresql] `v.14.12`
This charm is based on the Charmed PostgreSQL K8s ROCK revision `164`. It packages:
* [postgresql] `v.14.13`
* [pgbouncer] `v.1.21`
* [patroni] `v.3.1.2 `
* [patroni] `v.3.1.2`
* [pgBackRest] `v.2.53`
* [prometheus-postgres-exporter] `v.0.12.1`

Expand Down
5 changes: 3 additions & 2 deletions docs/reference/r-system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The charm supports several Juju releases from [2.9 LTS](https://juju.is/docs/juj

| Juju major release | Supported minor versions | Compatible charm revisions |Comment |
|:--------|:-----|:-----|:-----|
| ![3.6 LTS] | `3.6.0-beta2` | [280]+ | No known issues, but still in beta. Not recommended for production. |
| ![3.6 LTS] | `3.6.1+` | [444/445]+ | Recommended for production. |
| [![3.5]](https://juju.is/docs/juju/roadmap#juju-juju-35) | `3.5.1+` | [280]+ | [Known Juju issue](https://bugs.launchpad.net/juju/+bug/2066517) in `3.5.0` |
| [![3.4]](https://juju.is/docs/juju/roadmap#juju-juju-34) | `3.4.3+` | [280]+ | Know Juju issues with previous minor versions |
| [![3.3]](https://juju.is/docs/juju/roadmap#juju-juju-33) | `3.3.0+` | from [177] to [193] | No known issues |
Expand Down Expand Up @@ -61,4 +61,5 @@ At the moment IPv4 is supported only (see more [info](https://warthogs.atlassian
[73]: /t/11873
[177]: /t/12668
[193]: /t/13208
[280]: /t/14068
[280]: /t/14068
[444/445]: /t/15966
2 changes: 1 addition & 1 deletion docs/tutorial/t-set-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ All necessary components have been pre-installed inside the VM already, like Mic

<a href="#heading--juju"><h2 id="heading--juju"> Set up Juju </h2></a>

Let's bootstrap Juju to use the local MicroK8s controller:
Let's bootstrap Juju to use the local MicroK8s controller. We will call it "overlord", but you can give it any name you'd like.
```shell
juju bootstrap microk8s overlord
```
Expand Down
Loading