Skip to content

PG-2312 - Reorganize Docker installation instructions#957

Open
Andriciuc wants to merge 1 commit into18from
update-docker-based-on-image-changes
Open

PG-2312 - Reorganize Docker installation instructions#957
Andriciuc wants to merge 1 commit into18from
update-docker-based-on-image-changes

Conversation

@Andriciuc
Copy link
Copy Markdown
Contributor

This PR updates and reorganizes the instructions and content in docker.md for easier flow and user readability.

This PR updates and reorganizes the instructions and content in docker.md for easier flow and user readability.
Copy link
Copy Markdown

@rjd15372 rjd15372 left a comment

Choose a reason for hiding this comment

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

@Andriciuc thanks for working on this. I haven't finished reviewing all content but let's start with addressing these comments first.

Comment thread docs/docker/docker.md

* `container-name` is the name you assign to your container
* `POSTGRES_PASSWORD` is the superuser password
* `{{dockertag}}` is the tag specifying the version you need. Docker identifies the architecture (x86_64 or ARM64) and pulls the respective image. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-distribution-postgresql/tags/).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
* `{{dockertag}}` is the tag specifying the version you need. Docker identifies the architecture (x86_64 or ARM64) and pulls the respective image. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-distribution-postgresql/tags/).
* `{{dockertag}}` is the tag specifying the version you need. Docker identifies the architecture (amd64 or arm64) and pulls the respective image. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-distribution-postgresql/tags/).

Perhaps we could use the same arch identifiers as appear in docker hub.

Comment thread docs/docker/docker.md
Comment on lines +27 to +29
!!! note

Some extensions require server startup configuration and must be loaded via `shared_preload_libraries` before PostgreSQL starts.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I don't think this is a good location for this note. The reader still has no context about extensions at this point.
Also, I probably would not put this inside a note and would make it part of the first paragraph of section 2.

Comment thread docs/docker/docker.md

## 2. Enable extensions

Extensions must be explicitly loaded when starting the container using the `shared_preload_libraries` parameter, then enabled per database:
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Not all extensions require to be set using shared_preload_libraries . I would use the above note text here to motivate the need of using the shared_preload_libraries.

Comment thread docs/docker/docker.md
docker run --name container-name --env-file ./.my-pg.env -d percona/percona-distribution-postgresql:{{dockertag}}
```

## 2. Enable extensions
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Maybe before going into extensions, it would be nice to show how to connect to the server using the postgresql client psql. Similar to what we have in the current documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants