Document how to pack the ZODB when using containers#1886
Conversation
stevepiercy
left a comment
stevepiercy
left a comment
There was a problem hiding this comment.
This is good stuff. I think it belongs in another location, though. See comments, and let me know.
Otherwise just some grammar and enhancements with references.
| It will no longer output the access log, but will continue to output the event log. | ||
|
|
||
|
|
||
| ## Pack the ZODB |
There was a problem hiding this comment.
@erral @davisagli would this section be more appropriate under the existing Advanced usage in plone/plone-backend?
Co-authored-by: Steve Piercy <web@stevepiercy.com>
Co-authored-by: Steve Piercy <web@stevepiercy.com>
erral
changed the title
erral
changed the title
stevepiercy
left a comment
stevepiercy
left a comment
There was a problem hiding this comment.
Thanks, @erral! This is OK to merge, pending the resolution of https://github.com/plone/documentation/pull/1886/files#r1982636531. Do you have an opinion one way or the other?
I would simplify the overall structure and let "advanced usage" to be recipes. |
OK. That may be what @davisagli also has in mind. I trust that y'all will sort out the best path forward. Merging! |
github-project-automation
bot
moved this from In Progress
to Done
in Plone Documentation
| Packing removes old revisions of objects. | ||
| It is similar to [routine vacuuming in PostgreSQL](https://www.postgresql.org/docs/8.3/routine-vacuuming.html). | ||
|
|
||
| The official {doc}`/install/containers/images/backend` container and project containers based on them have a `pack` command to pack the ZODB. |
There was a problem hiding this comment.
This should have a versionadded note. I just merged the PR which adds this command today, and it won't actually be available in the images until the next Plone releases are made. The backport PR for Plone 6.0 is still pending.
| It is similar to [routine vacuuming in PostgreSQL](https://www.postgresql.org/docs/8.3/routine-vacuuming.html). | ||
|
|
||
| The official {doc}`/install/containers/images/backend` container and project containers based on them have a `pack` command to pack the ZODB. | ||
| The command will work in standalone mode, ZEO mode, and RelStorage mode but only with PostgreSQL. |
There was a problem hiding this comment.
This sentence is confusing. "but only with PostgreSQL" is meant to be a qualifier only when using it with Relstorage, but it sounds like it applies to all the options, which makes no sense (it's only possible to use postgres if you're doing via Relstorage).
|
|
||
| ```shell | ||
| docker run -e RELSTORAGE_DSN="dbname='plone' user='plone' host='db' password='password' port='5432'" pack | ||
| ``` |
There was a problem hiding this comment.
In Docker Swarm, it's also necessary to specify the network if the database is only available on an internal network. It might be easier to use docker exec to run the pack command in an existing plone-backend container.
|
@davisagli I created a new PR #1899 to address your suggestions. Sorry for the itchy trigger finger. |
* Addendum to pack the ZODB in containers - Refs #1886 (review) * Apply suggestions from @erral * Apply suggestions from @erral * Update docs/install/containers/recipes/index.md Co-authored-by: Mikel Larreategi <mlarreategi@codesyntax.com> * Update docs/install/containers/recipes/index.md * Update index.md --------- Co-authored-by: Mikel Larreategi <mlarreategi@codesyntax.com>
3 participants
First-time contributors
You must read and follow our First-time contributors.
Submit a pull request
Thank you for your contribution to the Plone Documentation.
Before submitting this pull request, please make sure you follow our guides:
Issue number
Description
To be merged after #1874 and plone/plone-backend#179
Add screenshots or links to a preview of the changes
📚 Documentation preview 📚: https://plone6--1886.org.readthedocs.build/