2020-12-25 21:56:42 +00:00
import os
2022-04-15 08:51:19 +00:00
import re
import typing as t
2020-12-25 21:56:42 +00:00
2020-01-08 18:38:13 +00:00
import click
2022-02-07 17:11:43 +00:00
from tutor import bindmounts
from tutor import config as tutor_config
from tutor import env as tutor_env
from tutor import fmt , jobs , utils
2022-04-15 08:51:19 +00:00
from tutor import serialize
2022-02-07 17:11:43 +00:00
from tutor . exceptions import TutorError
from tutor . types import Config
2022-04-15 08:51:19 +00:00
from tutor . commands . context import BaseJobContext
from tutor import hooks
2020-01-08 18:38:13 +00:00
2021-09-27 09:48:17 +00:00
class ComposeJobRunner ( jobs . BaseComposeJobRunner ) :
2021-09-27 10:32:28 +00:00
def __init__ ( self , root : str , config : Config ) :
super ( ) . __init__ ( root , config )
self . project_name = " "
2022-04-15 08:51:19 +00:00
self . docker_compose_files : t . List [ str ] = [ ]
self . docker_compose_job_files : t . List [ str ] = [ ]
2021-09-27 10:32:28 +00:00
def docker_compose ( self , * command : str ) - > int :
"""
Run docker - compose with the right yml files .
"""
2022-04-15 08:51:19 +00:00
self . __update_docker_compose_tmp ( )
2021-09-27 10:32:28 +00:00
args = [ ]
for docker_compose_path in self . docker_compose_files :
if os . path . exists ( docker_compose_path ) :
args + = [ " -f " , docker_compose_path ]
return utils . docker_compose (
* args , " --project-name " , self . project_name , * command
)
2022-04-15 08:51:19 +00:00
def __update_docker_compose_tmp ( self ) - > None :
"""
Update the contents of the docker - compose . tmp . yml file , which is generated at runtime .
"""
docker_compose_tmp = {
" version " : " {{ DOCKER_COMPOSE_VERSION }} " ,
" services " : { } ,
}
docker_compose_jobs_tmp = {
" version " : " {{ DOCKER_COMPOSE_VERSION }} " ,
" services " : { } ,
}
docker_compose_tmp = hooks . Filters . COMPOSE_LOCAL_TMP . apply ( docker_compose_tmp )
docker_compose_jobs_tmp = hooks . Filters . COMPOSE_LOCAL_JOBS_TMP . apply (
docker_compose_jobs_tmp
)
docker_compose_tmp = tutor_env . render_unknown ( self . config , docker_compose_tmp )
docker_compose_jobs_tmp = tutor_env . render_unknown (
self . config , docker_compose_jobs_tmp
)
tutor_env . write_to (
serialize . dumps ( docker_compose_tmp ) ,
tutor_env . pathjoin ( self . root , " local " , " docker-compose.tmp.yml " ) ,
)
tutor_env . write_to (
serialize . dumps ( docker_compose_jobs_tmp ) ,
tutor_env . pathjoin ( self . root , " local " , " docker-compose.jobs.tmp.yml " ) ,
)
2021-02-25 08:09:14 +00:00
def run_job ( self , service : str , command : str ) - > int :
Improve job running in local and k8s
Running jobs was previously done with "exec". This was because it
allowed us to avoid copying too much container specification information
from the docker-compose/deployments files to the jobs files. However,
this was limiting:
- In order to run a job, the corresponding container had to be running.
This was particularly painful in Kubernetes, where containers are
crashing as long as migrations are not correctly run.
- Containers in which we need to run jobs needed to be present in the
docker-compose/deployments files. This is unnecessary, for example when
mysql is disabled, or in the case of the certbot container.
Now, we create dedicated jobs files, both for local and k8s deployment.
This introduces a little redundancy, but not too much. Note that
dependent containers are not listed in the docker-compose.jobs.yml file,
so an actual platform is still supposed to be running when we launch the
jobs.
This also introduces a subtle change: now, jobs go through the container
entrypoint prior to running. This is probably a good thing, as it will
avoid forgetting about incorrect environment variables.
In k8s, we find ourselves interacting way too much with the kubectl
utility. Parsing output from the CLI is a pain. So we need to switch to
the native kubernetes client library.
2020-03-25 17:47:36 +00:00
"""
Run the " {{ service }}-job " service from local / docker - compose . jobs . yml with the
2021-11-02 17:24:38 +00:00
specified command .
Improve job running in local and k8s
Running jobs was previously done with "exec". This was because it
allowed us to avoid copying too much container specification information
from the docker-compose/deployments files to the jobs files. However,
this was limiting:
- In order to run a job, the corresponding container had to be running.
This was particularly painful in Kubernetes, where containers are
crashing as long as migrations are not correctly run.
- Containers in which we need to run jobs needed to be present in the
docker-compose/deployments files. This is unnecessary, for example when
mysql is disabled, or in the case of the certbot container.
Now, we create dedicated jobs files, both for local and k8s deployment.
This introduces a little redundancy, but not too much. Note that
dependent containers are not listed in the docker-compose.jobs.yml file,
so an actual platform is still supposed to be running when we launch the
jobs.
This also introduces a subtle change: now, jobs go through the container
entrypoint prior to running. This is probably a good thing, as it will
avoid forgetting about incorrect environment variables.
In k8s, we find ourselves interacting way too much with the kubectl
utility. Parsing output from the CLI is a pain. So we need to switch to
the native kubernetes client library.
2020-03-25 17:47:36 +00:00
"""
2021-09-27 10:32:28 +00:00
run_command = [ ]
for docker_compose_path in self . docker_compose_job_files :
path = tutor_env . pathjoin ( self . root , docker_compose_path )
if os . path . exists ( path ) :
run_command + = [ " -f " , path ]
2021-09-06 14:20:36 +00:00
run_command + = [ " run " , " --rm " ]
if not utils . is_a_tty ( ) :
run_command + = [ " -T " ]
2022-02-21 10:52:46 +00:00
job_service_name = f " { service } -job "
2021-09-27 09:48:17 +00:00
return self . docker_compose (
2021-09-06 14:20:36 +00:00
* run_command ,
job_service_name ,
2021-02-25 08:09:14 +00:00
" sh " ,
" -e " ,
" -c " ,
command ,
)
2020-01-08 18:38:13 +00:00
2021-09-27 09:48:17 +00:00
class BaseComposeContext ( BaseJobContext ) :
def job_runner ( self , config : Config ) - > ComposeJobRunner :
raise NotImplementedError
2022-04-15 08:51:19 +00:00
class MountParam ( click . ParamType ) :
"""
Parser for - - mount arguments of the form " service1[,service2,...]:/host/path:/container/path " .
"""
name = " mount "
MountType = t . Tuple [ str , str , str ]
# Note that this syntax does not allow us to include colon ':' characters in paths
PARAM_REGEXP = (
2022-04-21 15:43:44 +00:00
r " (?P<services>[a-zA-Z0-9-_, ]+):(?P<host_path>[^:]+):(?P<container_path>[^:]+) "
2022-04-15 08:51:19 +00:00
)
def convert (
self ,
value : str ,
param : t . Optional [ " click.Parameter " ] ,
ctx : t . Optional [ click . Context ] ,
) - > t . List [ " MountType " ] :
mounts : t . List [ " MountParam.MountType " ] = [ ]
match = re . match ( self . PARAM_REGEXP , value )
if match :
# Argument is of the form "containers:/host/path:/container/path"
services : t . List [ str ] = [
service . strip ( ) for service in match [ " services " ] . split ( " , " )
]
host_path = os . path . abspath ( os . path . expanduser ( match [ " host_path " ] ) )
host_path = host_path . replace ( os . path . sep , " / " )
container_path = match [ " container_path " ]
for service in services :
if not service :
self . fail (
f " incorrect services syntax: ' { match [ ' services ' ] } ' " , param , ctx
)
mounts . append ( ( service , host_path , container_path ) )
else :
# Argument is of the form "/host/path"
host_path = os . path . abspath ( os . path . expanduser ( value ) )
volumes : t . Iterator [
t . Tuple [ str , str ]
] = hooks . Filters . COMPOSE_MOUNTS . iterate ( os . path . basename ( host_path ) )
for service , container_path in volumes :
mounts . append ( ( service , host_path , container_path ) )
if not mounts :
raise self . fail ( f " no mount found for { value } " , param , ctx )
return mounts
mount_option = click . option (
" -m " ,
" --mount " ,
" mounts " ,
help = """ Bind-mount a folder from the host in the right containers. This option can take two different forms. The first one is explicit: ' service1[,service2...]:/host/path:/container/path ' . The other is implicit: ' /host/path ' . Arguments passed in the implicit form will be parsed by plugins to define the right folders to bind-mount from the host. """ ,
type = MountParam ( ) ,
multiple = True ,
)
2021-04-13 20:14:43 +00:00
@click.command (
short_help = " Run all or a selection of services. " ,
help = " Run all or a selection of services. Docker images will be rebuilt where necessary. " ,
)
2021-10-18 09:43:40 +00:00
@click.option ( " --skip-build " , is_flag = True , help = " Skip image building " )
2020-01-08 18:38:13 +00:00
@click.option ( " -d " , " --detach " , is_flag = True , help = " Start in daemon mode " )
2022-04-15 08:51:19 +00:00
@mount_option
2020-01-08 18:38:13 +00:00
@click.argument ( " services " , metavar = " service " , nargs = - 1 )
@click.pass_obj
2021-10-18 09:43:40 +00:00
def start (
2022-04-15 08:51:19 +00:00
context : BaseComposeContext ,
skip_build : bool ,
detach : bool ,
mounts : t . Tuple [ t . List [ MountParam . MountType ] ] ,
services : t . List [ str ] ,
2021-10-18 09:43:40 +00:00
) - > None :
command = [ " up " , " --remove-orphans " ]
if not skip_build :
command . append ( " --build " )
2020-01-08 18:38:13 +00:00
if detach :
command . append ( " -d " )
2022-04-15 08:51:19 +00:00
process_mount_arguments ( mounts )
2021-04-13 20:14:43 +00:00
# Start services
2021-09-27 09:48:17 +00:00
config = tutor_config . load ( context . root )
context . job_runner ( config ) . docker_compose ( * command , * services )
2020-01-08 18:38:13 +00:00
@click.command ( help = " Stop a running platform " )
@click.argument ( " services " , metavar = " service " , nargs = - 1 )
@click.pass_obj
2022-04-15 08:51:19 +00:00
def stop ( context : BaseComposeContext , services : t . List [ str ] ) - > None :
2020-01-08 18:38:13 +00:00
config = tutor_config . load ( context . root )
2021-09-27 09:48:17 +00:00
context . job_runner ( config ) . docker_compose ( " stop " , * services )
2020-01-08 18:38:13 +00:00
@click.command (
short_help = " Reboot an existing platform " ,
help = " This is more than just a restart: with reboot, the platform is fully stopped before being restarted again " ,
)
@click.option ( " -d " , " --detach " , is_flag = True , help = " Start in daemon mode " )
@click.argument ( " services " , metavar = " service " , nargs = - 1 )
2021-02-25 08:09:14 +00:00
@click.pass_context
2022-04-15 08:51:19 +00:00
def reboot ( context : click . Context , detach : bool , services : t . List [ str ] ) - > None :
2021-02-25 08:09:14 +00:00
context . invoke ( stop , services = services )
context . invoke ( start , detach = detach , services = services )
2020-01-08 18:38:13 +00:00
@click.command (
short_help = " Restart some components from a running platform. " ,
help = """ Specify ' openedx ' to restart the lms, cms and workers, or ' all ' to
restart all services . Note that this performs a ' docker-compose restart ' , so new images
may not be taken into account . It is useful for reloading settings , for instance . To
fully stop the platform , use the ' reboot ' command . """ ,
)
2020-03-12 08:52:22 +00:00
@click.argument ( " services " , metavar = " service " , nargs = - 1 )
2020-01-08 18:38:13 +00:00
@click.pass_obj
2022-04-15 08:51:19 +00:00
def restart ( context : BaseComposeContext , services : t . List [ str ] ) - > None :
2020-01-08 18:38:13 +00:00
config = tutor_config . load ( context . root )
command = [ " restart " ]
2020-03-12 08:52:22 +00:00
if " all " in services :
pass
else :
for service in services :
Improve job running in local and k8s
Running jobs was previously done with "exec". This was because it
allowed us to avoid copying too much container specification information
from the docker-compose/deployments files to the jobs files. However,
this was limiting:
- In order to run a job, the corresponding container had to be running.
This was particularly painful in Kubernetes, where containers are
crashing as long as migrations are not correctly run.
- Containers in which we need to run jobs needed to be present in the
docker-compose/deployments files. This is unnecessary, for example when
mysql is disabled, or in the case of the certbot container.
Now, we create dedicated jobs files, both for local and k8s deployment.
This introduces a little redundancy, but not too much. Note that
dependent containers are not listed in the docker-compose.jobs.yml file,
so an actual platform is still supposed to be running when we launch the
jobs.
This also introduces a subtle change: now, jobs go through the container
entrypoint prior to running. This is probably a good thing, as it will
avoid forgetting about incorrect environment variables.
In k8s, we find ourselves interacting way too much with the kubectl
utility. Parsing output from the CLI is a pain. So we need to switch to
the native kubernetes client library.
2020-03-25 17:47:36 +00:00
if service == " openedx " :
2020-09-17 10:53:14 +00:00
if config [ " RUN_LMS " ] :
2020-03-12 08:52:22 +00:00
command + = [ " lms " , " lms-worker " ]
2020-09-17 10:53:14 +00:00
if config [ " RUN_CMS " ] :
2020-03-12 08:52:22 +00:00
command + = [ " cms " , " cms-worker " ]
else :
command . append ( service )
2021-09-27 09:48:17 +00:00
context . job_runner ( config ) . docker_compose ( * command )
2020-01-08 18:38:13 +00:00
@click.command ( help = " Initialise all applications " )
2020-06-01 20:38:04 +00:00
@click.option ( " -l " , " --limit " , help = " Limit initialisation to this service or plugin " )
2022-04-15 08:51:19 +00:00
@mount_option
2020-01-08 18:38:13 +00:00
@click.pass_obj
2022-04-15 08:51:19 +00:00
def init (
context : BaseComposeContext ,
limit : str ,
mounts : t . Tuple [ t . List [ MountParam . MountType ] ] ,
) - > None :
process_mount_arguments ( mounts )
2020-01-08 18:38:13 +00:00
config = tutor_config . load ( context . root )
2021-09-27 09:48:17 +00:00
runner = context . job_runner ( config )
2021-03-13 18:46:44 +00:00
jobs . initialise ( runner , limit_to = limit )
2020-01-08 18:38:13 +00:00
@click.command ( help = " Create an Open edX user and interactively set their password " )
@click.option ( " --superuser " , is_flag = True , help = " Make superuser " )
@click.option ( " --staff " , is_flag = True , help = " Make staff user " )
@click.option (
" -p " ,
" --password " ,
help = " Specify password from the command line. If undefined, you will be prompted to input a password " ,
)
@click.argument ( " name " )
@click.argument ( " email " )
@click.pass_obj
2021-02-25 08:09:14 +00:00
def createuser (
2021-09-27 09:48:17 +00:00
context : BaseComposeContext ,
superuser : str ,
staff : bool ,
password : str ,
name : str ,
email : str ,
2021-02-25 08:09:14 +00:00
) - > None :
2020-01-08 18:38:13 +00:00
config = tutor_config . load ( context . root )
2021-09-27 09:48:17 +00:00
runner = context . job_runner ( config )
2021-03-13 18:46:44 +00:00
command = jobs . create_user_command ( superuser , staff , name , email , password = password )
Improve job running in local and k8s
Running jobs was previously done with "exec". This was because it
allowed us to avoid copying too much container specification information
from the docker-compose/deployments files to the jobs files. However,
this was limiting:
- In order to run a job, the corresponding container had to be running.
This was particularly painful in Kubernetes, where containers are
crashing as long as migrations are not correctly run.
- Containers in which we need to run jobs needed to be present in the
docker-compose/deployments files. This is unnecessary, for example when
mysql is disabled, or in the case of the certbot container.
Now, we create dedicated jobs files, both for local and k8s deployment.
This introduces a little redundancy, but not too much. Note that
dependent containers are not listed in the docker-compose.jobs.yml file,
so an actual platform is still supposed to be running when we launch the
jobs.
This also introduces a subtle change: now, jobs go through the container
entrypoint prior to running. This is probably a good thing, as it will
avoid forgetting about incorrect environment variables.
In k8s, we find ourselves interacting way too much with the kubectl
utility. Parsing output from the CLI is a pain. So we need to switch to
the native kubernetes client library.
2020-03-25 17:47:36 +00:00
runner . run_job ( " lms " , command )
2020-01-08 18:38:13 +00:00
2020-03-13 11:09:48 +00:00
@click.command (
2021-09-15 09:21:01 +00:00
help = " Assign a theme to the LMS and the CMS. To reset to the default theme , use ' default ' as the theme name. "
)
@click.option (
" -d " ,
" --domain " ,
" domains " ,
multiple = True ,
help = (
" Limit the theme to these domain names. By default, the theme is "
" applied to the LMS and the CMS, both in development and production mode "
) ,
2020-03-13 11:09:48 +00:00
)
@click.argument ( " theme_name " )
@click.pass_obj
2022-04-15 08:51:19 +00:00
def settheme (
context : BaseComposeContext , domains : t . List [ str ] , theme_name : str
) - > None :
2020-03-13 11:09:48 +00:00
config = tutor_config . load ( context . root )
2021-09-27 09:48:17 +00:00
runner = context . job_runner ( config )
2021-09-15 09:21:01 +00:00
domains = domains or jobs . get_all_openedx_domains ( config )
jobs . set_theme ( theme_name , domains , runner )
2020-03-13 11:09:48 +00:00
2020-01-08 18:38:13 +00:00
@click.command ( help = " Import the demo course " )
@click.pass_obj
2021-09-27 09:48:17 +00:00
def importdemocourse ( context : BaseComposeContext ) - > None :
2020-01-08 18:38:13 +00:00
config = tutor_config . load ( context . root )
2021-09-27 09:48:17 +00:00
runner = context . job_runner ( config )
2020-01-08 18:38:13 +00:00
fmt . echo_info ( " Importing demo course " )
2021-03-13 18:46:44 +00:00
jobs . import_demo_course ( runner )
2020-01-08 18:38:13 +00:00
2020-11-16 11:46:01 +00:00
@click.command (
short_help = " Run a command in a new container " ,
help = (
" Run a command in a new container. This is a wrapper around `docker-compose run`. Any option or argument passed "
" to this command will be forwarded to docker-compose. Thus, you may use `-v` or `-p` to mount volumes and "
" expose ports. "
) ,
context_settings = { " ignore_unknown_options " : True } ,
)
2022-04-15 08:51:19 +00:00
@mount_option
2020-11-16 11:46:01 +00:00
@click.argument ( " args " , nargs = - 1 , required = True )
2021-02-25 08:09:14 +00:00
@click.pass_context
2022-04-15 08:51:19 +00:00
def run (
context : click . Context ,
mounts : t . Tuple [ t . List [ MountParam . MountType ] ] ,
args : t . List [ str ] ,
) - > None :
process_mount_arguments ( mounts )
2020-12-25 21:56:42 +00:00
extra_args = [ " --rm " ]
2020-11-16 11:46:01 +00:00
if not utils . is_a_tty ( ) :
2020-12-25 21:56:42 +00:00
extra_args . append ( " -T " )
2021-02-25 08:09:14 +00:00
context . invoke ( dc_command , command = " run " , args = [ * extra_args , * args ] )
2020-12-25 21:56:42 +00:00
@click.command (
name = " bindmount " ,
help = " Copy the contents of a container directory to a ready-to-bind-mount host directory " ,
)
@click.argument (
" service " ,
)
@click.argument ( " path " )
@click.pass_obj
2021-09-27 09:48:17 +00:00
def bindmount_command ( context : BaseComposeContext , service : str , path : str ) - > None :
2022-04-15 08:51:19 +00:00
"""
This command is made obsolete by the - - mount arguments .
"""
2020-12-25 21:56:42 +00:00
config = tutor_config . load ( context . root )
2021-09-27 09:48:17 +00:00
host_path = bindmounts . create ( context . job_runner ( config ) , service , path )
2020-12-25 21:56:42 +00:00
fmt . echo_info (
2022-02-21 10:52:46 +00:00
f " Bind-mount volume created at { host_path } . You can now use it in all `local` and `dev` "
f " commands with the `--volume= { path } ` option. "
2020-12-25 21:56:42 +00:00
)
2020-11-16 11:46:01 +00:00
@click.command (
short_help = " Run a command in a running container " ,
help = (
" Run a command in a running container. This is a wrapper around `docker-compose exec`. Any option or argument "
" passed to this command will be forwarded to docker-compose. Thus, you may use `-e` to manually define "
" environment variables. "
) ,
context_settings = { " ignore_unknown_options " : True } ,
name = " exec " ,
)
@click.argument ( " args " , nargs = - 1 , required = True )
2021-02-25 08:09:14 +00:00
@click.pass_context
2022-04-15 08:51:19 +00:00
def execute ( context : click . Context , args : t . List [ str ] ) - > None :
2021-02-25 08:09:14 +00:00
context . invoke ( dc_command , command = " exec " , args = args )
2020-11-16 11:46:01 +00:00
@click.command (
short_help = " View output from containers " ,
help = " View output from containers. This is a wrapper around `docker-compose logs`. " ,
)
@click.option ( " -f " , " --follow " , is_flag = True , help = " Follow log output " )
@click.option ( " --tail " , type = int , help = " Number of lines to show from each container " )
@click.argument ( " service " , nargs = - 1 )
2021-02-25 08:09:14 +00:00
@click.pass_context
def logs ( context : click . Context , follow : bool , tail : bool , service : str ) - > None :
2020-12-25 21:56:42 +00:00
args = [ ]
2020-11-16 11:46:01 +00:00
if follow :
2020-12-25 21:56:42 +00:00
args . append ( " --follow " )
2020-11-16 11:46:01 +00:00
if tail is not None :
2020-12-25 21:56:42 +00:00
args + = [ " --tail " , str ( tail ) ]
args + = service
2021-02-25 08:09:14 +00:00
context . invoke ( dc_command , command = " logs " , args = args )
2020-12-25 21:56:42 +00:00
2022-04-08 16:02:21 +00:00
@click.command ( help = " Print status information for containers " )
@click.pass_context
def status ( context : click . Context ) - > None :
context . invoke ( dc_command , command = " ps " )
2020-12-25 21:56:42 +00:00
@click.command (
short_help = " Direct interface to docker-compose. " ,
help = (
" Direct interface to docker-compose. This is a wrapper around `docker-compose`. Most commands, options and "
" arguments passed to this command will be forwarded as-is to docker-compose. "
) ,
context_settings = { " ignore_unknown_options " : True } ,
name = " dc " ,
)
@click.argument ( " command " )
2021-05-04 15:57:47 +00:00
@click.argument ( " args " , nargs = - 1 )
2020-12-25 21:56:42 +00:00
@click.pass_obj
2022-04-15 08:51:19 +00:00
def dc_command ( context : BaseComposeContext , command : str , args : t . List [ str ] ) - > None :
2020-12-25 21:56:42 +00:00
config = tutor_config . load ( context . root )
volumes , non_volume_args = bindmounts . parse_volumes ( args )
volume_args = [ ]
for volume_arg in volumes :
if " : " not in volume_arg :
# This is a bind-mounted volume from the "volumes/" folder.
host_bind_path = bindmounts . get_path ( context . root , volume_arg )
if not os . path . exists ( host_bind_path ) :
raise TutorError (
2022-02-21 10:52:46 +00:00
f " Bind-mount volume directory { host_bind_path } does not exist. It must first be created "
f " with the ' { bindmount_command . name } ' command. "
2020-12-25 21:56:42 +00:00
)
2022-02-21 10:52:46 +00:00
volume_arg = f " { host_bind_path } : { volume_arg } "
2020-12-25 21:56:42 +00:00
volume_args + = [ " --volume " , volume_arg ]
2021-09-27 09:48:17 +00:00
context . job_runner ( config ) . docker_compose ( command , * volume_args , * non_volume_args )
2020-11-16 11:46:01 +00:00
2022-04-15 08:51:19 +00:00
def process_mount_arguments ( mounts : t . Tuple [ t . List [ MountParam . MountType ] ] ) - > None :
"""
Process - - mount arguments .
Most docker - compose commands support - - mount arguments . This option
is used to bind - mount folders from the host . A docker - compose . tmp . yml is
generated at runtime and includes the bind - mounted volumes that were passed as CLI
arguments .
Bind - mounts that are associated to " *-job " services will be added to the
docker - compose jobs file .
"""
app_mounts : t . List [ MountParam . MountType ] = [ ]
job_mounts : t . List [ MountParam . MountType ] = [ ]
for mount in mounts :
for service , host_path , container_path in mount :
if service . endswith ( " -job " ) :
job_mounts . append ( ( service , host_path , container_path ) )
else :
app_mounts . append ( ( service , host_path , container_path ) )
def _add_mounts (
docker_compose : t . Dict [ str , t . Any ] , bind_mounts : t . List [ MountParam . MountType ]
) - > t . Dict [ str , t . Any ] :
services = docker_compose . setdefault ( " services " , { } )
for service , host_path , container_path in bind_mounts :
fmt . echo_info ( f " Bind-mount: { host_path } -> { container_path } in { service } " )
services . setdefault ( service , { " volumes " : [ ] } )
services [ service ] [ " volumes " ] . append ( f " { host_path } : { container_path } " )
return docker_compose
# Save bind-mounts
@hooks.Filters.COMPOSE_LOCAL_TMP.add ( )
def _add_mounts_to_docker_compose_tmp (
docker_compose_tmp : t . Dict [ str , t . Any ]
) - > t . Dict [ str , t . Any ] :
return _add_mounts ( docker_compose_tmp , app_mounts )
@hooks.Filters.COMPOSE_LOCAL_JOBS_TMP.add ( )
def _add_mounts_to_docker_compose_jobs_tmp (
docker_compose_tmp : t . Dict [ str , t . Any ]
) - > t . Dict [ str , t . Any ] :
return _add_mounts ( docker_compose_tmp , job_mounts )
@hooks.Filters.COMPOSE_MOUNTS.add ( )
def _mount_edx_platform (
volumes : t . List [ t . Tuple [ str , str ] ] , name : str
) - > t . List [ t . Tuple [ str , str ] ] :
"""
When mounting edx - platform with ` - - mount = / path / to / edx - platform ` , bind - mount the host
repo in the lms / cms containers .
"""
if name == " edx-platform " :
path = " /openedx/edx-platform "
volumes + = [
( " lms " , path ) ,
( " cms " , path ) ,
( " lms-worker " , path ) ,
( " cms-worker " , path ) ,
( " lms-job " , path ) ,
( " cms-job " , path ) ,
]
return volumes
2021-02-25 08:09:14 +00:00
def add_commands ( command_group : click . Group ) - > None :
2020-01-08 18:38:13 +00:00
command_group . add_command ( start )
command_group . add_command ( stop )
command_group . add_command ( restart )
command_group . add_command ( reboot )
command_group . add_command ( init )
command_group . add_command ( createuser )
command_group . add_command ( importdemocourse )
2020-03-13 11:09:48 +00:00
command_group . add_command ( settheme )
2020-11-16 11:46:01 +00:00
command_group . add_command ( dc_command )
command_group . add_command ( run )
2020-12-25 21:56:42 +00:00
command_group . add_command ( bindmount_command )
2020-11-16 11:46:01 +00:00
command_group . add_command ( execute )
command_group . add_command ( logs )
2022-04-08 16:02:21 +00:00
command_group . add_command ( status )