Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated configuration in the DB to incorporate reviewer feedback. #7209

Merged
merged 2 commits into from
Jun 13, 2024

Conversation

cwarnermm
Copy link
Member

@cwarnermm cwarnermm commented Jun 13, 2024

Also fixes #7161

@cwarnermm cwarnermm added the 1: Dev Review Requires review by a core commiter label Jun 13, 2024
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 651c703

@cwarnermm cwarnermm added this to the v9.9.0 milestone Jun 13, 2024
Note that once you start using configuration in the database, you shouldn't manually edit the active configuration row. You should edit or update the configuration in one of the following ways:
.. important::

Once you start using configuration in the database, you shouldn't manually edit the active configuration row. You should edit or update the configuration in one of the following ways:
Copy link
Member

Choose a reason for hiding this comment

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

This says we should never manually edit the config row, but we say that as an option below. Should we edit the row or not?

Honestly, I'd veer people away from editing it since it's so easy to put invalid json.

Copy link
Member Author

Choose a reason for hiding this comment

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

Great point. Will remove.


mysql://mmuser:really_secure_password@tcp(127.0.0.1:3306)/mattermost?charset=utf8mb4,utf8&writeTimeout=30s

- If ``SqlSettings.DataSource`` doesn't start with ``postgres://``, you have to add it to the beginning based on the database in use. For example: ``postgres://mmuser:really_secure_password@localhost:5432/mattermost?sslmode=disable&connect_timeout=10``
Copy link
Member

Choose a reason for hiding this comment

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

iirc it should ALWAYS start with postgres:// or mysql://

- If you're using a High Availability cluster, you only need to run this command on 1 server in the cluster.
- When migrating configuration, Mattermost incorporates configuration from any existing ``MM_*`` environment variables set in the current shell. See :doc:`Environment Variables </configure/configuration-settings>` documentation for details.
- As with the environment file, you'll have to escape any single quotes in the database connection string.
- Any existing SAML certificates will be migrated into the database as well so they are available for all servers in the cluster. When the certificates expire, you can upload new certificates using the System Console or mmctl, which triggers a database update. Replacing the certificate files manually requires a reload of the Mattermost server to repull the certificates.
Copy link
Member

Choose a reason for hiding this comment

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

We should note that files stored for config are stored in the configurationfiles table on the database where the config is stored

@@ -4,23 +4,29 @@ Store configuration in your database
.. include:: ../_static/badges/allplans-selfhosted.rst
:start-after: :nosearch:

You can use your database as the single source of truth for the active configuration of your Mattermost installation. This changes the Mattermost binary from reading the default ``config.json`` file to reading the configuration settings stored within a configuration table in the database.
You can use your database as the single source of truth for the active configuration of your Mattermost installation. This changes the Mattermost binary from reading the default ``config.json`` file to reading the configuration settings stored within a configuration table in the database. Mattermost has been running our `community server <https://community.mattermost.com>`__ on this option since the feature was released, and recommends its use for those on :doc:`High Availability deployments <../scale/high-availability-cluster>`.
Copy link
Member

Choose a reason for hiding this comment

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

0/5 but mentioning it's on community feels like overkill.

Mattermost has been running our community server <https://community.mattermost.com>__ on this option since the feature was released

@cwarnermm cwarnermm added 3: Reviews Complete All reviewers have approved the pull request and removed 1: Dev Review Requires review by a core commiter labels Jun 13, 2024
Copy link

Newest code from mattermost has been published to preview environment for Git SHA ed2f67c

@cwarnermm cwarnermm merged commit 9f23305 into v9.9-documentation Jun 13, 2024
4 checks passed
@cwarnermm cwarnermm deleted the ha-config-in-db branch June 13, 2024 20:52
amyblais added a commit that referenced this pull request Jun 14, 2024
* Update conf.py

