Merge pull request #279 from luxas/cross_compile

Docker development container

Author: bryk

.dockerignore

@@ -0,0 +1 @@
+.git

Dockerfile

@@ -0,0 +1,60 @@
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This is a Dockerfile for running and building Kubernetes dashboard
+# It installs all deps in the container and adds the dashboard source
+# This way it abstracts all required build tools away and lets the user run gulp tasks on the code with only docker installed
+
+# golang is based on debian:jessie
+FROM golang:1.5.3
+
+# Install python, java and nodejs. go is already installed
+# A small tweak, apt-get update is already run by the nodejs setup script, so there's no need to run it again
+RUN curl -sL https://deb.nodesource.com/setup_5.x | bash - \
+  && apt-get install -y --no-install-recommends \
+	file \
+	python \
+	openjdk-7-jre \
+  nodejs \
+	&& rm -rf /var/lib/apt/lists/* \
+	&& apt-get clean
+
+# Download a statically linked docker client, so the container is able to build images on the host
+RUN curl -sSL https://get.docker.com/builds/Linux/x86_64/docker-1.9.1 > /usr/bin/docker && \
+    chmod +x /usr/bin/docker
+
+# Current directory is always /dashboard
+WORKDIR /dashboard
+
+# Make an normal user, required for npm and bower, they are user programs and should not be called as root
+RUN useradd normaluser -m -s /bin/bash && \
+    chown -R normaluser /dashboard
+# Our normal user should have access to /dashboard
+
+# Switch user to normaluser
+USER normaluser
+
+# Copy over package.json bower.json and postinstall.sh.
+# Why? Because of docker caching, npm install will only run again if one of these have changed
+COPY package.json bower.json ./
+COPY build/postinstall.sh build/
+
+# Install all npm deps, bower deps and godep. This will take a while.
+RUN npm install
+
+# Copy over the rest of the source
+COPY ./ ./
+
+# Switch back to the root user when where going to communicate with docker
+USER root

README.md

@@ -16,27 +16,32 @@ Kubernetes Dashboard project consists of two main components. They are called he
 ## Preparation
 
 Make sure the following software is installed and added to the `$PATH` variable:
-* Docker (1.3+)
+* docker (1.3+)
 * go (1.5+)
 * nodejs (4.2.2+)
 * npm (1.3+)
 * java (7+)
 * gulp (3.9+)
+* bash 
 
 Clone the repository and install the dependencies:
 ```
 $ npm install
 ```
 
+## Run dashboard inside a container
+
+It's possible to run `gulp` and all the dependencies inside a development container. To do this, just replace `gulp [some arg]` commands with `build/run-gulp-in-docker.sh [some arg]`. If you do this, the only dependency is `docker`, and required commands such as `npm install` will be run automatically.
+
 ## Run a Kubernetes Cluster
 
-For development it is recommended to run a local Kubernetes cluster. For your convenience, a task is provided that checks out the latest stable version, and runs it inside a Docker container. Open a separate tab in your terminal and run the following command:
+For development it is recommended to run a local Kubernetes cluster. For your convenience, a task is provided that runs a small Kubernetes cluster inside Docker containers. Run the following command:
 
 ```
 $ gulp local-up-cluster
 ```
 
-This will build and start a lightweight local cluster, consisting of a master and a single node. All processes run locally, in Docker container. The local cluster should behave like a real cluster, however, plugins like heapster are not installed. To shut it down, type the following command that kills all running Docker containers:
+This will start a lightweight local cluster. All processes run locally, in Docker containers. The local cluster should behave like a real cluster, but it has some shortcomings. See issues related to https://github.com/kubernetes/kubernetes/tree/master/docs/getting-started-guides/docker.md for more details. To shut it down, you can type the following command that kills all running Docker containers:
 
 ```
 $ docker kill $(docker ps -aq)
@@ -91,11 +96,9 @@ Open a browser and access the UI under `localhost:9090.` The following processes
 
 Dashboard backend (9090)  ---> Kubernetes API server (8080)
 
-
-
 In order to package everything into a ready-to-run Docker image, use the following task:
 ```
-$ gulp docker-image
+$ gulp docker-image:canary
 ```
 You might notice that the Docker image is very small and requires only a few MB. Only Dashboard assets are added to a scratch image. This is possible, because the `dashboard` binary has no external dependencies. Awesome!
 

build/run-gulp-in-docker.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This is a script that runs gulp in a docker container,
+# for machines that doesn't have nodejs, go and java installed.
+
+DOCKER_RUN_OPTS=${DOCKER_RUN_OPTS:-}
+DASHBOARD_IMAGE_NAME="kubernetes-dashboard-build-image"
+DEFAULT_COMMAND=${DEFAULT_COMMAND:-"node_modules/.bin/gulp"}
+
+# Always test if the image is up-to-date. If nothing has changed since last build, it'll just use the already-built image
+docker build -t ${DASHBOARD_IMAGE_NAME} .
+
+# Run gulp in the container in interactive mode and expose necessary ports automatically
+docker run \
+	-it \
+	--rm \
+	--net=host \
+	-v /var/run/docker.sock:/var/run/docker.sock \
+	${DOCKER_RUN_OPTS} \
+	${DASHBOARD_IMAGE_NAME} \
+	${DEFAULT_COMMAND} $@