Skip to content

Commit

Permalink
Sync docs from Discourse (#766)
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[bot] authored Nov 19, 2024
1 parent 7903d93 commit 7be30f6
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 12 deletions.
28 changes: 17 additions & 11 deletions docs/how-to/h-deploy-canonical-k8s.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,30 @@
# How to deploy on Canonical Kubernetes

[Canonical Kubernetes](https://ubuntu.com/kubernetes) is built on Ubuntu and combines security with optimal price-performance. Canonical is a Certified Kubernetes Service Provider, your trusted advisor for a successful cloud native strategy. This manual shows you simplicity of deploying Charmed PostgreSQL K8s to Canonical Kubernetes.
[Canonical Kubernetes](https://ubuntu.com/kubernetes) is a Kubernetes service built on Ubuntu and optimized for most major public clouds.

This guide shows you how to deploy Charmed PostgreSQL K8s to Canonical Kubernetes.

## Summary
Assuming you have a spare hardware/VMs running Ubuntu 22.04 LTS (or newer). The only necessary steps will be:
* [Install Canonical Kubernetes](#heading--install-canonical-k8s)
* [Install Juju](#heading--install-juju)
* [Deploy Charmed PostgreSQL K8s](#heading--deploy-postgresql)
This guide assumes you have a spare hardware/VMs running Ubuntu 22.04 LTS (or newer).

* [Install Canonical Kubernetes](#install-canonical-kubernetes)
* [Install Juju](#install-juju)
* [Deploy Charmed PostgreSQL K8s](#deploy-charmed-postgresql-k8s)
---

<a href="#heading--install-canonical-k8s"><h2 id="heading--install-canonical-k8s">Install Canonical Kubernetes</h2></a>
## Install Canonical Kubernetes

Follow the [official and detailed guide](https://documentation.ubuntu.com/canonical-kubernetes/latest/src/snap/howto/install/snap/) or simply run:
>The following instructions are a complete but summarized version of the steps for installing Canonical K8s. For more thorough instructions and details, see the official Canonical Kubernetes documentation: [Install Canonical Kubernetes from a snap](https://documentation.ubuntu.com/canonical-kubernetes/latest/src/snap/howto/install/snap/).
Install, bootstrap, and check the status of Canonical K8s with the following commands:

```shell
sudo snap install k8s --edge --classic
sudo k8s bootstrap
sudo k8s status --wait-ready
```

Once Canonical K8s is up and running, [enable the local storage](https://documentation.ubuntu.com/canonical-kubernetes/latest/snap/tutorial/getting-started/#enable-local-storage) (or any another persistent volumes provider, to be used by [Juju Storage](https://juju.is/docs/juju/storage) later):
Once Canonical K8s is up and running, [enable local storage](https://documentation.ubuntu.com/canonical-kubernetes/latest/snap/tutorial/getting-started/#enable-local-storage) (or any another persistent volume provider, to be used by [Juju Storage](https://juju.is/docs/juju/storage) later):
```shell
sudo k8s enable local-storage
sudo k8s status --wait-ready
Expand All @@ -32,7 +37,8 @@ mkdir ~/.kube
sudo k8s config > ~/.kube/config
kubectl get namespaces # to test the credentials
```
<a href="#heading--install-juju"><h2 id="heading--install-juju">Install Juju</h2></a>

## Install Juju

Install Juju and bootstrap the first Juju controller in K8s:
```shell
Expand All @@ -41,7 +47,7 @@ juju add-k8s ck8s --client --context-name="k8s"
juju bootstrap ck8s
```

<a href="#heading--deploy-postgresql"><h2 id="heading--deploy-postgresql">Deploy Charmed PostgreSQL K8s</h2></a>
## Deploy Charmed PostgreSQL K8s

```shell
juju add-model postgresql
Expand All @@ -65,4 +71,4 @@ Unit Workload Agent Address Ports Message
postgresql-k8s/0* active idle 10.1.0.16 Primary
```

Follow the further steps in Tutorial [to scale your application](/t/9299), [relate with other applications](/t/9301) and [more](/t/9296)!
>**Next steps:** Learn [how to scale your application](/t/9299), [relate with other applications](/t/9301) and [more](/t/9296).
6 changes: 5 additions & 1 deletion docs/how-to/h-restore-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,8 @@ juju run postgresql-k8s/leader restore restore-to-time="YYYY-MM-DDTHH:MM:SSZ"

Your restore will then be in progress.

It’s also possible to restore to the latest point from a specific timeline by passing the ID of a backup taken on that timeline and `restore-to-time=latest` when requesting a restore.
It’s also possible to restore to the latest point from a specific timeline by passing the ID of a backup taken on that timeline and `restore-to-time=latest` when requesting a restore:

```shell
juju run postgresql-k8s/leader restore restore-to-time=latest
```
1 change: 1 addition & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ PostgreSQL is a trademark or registered trademark of PostgreSQL Global Developme
| 1 | reference | [Reference]() |
| 2 | r-overview | [Overview](/t/13977) |
| 2 | r-releases | [Release Notes](/t/11872) |
| 3 | r-revision-444-445 | [Revision 444/445](/t/15966) |
| 3 | r-revision-381-382 | [Revision 381/382](/t/15442) |
| 3 | r-revision-280-281 | [Revision 280/281](/t/14068) |
| 3 | r-revision-193 | [Revision 193](/t/13208) |
Expand Down
10 changes: 10 additions & 0 deletions docs/reference/r-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ For a given release, this table shows:

| 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] |
Expand All @@ -36,6 +37,13 @@ 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 444-445 (`14/stable`)

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

### Release 381-382 (`14/stable`)

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

<!-- LINKS -->
[445]: /t/15966
[444]: /t/15966
[382]: /t/15442
[381]: /t/15442
[281]: /t/14068
Expand Down
30 changes: 30 additions & 0 deletions docs/reference/r-revision-444-445.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
>Reference > Release Notes > [All revisions] > Revision 444/445
# Revision 444/445 (hotfix for 381/382)
<sub>12 November 2024</sub>

Dear community,

Canonical has released a hotfix for Charmed PostgreSQL K8s operator in the [14/stable channel]:
* Revision 444 is built for `amd64` on Ubuntu 22.04 LTS (postgresql-image r162)
* Revision 445 is built for `arm64` on Ubuntu 22.04 LTS (postgresql-image r162)

## Highlights

This is a hotfix release to add Juju 3.6 compatibility for the previous stable [revisions 381/382](/t/15442).

## Bugfixes and stability

* Fixed Juju 3.6 support - fixed Pebble 1.12+ compatibility ([DPE-5915](https://warthogs.atlassian.net/browse/DPE-5915))

## Known limitations

See the [Release Notes for Revisions 381/382](/t/15442).

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

<!-- LABELS-->
[All revisions]: /t/11872
[system requirements]: /t/11744

[14/stable channel]: https://charmhub.io/postgresql?channel=14/stable

0 comments on commit 7be30f6

Please sign in to comment.