[Improve] Add quickstart-with-docker to README (#3486)
* [Improve] add quickstart-with-docker to README
* [Improve] apache-rat check issue fixed.
---------
Co-authored-by: benjobs <benjobx@gmail.com>
diff --git a/README.md b/README.md
index 369789f..784ab7e 100644
--- a/README.md
+++ b/README.md
@@ -58,6 +58,12 @@
+## 🚀 QuickStart
+- [Start with Docker](docker/README.md)
+- [Start with Kubernetes](helm/README.md)
+
+Click [Document](https://streampark.apache.org/docs/user-guide/quick-start) for more information
+
## 🔨 How to Build
```shell
@@ -70,10 +76,6 @@
Download address for run-directly software package : [https://streampark.apache.org/download](https://streampark.apache.org/download)
-## 🚀 Quick Start
-
-Click [Document](https://streampark.apache.org/docs/user-guide/quick-start) for more information
-
## 💋 Our users
Various companies and organizations use StreamPark for research, production and commercial products. Are you using this project? [Welcome to add your company](https://github.com/apache/incubator-streampark/issues/163)!
diff --git a/deploy/docker/README.md b/deploy/docker/README.md
deleted file mode 100644
index a2b77ff..0000000
--- a/deploy/docker/README.md
+++ /dev/null
@@ -1,20 +0,0 @@
-# Deploy StreamPark on Docker
-
-### 1. get docker-compose
-
-```shell
-wget https://raw.githubusercontent.com/apache/incubator-streampark/dev/deploy/docker/docker-compose.yaml
-wget https://raw.githubusercontent.com/apache/incubator-streampark/dev/deploy/docker/.env
-```
-
-### 2. docker-compose up
-
-```shell
-docker-compose up -d
-```
-
-### 3. open in browser
-
-http://localhost:10000
-
-#### [more detail](https://streampark.apache.org/docs/user-guide/docker-deployment)
diff --git a/deploy/docker/.env b/docker/.env
similarity index 100%
rename from deploy/docker/.env
rename to docker/.env
diff --git a/deploy/docker/Dockerfile b/docker/Dockerfile
similarity index 100%
rename from deploy/docker/Dockerfile
rename to docker/Dockerfile
diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 0000000..486bb98
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,13 @@
+# Deploy StreamPark on Docker
+
+### 1. docker-compose up
+
+```shell
+docker-compose up -d
+```
+
+### 2. open in browser
+
+http://localhost:10000
+
+#### [more detail](https://streampark.apache.org/docs/user-guide/docker-deployment)
diff --git a/deploy/docker/docker-compose.yaml b/docker/docker-compose.yaml
similarity index 100%
rename from deploy/docker/docker-compose.yaml
rename to docker/docker-compose.yaml
diff --git a/deploy/helm/README.md b/helm/README.md
similarity index 100%
rename from deploy/helm/README.md
rename to helm/README.md
diff --git a/deploy/helm/streampark/.helmignore b/helm/streampark/.helmignore
similarity index 100%
rename from deploy/helm/streampark/.helmignore
rename to helm/streampark/.helmignore
diff --git a/deploy/helm/streampark/Chart.yaml b/helm/streampark/Chart.yaml
similarity index 100%
rename from deploy/helm/streampark/Chart.yaml
rename to helm/streampark/Chart.yaml
diff --git a/deploy/helm/streampark/conf/streampark-console-config/ValidationMessages.properties b/helm/streampark/conf/streampark-console-config/ValidationMessages.properties
similarity index 100%
rename from deploy/helm/streampark/conf/streampark-console-config/ValidationMessages.properties
rename to helm/streampark/conf/streampark-console-config/ValidationMessages.properties
diff --git a/deploy/helm/streampark/conf/streampark-console-config/application-h2.yml b/helm/streampark/conf/streampark-console-config/application-h2.yml
similarity index 100%
rename from deploy/helm/streampark/conf/streampark-console-config/application-h2.yml
rename to helm/streampark/conf/streampark-console-config/application-h2.yml
diff --git a/deploy/helm/streampark/conf/streampark-console-config/application-mysql.yml b/helm/streampark/conf/streampark-console-config/application-mysql.yml
similarity index 100%
rename from deploy/helm/streampark/conf/streampark-console-config/application-mysql.yml
rename to helm/streampark/conf/streampark-console-config/application-mysql.yml
diff --git a/deploy/helm/streampark/conf/streampark-console-config/application-pgsql.yml b/helm/streampark/conf/streampark-console-config/application-pgsql.yml
similarity index 100%
rename from deploy/helm/streampark/conf/streampark-console-config/application-pgsql.yml
rename to helm/streampark/conf/streampark-console-config/application-pgsql.yml
diff --git a/deploy/helm/streampark/conf/streampark-console-config/application-sso.yml b/helm/streampark/conf/streampark-console-config/application-sso.yml
similarity index 100%
rename from deploy/helm/streampark/conf/streampark-console-config/application-sso.yml
rename to helm/streampark/conf/streampark-console-config/application-sso.yml
diff --git a/deploy/helm/streampark/conf/streampark-console-config/application.yml b/helm/streampark/conf/streampark-console-config/application.yml
similarity index 100%
rename from deploy/helm/streampark/conf/streampark-console-config/application.yml
rename to helm/streampark/conf/streampark-console-config/application.yml
diff --git a/deploy/helm/streampark/conf/streampark-console-config/kerberos.yml b/helm/streampark/conf/streampark-console-config/kerberos.yml
similarity index 100%
rename from deploy/helm/streampark/conf/streampark-console-config/kerberos.yml
rename to helm/streampark/conf/streampark-console-config/kerberos.yml
diff --git a/deploy/helm/streampark/conf/streampark-console-config/logback-spring.xml b/helm/streampark/conf/streampark-console-config/logback-spring.xml
similarity index 100%
rename from deploy/helm/streampark/conf/streampark-console-config/logback-spring.xml
rename to helm/streampark/conf/streampark-console-config/logback-spring.xml
diff --git a/deploy/helm/streampark/conf/streampark-console-config/spy.properties b/helm/streampark/conf/streampark-console-config/spy.properties
similarity index 100%
rename from deploy/helm/streampark/conf/streampark-console-config/spy.properties
rename to helm/streampark/conf/streampark-console-config/spy.properties
diff --git a/deploy/helm/streampark/templates/NOTES.txt b/helm/streampark/templates/NOTES.txt
similarity index 100%
rename from deploy/helm/streampark/templates/NOTES.txt
rename to helm/streampark/templates/NOTES.txt
diff --git a/deploy/helm/streampark/templates/_helpers.tpl b/helm/streampark/templates/_helpers.tpl
similarity index 100%
rename from deploy/helm/streampark/templates/_helpers.tpl
rename to helm/streampark/templates/_helpers.tpl
diff --git a/deploy/helm/streampark/templates/configmap.yaml b/helm/streampark/templates/configmap.yaml
similarity index 100%
rename from deploy/helm/streampark/templates/configmap.yaml
rename to helm/streampark/templates/configmap.yaml
diff --git a/deploy/helm/streampark/templates/ingress.yaml b/helm/streampark/templates/ingress.yaml
similarity index 100%
rename from deploy/helm/streampark/templates/ingress.yaml
rename to helm/streampark/templates/ingress.yaml
diff --git a/deploy/helm/streampark/templates/rbac.yaml b/helm/streampark/templates/rbac.yaml
similarity index 100%
rename from deploy/helm/streampark/templates/rbac.yaml
rename to helm/streampark/templates/rbac.yaml
diff --git a/deploy/helm/streampark/templates/service.yaml b/helm/streampark/templates/service.yaml
similarity index 100%
rename from deploy/helm/streampark/templates/service.yaml
rename to helm/streampark/templates/service.yaml
diff --git a/deploy/helm/streampark/templates/serviceaccount.yaml b/helm/streampark/templates/serviceaccount.yaml
similarity index 100%
rename from deploy/helm/streampark/templates/serviceaccount.yaml
rename to helm/streampark/templates/serviceaccount.yaml
diff --git a/deploy/helm/streampark/templates/streampark.yml b/helm/streampark/templates/streampark.yml
similarity index 100%
rename from deploy/helm/streampark/templates/streampark.yml
rename to helm/streampark/templates/streampark.yml
diff --git a/deploy/helm/streampark/values.yaml b/helm/streampark/values.yaml
similarity index 100%
rename from deploy/helm/streampark/values.yaml
rename to helm/streampark/values.yaml
diff --git a/pom.xml b/pom.xml
index d6faec1..346a0e8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -828,7 +828,8 @@
<exclude>.mvn/**</exclude>
<exclude>compiler/**</exclude>
<exclude>dist-material/**</exclude>
- <exclude>deploy/**</exclude>
+ <exclude>docker/**</exclude>
+ <exclude>helm/**</exclude>
<exclude>mvnw</exclude>
<exclude>mvnw.cmd</exclude>
<exclude>README.md</exclude>
diff --git a/streampark-console/streampark-console-service/src/main/assembly/plugins/.gitkeep b/streampark-console/streampark-console-service/src/main/assembly/plugins/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/streampark-console/streampark-console-service/src/main/assembly/plugins/.gitkeep
diff --git a/streampark-console/streampark-console-service/src/main/assembly/plugins/Dockerfile b/streampark-console/streampark-console-service/src/main/assembly/plugins/Dockerfile
deleted file mode 100644
index 41a41c5..0000000
--- a/streampark-console/streampark-console-service/src/main/assembly/plugins/Dockerfile
+++ /dev/null
@@ -1,48 +0,0 @@
-###############################################################################
-# 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.
-###############################################################################
-FROM docker:dind
-WORKDIR /streampark
-COPY . /streampark
-
-ARG DB=localhost
-ENV NODE_VERSION=16.1.0
-ENV NPM_VERSION=7.11.2
-
-RUN sed -i -e 's/eval $NOHUP/eval/' bin/streampark.sh \
- && sed -i -e 's/>> "$APP_OUT" 2>&1 "&"//' bin/streampark.sh \
- && sed -i -e 's/localhost/'$DB'/' conf/application.yml
-
-RUN apk add openjdk8 \
- && apk add maven \
- && apk add wget \
- && apk add vim \
- && apk add bash
-
-ENV JAVA_HOME=/usr/lib/jvm/java-1.8-openjdk
-ENV MAVEN_HOME=/usr/share/java/maven-3
-ENV PATH $JAVA_HOME/bin:$PATH
-ENV PATH $MAVEN_HOME/bin:$PATH
-
-RUN wget "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-x64.tar.gz" \
- && tar zxvf "node-v$NODE_VERSION-linux-x64.tar.gz" -C /usr/local --strip-components=1 \
- && rm "node-v$NODE_VERSION-linux-x64.tar.gz" \
- && ln -s /usr/local/bin/node /usr/local/bin/nodejs
-
-RUN mkdir -p ~/.kube \
- && cat plugins/config >> ~/.kube/config
-
-EXPOSE 10000
