This is an automated email from the ASF dual-hosted git repository. gaoxihui pushed a commit to branch fix_readme in repository https://gitbox.apache.org/repos/asf/ozhera.git
commit 666cda339be763dcc0b1d647fe843b391df84239 Author: gaoxihui <[email protected]> AuthorDate: Mon Apr 7 15:00:56 2025 +0800 fix: remove unused documents --- dist/README.md | 62 --------------------------------------------------- dist/README_CN.md | 66 ------------------------------------------------------- 2 files changed, 128 deletions(-) diff --git a/dist/README.md b/dist/README.md deleted file mode 100644 index ee1a553f..00000000 --- a/dist/README.md +++ /dev/null @@ -1,62 +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. - ---> - -## 1. Build the project -You can use the following command to build the project from the source code -mvn clean install -Papache-release -Dmaven.test.skip=true - -## 2. Resource usage instructions -The binary tarball provides executable jar files according to the directory hierarchy, and comes with the corresponding Dockerfile -You can use the corresponding jar package and the corresponding Dockerfile to build the image. - -## 3. Build the image -The corresponding executable jar package and the corresponding Dockerfile are provided in each directory. You need to switch to the directory corresponding to the Dockerfile first, and execute the command: -build . --build-arg SRC_PATH=. --build-arg APP_VERSION=2.2.5-incubating -t ${DOCKER_USERNAME}/${REPOSITORY_NAME}:${TAG} - -Note: Because the environment variables SRC_PATH and APP_VERSION are used in Dockerfile, the corresponding parameter values need to be specified when building the image -SRC_PATH: The path where the executable jar package is located. If you have switched to the directory corresponding to the Dockerfile, the executable jar package and the Dockerfile are in the same directory, so you can specify the current directory. -APP_VERSION: This version is 2.2.5-incubating - -Example: -cd ozhera-app/app-server -docker build . --build-arg SRC_PATH=./target --build-arg APP_VERSION=2.2.5-incubating -t herahub/opensource-pub:app-server-2.2.5-incubating-beta-v1 - -## 4. How to deploy the project - -During the startup process, OzHera's services rely on many basic services, including: mysql, Nacos, elasticsearch, Redis, RocketMQ, grafana, prometheus, alertManager, node-exporter, Cadvisor, etc.; -In addition, the configuration items of each module and the dependencies between projects make it a very complicated process to manually start each application. Therefore, OzHera -provides an operator that is convenient for users to use. You can follow the instructions in the following link to make your deployment process simple and easy. - -For the deployment process, you need to refer to the following documentation -https://ozhera.apache.org/zh/docs/deployment.html -https://ozhera.apache.org/en/docs/deployment.html - -Of course, before using the operator, you need to build the image of the corresponding service module under OzHera for the operator to use during the deployment process. - -## 5. How to build executable jar files from source code -All executable jar files can be obtained through source code building; -You can execute the following command in the root directory of the project (ozhera) or the directory where the submodule is located to obtain the corresponding executable jar package: -mvn clean install -Papache-release -Dmaven.test.skip=true -Note: The parameter -Papache-release must be added here - -### Build environment requirements -You need to rely on the environment to build the project locally: -maven3 and jdk21 \ No newline at end of file diff --git a/dist/README_CN.md b/dist/README_CN.md deleted file mode 100644 index 355bb3dd..00000000 --- a/dist/README_CN.md +++ /dev/null @@ -1,66 +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. - ---> - -## 1、构建项目 -可使用如下命令从源代码构建项目 -mvn clean install -Papache-release -Dmaven.test.skip=true - -## 2、资源使用说明 -二进制tarball下按目录层次提供了可执行jar文件，并附带了对应的Dockerfile -您可以使用对应的jar包和对应的Dockerfile构建镜像. - -## 3、构建镜像 -在每个目录下都提供了对应的可执行jar包和对应的Dockerfile，你需要先切换到Dockerfile对应的 -目录下，并且执行命令: -build . --build-arg SRC_PATH=. --build-arg APP_VERSION=2.2.5-incubating -t ${DOCKER_USERNAME}/${REPOSITORY_NAME}:${TAG} - - -说明：因为Dockerfile中使用了环境变量SRC_PATH和APP_VERSION，在构建镜像的时候需要指定相应的参数值 -SRC_PATH: 可执行jar包所在位置路径，如果已经切换到了Dockerfile对应的目录下，可执行jar包与Dockerfile在相同的目录下，所以指定当前目录即可。 -APP_VERSION: 本次版本是2.2.5-incubating - -例子： -cd ozhera-app/app-server -docker build . --build-arg SRC_PATH=./target --build-arg APP_VERSION=2.2.5-incubating -t herahub/opensource-pub:app-server-2.2.5-incubating-beta-v1 - -## 4、如何部署项目 - -OzHera的服务在启动过程中，依赖了众多基础服务，包括：mysql、Nacos、 -elasticsearch、Redis、RocketMQ、grafana、prometheus、 -alertManager、node-exporter、Cadvisor等； -另，加之各个模块的配置项， 以及项目之前的依赖关系，使得手动启动各应用是一项很复杂的过程，因此OzHera -提供了便利用户使用的operator，可以通过以下的链接按照说明文档界面化操作， 使您的部署过程变得简单易行。 - -部署过程您需要参考以下说明文档 -https://ozhera.apache.org/zh/docs/deployment.html -https://ozhera.apache.org/en/docs/deployment.html - -当然，在使用operator之前，您需要先构建OzHera下的相应的服务模块的镜像， 以供operator在部署过程中使用。 - -## 5、如何通过源代码构建可执行jar文件 -所有的可执行jar文件，您都可以通过源码构建获取； -你可以在项目的根目录(ozhera)，或者子模块所在的目录执行以下命令，来获取对应的可执行jar包： -mvn clean install -Papache-release -Dmaven.test.skip=true -注意：这里一定要加上参数-Papache-release - -### 构建环境要求 -您在本地构建项目需要依赖的环境： -maven3 和 jdk21 \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
