From b3879e13b6fede24dd1c168698de72efbac331e2 Mon Sep 17 00:00:00 2001 From: Braden MacDonald Date: Thu, 15 Jun 2023 12:06:56 -0700 Subject: [PATCH] docs: update ARM tutorial --- docs/tutorials/arm64.rst | 37 +++++-------------------------------- 1 file changed, 5 insertions(+), 32 deletions(-) diff --git a/docs/tutorials/arm64.rst b/docs/tutorials/arm64.rst index 23beed5..2d04f7a 100644 --- a/docs/tutorials/arm64.rst +++ b/docs/tutorials/arm64.rst @@ -3,37 +3,10 @@ Running Tutor on ARM-based systems ================================== -Tutor can be used on ARM64 systems, although no official ARM64 docker images are available. If you want to get started quickly, there is `an unofficial community-maintained ARM64 plugin `_ which will set the required settings for you and which includes unofficial docker images. If you prefer not to use an unofficial plugin, you can follow this tutorial. +Tutor can be used on ARM64 systems, and official ARM64 docker images are available starting from Tutor v16. -.. note:: There are generally two ways to run Tutor on an ARM system - using emulation (via qemu or Rosetta 2) to run x86_64 images or running native ARM images. Since emulation can be noticeably slower (typically 20-100% slower depending on the emulation method), this tutorial aims to use native images where possible. +For older versions of Tutor (v14 or v15), there are several options: -Building the images -------------------- - -Although there are no official ARM64 images, Tutor makes it easy to build the images yourself. - -Start by :ref:`installing ` Tutor and its dependencies (e.g. Docker) onto your system. - -.. note:: For Open edX developers, if you want to use the :ref:`nightly ` version of Tutor to "run master", install Tutor using git and check out the ``nightly`` branch of Tutor at this point. See the :ref:`nightly documentation ` for details. - -Next, configure Tutor:: - - tutor config save --interactive - -Go through the configuration process, answering each question. - -Then, build the "openedx" and "permissions" images:: - - tutor images build openedx permissions - -If you want to use Tutor as an Open edX development environment, you should also build the development image:: - - tutor images build openedx-dev # this will be automatically done by `tutor dev launch` - -From this point on, use Tutor as normal. For example, start Open edX and run migrations with:: - - tutor local launch - -Or for a development environment:: - - tutor dev launch +* Use emulation (via qemu or Rosetta 2) to run x86_64 images. Just make sure your installation of Docker supports emulation and use Tutor as normal. This may be 20%-100% slower than native images, depending on the emulation method. +* Use the `unofficial community-maintained ARM64 plugin `_ which will set the required settings for you and which includes unofficial docker images. +* Build your own ARM64 images, e.g. using ``tutor images build openedx permissions`` and/or ``tutor images build openedx-dev`` before launching the LMS.