7
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-06-15 20:12:20 +00:00
tutor/tutor/commands/images.py

154 lines
4.5 KiB
Python
Raw Normal View History

import click
from .. import config as tutor_config
from .. import env as tutor_env
from .. import images
from .. import plugins
from .. import utils
BASE_IMAGE_NAMES = ["openedx", "forum", "android"]
DEV_IMAGE_NAMES = ["openedx-dev"]
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
VENDOR_IMAGES = [
"caddy",
"elasticsearch",
"mongodb",
"mysql",
"nginx",
"redis",
"smtp",
]
2019-07-03 14:09:33 +00:00
2019-04-23 07:57:55 +00:00
@click.group(name="images", short_help="Manage docker images")
2019-04-23 07:57:55 +00:00
def images_command():
pass
2019-04-23 07:57:55 +00:00
@click.command(
short_help="Build docker images",
help="Build the docker images necessary for an Open edX platform.",
2019-02-13 19:18:47 +00:00
)
2020-10-01 22:25:03 +00:00
@click.argument("image_names", metavar="image", nargs=-1)
@click.option(
"--no-cache", is_flag=True, help="Do not use cache when building the image"
)
@click.option(
"-a",
"--build-arg",
"build_args",
multiple=True,
help="Set build-time docker ARGS in the form 'myarg=value'. This option may be specified multiple times.",
)
@click.option(
"--add-host",
"add_hosts",
multiple=True,
help="Set a custom host-to-IP mapping (host:ip).",
)
@click.pass_obj
2020-10-01 22:25:03 +00:00
def build(context, image_names, no_cache, build_args, add_hosts):
config = tutor_config.load(context.root)
command_args = []
if no_cache:
command_args.append("--no-cache")
for build_arg in build_args:
command_args += ["--build-arg", build_arg]
for add_host in add_hosts:
command_args += ["--add-host", add_host]
2020-10-01 22:25:03 +00:00
for image in image_names:
build_image(context.root, config, image, *command_args)
@click.command(short_help="Pull images from the Docker registry")
2020-10-01 22:25:03 +00:00
@click.argument("image_names", metavar="image", nargs=-1)
@click.pass_obj
2020-10-01 22:25:03 +00:00
def pull(context, image_names):
config = tutor_config.load(context.root)
2020-10-01 22:25:03 +00:00
for image in image_names:
pull_image(config, image)
@click.command(short_help="Push images to the Docker registry")
2020-10-01 22:25:03 +00:00
@click.argument("image_names", metavar="image", nargs=-1)
@click.pass_obj
2020-10-01 22:25:03 +00:00
def push(context, image_names):
config = tutor_config.load(context.root)
2020-10-01 22:25:03 +00:00
for image in image_names:
push_image(config, image)
@click.command(short_help="Print tag associated to a Docker image")
@click.argument("image_names", metavar="image", nargs=-1)
@click.pass_obj
def printtag(context, image_names):
config = tutor_config.load(context.root)
for image in image_names:
for _img, tag in iter_images(config, image, BASE_IMAGE_NAMES):
print(tag)
for _img, tag in iter_plugin_images(config, image, "build-image"):
print(tag)
2019-10-24 19:34:14 +00:00
def build_image(root, config, image, *args):
# Build base images
for img, tag in iter_images(config, image, BASE_IMAGE_NAMES):
images.build(tutor_env.pathjoin(root, "build", img), tag, *args)
# Build plugin images
for plugin, img, tag in iter_plugin_images(config, image, "build-image"):
images.build(
tutor_env.pathjoin(root, "plugins", plugin, "build", img), tag, *args
)
# Build dev images with user id argument
dev_build_arg = ["--build-arg", "USERID={}".format(utils.get_user_id())]
for img, tag in iter_images(config, image, DEV_IMAGE_NAMES):
images.build(tutor_env.pathjoin(root, "build", img), tag, *dev_build_arg, *args)
def pull_image(config, image):
for _img, tag in iter_images(config, image, all_image_names(config)):
images.pull(tag)
for _plugin, _img, tag in iter_plugin_images(config, image, "remote-image"):
images.pull(tag)
def push_image(config, image):
for _img, tag in iter_images(config, image, BASE_IMAGE_NAMES):
images.push(tag)
for _plugin, _img, tag in iter_plugin_images(config, image, "remote-image"):
images.push(tag)
def iter_images(config, image, image_list):
for img in image_list:
if image in [img, "all"]:
tag = images.get_tag(config, img)
yield img, tag
def iter_plugin_images(config, image, hook_name):
for plugin, hook in plugins.iter_hooks(config, hook_name):
for img, tag in hook.items():
if image in [img, "all"]:
tag = tutor_env.render_str(config, tag)
yield plugin, img, tag
2019-04-23 07:57:55 +00:00
def all_image_names(config):
return BASE_IMAGE_NAMES + vendor_image_names(config)
def vendor_image_names(config):
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
vendor_images = VENDOR_IMAGES[:]
for image in VENDOR_IMAGES:
if not config.get("RUN_" + image.upper(), True):
2019-07-03 14:09:33 +00:00
vendor_images.remove(image)
return vendor_images
2019-04-23 07:57:55 +00:00
images_command.add_command(build)
images_command.add_command(pull)
images_command.add_command(push)
2020-10-01 22:25:03 +00:00
images_command.add_command(printtag)