tutor k8s

Run Open edX on Kubernetes

tutor k8s [OPTIONS] COMMAND [ARGS]...

createuser

Create an Open edX user and interactively set their password

tutor k8s createuser [OPTIONS] NAME EMAIL

Options

--superuser

Make superuser

--staff

Make staff user

-p, --password <password>

Specify password from the command line. If undefined, you will be prompted to input a password

Arguments

NAME

Required argument

EMAIL

Required argument

delete

Completely delete an existing platform

tutor k8s delete [OPTIONS]

Options

-y, --yes

Do not ask for confirmation

exec

Execute a command in a pod of the given application

tutor k8s exec [OPTIONS] SERVICE COMMAND

Arguments

SERVICE

Required argument

COMMAND

Required argument

importdemocourse

Import the demo course

tutor k8s importdemocourse [OPTIONS]

init

Initialise all applications

tutor k8s init [OPTIONS]

Options

-l, --limit <limit>

Limit initialisation to this service or plugin

logs

View output from containers

tutor k8s logs [OPTIONS] SERVICE

Options

-c, --container <container>

Print the logs of this specific container

-f, --follow

Follow log output

--tail <tail>

Number of lines to show from each container

Arguments

SERVICE

Required argument

quickstart

Configure and run Open edX from scratch

tutor k8s quickstart [OPTIONS]

Options

-I, --non-interactive

Run non-interactively

reboot

Reboot an existing platform

tutor k8s reboot [OPTIONS]

settheme

Assign a theme to the LMS and the CMS. To reset to the default theme , use ‘default’ as the theme name.

tutor k8s settheme [OPTIONS] THEME_NAME

Options

-d, --domain <domains>

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

Arguments

THEME_NAME

Required argument

start

Run all configured Open edX services

tutor k8s start [OPTIONS]

stop

Stop a running platform

tutor k8s stop [OPTIONS]

upgrade

Upgrade from a previous Open edX named release

tutor k8s upgrade [OPTIONS]

Options

--from <from_version>
Options

ironwood | juniper | koa

wait

Wait for a pod to become ready

tutor k8s wait [OPTIONS] NAME

Arguments

NAME

Required argument