From a7f874f6e8f7eb1cc7175c9d0729e7a5d1c7fcc7 Mon Sep 17 00:00:00 2001 From: Fred Park Date: Tue, 3 Oct 2017 13:40:47 -0700 Subject: [PATCH] Docker image naming changes (#130) --- CHANGELOG.md | 2 ++ README.md | 4 ++-- docs/01-batch-shipyard-installation.md | 4 ++-- docs/20-batch-shipyard-usage.md | 8 ++++---- scripts/shipyard_nodeprep.sh | 13 +++++++------ scripts/shipyard_nodeprep_customimage.sh | 9 +++++---- scripts/shipyard_nodeprep_nativedocker.sh | 5 +++-- 7 files changed, 25 insertions(+), 20 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ffe1a7e..5a862e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,8 @@ commandline. - Virtual Network guide ### Changed +- **Breaking Change:** Docker image tag for the CLI has been renamed to +`alfpark/batch-shipyard:latest-cli`. - **Breaking Change:** Fully qualified Docker image names are now required under both the global config `global_resources`.`docker_images` and jobs `task` array `docker_image` (or `image`). diff --git a/README.md b/README.md index 89295c9..1d0dea3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![Build Status](https://travis-ci.org/Azure/batch-shipyard.svg?branch=master)](https://travis-ci.org/Azure/batch-shipyard) [![Build status](https://ci.appveyor.com/api/projects/status/3a0j0gww57o6nkpw/branch/master?svg=true)](https://ci.appveyor.com/project/alfpark/batch-shipyard) [![Docker Pulls](https://img.shields.io/docker/pulls/alfpark/batch-shipyard.svg)](https://hub.docker.com/r/alfpark/batch-shipyard) -[![Image Layers](https://images.microbadger.com/badges/image/alfpark/batch-shipyard:cli-latest.svg)](http://microbadger.com/images/alfpark/batch-shipyard) +[![Image Layers](https://images.microbadger.com/badges/image/alfpark/batch-shipyard:latest-cli.svg)](http://microbadger.com/images/alfpark/batch-shipyard) # Batch Shipyard [Batch Shipyard](https://github.com/Azure/batch-shipyard) is a tool to help @@ -91,7 +91,7 @@ the CLI. ### Local Installation Installation is typically an easy two-step process. The CLI is also available as a Docker image: -[alfpark/batch-shipyard:cli-latest](https://hub.docker.com/r/alfpark/batch-shipyard). +[alfpark/batch-shipyard:latest-cli](https://hub.docker.com/r/alfpark/batch-shipyard). Please see [the installation guide](http://batch-shipyard.readthedocs.io/en/latest/01-batch-shipyard-installation/) for more information regarding installation and requirements. diff --git a/docs/01-batch-shipyard-installation.md b/docs/01-batch-shipyard-installation.md index b734dfd..b7c04a0 100644 --- a/docs/01-batch-shipyard-installation.md +++ b/docs/01-batch-shipyard-installation.md @@ -290,7 +290,7 @@ Please see the Upgrading section below for information on upgrading to a new release of Batch Shipyard. ## Batch Shipyard CLI Installation via Docker -If using the [alfpark/batch-shipyard:cli-latest](https://hub.docker.com/r/alfpark/batch-shipyard) +If using the [alfpark/batch-shipyard:latest-cli](https://hub.docker.com/r/alfpark/batch-shipyard) Docker image, then all of the required software is bundled in the image itself, however, you will need an installation of the Docker engine on your machine. More information on installing Docker to your local machine @@ -298,7 +298,7 @@ can be found [here](https://www.docker.com/products/overview). To install: ```shell -docker pull alfpark/batch-shipyard:cli-latest +docker pull alfpark/batch-shipyard:latest-cli ``` This will pull the cli Docker image of batch-shipyard to your local machine. You are now ready to execute it with `docker run`. Please see the diff --git a/docs/20-batch-shipyard-usage.md b/docs/20-batch-shipyard-usage.md index 4d08c0d..e81064b 100644 --- a/docs/20-batch-shipyard-usage.md +++ b/docs/20-batch-shipyard-usage.md @@ -1,7 +1,7 @@ # Batch Shipyard Usage This page contains in-depth details on how to use the Batch Shipyard tool. Please see the [Batch Shipyard Docker Image CLI](#docker-cli) section for -information regarding how to use the `alfpark/batch-shipyard:cli-latest` +information regarding how to use the `alfpark/batch-shipyard:latest-cli` Docker image if not invoking the Python script directly. ## Batch Shipyard Invocation @@ -608,11 +608,11 @@ task `task1` from a live compute node. Because all portions of the `--filespec` option are specified, the tool will not prompt for any input. ## Batch Shipyard Docker Image CLI Invocation -If using the [alfpark/batch-shipyard:cli-latest](https://hub.docker.com/r/alfpark/batch-shipyard) +If using the [alfpark/batch-shipyard:latest-cli](https://hub.docker.com/r/alfpark/batch-shipyard) Docker image, then you would invoke the tool as: ```shell -docker run --rm -it alfpark/batch-shipyard:cli-latest \ +docker run --rm -it alfpark/batch-shipyard:latest-cli \ ``` @@ -631,7 +631,7 @@ as: docker run --rm -it \ -v /home/user/batch-shipyard-configs:/configs \ -e SHIPYARD_CONFIGDIR=/configs \ - alfpark/batch-shipyard:cli-latest \ + alfpark/batch-shipyard:latest-cli \ ``` diff --git a/scripts/shipyard_nodeprep.sh b/scripts/shipyard_nodeprep.sh index ebe827a..b35d2fe 100755 --- a/scripts/shipyard_nodeprep.sh +++ b/scripts/shipyard_nodeprep.sh @@ -382,8 +382,8 @@ docker_pull_image() { set -e } -echo "Configuration:" -echo "--------------" +echo "Configuration [Non-Native Docker]:" +echo "----------------------------------" echo "Batch Shipyard version: $version" echo "Blobxfer version: $blobxferversion" echo "Offer/Sku: $offer $sku" @@ -397,6 +397,7 @@ echo "Azure File: $azurefile" echo "GlusterFS on compute: $gluster_on_compute" echo "HPN-SSH: $hpnssh" echo "Block on images: $block" +echo "" # check sdb1 mount check_for_buggy_ntfs_mount @@ -836,8 +837,8 @@ fi # retrieve docker images related to data movement docker_pull_image alfpark/blobxfer:$blobxferversion -docker_pull_image alfpark/batch-shipyard:tfm-$version -docker_pull_image alfpark/batch-shipyard:rjm-$version +docker_pull_image alfpark/batch-shipyard:${version}-tfm +docker_pull_image alfpark/batch-shipyard:${version}-rjm # login to registry servers (do not specify -e as creds have been decrypted) ./registry_login.sh @@ -922,14 +923,14 @@ p2p=$p2p EOF chmod 600 $envfile # pull image - docker_pull_image alfpark/batch-shipyard:cascade-$version + docker_pull_image alfpark/batch-shipyard:${version}-cascade # launch container docker run $detached --net=host --env-file $envfile \ -v /var/run/docker.sock:/var/run/docker.sock \ -v $AZ_BATCH_NODE_ROOT_DIR:$AZ_BATCH_NODE_ROOT_DIR \ -w $AZ_BATCH_TASK_WORKING_DIR \ -p 6881-6891:6881-6891 -p 6881-6891:6881-6891/udp \ - alfpark/batch-shipyard:cascade-$version & + alfpark/batch-shipyard:${version}-cascade & cascadepid=$! else # add timings diff --git a/scripts/shipyard_nodeprep_customimage.sh b/scripts/shipyard_nodeprep_customimage.sh index 8a261d5..75e7288 100755 --- a/scripts/shipyard_nodeprep_customimage.sh +++ b/scripts/shipyard_nodeprep_customimage.sh @@ -315,6 +315,7 @@ echo "P2P: $p2penabled" echo "Azure File: $azurefile" echo "GlusterFS on compute: $gluster_on_compute" echo "Block on images: $block" +echo "" # check sdb1 mount check_for_buggy_ntfs_mount @@ -440,8 +441,8 @@ fi # retrieve docker images related to data movement docker_pull_image alfpark/blobxfer:$blobxferversion -docker_pull_image alfpark/batch-shipyard:tfm-$version -docker_pull_image alfpark/batch-shipyard:rjm-$version +docker_pull_image alfpark/batch-shipyard:${version}-tfm +docker_pull_image alfpark/batch-shipyard:${version}-rjm # login to registry servers (do not specify -e as creds have been decrypted) ./registry_login.sh @@ -483,14 +484,14 @@ p2p=$p2p EOF chmod 600 $envfile # pull image -docker_pull_image alfpark/batch-shipyard:cascade-$version +docker_pull_image alfpark/batch-shipyard:${version}-cascade # launch container docker run $detached --net=host --env-file $envfile \ -v /var/run/docker.sock:/var/run/docker.sock \ -v $AZ_BATCH_NODE_ROOT_DIR:$AZ_BATCH_NODE_ROOT_DIR \ -w $AZ_BATCH_TASK_WORKING_DIR \ -p 6881-6891:6881-6891 -p 6881-6891:6881-6891/udp \ - alfpark/batch-shipyard:cascade-$version & + alfpark/batch-shipyard:${version}-cascade & cascadepid=$! # if not in p2p mode, then wait for cascade exit diff --git a/scripts/shipyard_nodeprep_nativedocker.sh b/scripts/shipyard_nodeprep_nativedocker.sh index b37ea62..fcb74bf 100755 --- a/scripts/shipyard_nodeprep_nativedocker.sh +++ b/scripts/shipyard_nodeprep_nativedocker.sh @@ -274,6 +274,7 @@ echo "Encrypted: $encrypted" echo "Storage cluster mount: ${sc_args[*]}" echo "Azure File: $azurefile" echo "GlusterFS on compute: $gluster_on_compute" +echo "" # check sdb1 mount check_for_buggy_ntfs_mount @@ -436,8 +437,8 @@ fi # retrieve docker images related to data movement docker_pull_image alfpark/blobxfer:$blobxferversion -docker_pull_image alfpark/batch-shipyard:tfm-$version -docker_pull_image alfpark/batch-shipyard:rjm-$version +docker_pull_image alfpark/batch-shipyard:${version}-tfm +docker_pull_image alfpark/batch-shipyard:${version}-rjm # login to registry servers (do not specify -e as creds have been decrypted) ./registry_login.sh