This is an automated email from the ASF dual-hosted git repository.
pingsutw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new 76e31e9c SUBMARINE-1259. Push submarine-cicd and jupyter-gpu docker
images to docker hub and update submarine cicd doc
76e31e9c is described below
commit 76e31e9cb7f5a2cc7a589db59830d03ff5f2645d
Author: MortalHappiness <[email protected]>
AuthorDate: Tue Apr 19 00:12:10 2022 +0800
SUBMARINE-1259. Push submarine-cicd and jupyter-gpu docker images to docker
hub and update submarine cicd doc
### What is this PR for?
1. Push submarine-cicd and jupyter-gpu docker images to docker hub.
2. Update the documentation of submarine cicd.
### What type of PR is it?
[Improvement]
### Todos
* [x] Push submarine-cicd and jupyter-gpu docker images to docker hub.
* [x] Update the documentation of submarine cicd.
### What is the Jira issue?
https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE-1259
### How should this be tested?
<!--
* First time? Setup Travis CI as described on
https://submarine.apache.org/contribution/contributions.html#continuous-integration
* Strongly recommended: add automated unit tests for any new or changed
behavior
* Outline any manual steps to test the PR here.
-->
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: MortalHappiness <[email protected]>
Signed-off-by: Kevin Su <[email protected]>
Closes #937 from MortalHappiness/SUBMARINE-1259 and squashes the following
commits:
8191291a [MortalHappiness] SUBMARINE-1259. Push submarine-cicd and
jupyter-gpu docker images to docker hub and update submarine cicd doc
---
.github/workflows/deploy_docker_images.yml | 10 ++++++
dev-support/cicd/README.md | 51 ++++++++++++++++++------------
dev-support/cicd/build.sh | 32 +++++++++++++++++++
3 files changed, 72 insertions(+), 21 deletions(-)
diff --git a/.github/workflows/deploy_docker_images.yml
b/.github/workflows/deploy_docker_images.yml
index 75e23bd7..4955dc49 100644
--- a/.github/workflows/deploy_docker_images.yml
+++ b/.github/workflows/deploy_docker_images.yml
@@ -70,6 +70,11 @@ jobs:
- name: Push submarine-jupyter docker image
run: docker push apache/submarine:jupyter-notebook-$SUBMARINE_VERSION
+ - name: Build submarine jupyter gpu
+ run: ./dev-support/docker-images/jupyter-gpu/build.sh
+ - name: Push submarine-jupyter-gpu docker image
+ run: docker push
apache/submarine:jupyter-notebook-gpu-$SUBMARINE_VERSION
+
- name: Build submarine operator
run: ./dev-support/docker-images/operator/build.sh
- name: Push submarine-operator docker image
@@ -89,3 +94,8 @@ jobs:
run: ./dev-support/examples/quickstart/build.sh
- name: Push submarine quickstart docker image
run: docker push apache/submarine:quickstart-$SUBMARINE_VERSION
+
+ - name: Build submarine cicd
+ run: ./dev-support/cicd/build.sh
+ - name: Push submarine-cicd docker image
+ run: docker push apache/submarine:cicd-$SUBMARINE_VERSION
diff --git a/dev-support/cicd/README.md b/dev-support/cicd/README.md
index 1a327a19..20b82dde 100644
--- a/dev-support/cicd/README.md
+++ b/dev-support/cicd/README.md
@@ -11,6 +11,7 @@
See the License for the specific language governing permissions and
limitations under the License. See accompanying LICENSE file.
-->
+
# CICD Introduction
> Please note that cicd is a tool provided to submarine committers for PR
> merging and release. Only submarine committers have permission to execute.
@@ -21,44 +22,53 @@ To use them more easily, we provide a Docker image to help
committer to handle t
## Docker mode
+Build the image and start the container
+
```
./build_and_start_cicd_image.sh
```
-Or
+Or separate image building and container running process
```
-cd <path-to-submarine-home>/dev-support/cicd
-docker build -t submarine-cicd .
-docker run -it --rm submarine-cicd
+./build.sh
+docker run -it --rm apache/submarine:cicd-0.7.0
```
-Jira username, password, apache id and apache username are required in the
docker container. You can
-add them to the local environment variable.
+Or directly use the image on docker hub
```
-vi ~/.bash_profile
-export JIRA_USERNAME='Your jira username'
-export JIRA_PASSWORD='Your jira password'
-export APACHE_ID='Your apache id' # Your apache email prefix
-export APACHE_NAME='Your apache name'
+docker run -it --rm apache/submarine:cicd-0.7.0
```
-And you'll see output like below and then you can decide what to accomplish.
+After successfully running the container, you will see output like below and
then you can decide what to accomplish.
+
```
-$ docker run -it -e JIRA_USERNAME="${JIRA_USERNAME}" -e
JIRA_PASSWORD="${JIRA_PASSWORD}" -e APACHE_ID="${APACHE_ID}" -e
APACHE_NAME="${APACHE_NAME}" -p 4000:4000 --rm submarine-cicd
+Start Submarine CI/CD.
+==== Merge PR Begin ====
+Enter Your Apache JIRA User name:
```
-The screen outputs the following information:
+Jira username, password, apache id and apache username can be provided to the
docker container so that you do not need to type them everytime. You can add
them to the local environment variable file.
+
+For example, create a file named `~/.secrets/submarine-cicd.env` and write the
following content to it.
```
-Start Submarine CI/CD.
-==== Merge PR Begin ====
-Enter Your Apache JIRA User name:
+JIRA_USERNAME=YOUR_JIRA_USERNAME
+JIRA_PASSWORD=YOUR_JIRA_PASSWORD
+APACHE_ID=YOUR_APACHE_ID
+APACHE_NAME=YOUR_APACHE_NAME
+```
+
+And then you can run the docker image with the following command
+
```
+docker run -it --env-file ~/.secrets/submarine-cicd.env -p 4000:4000 --rm
apache/submarine:cicd-0.7.0
+```
+
## Manual mode (Not Recommended)
-First, You need install `python 2.7.13` and `pip insall jira`
+First, You need to have `python 3` and run `pip insall jira`
### The Procedure of Merging PR
@@ -68,9 +78,8 @@ First, You need install `python 2.7.13` and `pip insall jira`
4. cd submarine
5. git remote rename origin apache
6. git remote add apache-github https://github.com/apache/submarine.git
-7. optional: git config --local --add user.name {name}
+7. optional: git config --local --add user.name {name}
8. optional: git config --local --add user.email {username}@apache.org
9. optional: echo -e
"JIRA_USERNAME={jira_username}\nJIRA_PASSWORD={jira_password}" >> ~/.bashrc
10. optional: source ~/.bashrc
-11. dev-support/cicd/merge_submarine_pr.py
-
+11. ./dev-support/cicd/merge_submarine_pr.py
diff --git a/dev-support/cicd/build.sh b/dev-support/cicd/build.sh
new file mode 100755
index 00000000..2851afa5
--- /dev/null
+++ b/dev-support/cicd/build.sh
@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+# 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.
+
+set -euxo pipefail
+
+IMAGE="apache/submarine:cicd-0.7.0"
+
+if [ -L ${BASH_SOURCE-$0} ]; then
+ PWD=$(dirname $(readlink "${BASH_SOURCE-$0}"))
+else
+ PWD=$(dirname ${BASH_SOURCE-$0})
+fi
+export CURRENT_PATH=$(cd "${PWD}">/dev/null; pwd)
+SUBMARINE_HOME=${CURRENT_PATH}/../../..
+
+# build image
+echo "Start building the ${IMAGE} docker image ..."
+cd ${CURRENT_PATH}
+docker build -t ${IMAGE} .
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
