scripts/xds-docker-create-container.sh

   1 #!/bin/bash
   2 # shellcheck disable=SC2086
   3
   4 ##########################################
   5 # WARNING WARNING WARNING WARNING
   6 #
   7 # This script is an example to start a new AGL XDS container
   8 #
   9 # You should customize it to fit your environment and in particular
  10 # adjust the paths and permissions where needed.
  11 #
  12 ##########################################
  13
  14 REGISTRY=docker.automotivelinux.org
  15 REPO=agl
  16 NAME=worker
  17 FLAVOUR=xds
  18 VERSION=4.0
  19
  20 # ---------------------------------------------------
  21 # --- computed - don't touch !
  22 # ---------------------------------------------------
  23 DOCKER_USER=devel
  24
  25 DEFIMAGE=$REGISTRY/$REPO/$NAME-$FLAVOUR:$VERSION
  26
  27 function usage() {
  28         echo "Usage: $(basename $0) [-h|--help] [-fr] [-id <instance container ID>] "
  29     echo "          [-nc] [-nuu] [-v|--volume <inpath:outpath>] [image name]"
  30         echo "Image name is optional; 'docker images' is used by default to get image"
  31         echo "Default image:"
  32     echo " $DEFIMAGE"
  33     echo ""
  34     echo "Options:"
  35     echo " -fr | --force-restart   Force restart of xds-server service"
  36     echo " -id                     Instance ID used to build container name, a positive integer (0,1,2,...)"
  37     echo " -nuu | --no-uid-update  Don't update user/group id within docker"
  38     echo " -v | --volume           Additional docker volume to bind, syntax is -v /InDockerPath:/HostPath "
  39         exit 1
  40 }
  41
  42 ID=""
  43 IMAGE=""
  44 FORCE_RESTART=false
  45 UPDATE_UID=true
  46 USER_VOLUME_OPTION=""
  47 NO_CLEANUP=false
  48 while [ $# -ne 0 ]; do
  49     case $1 in
  50         -h|--help|"")
  51             usage
  52             ;;
  53         -fr|--force-restart)
  54             FORCE_RESTART=true
  55             ;;
  56         -nc|--no-cleanup)
  57             NO_CLEANUP=true
  58             ;;
  59         -nuu|--no-uid-update)
  60             UPDATE_UID=false
  61             ;;
  62         -v|--volume)
  63             shift
  64             if [[ "$1" =~ .*:.* ]]; then
  65                 USER_VOLUME_OPTION="-v $1"
  66             else
  67                 echo "Invalid volume option, format must be /InDockerPath:/hostPath"
  68                 exit 1
  69             fi
  70             ;;
  71         -id)
  72             shift
  73             ID=$1
  74             ;;
  75         *)
  76             if [[ "$1" =~ ^[\.0-9]+$ ]]; then
  77                 IMAGE=$REGISTRY/$REPO/$NAME-$FLAVOUR:$1
  78             else
  79                 IMAGE=$1
  80             fi
  81             ;;
  82     esac
  83     shift
  84 done
  85
  86 [ "$ID" = "" ] && ID=0
  87
  88 # Dynamically retrieve image name
  89 if [ "$IMAGE" = "" ]; then
  90
  91     VERSION_LIST=$(docker images $REGISTRY/$REPO/$NAME-$FLAVOUR --format '{{.Tag}}')
  92     VER_NUM=$(echo "$VERSION_LIST" | wc -l)
  93     if [ "$VER_NUM" -gt 1 ]; then
  94         echo "ERROR: more than one xds image found, please set explicitly the image to use !"
  95         echo "List of found images:"
  96         echo "$VERSION_LIST"
  97         exit 1
  98     elif [ "$VER_NUM" -lt 1 ]; then
  99         echo "ERROR: cannot automatically retrieve image tag for $REGISTRY/$REPO/$NAME-$FLAVOUR"
 100         exit 1
 101     fi
 102     if [ "$VERSION_LIST" = "" ]; then
 103         echo "ERROR: cannot automatically retrieve image tag for $REGISTRY/$REPO/$NAME-$FLAVOUR"
 104         usage
 105         exit 1
 106     fi
 107
 108     IMAGE=$REGISTRY/$REPO/$NAME-$FLAVOUR:$VERSION_LIST
 109 fi
 110
 111 USER=$(id -un)
 112 echo "Using instance ID #$ID (user $(id -un))"
 113
 114 NAME=agl-xds-$(hostname|cut -f1 -d'.')-$ID-$USER
 115
 116 if docker ps -a |grep "$NAME" > /dev/null; then
 117     echo "Image name already exist ! (use -h option to read help)"
 118     exit 1
 119 fi
 120
 121 XDS_WKS=$HOME/xds-workspace
 122 XDTDIR=$XDS_WKS/.xdt_$ID
 123
 124 SSH_PORT=$((2222 + ID))
 125 WWW_PORT=$((8000 + ID))
 126 BOOT_PORT=$((69 + ID))
 127 NBD_PORT=$((10809 + ID))
 128
 129 # Delete container on error
 130 creation_done=false
 131 trap "cleanExit" 0 1 2 15
 132 cleanExit ()
 133 {
 134     if [ "$creation_done" != "true" ] && [ "$NO_CLEANUP" != "true" ]; then
 135         echo "Error detected, remove unusable docker image ${NAME}"
 136         docker rm -f "${NAME}" > /dev/null 2>&1
 137     fi
 138 }
 139
 140 ### Create the new container
 141 mkdir -p $XDS_WKS $XDTDIR  || exit 1
 142 if ! docker run \
 143         --publish=${SSH_PORT}:22 \
 144         --publish=${WWW_PORT}:8000 \
 145         --publish=${BOOT_PORT}:69/udp \
 146         --publish=${NBD_PORT}:10809 \
 147         --detach=true \
 148         --hostname="$NAME" --name="$NAME" \
 149         --privileged -v /sys/fs/cgroup:/sys/fs/cgroup:ro \
 150         -v $XDS_WKS:/home/$DOCKER_USER/xds-workspace \
 151         -v $XDTDIR:/xdt \
 152     $USER_VOLUME_OPTION \
 153         -it $IMAGE;
 154 then
 155     echo "An error was encountered while creating docker container."
 156     exit 1
 157 fi
 158
 159 ### Ssh key
 160 echo "Copying your identity to container $NAME"
 161 echo -n wait ssh service .
 162 res=3
 163 max=30
 164 count=0
 165 while [ $res -ne 0 ] && [ $count -le $max ]; do
 166     sleep 1
 167     docker exec ${NAME} bash -c "systemctl status ssh" 2>/dev/null 1>&2
 168     res=$?
 169     echo -n "."
 170     count=$((count + 1));
 171 done
 172 echo
 173
 174 [ -f ~/.ssh/known_hosts ] && { ssh-keygen -R "[localhost]:$SSH_PORT" -f ~/.ssh/known_hosts || exit 1; }
 175 [ ! -f ~/.ssh/id_rsa.pub ] && { ssh-keygen -t rsa -f ~/.ssh/id_rsa -P "" > /dev/null || exit 1; }
 176 docker exec ${NAME} bash -c "mkdir -p /home/$DOCKER_USER/.ssh" || exit 1
 177 docker cp -L ~/.ssh/id_rsa.pub ${NAME}:/home/$DOCKER_USER/.ssh/authorized_keys || exit 1
 178 docker exec ${NAME} bash -c "chown $DOCKER_USER:$DOCKER_USER -R /home/$DOCKER_USER/.ssh ;chmod 0700 /home/$DOCKER_USER/.ssh; chmod 0600 /home/$DOCKER_USER/.ssh/*" || exit 1
 179 ssh -n -o StrictHostKeyChecking=no -p $SSH_PORT $DOCKER_USER@localhost exit || exit 1
 180
 181 echo "You can now login using:"
 182 echo "   ssh -p $SSH_PORT $DOCKER_USER@localhost"
 183
 184
 185 ### User / Group id
 186 if ($UPDATE_UID); then
 187     echo -n "Setup docker user and group id to match yours "
 188
 189     docker exec -t ${NAME} bash -c "/bin/loginctl kill-user devel"
 190     res=3
 191     max=30
 192     count=0
 193     while [ $res -ne 1 ] && [ $count -le $max ]; do
 194         sleep 1
 195         docker exec ${NAME} bash -c "loginctl user-status devel |grep sd-pam" 2>/dev/null 1>&2
 196         res=$?
 197         echo -n "."
 198         count=$((count + 1));
 199     done
 200
 201     echo -n " ."
 202
 203      # Set uid
 204     if docker exec -t ${NAME} bash -c "id $(id -u)" > /dev/null 2>&1 && [ "$(id -u)" != "1664" ]; then
 205         echo "Cannot set docker devel user id to your id: conflict id $(id -u) !"
 206         exit 1
 207     fi
 208     docker exec -t ${NAME} bash -c "usermod -u $(id -u) $DOCKER_USER" || exit 1
 209     echo -n "."
 210
 211     # Set gid
 212     if docker exec -t ${NAME} bash -c "grep $(id -g) /etc/group" > /dev/null 2>&1; then
 213         docker exec -t ${NAME} bash -c "usermod -g $(id -g) $DOCKER_USER" || exit 1
 214     else
 215         docker exec -t ${NAME} bash -c "groupmod -g $(id -g) $DOCKER_USER" || exit 1
 216     fi
 217     echo -n "."
 218
 219     docker exec -t ${NAME} bash -c "chown -R $DOCKER_USER:$DOCKER_USER /home/$DOCKER_USER" || exit 1
 220     echo -n "."
 221     docker exec -t ${NAME} bash -c "chown -R $DOCKER_USER:$DOCKER_USER /tmp/xds*"
 222     echo -n "."
 223     docker exec -t ${NAME} bash -c "systemctl start autologin"
 224     echo -n "."
 225     ssh -n -p $SSH_PORT $DOCKER_USER@localhost "systemctl --user start xds-server" || exit 1
 226     echo "."
 227     docker restart ${NAME}
 228 fi
 229
 230 creation_done=true
 231
 232 ### Force xds-server restart
 233 if ($FORCE_RESTART); then
 234     echo "Restart xds-server..."
 235     ssh -n -p $SSH_PORT $DOCKER_USER@localhost "systemctl --user restart xds-server" || exit 1
 236 fi
 237
 238 echo "Done, docker container $NAME is ready to be used."