Skip to content

Commit

Permalink
[discourse-gatekeeper] Migrate charm docs (#631)
Browse files Browse the repository at this point in the history
* 'modified: docs/reference/r-system-requirements.md,docs/how-to/h-upgrade/h-upgrade-minor.md,docs/how-to/h-set-up/h-deploy-aks.md'

* 'modified: docs/explanation/flowcharts/e-flowchart-charm.md'

---------

Co-authored-by: discourse-gatekeeper-docs-bot <[email protected]>
  • Loading branch information
github-actions[bot] and discourse-gatekeeper-docs-bot authored Aug 20, 2024
1 parent da10ce6 commit 2998706
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/explanation/flowcharts/e-flowchart-charm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The file `charm.py` is the entrypoint for the charm. It contains functions for i
These flowcharts detail the control flow of the hooks in this program. Unless otherwise stated, **a hook deferral is always followed by a return**.

## Leader Elected Hook
[Click to navigate the mermaid diagram on GitHub](https://github.com/canonical/postgresql-k8s-operator/blob/main/docs/explanation/e-charm.md).
[Click to navigate the mermaid diagram on GitHub](https://github.com/canonical/postgresql-k8s-operator/blob/e760a3df8ceceab49357ff57c620299d9d101fc8/docs/explanation/flowcharts/e-flowchart-charm.md).

```mermaid
flowchart TD
Expand All @@ -34,7 +34,7 @@ flowchart TD
```

## PostgreSQL Pebble Ready Hook
[Click to navigate the mermaid diagram on GitHub](https://github.com/canonical/postgresql-k8s-operator/blob/main/docs/explanation/e-charm.md).
[Click to navigate the mermaid diagram on GitHub](https://github.com/canonical/postgresql-k8s-operator/blob/e760a3df8ceceab49357ff57c620299d9d101fc8/docs/explanation/flowcharts/e-flowchart-charm.md).

```mermaid
flowchart TD
Expand Down
8 changes: 3 additions & 5 deletions docs/how-to/h-set-up/h-deploy-aks.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,12 @@ juju model-config logging-config='<root>=INFO;unit=DEBUG'

The following command deploys PostgreSQL K8s:

> **Important**: AKS supported for charm revision 247+ currently in the channel `14/candidate` only.
```shell
juju deploy postgresql-k8s --trust -n 3 --channel 14/candidate
juju deploy postgresql-k8s --trust -n 3 --channel 14/stable
```
Sample output:
```shell
Deployed "postgresql-k8s" from charm-hub charm "postgresql-k8s", revision 247 in channel 14/candidate on [email protected]/stable
Deployed "postgresql-k8s" from charm-hub charm "postgresql-k8s", revision 247 in channel 14/stable on [email protected]/stable
```

Check the status:
Expand All @@ -151,7 +149,7 @@ Model Controller Cloud/Region Version SLA Timestamp
welcome aks aks/eastus 3.4.2 unsupported 17:53:35+02:00

App Version Status Scale Charm Channel Rev Address Exposed Message
postgresql-k8s 14.11 active 3 postgresql-k8s 14/candidate 247 10.0.237.223 no Primary
postgresql-k8s 14.11 active 3 postgresql-k8s 14/stable 247 10.0.237.223 no Primary

Unit Workload Agent Address Ports Message
postgresql-k8s/0* active idle 10.244.0.19 Primary
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to/h-upgrade/h-upgrade-minor.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@ Example with channel selection and juju 3.x:
```shell
juju refresh postgresql-k8s --channel 14/edge --trust
```
Example with specific revision selection:
Example with specific revision selection (do NOT miss OCI resource!):
```shell
juju refresh postgresql-k8s --revision=189
juju refresh postgresql-k8s --revision=189 --resource postgresql-image=...
```

### Important Notes
Expand Down
21 changes: 11 additions & 10 deletions docs/reference/r-system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,17 @@ The following are the minimum software and hardware requirements to run Charmed

### Juju

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 minimum supported Juju versions are:

* 2.9.32+ (no tests made for older versions).
* 3.1.7+ (Juju secrets refactored/stabilized in Juju 3.1.7)

[note type="caution"]
**Note**: Juju 3.1 is supported from the charm revision 116+
[/note]
The charm supports both [Juju 2.9 LTS](https://github.com/juju/juju/releases) and [Juju 3.x](https://github.com/juju/juju/releases) with the following conditions:

| Juju Releases | Juju Supported | Min charm revision |Comment |
|:--------|:-----|:-----|:-----|
| 2.9 LTS | 2.9.32+ | 73+ | no tests made for older versions |
| 3.1 | 3.1.7+ | 193+ | Juju secrets refactored/stabilized in Juju 3.1.7 |
| 3.2 | 3.2.0+ | 280+ | no known issues |
| 3.3 | 3.3.0+ | 280+ | no known issues |
| 3.4 | 3.4.3+ | 280+ | know Juju issues with previous versions |
| 3.5 | 3.5.1+ | 280+ | [known](https://bugs.launchpad.net/juju/+bug/2066517) Juju issue in 3.5.0 |
| 3.6 LTS | 3.6.0-beta1 | 280+ | LAB TESTS ONLY! No known issues. |

### Kubernetes

Expand Down

0 comments on commit 2998706

Please sign in to comment.