Skip to content
This repository has been archived by the owner on Aug 1, 2024. It is now read-only.

[idea] Create document of devstack upgrade instructions #1144

Closed
3 tasks done
robrap opened this issue Aug 2, 2023 · 2 comments
Closed
3 tasks done

[idea] Create document of devstack upgrade instructions #1144

robrap opened this issue Aug 2, 2023 · 2 comments
Assignees

Comments

@robrap
Copy link
Contributor

robrap commented Aug 2, 2023

A/C:

  • Create a devstack documentation page for the instructions
    • The entries should be dated and in reverse chronological order, with this stated in the doc
    • Copy the last upgrade instruction announcement like this that went out via email or Slack into it
    • Link to the new page from the index and the troubleshooting doc
  • Add Slack channel bookmark for new page
  • Announce the existence of the page and intended usage

From time to time, changes are made in devstack and that require some manual intervention for getting the latest. Instructions are often sent in Slack and email, but may not reach everyone in the community.

Add a doc of upgrade instructions that we can append to as-needed (latest at top). We could also remind people to share on Open edX Discuss at the top of the doc.

Here is an example message sent recently:

[inform] Team Infinity has upgraded the forum service from Ruby 2 to Ruby 3. The upgrade includes changes to the devstack image and provisioning of the forum service. To upgrade to the latest Ruby version, devstack would require pulling in the new forums' docker image, and running the provisioning step for the service as well.
The following commands should be enough to get up and running with the latest forum service (on latest master branch on devstack):
- make dev.pull.forum  # pull in new forum image
- make dev.provision.forum  # provision forum service
If you run into any issues with the upgrade, please contact Team Infinity at [#team-edx-infinity](https://twou.slack.com/archives/C048W0LC9FA)
Thank you!
@robrap robrap added this to Arch-BOM Aug 2, 2023
@robrap
Copy link
Contributor Author

robrap commented Aug 8, 2023

The ticket #1136 includes writing up some general devstack reboot instructions. This doc may want to include or point to these reboot instructions.

@robrap
Copy link
Contributor Author

robrap commented Aug 8, 2023

It may be that DEPR removals could be documented here, as appropriate, if they could cause issues with devstack. See https://discuss.openedx.org/t/devstack-installation-make-dev-provision-throwing-error/10916/2 as an example.

@jmbowman jmbowman moved this to Prioritized in Arch-BOM Aug 9, 2023
@jmbowman jmbowman moved this from Prioritized to Groomed in Arch-BOM Sep 1, 2023
@timmc-edx timmc-edx self-assigned this Sep 21, 2023
@timmc-edx timmc-edx moved this from Groomed to In Progress in Arch-BOM Sep 21, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in Arch-BOM Sep 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants