Yunikorn 146

.asf.yaml

@@ -1,3 +1,22 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+
 github:
   enabled_merge_buttons:
     squash:  true
@@ -6,4 +25,4 @@ github:
   features:
     wiki: true
     issues: false
-    projects: false
+    projects: false

.travis.yml

@@ -0,0 +1,49 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+language: node_js
+node_js:
+  - "12"
+
+git:
+  depth: 1
+
+services:
+  - 'docker'
+
+jobs:
+  include:
+    - stage: pre-commit checks
+      install:
+        - rm -rf package-lock.json node_modules
+        - npm install -g @angular/cli
+        - npm install karma
+        - npm install -g protractor
+        - npm install yarn
+      script:
+        - make check-license
+        - make build-prod
+        - yarn test:coverage
+        - yarn lint
+    - stage: publish docker image
+      install: skip
+      deploy:
+        provider: script
+        script: make push
+        on:
+          branch: master
+          condition: $TRAVIS_EVENT_TYPE = cron

Makefile

@@ -30,13 +30,22 @@ endif
 
 # Image build parameters
 # This tag of the image must be changed when pushed to a public repository.
-ifeq ($(TAG),)
-TAG := yunikorn/yunikorn-web
+ifeq ($(REGISTRY),)
+REGISTRY := apache
 endif
 
 # Set the default web port, this must be the same as in the nginx/nginx.conf file.
 PORT=9889
 
+.PHONY: check-license
+check-license:
+	@echo "checking license header"
+	@licRes=$$(grep -Lr --exclude-dir={node_modules,dist} --include=*.{sh,md,yaml,yml,js,ts,html,js,scss} "Licensed to the Apache Software Foundation" .) ; \
+	if [ -n "$${licRes}" ]; then \
+		echo "following files have incorrect license header:\n$${licRes}" ; \
+		exit 1; \
+	fi
+
 # Local build and deploy with compose
 .PHONY: deploy-prod
 deploy-prod:
@@ -50,17 +59,19 @@ start-dev:
 # Run the web interface from the production image
 .PHONY: run
 run: image
-	docker run -d -p ${PORT}:9889 ${TAG}:${VERSION}
+	docker run -d -p ${PORT}:9889 ${REGISTRY}/yunikorn:web-${VERSION}
 
 # Build the web interface in a production ready version
 .PHONY: build-prod
 build-prod:
 	yarn install && yarn build:prod
 
 # Build an image based on the production ready version
-image: build-prod
+.PHONY: image
+image:
+	@echo "building web UI docker image"
 	@SHA=$$(git rev-parse --short=12 HEAD) ; \
-	docker build -t ${TAG}:${VERSION} . \
+	docker build -t ${REGISTRY}/yunikorn:web-${VERSION} . \
 	--label "GitRevision=$${SHA}" \
 	--label "Version=${VERSION}" \
 	--label "BuildTimeStamp=${DATE}"
@@ -82,3 +93,9 @@ clean:
 	rm -rf ./node_modules
 	rm -rf ./out
 	rm -rf ./out-tsc
+
+.PHONY: push_image
+push_image: image
+	@echo "push docker images"
+	echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}" --password-stdin
+	docker push ${REGISTRY}/yunikorn:web-${VERSION}

README.md

@@ -1,3 +1,21 @@
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ -->
+
 # Yunikorn web UI
 YuniKorn web provides a web interface on top of the scheduler. It provides insight in the current and historic scheduler status.
 It depends on `yunikorn-core` which encapsulates all the actual scheduling logic.
@@ -31,11 +49,11 @@ Image builds are geared towards a production build and will always build with th
 Run `make image` to build the docker image `yunikorn-web`. 
 Run `make run` to build the image and deploy the container from the docker image `yunikorn-web`.
 
-You can set `TAG` and `VERSION` in the commandline to build docker image with a specified version and tag. For example,
+You can set `REGISTRY` and `VERSION` in the commandline to build docker image with a specified version and registry. For example,
 ```
-make image TAG=yunikorn/yunikorn-web VERSION=latest
+make image REGISTRY=yunikorn VERSION=latest
 ```
-this command will build binary with version `latest` and the docker image tag is `yunikorn/yunikorn-web:latest`.
+This command will build binary with version `web-latest` and the docker full image tag is `yunikorn/yunikorn:web-latest`.
 
 Run `make deploy-prod` to build and deploy the scheduler webapp using docker-compose.
 The project uses [multi-stage build](https://docs.docker.com/develop/develop-images/multistage-build/) feature of the docker and requires Docker 17.05 or higher.

docker-compose.yml

@@ -1,7 +1,26 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+
 version: '3'
 services:
   yunikornwebapp:
     build: .
-    image: yunikorn/yunikorn-web
+    image: yunikorn/yunikorn:web-latest
     ports:
       - 9889:9889

docker_start.sh

@@ -27,8 +27,8 @@ yarn install
 echo "[3/5] Building modules..."
 yarn build:prod
 
-echo "[4/5] Building docker image yunikorn/yunikorn-web:latest..."
-docker build -t yunikorn/yunikorn-web:latest -f ./nginx/Dockerfile .
+echo "[4/5] Building docker image apache/yunikorn:web-latest..."
+docker build -t apache/yunikorn:web-latest -f ./nginx/Dockerfile .
 
-echo "[5/5] Starting docker container using image yunikorn/yunikorn-web:latest..."
-docker run -d -p 9889:9889 yunikorn/yunikorn-web:latest
+echo "[5/5] Starting docker container using image apache/yunikorn:web-latest..."
+docker run -d -p 9889:9889 apache/yunikorn:web-latest

docs/how-to-contribute.md

@@ -1,3 +1,20 @@
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ -->
 # How do I contribute code? 
 
 ### Find