* Removed v7.9 & later true-up workflow (#7177)

* Added DisableWakeUpReconnectHandler config setting (#7179)

* Added note to close desktop app before installing via MSI (#7194)

* Added team archival docs (#7187)

* Added FAQ for MM sub-path deploy (#7188)

* Split Docker prod deploy details from trial (#7191)

* Added PG 15+ grant user access DB link (#7193)

* Corrected short codes to zh-Hans and zh-Hant (#7182)

* Removed deprecated PostEditTimeLimit link (#7181)

* Updated user count & removed message count (#7180)

* Increased max password length to 72 (#7178)

* Prioritized Enterprise offerings first over others (#7190)

* Added live captioning end user docs & updated calls search metadata (#7176)

* Added live captioning end user docs & updated calls search metadata

* Incorporated review feedback

* Noted that require plugin signature disables file upload (#7183)

* Clarified wording re: migration window (#7184)

* Added FAQ re: enabling calls on a per-channel basis for slower rollouts (#7202)

* Added browser notification prompt & cleaned up indentation syntax (#7201)

* Added mmctl ldap job, job list, and job show (#7195)

* Added mmctl ldap job, job list, and job show

* Changed ldap sync heading type

* Added note detailing what happens with deactivated user integrations (#7192)

* Added note detailing what happens with deactivated user integrations

* Incorporated reviewer feedback

* Update source/configure/user-management-configuration-settings.rst

Co-authored-by: Eva Sarafianou <eva.sarafianou@gmail.com>

---------

Co-authored-by: Eva Sarafianou <eva.sarafianou@gmail.com>

* Documented S3Bucket name (#7185)

* v9.9 changelog (#7142)

* Update open-source-components.rst

* Update release-lifecycle.rst

* Update download-latest-tarball.rst

* Update mattermost-changelog.md

* Update deprecated-features.rst

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update software-hardware-requirements.rst

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update source/deploy/mattermost-changelog.md

Co-authored-by: Doug Lauder <wiggin77@warpmail.net>

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Apply suggestions from code review

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update release-lifecycle.rst

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

---------

Co-authored-by: Doug Lauder <wiggin77@warpmail.net>
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Replaced screenshot (#7175)

* Added calls host control functionality to docs (#7204)

* Added host control features

* Update source/collaborate/make-calls.rst

Co-authored-by: Christopher Poile <cpoile@gmail.com>

* Update source/collaborate/make-calls.rst

Co-authored-by: Christopher Poile <cpoile@gmail.com>

* Update source/collaborate/make-calls.rst

Co-authored-by: Christopher Poile <cpoile@gmail.com>

* Update source/collaborate/make-calls.rst

Co-authored-by: Christopher Poile <cpoile@gmail.com>

* Incorporated reviewer feedback

---------

Co-authored-by: Christopher Poile <cpoile@gmail.com>

* Added Cloud & SH advanced & audit logging config settings (#7198)

* Replaced support email links with Support portal links (#7210)

* Doc'd bash script that checks for new integrations via Marketplace (#7208)

* Added animated gif to show per-channel notification workflow (#7207)

* Fixes for build warnings & errors

* New user survey plugin admin docs (#7173)

* New user survey plugin admin docs

* Finalized draft content for new plugin

* Incorporated reviewer feedback & screenshots

* Update source/configure/manage-user-surveys.rst

Co-authored-by: Matthew Birtch <mattbirtch@gmail.com>

* Update source/configure/manage-user-surveys.rst

Co-authored-by: Matthew Birtch <mattbirtch@gmail.com>

---------

Co-authored-by: Matthew Birtch <mattbirtch@gmail.com>

* Updated configuration in the DB to incorporate reviewer feedback. (#7209)

* Incorporated reviewer updates to clarify key points for success

* Incorporated reviewer feedback

* Added links for WebApp & Notification Health metrics (#7203)

* Added links for WebApp & Notification Health metrics

* Added telemetry, config setting for notification metrics, & links

* Update source/scale/deploy-prometheus-grafana-for-performance-monitoring.rst

* Update source/scale/deploy-prometheus-grafana-for-performance-monitoring.rst

* Update source/scale/deploy-prometheus-grafana-for-performance-monitoring.rst

Co-authored-by: Harrison Healey <harrisonmhealey@gmail.com>

---------

Co-authored-by: Harrison Healey <harrisonmhealey@gmail.com>

* Clarified min mobile version supporting host controls

* Fixed build error

---------

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
Co-authored-by: Eva Sarafianou <eva.sarafianou@gmail.com>
Co-authored-by: Doug Lauder <wiggin77@warpmail.net>
Co-authored-by: Christopher Poile <cpoile@gmail.com>
Co-authored-by: Matthew Birtch <mattbirtch@gmail.com>
Co-authored-by: Harrison Healey <harrisonmhealey@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3: Reviews Complete All reviewers have approved the pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants