X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/6fb70ef1e1398c30137580c8417e98693dfbfc1d..3e8f849f40aed8fe2f6ce7e41c674195d177c52b:/doc/_includes/_install_compute_docker.liquid diff --git a/doc/_includes/_install_compute_docker.liquid b/doc/_includes/_install_compute_docker.liquid index 1a2e21c3b3..5a3efee740 100644 --- a/doc/_includes/_install_compute_docker.liquid +++ b/doc/_includes/_install_compute_docker.liquid @@ -1,17 +1,20 @@ +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} + h2. Install Docker Compute nodes must have Docker installed to run containers. This requires a relatively recent version of Linux (at least upstream version 3.10, or a distribution version with the appropriate patches backported). Follow the "Docker Engine installation documentation":https://docs.docker.com/ for your distribution. -For Debian-based systems, the Arvados package repository includes a backported @docker.io@ package with a known-good version you can install. - h2(#configure_docker_daemon). Configure the Docker daemon Crunch runs Docker containers with relatively little configuration. You may need to start the Docker daemon with specific options to make sure these jobs run smoothly in your environment. This section highlights options that are useful to most installations. Refer to the "Docker daemon reference":https://docs.docker.com/reference/commandline/daemon/ for complete information about all available options. The best way to configure these options varies by distribution. -* If you're using our backported @docker.io@ package, you can list these options in the @DOCKER_OPTS@ setting in @/etc/default/docker.io@. -* If you're using another Debian-based package, you can list these options in the @DOCKER_OPTS@ setting in @/etc/default/docker@. +* If you're using the Debian package, you can list these options in the @DOCKER_OPTS@ setting in @/etc/default/docker@. * On Red Hat-based distributions, you can list these options in the @other_args@ setting in @/etc/sysconfig/docker@. h3. Default ulimits @@ -43,3 +46,31 @@ On Red Hat-based systems, run: Finally, reboot the system to make these changes effective. + +h2. Create a project for Docker images + +Here we create a default project for the standard Arvados Docker images, and give all users read access to it. The project is owned by the system user. + + +
~$ uuid_prefix=`arv --format=uuid user current | cut -d- -f1`
+~$ project_uuid=`arv --format=uuid group create --group "{\"owner_uuid\":\"$uuid_prefix-tpzed-000000000000000\", \"group_class\":\"project\", \"name\":\"Arvados Standard Docker Images\"}"`
+~$ echo "Arvados project uuid is '$project_uuid'"
+~$ read -rd $'\000' newlink <<EOF; arv link create --link "$newlink"
+{
+ "tail_uuid":"$all_users_group_uuid",
+ "head_uuid":"$project_uuid",
+ "link_class":"permission",
+ "name":"can_read"
+}
+EOF
+
+ +h2. Download and tag the latest arvados/jobs docker image + +In order to start workflows from workbench, there needs to be Docker image tagged @arvados/jobs:latest@. The following command downloads the latest arvados/jobs image from Docker Hub, loads it into Keep, and tags it as 'latest'. In this example @$project_uuid@ should be the UUID of the "Arvados Standard Docker Images" project. + + +
~$ arv-keepdocker --pull arvados/jobs latest --project-uuid $project_uuid
+
+ +If the image needs to be downloaded from Docker Hub, the command can take a few minutes to complete, depending on available network bandwidth.