Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Adjusted the backup and healthcheck notes to use appropriate GitHub Markdown syntax.
justinclift authored Nov 14, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent 3e4dd90 commit 6f61729
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -14,15 +14,16 @@ official Docker PostgreSQL image has no ability to handle
version upgrades, which leaves people to figure it out
manually (not great): https://github.com/docker-library/postgres/issues/37

## WARNING! Backup your data!

This Docker image does an in-place upgrade of the database
data, so if something goes wrong you are expected to already
have backups you can restore from.

Also, remove any healthchecks.
Due to how we perform the update process, we had to implement our own healthcheck.
So no extra healthcheck is needed.
> [!WARNING]
> Backup your data!
> This Docker image does an in-place upgrade of the database
> data, so if something goes wrong you are expected to already
> have backups you can restore from.
> [!IMPORTANT]
> Also, remove any healthchecks.
> Due to how we perform the update process, we had to implement our own healthcheck.
> So no extra healthcheck is needed.
## How to use this image

2 comments on commit 6f61729

@ola-nate
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome tool!. We are in the exact same situation 9.6 - > 17.

I noticed the way the readme dosent tell which type of data pgupgrade can work on (we are doing it on the side of the actual database).
As I understand it the input wants the data directory raw and no logical or physical backup. The readme could be clearer source= input it accepts.

@justinclift
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which type of data pgupgrade can work on

It's a bit unclear to me what you're meaning. When you say "which type of data", as far as I know all of the different types of data that PostgreSQL understands are contained within the database directory.

Perhaps I need to do some more reading and learning? 😄

Please sign in to comment.