From 4483bffa7251243afed24bf8199df73f42d39455 Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Mon, 14 Aug 2023 09:31:24 -0400 Subject: [PATCH 1/5] feat: Update troubleshoot guide with reset info --- docs/troubleshoot_general_tips.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/troubleshoot_general_tips.rst b/docs/troubleshoot_general_tips.rst index bccf501acf..00e45a9c5c 100644 --- a/docs/troubleshoot_general_tips.rst +++ b/docs/troubleshoot_general_tips.rst @@ -247,7 +247,7 @@ See `the github issue`_ to follow the work being done on the resolution. Past problems (fixed) ===================== -If you see any of the following issues, you'll need to update your repos and pull the latest images. +If you see any of the following issues, you'll need to `update your repos and pull the latest images`_. Permission denied for copying studio-frontend JS & CSS during provisioning -------------------------------------------------------------------------- @@ -263,6 +263,19 @@ During ``make dev.provision``, the edx-platform script ``copy-node-modules.sh`` This issue was introduced on edx-platform master in July 2023 and was resolved in August 2023 (without becoming part of a named release). See https://github.com/openedx/devstack/issues/1138 for more details, including a workaround for those unable to upgrade their repos or images for some reason. +.. _update your repos and pull the latest images: +Updating Devstack +================= +It is a good idea to periodically update your devstack to bring in new bug fixes. You can do this without losing any of your existing data or having to reprovision, although you will lose your container command history once you remove it. To update devstack to the latest images and code: +1. `make dev.stop` This will stop all running containers +2. `make dev.remove-containers` This will remove all stopped containers. After this you will not be able to get the command history back. +3. `make dev.reset-repos` This will pull all the latest code into all your devstack service and MFE repos +4. `git fetch && git pull` on the master branch in devstack. This will pull all the latest code into the devstack repo itself +5. `make dev.pull.large-and-slow` This will pull all the latest images. If you only care about specific services/MFEs, you can replace this with `make dev.pull.lms+cms+other_service+other_MFE...` + +Depending on your needs, you may also want to run `make dev.migrate` to apply all the latest migrations and `make dev.static` to recompile static assets. Like with pulling images, you can also narrow these commands to specific services/MFEs with `make dev.migrate.lms+cms+...` + +Running `make dev.reset` will do all the above for all services, which can be useful but takes much more time. It will also run a full `docker system prune -f` to get rid of unused images and networks. Starting From Scratch ===================== From fcb0dc21ec6373c4ecaccfd7044fcd00febcd534 Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Mon, 14 Aug 2023 10:20:33 -0400 Subject: [PATCH 2/5] fixup!: Update troubleshoot_general_tips.rst --- docs/troubleshoot_general_tips.rst | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/troubleshoot_general_tips.rst b/docs/troubleshoot_general_tips.rst index 00e45a9c5c..0492006181 100644 --- a/docs/troubleshoot_general_tips.rst +++ b/docs/troubleshoot_general_tips.rst @@ -247,7 +247,7 @@ See `the github issue`_ to follow the work being done on the resolution. Past problems (fixed) ===================== -If you see any of the following issues, you'll need to `update your repos and pull the latest images`_. +If you see any of the following issues, you'll need to `pull new code and images`_. Permission denied for copying studio-frontend JS & CSS during provisioning -------------------------------------------------------------------------- @@ -263,19 +263,23 @@ During ``make dev.provision``, the edx-platform script ``copy-node-modules.sh`` This issue was introduced on edx-platform master in July 2023 and was resolved in August 2023 (without becoming part of a named release). See https://github.com/openedx/devstack/issues/1138 for more details, including a workaround for those unable to upgrade their repos or images for some reason. -.. _update your repos and pull the latest images: +.. _pull new code and images: + Updating Devstack ================= -It is a good idea to periodically update your devstack to bring in new bug fixes. You can do this without losing any of your existing data or having to reprovision, although you will lose your container command history once you remove it. To update devstack to the latest images and code: -1. `make dev.stop` This will stop all running containers -2. `make dev.remove-containers` This will remove all stopped containers. After this you will not be able to get the command history back. -3. `make dev.reset-repos` This will pull all the latest code into all your devstack service and MFE repos -4. `git fetch && git pull` on the master branch in devstack. This will pull all the latest code into the devstack repo itself -5. `make dev.pull.large-and-slow` This will pull all the latest images. If you only care about specific services/MFEs, you can replace this with `make dev.pull.lms+cms+other_service+other_MFE...` +It may be that the bug you have encountered has already been resolved and you just need to update your devstack. You can do this without losing any of your existing data or having to reprovision, although you will lose your container command history once you pull new images. + +To update devstack to the latest images and code: + +1. ``make dev.stop`` This will stop all running containers. +2. ``make dev.reset-repos`` This will pull all the latest code into all your devstack service and MFE repos. +3. ``git fetch && git pull`` on the master branch in devstack. This will pull all the latest code into the devstack repo itself +4. ``make dev.pull.lms`` This will pull the latest lms image and all its dependencies. If you need other services/MFEs, you can replace this with ``make dev.pull.lms+cms+other_service+other_MFE...`` or ``make dev.pull.large-and-slow`` if you really need everything. -Depending on your needs, you may also want to run `make dev.migrate` to apply all the latest migrations and `make dev.static` to recompile static assets. Like with pulling images, you can also narrow these commands to specific services/MFEs with `make dev.migrate.lms+cms+...` +Depending on your needs, you may also want to run ``make dev.migrate.lms`` to apply all the latest migrations and/or ``make dev.static.lms`` to recompile static assets. +Like with pulling images, you can also narrow these commands to specific services/MFEs with ``make dev.migrate.lms+cms+...,`` or run ``make dev.migrate`` and ``make dev.static`` (no suffixes) to include everything. -Running `make dev.reset` will do all the above for all services, which can be useful but takes much more time. It will also run a full `docker system prune -f` to get rid of unused images and networks. +Running ``make dev.reset`` will do all the above for all services, which can be useful but takes much more time. It will also run a full ``docker system prune -f`` to get rid of unused images and networks. Starting From Scratch ===================== From cfd7241afa18a46e5aa60c0ce13ab489803a0194 Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Mon, 14 Aug 2023 10:52:51 -0400 Subject: [PATCH 3/5] fixup!: spaces --- docs/troubleshoot_general_tips.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/troubleshoot_general_tips.rst b/docs/troubleshoot_general_tips.rst index 0492006181..13cfa3bc01 100644 --- a/docs/troubleshoot_general_tips.rst +++ b/docs/troubleshoot_general_tips.rst @@ -267,7 +267,7 @@ This issue was introduced on edx-platform master in July 2023 and was resolved i Updating Devstack ================= -It may be that the bug you have encountered has already been resolved and you just need to update your devstack. You can do this without losing any of your existing data or having to reprovision, although you will lose your container command history once you pull new images. +It may be that the bug you have encountered has already been resolved and you just need to update your devstack. You can do this without losing any of your existing data or having to reprovision, although you will lose your container command history once you pull new images. To update devstack to the latest images and code: @@ -276,10 +276,10 @@ To update devstack to the latest images and code: 3. ``git fetch && git pull`` on the master branch in devstack. This will pull all the latest code into the devstack repo itself 4. ``make dev.pull.lms`` This will pull the latest lms image and all its dependencies. If you need other services/MFEs, you can replace this with ``make dev.pull.lms+cms+other_service+other_MFE...`` or ``make dev.pull.large-and-slow`` if you really need everything. -Depending on your needs, you may also want to run ``make dev.migrate.lms`` to apply all the latest migrations and/or ``make dev.static.lms`` to recompile static assets. +Depending on your needs, you may also want to run ``make dev.migrate.lms`` to apply all the latest migrations and/or ``make dev.static.lms`` to recompile static assets. Like with pulling images, you can also narrow these commands to specific services/MFEs with ``make dev.migrate.lms+cms+...,`` or run ``make dev.migrate`` and ``make dev.static`` (no suffixes) to include everything. -Running ``make dev.reset`` will do all the above for all services, which can be useful but takes much more time. It will also run a full ``docker system prune -f`` to get rid of unused images and networks. +Running ``make dev.reset`` will do all the above for all services, which can be useful but takes much more time. It will also run a full ``docker system prune -f`` to get rid of unused images and networks. Starting From Scratch ===================== From 6d793776c2c4b614f784fdc1c70d2e6846f188b6 Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Mon, 14 Aug 2023 10:55:22 -0400 Subject: [PATCH 4/5] fixup!: old text --- docs/troubleshoot_general_tips.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/troubleshoot_general_tips.rst b/docs/troubleshoot_general_tips.rst index 13cfa3bc01..37b99c4776 100644 --- a/docs/troubleshoot_general_tips.rst +++ b/docs/troubleshoot_general_tips.rst @@ -247,7 +247,7 @@ See `the github issue`_ to follow the work being done on the resolution. Past problems (fixed) ===================== -If you see any of the following issues, you'll need to `pull new code and images`_. +If you see any of the following issues, you'll need to `update your repos and pull the latest images`_. Permission denied for copying studio-frontend JS & CSS during provisioning -------------------------------------------------------------------------- @@ -263,7 +263,7 @@ During ``make dev.provision``, the edx-platform script ``copy-node-modules.sh`` This issue was introduced on edx-platform master in July 2023 and was resolved in August 2023 (without becoming part of a named release). See https://github.com/openedx/devstack/issues/1138 for more details, including a workaround for those unable to upgrade their repos or images for some reason. -.. _pull new code and images: +.. _update your repos and pull the latest images: Updating Devstack ================= From f86fedca7ca8a8ef01a61053afec227a1dd6171d Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Mon, 14 Aug 2023 14:05:46 -0400 Subject: [PATCH 5/5] fixup!: Update docs/troubleshoot_general_tips.rst Co-authored-by: Robert Raposa --- docs/troubleshoot_general_tips.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshoot_general_tips.rst b/docs/troubleshoot_general_tips.rst index 37b99c4776..9c0e505cfd 100644 --- a/docs/troubleshoot_general_tips.rst +++ b/docs/troubleshoot_general_tips.rst @@ -273,7 +273,7 @@ To update devstack to the latest images and code: 1. ``make dev.stop`` This will stop all running containers. 2. ``make dev.reset-repos`` This will pull all the latest code into all your devstack service and MFE repos. -3. ``git fetch && git pull`` on the master branch in devstack. This will pull all the latest code into the devstack repo itself +3. ``git fetch && git pull`` on the master branch in devstack. This will pull all the latest code into the devstack repo itself. 4. ``make dev.pull.lms`` This will pull the latest lms image and all its dependencies. If you need other services/MFEs, you can replace this with ``make dev.pull.lms+cms+other_service+other_MFE...`` or ``make dev.pull.large-and-slow`` if you really need everything. Depending on your needs, you may also want to run ``make dev.migrate.lms`` to apply all the latest migrations and/or ``make dev.static.lms`` to recompile static assets.