feat: add support for building and running the cli in a docker container

Author: starpit

Dockerfile

@@ -0,0 +1,38 @@
+FROM ubuntu:latest
+
+ENV DEBIAN_FRONTEND=noninteractive
+ENV PATH=/usr/local/CodeFlare/bin:$PATH
+
+# TODO hard-coded arch
+ADD dist/electron/CodeFlare-linux-x64 /usr/local/CodeFlare
+
+# Note, the `codeflare ...` commands are not strictly necessary. We do
+# them here only to save some time installing these prereqs on every
+# run.
+RUN apt update && apt -y install python3 python3-pip \
+        && apt -y clean && rm -rf /var/lib/apt/lists/* \
+        && codeflare util/jq \
+        && codeflare util/websocat \
+        && codeflare s3/install/cli \
+        && codeflare ml/ray/install/cli \
+        && codeflare kubernetes/kubectl \
+        && codeflare kubernetes/helm3 \
+        && adduser --disabled-password --gecos '' codeflare && adduser codeflare sudo && adduser root sudo && echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers \
+        && touch /home/codeflare/.codeflare 
+
+ENTRYPOINT ["codeflare"]
+WORKDIR /home/codeflare
+USER codeflare
+
+
+
+
+# in case we want to use the published production versions at some point...
+#RUN export FILE=CodeFlare-linux-$([ "$(uname -m)" = "x86_64" ] && echo x64 || echo arm64) \
+#        && apt update && apt -y install bash \
+#        && curl -LO https://github.com/project-codeflare/codeflare-cli/releases/latest/download/$FILE.zip \
+#        && unzip $FILE.zip \
+#        && apt -y remove curl unzip && apt -y clean && rm -rf /var/lib/apt/lists/* \
+#        && rm $FILE.zip \
+#        && mv $FILE /usr/local/CodeFlare
+

README.md

@@ -17,6 +17,41 @@ brew tap project-codeflare/codeflare-cli https://github.com/project-codeflare/co
 brew install codeflare
 ```
 
+## Development
+
+For codeflare-cli developers:
+
+```shell
+git clone https://github.com/project-codeflare/codeflare-cli
+cd codeflare-cli
+npm ci
+npm run watch
+```
+
+Now you may use `./bin/codeflare` to launch your local clone. The
+watcher will recompile things when you make changes to TypeScript or
+SCSS source files.
+
+### Docker
+
+If you want to build a Docker image, this command will build a
+production client (which takes around 30 seconds), and then build the
+Docker image (which takes another few minutes).
+
+```shell
+npm run build:docker
+```
+
+If you want to skip the first step, and only test building the Docker
+image, use `build:docker0`.
+
+To test your image, try `./bin/codeflare -d`. If you want to debug the
+image itself, use `npm run docker:debug` which will get you a shell
+into a running container.
+
+Limitations: the Docker build scripts are currently hard-wired to
+x86. PRs welcome to leverage `docker buildx` to build for ARM, etc.
+
 ## License
 
 CodeFlare CLI is an open-source project with an [Apache 2.0 license](LICENSE).

bin/codeflare

@@ -110,16 +110,22 @@ fi
 # check if the user wants us to run the graphical version (currently
 # indicated by the -u option)
 do_cli=1
-while getopts "nVus:" opt
+use_docker=0
+while getopts "dnVus:" opt
 do
     case $opt in
+        d) use_docker=1; continue;;
         u) do_cli=0; continue;;
         s) GUIDEBOOK_STORE=$OPTARG; continue;;
         *) EXTRAPREFIX="$EXTRAPREFIX -$opt"; continue;;
     esac
 done
 shift $((OPTIND-1))
 
+if [ $use_docker = 1 ]; then
+    exec docker run -it --entrypoint ${ENTRYPOINT-codeflare} --rm -v /tmp:/tmp -v ~/.aws:/home/codeflare/.aws -v ~/.bluemix:/home/codeflare/.bluemix -v ~/.kube:/home/codeflare/.kube -e KUBECONFIG=$(echo $KUBECONFIG | sed "s/$USER/codeflare/g" | sed 's/Users/home/g') projectcodeflare/codeflare-cli
+fi
+
 if  ([ $do_cli = 1 ] && [ $# = 0 ]) || ([ $# = 1 ] && [ "$1" != "version" ]); then
     # use the "guide" command if none was given
     EXTRAPREFIX="$EXTRAPREFIX guide"
@@ -164,5 +170,8 @@ if [ ! -f ~/.codeflare ] && [ $(uname) = Linux ]; then
     fi
 fi
 
+# helps with ctrl+c when running in a docker container
+trap 'pkill -P $$; exit 1;' TERM INT
+
 # otherwise, we launch the UI version
 "$NODE" "$HEADLESS"/codeflare.min.js -- $EXTRAPREFIX $*

package.json

@@ -19,6 +19,9 @@
     "pty:nodejs": "npm run pty:rebuild node",
     "prepare": "cross-env husky install",
     "preprod": "npm run mirror",
+    "build:docker0": "docker build -t projectcodeflare/codeflare-cli .",
+    "build:docker": "NO_INSTALLER=true npm run build:electron:linux:amd64 && npm run build:docker0",
+    "docker:debug": "ENTRYPOINT=bash ./bin/codeflare -d",
     "build:electron:mac:amd64": "npm run preprod && KUI_HEADLESS_WEBPACK=true KUI_LAUNCHER=$PWD/bin/codeflare PLATFORM=mac ARCH=x64 kui-build-electron",
     "build:electron:mac:arm64": "npm run preprod && KUI_HEADLESS_WEBPACK=true KUI_LAUNCHER=$PWD/bin/codeflare PLATFORM=mac ARCH=arm64 kui-build-electron",
     "build:electron:osx:amd64": "npm run preprod && KUI_HEADLESS_WEBPACK=true KUI_LAUNCHER=$PWD/bin/codeflare npm run build:electron:mac:amd64",