Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

docs: Add upgrade note for non-concurrent index migrations.

Aman Agrawal9e0a204240ac
diff --git a/docs/overview/changelog.md b/docs/overview/changelog.md
index 3a755828025..1481aab401f 100644
--- a/docs/overview/changelog.md
+++ b/docs/overview/changelog.md
@@ -15,7 +15,13 @@ _Unreleased_
### Upgrade notes for 13.0
-- None yet.
+- Migrations that add or remove database indexes no longer use
+ PostgreSQL's `CONCURRENTLY` option by default, so they lock the
+ table while they run. This does not affect the standard upgrade
+ process, which stops the server before running migrations. If you
+ run migrations while your server is running, set
+ `MIGRATIONS_ADD_REMOVE_INDEXES_CONCURRENTLY = True` in
+ `/etc/zulip/settings.py` before upgrading.
## Zulip Server 12.x series
diff --git a/docs/production/system-configuration.md b/docs/production/system-configuration.md
index 664ed53d8a7..0b5ac1c8b3d 100644
--- a/docs/production/system-configuration.md
+++ b/docs/production/system-configuration.md
@@ -86,6 +86,10 @@ Options passed by `upgrade-zulip` and `upgrade-zulip-from-git` into
to run `zulip-puppet-apply` manually after the upgrade.
- **`--skip-migrations`** skips running database migrations. The
user will need to run `./manage.py migrate` manually after the upgrade.
+ If you run migrations while the server is running, set
+ `MIGRATIONS_ADD_REMOVE_INDEXES_CONCURRENTLY = True` in
+ `/etc/zulip/settings.py`, so that migrations adding or removing
+ indexes don't lock the table.
- **`--skip-purge-old-deployments`** skips purging old deployments;
without it, only deployments with the last two weeks are kept.