ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
canvas-lms/config/database.yml.example

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

31 lines
620 B
Plaintext
Raw Normal View History

add help comment to database config example Having a queue section in tests causes tests to fail and we get questions about it all the time. This should help prevent that. Change-Id: I218c6e3cd5047d5be67478787f8efcfd93bd415c Reviewed-on: https://gerrit.instructure.com/14351 Tested-by: Jenkins <jenkins@instructure.com> Reviewed-by: Jeremy Stanley <jeremy@instructure.com>
2012-10-12 20:50:55 +08:00
# do not create a queue: section for your test environment
Initial commit. closes #6988138
2011-02-01 09:57:29 +08:00
test:
default database.yml.example to postgres Change-Id: I052ec7e00da170ade4e3b6ea281072bc3972560f Reviewed-on: https://gerrit.instructure.com/12482 Tested-by: Jenkins <jenkins@instructure.com> Reviewed-by: Brian Palmer <brianp@instructure.com>
2012-07-26 03:16:08 +08:00
adapter: postgresql
Initial commit. closes #6988138
2011-02-01 09:57:29 +08:00
encoding: utf8
database: canvas_test
host: localhost
username: canvas
Add password to database.yml.example for Postgres changes fixes GH-1614 flag=none Test plan - Specs pass - Start a new Canvas install with the quick start guide and ensure it is able to access postgres Change-Id: If07f323f94f482482e2473155eaeafddc8c816ee Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/235597 Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Jeremy Stanley <jeremy@instructure.com> QA-Review: Mysti Lilla <mysti@instructure.com> Product-Review: Mysti Lilla <mysti@instructure.com>
2020-04-29 07:23:43 +08:00
password: your_password
Initial commit. closes #6988138
2011-02-01 09:57:29 +08:00
timeout: 5000
add persistent test shards to database.yml.example Change-Id: I916ff3572596c856bb055354373d2aa71ce9c0fd Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/336685 Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Cody Cutrer <cody@instructure.com> QA-Review: Jeremy Stanley <jeremy@instructure.com> Product-Review: Jeremy Stanley <jeremy@instructure.com>
2024-01-05 02:16:44 +08:00
shard1: canvas_test_shard_1
shard2: canvas_test_shard_2
Initial commit. closes #6988138
2011-02-01 09:57:29 +08:00
development:
default database.yml.example to postgres Change-Id: I052ec7e00da170ade4e3b6ea281072bc3972560f Reviewed-on: https://gerrit.instructure.com/12482 Tested-by: Jenkins <jenkins@instructure.com> Reviewed-by: Brian Palmer <brianp@instructure.com>
2012-07-26 03:16:08 +08:00
adapter: postgresql
Initial commit. closes #6988138
2011-02-01 09:57:29 +08:00
encoding: utf8
database: canvas_development
Add password to database.yml.example for Postgres changes fixes GH-1614 flag=none Test plan - Specs pass - Start a new Canvas install with the quick start guide and ensure it is able to access postgres Change-Id: If07f323f94f482482e2473155eaeafddc8c816ee Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/235597 Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Jeremy Stanley <jeremy@instructure.com> QA-Review: Mysti Lilla <mysti@instructure.com> Product-Review: Mysti Lilla <mysti@instructure.com>
2020-04-29 07:23:43 +08:00
password: your_password
Initial commit. closes #6988138
2011-02-01 09:57:29 +08:00
timeout: 5000
create read-only "secondary" db user for dev/test and activate this user while on the "secondary" in tests Canvas uses read-only secondary database replicas, but before now, GuardRail.activate(:secondary) had no effect in specs. The result is that specs wouldn't catch attempts to write to a secondary, and the error would be discovered in production, often requiring a hotfix. This patchset sets up a migration that creates a `canvas_readonly_user` in the database and sets up SELECT permissions for it in each shard's schema. (The migration does nothing in production.) It also stubs out GuardRail in specs to run `SET ROLE canvas_readonly_user` when activating the secondary, and `RESET ROLE` when returning to the primary. test plan: - specs pass (this PS includes specs that attempt to write to the secondary and verify the correct error is raised) - use the read-only user in development by adding the following to the development section in config/database.yml: secondary: username: canvas_readonly_user then try to write to the secondary in the rails console and ensure you get a permission denied error. for example, GuardRail.activate(:secondary) { User.create! } should result in PG::InsufficientPrivilege: ERROR: permission denied for table users (ActiveRecord::StatementInvalid) flag = none closes LS-2818 Change-Id: Ibfa75af821eb7f5d65f6b26aea03417378ab255a Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/161086 QA-Review: Isaac Moore <isaac.moore@instructure.com> Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Cody Cutrer <cody@instructure.com> Product-Review: Cody Cutrer <cody@instructure.com>
2021-11-02 08:24:48 +08:00
secondary:
Bump switchman Change-Id: I6bcce0e81b6a79dc5e0a693d3fc4669437643d8a Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/287546 Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> QA-Review: Jacob Burroughs <jburroughs@instructure.com> Product-Review: Jacob Burroughs <jburroughs@instructure.com> Reviewed-by: Aaron Ogata <aogata@instructure.com>
2022-03-21 22:27:07 +08:00
replica: true
create read-only "secondary" db user for dev/test and activate this user while on the "secondary" in tests Canvas uses read-only secondary database replicas, but before now, GuardRail.activate(:secondary) had no effect in specs. The result is that specs wouldn't catch attempts to write to a secondary, and the error would be discovered in production, often requiring a hotfix. This patchset sets up a migration that creates a `canvas_readonly_user` in the database and sets up SELECT permissions for it in each shard's schema. (The migration does nothing in production.) It also stubs out GuardRail in specs to run `SET ROLE canvas_readonly_user` when activating the secondary, and `RESET ROLE` when returning to the primary. test plan: - specs pass (this PS includes specs that attempt to write to the secondary and verify the correct error is raised) - use the read-only user in development by adding the following to the development section in config/database.yml: secondary: username: canvas_readonly_user then try to write to the secondary in the rails console and ensure you get a permission denied error. for example, GuardRail.activate(:secondary) { User.create! } should result in PG::InsufficientPrivilege: ERROR: permission denied for table users (ActiveRecord::StatementInvalid) flag = none closes LS-2818 Change-Id: Ibfa75af821eb7f5d65f6b26aea03417378ab255a Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/161086 QA-Review: Isaac Moore <isaac.moore@instructure.com> Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Cody Cutrer <cody@instructure.com> Product-Review: Cody Cutrer <cody@instructure.com>
2021-11-02 08:24:48 +08:00
username: canvas_readonly_user
remove queue section from example development database.yml Change-Id: I19178e87f5b096e69bda9365736c6a52457adac5 Reviewed-on: https://gerrit.instructure.com/56436 Tested-by: Jenkins Reviewed-by: Ethan Vizitei <evizitei@instructure.com> Product-Review: Cody Cutrer <cody@instructure.com> QA-Review: Cody Cutrer <cody@instructure.com>
2015-06-16 01:07:05 +08:00
Initial commit. closes #6988138
2011-02-01 09:57:29 +08:00
production:
default database.yml.example to postgres Change-Id: I052ec7e00da170ade4e3b6ea281072bc3972560f Reviewed-on: https://gerrit.instructure.com/12482 Tested-by: Jenkins <jenkins@instructure.com> Reviewed-by: Brian Palmer <brianp@instructure.com>
2012-07-26 03:16:08 +08:00
adapter: postgresql
Initial commit. closes #6988138
2011-02-01 09:57:29 +08:00
encoding: utf8
database: canvas_production
host: localhost
username: canvas
password: your_password
timeout: 5000