You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ha...@apache.org on 2021/02/07 00:37:37 UTC

[skywalking-docker] branch release-refactor updated: Update README.md

This is an automated email from the ASF dual-hosted git repository.

hanahmily pushed a commit to branch release-refactor
in repository https://gitbox.apache.org/repos/asf/skywalking-docker.git


The following commit(s) were added to refs/heads/release-refactor by this push:
     new 605ee49  Update README.md
605ee49 is described below

commit 605ee494e63b8415482af7c6c830c0ec484ba3e0
Author: Gao Hongtao <ha...@gmail.com>
AuthorDate: Sun Feb 7 08:37:03 2021 +0800

    Update README.md
    
    Signed-off-by: Gao Hongtao <ha...@gmail.com>
---
 8/v8.4.0.sh      | 17 +++++++++++++++++
 Makefile         | 18 +++++++++++++++---
 README.md        | 39 +++++++++++++++++++++++++++++++++++++++
 compose/.env.es6 | 16 ++++++++++++++++
 compose/.env.es7 | 16 ++++++++++++++++
 5 files changed, 103 insertions(+), 3 deletions(-)

diff --git a/8/v8.4.0.sh b/8/v8.4.0.sh
new file mode 100644
index 0000000..ae23669
--- /dev/null
+++ b/8/v8.4.0.sh
@@ -0,0 +1,17 @@
+# 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.
+
+export SW_VERSION=8.4.0
diff --git a/Makefile b/Makefile
index 3703111..8b05df1 100644
--- a/Makefile
+++ b/Makefile
@@ -1,9 +1,21 @@
-
-SW_VERSION ?= 8.4.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.
 
 TAG_SUFS := es6 es7
 
-
 ROOT := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
 
 D := docker
diff --git a/README.md b/README.md
index 18d18de..ed4583c 100644
--- a/README.md
+++ b/README.md
@@ -17,5 +17,44 @@ The convenience images are published in docker hub.
 - https://hub.docker.com/r/apache/skywalking-ui
 - https://hub.docker.com/r/apache/skywalking-oap-server
 
+# How to build
+
+When the version < `8.4.0`, the release manifests are grouping by their major version number and full version number in `archive`.
+
+From `8.4.0`, issuing follows to build relevant docker images
+
+```sh
+# source 8/v8.4.0.sh if the target version is 8.4.0
+source <major_version>/v<version>.sh
+
+make
+```
+
+# How to publish images
+
+After a SkyWalking's Apache release, composing a new version environment setting script to `<major_version>` folder with the name like `v<version>.sh`
+
+Building images as below:
+
+```sh
+source <major_version>/v<version>.sh
+make
+```
+
+Verifying images:
+
+```sh
+# Booting up a compose of ES6, OAP server and UI
+make compose.es6
+# Booting up a compose of ES7, OAP server and UI
+make compose.es7
+```
+
+Pushing built images to docker hub repos:
+
+```sh
+make docker.push
+```
+
 # License
 [Apache 2.0 License.](/LICENSE)
diff --git a/compose/.env.es6 b/compose/.env.es6
index 25a552a..8879a4d 100644
--- a/compose/.env.es6
+++ b/compose/.env.es6
@@ -1,2 +1,18 @@
+# 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.
+
 ES_VERSION=6.8.8
 SW_STORAGE=elasticsearch
\ No newline at end of file
diff --git a/compose/.env.es7 b/compose/.env.es7
index 17a4bb1..1e2ecaa 100644
--- a/compose/.env.es7
+++ b/compose/.env.es7
@@ -1,2 +1,18 @@
+# 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.
+
 ES_VERSION=7.5.0
 SW_STORAGE=elasticsearch7
\ No newline at end of file