Skip to content

Commit

Permalink
[discourse-gatekeeper] Migrate charm docs (#534)
Browse files Browse the repository at this point in the history
* 'modified: docs/reference/r-releases-group/r-releases-rev280.md,docs/reference/r-system-requirements.md,docs/reference/r-releases-group/r-releases-rev158.md,docs/reference/r-releases-group/r-releases-rev193.md,docs/reference/r-releases-group/r-releases-rev177.md'

* 'modified: docs/how-to/h-set-up/h-deploy-microk8s.md'

* 'modified: docs/reference/r-releases-group/r-releases-rev280.md,docs/reference/r-releases-group/r-releases.md,docs/index.md'

---------

Co-authored-by: upload-charms-docs-bot <[email protected]>
Co-authored-by: discourse-gatekeeper-docs-bot <[email protected]>
  • Loading branch information
3 people authored Jul 1, 2024
1 parent 4410352 commit dd453ee
Show file tree
Hide file tree
Showing 8 changed files with 101 additions and 10 deletions.
7 changes: 6 additions & 1 deletion docs/how-to/h-set-up/h-deploy-microk8s.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# How to deploy on MicroK8s

[MicroK8s](https://microk8s.io/docs) is a lightweight Kubernetes engine created by Canonical.
This guide goes shows you how to deploy Charmed PostgreSQL on [MicroK8s](https://microk8s.io/docs), Canonical's lightweight Kubernetes engine.

## Prerequisites
* Charmed PostgreSQL K8s Revision 73+
* Canonical MicroK8s 1.27+
* Fulfill the general [system requirements](/t/11744)

## Summary
* [MicroK8s on Multipass](#heading--multipass)
Expand Down
76 changes: 76 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,79 @@ Charmed PostgreSQL K8s is an official distribution of PostgreSQL. It’s an open
The Charmed PostgreSQL Operator is distributed under the [Apache Software Licence version 2.0](https://github.com/canonical/postgresql-operator/blob/main/LICENSE). It depends on [PostgreSQL](https://www.postgresql.org/ftp/source/), which is licensed under the [PostgreSQL License](https://www.postgresql.org/about/licence/) - a liberal open-source licence similar to the BSD or MIT licences.

PostgreSQL is a trademark or registered trademark of PostgreSQL Global Development Group. Other trademarks are the property of their respective owners.

# Contents

1. [Tutorial](tutorial)
1. [Overview](tutorial/t-overview.md)
1. [1. Set up the environment](tutorial/t-set-up.md)
1. [2. Deploy PostgreSQL](tutorial/t-deploy.md)
1. [3. Access PostgreSQL](tutorial/t-access.md)
1. [4. Scale replicas](tutorial/t-scale.md)
1. [5. Manage passwords](tutorial/t-passwords.md)
1. [6. Integrate with other applications](tutorial/t-integrate.md)
1. [7. Enable TLS](tutorial/t-enable-tls.md)
1. [8. Clean up environment](tutorial/t-clean-up.md)
1. [How-to guides](how-to)
1. [Set up](how-to/h-set-up)
1. [Deploy on MicroK8s](how-to/h-set-up/h-deploy-microk8s.md)
1. [Deploy on GKE](how-to/h-set-up/h-deploy-gke.md)
1. [Deploy on EKS](how-to/h-set-up/h-deploy-eks.md)
1. [Deploy on AKS](how-to/h-set-up/h-deploy-aks.md)
1. [Scale units](how-to/h-set-up/h-scale.md)
1. [Enable TLS](how-to/h-set-up/h-enable-tls.md)
1. [Manage client applications](how-to/h-set-up/h-manage-client.md)
1. [Back up and restore](how-to/h-backups)
1. [Configure S3 AWS](how-to/h-backups/h-configure-s3-aws.md)
1. [Configure S3 RadosGW](how-to/h-backups/h-configure-s3-radosgw.md)
1. [Create a backup](how-to/h-backups/h-create-backup.md)
1. [Restore a backup](how-to/h-backups/h-restore-backup.md)
1. [Manage backup retention](how-to/h-backups/h-manage-backup-retention.md)
1. [Migrate a cluster](how-to/h-backups/h-migrate-cluster.md)
1. [Monitoring (COS)](how-to/h-monitor)
1. [Enable monitoring](how-to/h-monitor/h-enable-monitoring.md)
1. [Enable Alert Rules](how-to/h-monitor/h-enable-alert-rules.md)
1. [Upgrade](how-to/h-upgrade)
1. [Overview](how-to/h-upgrade/h-upgrade-intro.md)
1. [Perform a major upgrade](how-to/h-upgrade/h-upgrade-major.md)
1. [Perform a major rollback](how-to/h-upgrade/h-rollback-major.md)
1. [Perform a minor upgrade](how-to/h-upgrade/h-upgrade-minor.md)
1. [Perform a minor rollback](how-to/h-upgrade/h-rollback-minor.md)
1. [Connect your charm](how-to/h-connect-your-charm)
1. [Integrate a database with your charm](how-to/h-connect-your-charm/h-integrate-with-your-charm.md)
1. [Migrate data via...](how-to/h-connect-your-charm/h-connect-migrate)
1. [...pg_dump](how-to/h-connect-your-charm/h-connect-migrate/h-connect-migrate-pgdump.md)
1. [...backup/restore](how-to/h-connect-your-charm/h-connect-migrate/h-connect-migrate-backup-restore.md)
1. [Cross-regional async replication](how-to/h-async)
1. [Set up clusters](how-to/h-async/h-async-set-up.md)
1. [Integrate with a client app](how-to/h-async/h-async-integrate.md)
1. [Remove or recover a cluster](how-to/h-async/h-async-remove-recover.md)
1. [Enable plugins/extensions](how-to/h-enable-plugins-extensions.md)
1. [Reference](reference)
1. [Overview](reference/r-overview.md)
1. [Release Notes](reference/r-releases-group)
1. [All releases](reference/r-releases-group/r-releases.md)
1. [Revision 280/281](reference/r-releases-group/r-releases-rev280.md)
1. [Revision 193](reference/r-releases-group/r-releases-rev193.md)
1. [Revision 177](reference/r-releases-group/r-releases-rev177.md)
1. [Revision 158](reference/r-releases-group/r-releases-rev158.md)
1. [Revision 73](reference/r-releases-group/r-releases-rev73.md)
1. [System requirements](reference/r-system-requirements.md)
1. [Software testing](reference/r-software-testing.md)
1. [Performance and resource allocation](reference/r-performance.md)
1. [Troubleshooting](reference/h-troubleshooting.md)
1. [Plugins/extensions](reference/r-plugins-extensions.md)
1. [Contacts](reference/r-contacts.md)
1. [Explanation](explanation)
1. [Architecture](explanation/e-architecture.md)
1. [Interfaces/endpoints](explanation/e-interfaces-endpoints.md)
1. [Statuses](explanation/e-statuses.md)
1. [Users](explanation/e-users.md)
1. [Logs](explanation/e-logs.md)
1. [Juju](explanation/e-juju-details.md)
1. [Legacy charm](explanation/e-legacy-charm.md)
1. [Flowcharts](explanation/flowcharts)
1. [Charm](explanation/flowcharts/e-flowchart-charm.md)
1. [Relations](explanation/flowcharts/e-flowchart-peers.md)
1. [Backups](explanation/flowcharts/e-flowchart-backups.md)
1. [Search](https://canonical.com/data/docs/postgresql/k8s)
3 changes: 2 additions & 1 deletion docs/reference/r-releases-group/r-releases-rev158.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ Canonical Data issues are now public on both [Jira](https://warthogs.atlassian.n

* `juju refresh` from the old-stable revision 73 to the current-revision 158 is **NOT** supported!!!<br/>The [upgrade](/t/12092) functionality is new and supported for revision 158+ only!
* Please check [the external components requirements](/t/11744)
* Please check additionally [the previously posted restrictions](/t/11873).
* Please check additionally [the previously posted restrictions](/t/11873)
* Ensure [the charm requirements](/t/11744) met

## Contact us

Expand Down
1 change: 1 addition & 0 deletions docs/reference/r-releases-group/r-releases-rev177.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Canonica Data issues are now public on both [Jira](https://warthogs.atlassian.ne
* Use this operator together with a modern operator "[pgBouncer K8s](https://charmhub.io/pgbouncer-k8s)"
* Please check [the external components requirements](/t/11744)
* Please check additionally [the previously posted restrictions](/t/11872)
* Ensure [the charm requirements](/t/11744) met

## Contact us

Expand Down
1 change: 1 addition & 0 deletions docs/reference/r-releases-group/r-releases-rev193.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Canonical Data issues are now public on both [Jira](https://warthogs.atlassian.n
* It is recommended to use this operator together with modern [Charmed PgBouncer operator](https://charmhub.io/pgbouncer-k8s?channel=1/stable)
* Please check [the external components requirements](/t/11744)
* Please check [the previously posted restrictions](/t/11872)
* Ensure [the charm requirements](/t/11744) met

## Contact us

Expand Down
5 changes: 3 additions & 2 deletions docs/reference/r-releases-group/r-releases-rev280.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
>Reference > Release Notes > [All revisions](/t/11872) > Revision 280/281
# Revision 280/281 (`14/candidate` only)
# Revision 280/281

<sub>TODO: DD, MM, YYYY</sub>
<sub>June 28, 2024</sub>

Dear community,

Expand Down Expand Up @@ -76,6 +76,7 @@ Canonical Data issues are now public on both [Jira](https://warthogs.atlassian.n
* It is recommended to use this operator together with modern [Charmed PgBouncer K8s operator](https://charmhub.io/pgbouncer-k8s?channel=1/stable)
* Please check [the external components requirements](https://charmhub.io/postgresql-k8s/docs/r-requirements)
* Please check [previously posted restrictions](https://charmhub.io/postgresql-k8s/docs/r-releases)
* Ensure [the charm requirements](/t/11744) met

## Contact us

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/r-releases-group/r-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Here you will find release notes for the main revisions of this charm that are a

| Channel | amd64 | arm64 |
|:--------------:|:-----:|:----:|
| `14/candidate` | [281](/t/14068) | [280](/t/14068) |
| `14/stable` | [193](/t/13208) | - |
| | [177](/t/12668) | - |
| | [158](/t/11874) | - |
| | [73](/t/11873) | - |
| `14/stable` | [281](/t/14068) | [280](/t/14068) |
| | [193](/t/13208) | - |
| | [177](/t/12668) | - |
| | [158](/t/11874) | - |
| | [73](/t/11873) | - |
8 changes: 7 additions & 1 deletion docs/reference/r-system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,10 @@ The charm is based on the [charmed-postgresql snap](https://snapcraft.io/charmed

The charm is based on the [ROCK OCI](https://github.com/canonical/charmed-postgresql-rock) named [`charmed-postgresql`](https://github.com/canonical/charmed-postgresql-rock/pkgs/container/charmed-postgresql).

[Contact us](https://chat.charmhub.io/charmhub/channels/data-platform) if you are interested in new architecture!
[Contact us](/t/11852) if you are interested in new architecture!

## Networking

At the moment IPv4 is supported only (see more [info](https://warthogs.atlassian.net/browse/DPE-4695)).

[Contact us](/t/11852) if you are interested in IPv6!

0 comments on commit dd453ee

Please sign in to comment.