mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-09-29 04:39:01 +00:00
01b58d9d75
With this change, containers are no longer run as "root" but as unprivileged users. This is necessary in some environments, notably some Kubernetes clusters. To make this possible, we need to manually fix bind-mounted volumes in docker-compose. This is pretty much equivalent to the behaviour in Kubernetes, where permissions are fixed at runtime if the volume owner is incorrect. Thus, we have a consistent behaviour between docker-compose and Kubernetes. We achieve this by bind-mounting some repos inside "*-permissions" services. These services run as root user on docker-compose and will fix the required permissions, as per build/permissions/setowner.sh These services simply do not run on Kubernetes, where we don't rely on bind-mounted volumes. There, we make use of Kubernete's built-in volume ownership feature. With this change, we get rid of the "openedx-dev" Docker image, in the sense that it no longer has its own Dockerfile. Instead, the dev image is now simply a different target in the multi-layer openedx Docker image. This makes it much faster to build the openedx-dev image. Because we declare the APP_USER_ID in the dev/docker-compose.yml file, we need to pass the user ID from the host there. The only way to achieve that is with a tutor config variable. The downside of this approach is that the dev/docker-compose.yml file is no longer portable from one machine to the next. We consider that this is not such a big issue, as it affects the development environment only. We take this opportunity to replace the base image of the "forum" image. There is now no need to re-install ruby inside the image. The total image size is only decreased by 10%, but re-building the image is faster. In order to run the smtp service as non-root, we switch from namshi/smtp to devture/exim-relay. This change should be backward-compatible. Note that the nginx container remains privileged. We could switch to nginxinc/nginx-unprivileged, but it's probably not worth the effort, as we are considering to get rid of the nginx container altogether. Close #323.
84 lines
2.5 KiB
Python
84 lines
2.5 KiB
Python
import os
|
|
from typing import List, Tuple
|
|
|
|
import click
|
|
|
|
from .exceptions import TutorError
|
|
from .jobs import BaseComposeJobRunner
|
|
from .utils import get_user_id
|
|
|
|
|
|
def create(
|
|
runner: BaseComposeJobRunner,
|
|
service: str,
|
|
path: str,
|
|
) -> str:
|
|
volumes_root_path = get_root_path(runner.root)
|
|
volume_name = get_name(path)
|
|
container_volumes_root_path = "/tmp/volumes"
|
|
command = """rm -rf {volumes_path}/{volume_name}
|
|
cp -r {src_path} {volumes_path}/{volume_name}
|
|
chown -R {user_id} {volumes_path}/{volume_name}""".format(
|
|
volumes_path=container_volumes_root_path,
|
|
volume_name=volume_name,
|
|
src_path=path,
|
|
user_id=get_user_id(),
|
|
)
|
|
|
|
# Create volumes root dir if it does not exist. Otherwise it is created with root owner and might not be writable
|
|
# in the container, e.g: in the dev containers.
|
|
if not os.path.exists(volumes_root_path):
|
|
os.makedirs(volumes_root_path)
|
|
|
|
runner.docker_compose(
|
|
"run",
|
|
"--rm",
|
|
"--no-deps",
|
|
"--user=0",
|
|
"--volume",
|
|
"{}:{}".format(volumes_root_path, container_volumes_root_path),
|
|
service,
|
|
"sh",
|
|
"-e",
|
|
"-c",
|
|
command,
|
|
)
|
|
return os.path.join(volumes_root_path, volume_name)
|
|
|
|
|
|
def get_path(root: str, container_bind_path: str) -> str:
|
|
bind_basename = get_name(container_bind_path)
|
|
return os.path.join(get_root_path(root), bind_basename)
|
|
|
|
|
|
def get_name(container_bind_path: str) -> str:
|
|
# We rstrip slashes, otherwise os.path.basename returns an empty string
|
|
# We don't use basename here as it will not work on Windows
|
|
name = container_bind_path.rstrip("/").split("/")[-1]
|
|
if not name:
|
|
raise TutorError("Mounting a container root folder is not supported")
|
|
return name
|
|
|
|
|
|
def get_root_path(root: str) -> str:
|
|
return os.path.join(root, "volumes")
|
|
|
|
|
|
def parse_volumes(docker_compose_args: List[str]) -> Tuple[List[str], List[str]]:
|
|
"""
|
|
Parse `-v/--volume` options from an arbitrary list of arguments.
|
|
"""
|
|
|
|
@click.command(context_settings={"ignore_unknown_options": True})
|
|
@click.option("-v", "--volume", "volumes", multiple=True)
|
|
@click.argument("args", nargs=-1)
|
|
def custom_docker_compose(
|
|
volumes: List[str], args: List[str]
|
|
) -> None: # pylint: disable=unused-argument
|
|
pass
|
|
|
|
if isinstance(docker_compose_args, tuple):
|
|
docker_compose_args = list(docker_compose_args)
|
|
context = custom_docker_compose.make_context("custom", docker_compose_args)
|
|
return context.params["volumes"], context.params["args"]
|