Skip to content

Commit

Permalink
Sync docs from Discourse (#591)
Browse files Browse the repository at this point in the history 
Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
@github-actions
github-actions[bot] authored Aug 22, 2024
1 parent 99788f0 commit c9216a7
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/explanation/e-statuses.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The charm follows [standard Juju applications statuses](https://juju.is/docs/olm
| **active** | any | Normal charm operations | No actions required |
| **waiting** | any | Charm is waiting for relations to be finished | No actions required |
| **maintenance** | any | Charm is performing the internal maintenance (e.g. cluster re-configuration, upgrade, ...) | No actions required |
| **blocked** | the S3 repository has backups from another cluster | The bucket contains foreign backup. To avoid accident DB corruption, use clean bucket. The cluster identified by Juju app name + DB UUID. | Chose/change the new S3 [bucket](https://charmhub.io/s3-integrator/configuration#bucket)/[path](https://charmhub.io/s3-integrator/configuration#path) OR clean the current one. |
| **blocked** | the S3 repository has backups from another cluster | The bucket contains foreign backup. To avoid accident DB corruption, use clean bucket. The cluster identified by Juju app name + DB UUID. | Choose/change the new S3 [bucket](https://charmhub.io/s3-integrator/configuration#bucket)/[path](https://charmhub.io/s3-integrator/configuration#path) OR clean the current one. |
| **blocked** | failed to update cluster members on member | TODO: error/retry? | |
| **blocked** | failed to install snap packages | There are issues with the network connection and/or the Snap Store | Check your internet connection and https://status.snapcraft.io/. Remove the application and when everything is ok, deploy the charm again |
| **blocked** | failed to patch snap seccomp profile | The charm failed to patch one issue that happens when pgBackRest restores a backup (this blocked status should be removed when https://github.com/pgbackrest/pgbackrest/releases/tag/release%2F2.46 is added to the snap) | Remove the unit and add it back again |
Expand Down
19 changes: 12 additions & 7 deletions docs/reference/r-releases.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ The table below is a high-level overview of the architectures and integrations t

| Revision | amd64 | arm64 | [TLS encryption](/t/9685)* | [Monitoring (COS, Grafana)](/t/10600) | [Tracing (Tempo K8s)](/t/14521) |
|:--------:|:-----:|:-----:|:--------------------:|:---------------:|:--------------------:|
| [430](/t/14067) | :heavy_multiplication_x: |:white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [429](/t/14067) | :white_check_mark: | :heavy_multiplication_x: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [363](/t/13124) | :white_check_mark: | :heavy_multiplication_x: | :white_check_mark: | :white_check_mark: | :heavy_multiplication_x: |
| [351](/t/12823) | :white_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :white_check_mark: | :heavy_multiplication_x: |
| [336](/t/11877) | :white_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :white_check_mark: | :heavy_multiplication_x: |
| [288](/t/11876) | :white_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
| [430](/t/14067) | | ![check] | ![check] | ![check] | ![check] |
| [429](/t/14067) | ![check] | | ![check] | ![check] | ![check] |
| [363](/t/13124) | ![check] | | ![check] | ![check] | |
| [351](/t/12823) | ![check] | | | ![check] | |
| [336](/t/11877) | ![check] | | | ![check] | |
| [288](/t/11876) | ![check] | | | | |



**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 @@ -24,4 +25,8 @@ For more details about each feature/interface, refer to their dedicated How-To g

### Plugins/extensions

For a list of all plugins supported for each revision, see the reference page [Plugins/extensions](/t/10946).
For a list of all plugins supported for each revision, see the reference page [Plugins/extensions](/t/10946).

<!-- BADGES -->
[check]: https://img.shields.io/badge/%E2%9C%93-brightgreen
[cross]: https://img.shields.io/badge/x-white
4 changes: 1 addition & 3 deletions docs/reference/r-revision-288.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ Charmed PostgreSQL is an open source project that warmly welcomes community cont

* Raise software issues or feature requests on [**GitHub**](https://github.com/canonical/postgresql-operator/issues/new/choose)
* Report security issues through [**Launchpad**](https://wiki.ubuntu.com/DebuggingSecurity#How%20to%20File)
* Contact the Canonical Data Platform team through our [Matrix](https://matrix.to/#/#charmhub-data-platform:ubuntu.com) channel.


* Contact the Canonical Data Platform team through our [Matrix](https://matrix.to/#/#charmhub-data-platform:ubuntu.com) channel!

<!--The document was originally posted [here](https://discourse.charmhub.io/t/juju-operators-for-postgresql-and-mysql-are-now-stable/10223).-->
6 changes: 2 additions & 4 deletions docs/reference/r-revision-429.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ juju deploy postgresql --constraints arch=<arch>
```
where `<arch>` can be `amd64` or `arm64`.

[note]
If you are jumping over several stable revisions, check [previous release notes](/t/11875) before upgrading.
[/note]

---

## Highlights
Expand Down Expand Up @@ -64,6 +60,8 @@ For a full list of all changes in this revision, see the [GitHub Release](https:
## Technical details
This section contains some technical details about the charm's contents and dependencies. Make sure to also check the [system requirements](/t/11743).

If you are jumping over several stable revisions, check [previous release notes](/t/11875) before upgrading.

### Packaging
This charm is based on the [`charmed-postgresql` snap](https://snapcraft.io/charmed-postgresql) (pinned revision 113). It packages:
* postgresql `v.14.11`
Expand Down
36 changes: 29 additions & 7 deletions docs/reference/r-system-requirements.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,20 @@ The following are the minimum software and hardware requirements to run Charmed
## Software
* Ubuntu 22.04 (Jammy) or later.

The minimum supported Juju versions are:
### Juju

* 2.9.32+ (older versions are untested).
* 3.1.7+ (Juju secrets were stabilized in `v.3.1.7`)
The charm supports several Juju releases from [2.9 LTS](https://juju.is/docs/juju/roadmap#juju-juju-29) onwards. The table below shows which minor versions of each major Juju release are supported by the stable Charmhub releases of PostgreSQL.

[note type="caution"]
**Note**: Juju 3.1 is supported from the charm revision 315+
[/note]
| Juju major release | Supported minor versions | Compatible charm revisions |Comment |
|:--------|:-----|:-----|:-----|
| ![3.6 LTS] | `3.6.0-beta1` | [363]+ | No known issues, but still in beta. Not recommended for production. |
| [![3.5]](https://juju.is/docs/juju/roadmap#juju-juju-35) | `3.5.1+` | [363]+ | [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+` | [363]+ | Know Juju issues with previous minor versions |
| [![3.3]](https://juju.is/docs/juju/roadmap#juju-juju-33) | `3.3.0+` | from [363] to [430] | No known issues |
| [![3.2]](https://juju.is/docs/juju/roadmap#juju-juju-32) | `3.2.0+` | from [363] to [430] | No known issues |
| [![3.1]](https://juju.is/docs/juju/roadmap#juju-juju-31) | `3.1.7+` | from [336] to [430] | Juju secrets were stabilized in `3.1.7` |
| [![2.9 LTS]](https://juju.is/docs/juju/roadmap#juju-juju-29) | `2.9.49+` | [288]+ | |
| | `2.9.32+` | from [288] to [430] | No tests for older Juju versions. |

## Hardware

Expand All @@ -32,4 +38,20 @@ The charm is based on the [charmed-postgresql snap](https://snapcraft.io/charmed
* Access to the internet is required for downloading required snaps and charms
* Only IPv4 is supported at the moment
* See more information about this limitation in [this Jira issue](https://warthogs.atlassian.net/browse/DPE-4695)
* [Contact us](/t/11863) if you are interested in IPv6!
* [Contact us](/t/11863) if you are interested in IPv6!

<!-- BADGES -->

[2.9 LTS]: https://img.shields.io/badge/2.9_LTS-%23E95420?label=Juju
[3.1]: https://img.shields.io/badge/3.1-%23E95420?label=Juju
[3.2]: https://img.shields.io/badge/3.2-%23E95420?label=Juju
[3.3]: https://img.shields.io/badge/3.3-%23E95420?label=Juju
[3.4]: https://img.shields.io/badge/3.4-%23E95420?label=Juju
[3.5]: https://img.shields.io/badge/3.5-%23E95420?label=Juju
[3.6 LTS]: https://img.shields.io/badge/3.6_LTS-%23E95420?label=Juju

<!-- LINKS -->
[288]: /t/11876
[336]: /t/11877
[363]: /t/13124
[430]: /t/14067

0 comments on commit c9216a7

Please sign in to comment.