mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-09-27 11:49:02 +00:00
ceddc11c29
One of the breaking changes of this release is the removal of the webui and android features; these are moved to dedicated plugins. This causes a breaking change: the renaming of the DOCKER_IMAGE_ANDROID config variable to ANDROID_DOCKER_IMAGE. See this TEP for reference: https://discuss.overhang.io/t/separate-webui-and-android-from-tutor-core-and-move-to-dedicated-plugins/1473
211 lines
7.0 KiB
Python
211 lines
7.0 KiB
Python
import os
|
|
|
|
import click
|
|
|
|
from .. import config as tutor_config
|
|
from .. import env as tutor_env
|
|
from .. import fmt
|
|
from ..types import get_typed, Config
|
|
from .. import utils
|
|
from . import compose
|
|
from .config import save as config_save_command
|
|
from .context import Context
|
|
|
|
|
|
def docker_compose(root: str, config: Config, *command: str) -> int:
|
|
"""
|
|
Run docker-compose with local and production yml files.
|
|
"""
|
|
args = []
|
|
override_path = tutor_env.pathjoin(root, "local", "docker-compose.override.yml")
|
|
if os.path.exists(override_path):
|
|
args += ["-f", override_path]
|
|
return utils.docker_compose(
|
|
"-f",
|
|
tutor_env.pathjoin(root, "local", "docker-compose.yml"),
|
|
"-f",
|
|
tutor_env.pathjoin(root, "local", "docker-compose.prod.yml"),
|
|
*args,
|
|
"--project-name",
|
|
get_typed(config, "LOCAL_PROJECT_NAME", str),
|
|
*command
|
|
)
|
|
|
|
|
|
@click.group(help="Run Open edX locally with docker-compose")
|
|
@click.pass_obj
|
|
def local(context: Context) -> None:
|
|
context.docker_compose_func = docker_compose
|
|
|
|
|
|
@click.command(help="Configure and run Open edX from scratch")
|
|
@click.option("-I", "--non-interactive", is_flag=True, help="Run non-interactively")
|
|
@click.option("-p", "--pullimages", is_flag=True, help="Update docker images")
|
|
@click.pass_context
|
|
def quickstart(context: click.Context, non_interactive: bool, pullimages: bool) -> None:
|
|
if tutor_env.needs_major_upgrade(context.obj.root):
|
|
click.echo(fmt.title("Upgrading from an older release"))
|
|
context.invoke(
|
|
upgrade,
|
|
from_version=tutor_env.current_release(context.obj.root),
|
|
non_interactive=non_interactive,
|
|
)
|
|
|
|
click.echo(fmt.title("Interactive platform configuration"))
|
|
context.invoke(
|
|
config_save_command,
|
|
interactive=(not non_interactive),
|
|
set_vars=[],
|
|
unset_vars=[],
|
|
)
|
|
click.echo(fmt.title("Stopping any existing platform"))
|
|
context.invoke(compose.stop)
|
|
if pullimages:
|
|
click.echo(fmt.title("Docker image updates"))
|
|
context.invoke(compose.dc_command, command="pull")
|
|
click.echo(fmt.title("Starting the platform in detached mode"))
|
|
context.invoke(compose.start, detach=True)
|
|
click.echo(fmt.title("Database creation and migrations"))
|
|
context.invoke(compose.init)
|
|
|
|
config = tutor_config.load(context.obj.root)
|
|
fmt.echo_info(
|
|
"""The Open edX platform is now running in detached mode
|
|
Your Open edX platform is ready and can be accessed at the following urls:
|
|
|
|
{http}://{lms_host}
|
|
{http}://{cms_host}
|
|
""".format(
|
|
http="https" if config["ENABLE_HTTPS"] else "http",
|
|
lms_host=config["LMS_HOST"],
|
|
cms_host=config["CMS_HOST"],
|
|
)
|
|
)
|
|
|
|
|
|
@click.command(help="Upgrade from a previous Open edX named release")
|
|
@click.option(
|
|
"--from",
|
|
"from_version",
|
|
default="koa",
|
|
type=click.Choice(["ironwood", "juniper", "koa"]),
|
|
)
|
|
@click.option("-I", "--non-interactive", is_flag=True, help="Run non-interactively")
|
|
@click.pass_context
|
|
def upgrade(context: click.Context, from_version: str, non_interactive: bool) -> None:
|
|
config = tutor_config.load_no_check(context.obj.root)
|
|
|
|
if not non_interactive:
|
|
question = """You are about to upgrade your Open edX platform. It is strongly recommended to make a backup before upgrading. To do so, run:
|
|
|
|
tutor local stop
|
|
sudo rsync -avr "$(tutor config printroot)"/ /tmp/tutor-backup/
|
|
|
|
In case of problem, to restore your backup you will then have to run: sudo rsync -avr /tmp/tutor-backup/ "$(tutor config printroot)"/
|
|
|
|
Are you sure you want to continue?"""
|
|
click.confirm(
|
|
fmt.question(question), default=True, abort=True, prompt_suffix=" "
|
|
)
|
|
|
|
running_version = from_version
|
|
if running_version == "ironwood":
|
|
upgrade_from_ironwood(context, config)
|
|
running_version = "juniper"
|
|
|
|
if running_version == "juniper":
|
|
upgrade_from_juniper(context, config)
|
|
running_version = "koa"
|
|
|
|
if running_version == "koa":
|
|
upgrade_from_koa(context, config)
|
|
running_version = "lilac"
|
|
|
|
|
|
def upgrade_from_ironwood(context: click.Context, config: Config) -> None:
|
|
click.echo(fmt.title("Upgrading from Ironwood"))
|
|
tutor_env.save(context.obj.root, config)
|
|
|
|
click.echo(fmt.title("Stopping any existing platform"))
|
|
context.invoke(compose.stop)
|
|
|
|
if not config["RUN_MONGODB"]:
|
|
fmt.echo_info(
|
|
"You are not running MongDB (RUN_MONGODB=false). It is your "
|
|
"responsibility to upgrade your MongoDb instance to v3.6. There is "
|
|
"nothing left to do to upgrade from Ironwood to Juniper."
|
|
)
|
|
return
|
|
|
|
upgrade_mongodb(context, config, "3.4")
|
|
context.invoke(compose.stop)
|
|
upgrade_mongodb(context, config, "3.6")
|
|
context.invoke(compose.stop)
|
|
|
|
|
|
def upgrade_from_juniper(context: click.Context, config: Config) -> None:
|
|
click.echo(fmt.title("Upgrading from Juniper"))
|
|
tutor_env.save(context.obj.root, config)
|
|
|
|
click.echo(fmt.title("Stopping any existing platform"))
|
|
context.invoke(compose.stop)
|
|
|
|
if not config["RUN_MYSQL"]:
|
|
fmt.echo_info(
|
|
"You are not running MySQL (RUN_MYSQL=false). It is your "
|
|
"responsibility to upgrade your MySQL instance to v5.7. There is "
|
|
"nothing left to do to upgrade from Juniper."
|
|
)
|
|
return
|
|
|
|
click.echo(fmt.title("Upgrading MySQL from v5.6 to v5.7"))
|
|
context.invoke(compose.start, detach=True, services=["mysql"])
|
|
context.invoke(
|
|
compose.execute,
|
|
args=[
|
|
"mysql",
|
|
"bash",
|
|
"-e",
|
|
"-c",
|
|
"mysql_upgrade -u {} --password='{}'".format(
|
|
config["MYSQL_ROOT_USERNAME"], config["MYSQL_ROOT_PASSWORD"]
|
|
),
|
|
],
|
|
)
|
|
context.invoke(compose.stop)
|
|
|
|
|
|
def upgrade_from_koa(context: click.Context, config: Config) -> None:
|
|
if not config["RUN_MONGODB"]:
|
|
fmt.echo_info(
|
|
"You are not running MongDB (RUN_MONGODB=false). It is your "
|
|
"responsibility to upgrade your MongoDb instance to v4.0. There is "
|
|
"nothing left to do to upgrade from Koa to Lilac."
|
|
)
|
|
return
|
|
upgrade_mongodb(context, config, "4.0")
|
|
|
|
|
|
def upgrade_mongodb(context: click.Context, config: Config, to_version: str) -> None:
|
|
click.echo(fmt.title("Upgrading MongoDb to v{}".format(to_version)))
|
|
# Note that the DOCKER_IMAGE_MONGODB value is never saved, because we only save the
|
|
# environment, not the configuration.
|
|
config["DOCKER_IMAGE_MONGODB"] = "mongo:{}".format(to_version)
|
|
tutor_env.save(context.obj.root, config)
|
|
context.invoke(compose.start, detach=True, services=["mongodb"])
|
|
context.invoke(
|
|
compose.execute,
|
|
args=[
|
|
"mongodb",
|
|
"mongo",
|
|
"--eval",
|
|
'db.adminCommand({ setFeatureCompatibilityVersion: "%s" })' % to_version,
|
|
],
|
|
)
|
|
context.invoke(compose.stop)
|
|
|
|
|
|
local.add_command(quickstart)
|
|
local.add_command(upgrade)
|
|
compose.add_commands(local)
|