Skip to content

Commit 2dc18e5

Browse files
Update landing page
1 parent ebb8757 commit 2dc18e5

File tree

3 files changed

+39
-19
lines changed

3 files changed

+39
-19
lines changed

docs/how-to/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Other deployment scenarios and configurations:
4646
## Refresh (upgrade)
4747
* [How to refresh]
4848
* [Perform a minor upgrade]
49-
* [Perform a minor rollback]
49+
* [Roll back an in-progress refresh]
5050

5151
## Cross-regional (cluster-cluster) async replication
5252

@@ -103,7 +103,7 @@ This section is for charm developers looking to support PostgreSQL integrations
103103

104104
[How to upgrade]: /how-to/refresh/index
105105
[Perform a minor upgrade]: /how-to/refresh/minor-upgrade
106-
[Perform a minor rollback]: /how-to/refresh/minor-rollback
106+
[Roll back an in-progress refresh]: /how-to/refresh/rollback
107107

108108
[Cross-regional async replication]: /how-to/cross-regional-async-replication/index
109109
[Set up clusters]: /how-to/cross-regional-async-replication/set-up-clusters

docs/how-to/refresh/index.md

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,55 @@
11
# Refresh (upgrade)
22

3-
Charmed PostgreSQL supports minor {term}`in-place` {term}`refresh` via the [`juju refresh`](https://documentation.ubuntu.com/juju/3.6/reference/juju-cli/list-of-juju-cli-commands/refresh/#details) command.
4-
53
```{admonition} Emergency stop button
64
:class: attention
7-
Use `juju config appname pause-after-unit-refresh=all` to halt an in-progress refresh
5+
Use `juju config appname pause-after-unit-refresh=all` to halt an in-progress refresh. Then, consider [rolling back](/how-to/refresh/rollback)
86
```
97

10-
## Supported refreshes
8+
Charmed PostgreSQL supports minor {term}`in-place` {term}`refresh` via the [`juju refresh`](https://documentation.ubuntu.com/juju/3.6/reference/juju-cli/list-of-juju-cli-commands/refresh/#details) command.
119

12-
**Minor in-place {term}`upgrade`** between stable releases.
13-
E.g. PostgreSQL 16.9 is upgraded to 16.10
10+
## Recommended refreshes
1411

15-
> See [How to perform a minor upgrade](/how-to/refresh/minor-upgrade)
12+
These refreshes are well-tested and should be preferred.
1613

17-
**Minor in-place {term}`rollback`** between stable releases.
18-
E.g. An upgrade from PostgreSQL 16.9 -> 16.10 fails, so a rollback is triggered to take all units from 16.10 back to 16.9.
14+
```{eval-rst}
15+
+-------------+------------+------------+------------+
16+
| .. centered:: From | .. centered:: To |
17+
+-------------+------------+------------+------------+
18+
| Revision | PostgreSQL | Revision | PostgreSQL |
19+
| | Version | | Version |
20+
+=============+============+============+============+
21+
| `843, 844`_ | 16.9 | TODO | 16.9 |
22+
+-------------+------------+------------+------------+
1923
20-
> See [How to perform a minor rollback](/how-to/refresh/minor-rollback)
24+
.. _843, 844: https://github.com/canonical/postgresql-operator/releases/tag/v16%2F1.59.0
25+
```
2126

22-
<!-- TODO: Add when new stable: * Minor in-place upgrade from Revision X to Y -->
27+
## Supported refreshes
2328

24-
Check all available Charmed PostgreSQL 16 versions in [](/reference/releases).
29+
These refreshes should be supported. If possible, use a [recommended refresh](#recommended-refreshes) instead.
30+
31+
```{eval-rst}
32+
+-------------+------------+------------+------------+
33+
| .. centered:: From | .. centered:: To |
34+
+-------------+------------+------------+------------+
35+
| Revision | PostgreSQL | Revision | PostgreSQL |
36+
| | Version | | Version |
37+
+=============+============+============+============+
38+
| `843, 844`_ | 16.9 | TODO | 16.9 |
39+
| | +------------+------------+
40+
| | | TODO | 16.10 |
41+
+-------------+------------+------------+------------+
42+
43+
.. _843, 844: https://github.com/canonical/postgresql-operator/releases/tag/v16%2F1.59.0
44+
```
2545

2646
## Non-supported refreshes
47+
These refreshes are not supported {term}`in-place`. In some of these cases, it may be possible to perform an out-of-place upgrade or downgrade.
48+
2749
* Minor in-place {term}`downgrade` from PostgreSQL 16.10 to 16.9
2850
* Major in-place {term}`upgrade` from PostgreSQL 14 to 16
2951
* Major in-place {term}`downgrade` from PostgreSQL 16 to 14
30-
* Any refresh involving non-stable versions (e.g. 16/edge)
31-
32-
The actions listed above must be performed as out of place upgrades.
52+
* Any refresh from or to a non-stable version (e.g. 16/edge)
3353

3454
<!--TODO: When ready, point to 14-16 migration guide -->
3555

@@ -39,5 +59,5 @@ The actions listed above must be performed as out of place upgrades.
3959
:hidden:
4060
4161
Perform a minor upgrade <minor-upgrade>
42-
Perform a minor rollback <minor-rollback>
43-
```
62+
Roll back an in-progress refresh <rollback>
63+
```
File renamed without changes.

0 commit comments

Comments
 (0)