This is an automated email from the ASF dual-hosted git repository.
zhongxjian pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dubbo-kubernetes.git
The following commit(s) were added to refs/heads/master by this push:
new 8120c319 Update project content
8120c319 is described below
commit 8120c319c8fdd07c235b5ddce27a425828ff0b36
Author: mfordjody <[email protected]>
AuthorDate: Sun Jun 1 08:09:11 2025 +0800
Update project content
---
.github/workflows/ci.yml | 29 ++++-----
.github/workflows/dubbo-cp-release.yaml | 72 +++++++++++++--------
.github/workflows/dubboctl-release.yaml | 35 +++++-----
CONTRIBUTING.md | 10 +--
DEVELOPER.md | 28 --------
Makefile | 2 +-
README.md | 51 ++-------------
README.md => app/README.md | 63 +++++++++---------
.../docs}/static/images/homepage/half-mode.png | Bin
.../static/images/homepage/kubernetes-mode.png | Bin
.../static/images/homepage/universal-mode.png | Bin
.../static/images/other}/ide_configuration.png | Bin
12 files changed, 111 insertions(+), 179 deletions(-)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 25ef8a9d..f2e133a4 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1,21 +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
#
-# 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.
+# 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.
+
name: Continues Integration
on:
diff --git a/.github/workflows/dubbo-cp-release.yaml
b/.github/workflows/dubbo-cp-release.yaml
index 909de7b4..e4a5d995 100644
--- a/.github/workflows/dubbo-cp-release.yaml
+++ b/.github/workflows/dubbo-cp-release.yaml
@@ -1,36 +1,50 @@
+# 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
#
-# 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.
+# 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.
name: dubbo-cp Release
on:
push:
tags:
- - 'dubbo-cp-**'
- release:
- types: [published]
+ - 'v*'
+
+permissions:
+ contents: write
jobs:
- release:
- name: Release dubbo-cp
- permissions:
- contents: write
+ create_release:
+ name: Create Release
+ runs-on: ubuntu-latest
+ outputs:
+ upload_url: ${{ steps.create_release.outputs.upload_url }}
+
+ steps:
+ - name: Create GitHub Release
+ id: create_release
+ uses: actions/create-release@v1
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ tag_name: ${{ github.ref_name }}
+ release_name: "${{ github.ref_name }}"
+ draft: false
+ prerelease: false
+
+ build_and_upload:
+ name: Build and Upload Binaries
+ needs: create_release
runs-on: ubuntu-latest
strategy:
matrix:
@@ -39,6 +53,7 @@ jobs:
exclude:
- goos: darwin
goarch: 386
+
steps:
- name: Checkout code
uses: actions/checkout@v4
@@ -61,8 +76,9 @@ jobs:
make build-dubbo-cp GOOS=${GOOS} GOARCH=${GOARCH}
GIT_VERSION=${GIT_VERSION}
cp README.md LICENSE build/
mv bin/dubbo-cp* build/
+ ls -ln build/
- - name: Create package
+ - name: Package files
id: package
run: |
VERSION=${GITHUB_REF#refs/tags/}
@@ -77,8 +93,10 @@ jobs:
- name: Upload Release Asset
uses: actions/upload-release-asset@v1
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
- upload_url: ${{ .upload_url }}
- asset_path: ./${{ steps.package.outputs.name }}
+ upload_url: ${{ needs.create_release.outputs.upload_url }}
+ asset_path: ${{ steps.package.outputs.name }}
asset_name: ${{ steps.package.outputs.name }}
- asset_content_type: application/octet-stream
\ No newline at end of file
+ asset_content_type: application/octet-stream
diff --git a/.github/workflows/dubboctl-release.yaml
b/.github/workflows/dubboctl-release.yaml
index 3edfa76e..006d0789 100644
--- a/.github/workflows/dubboctl-release.yaml
+++ b/.github/workflows/dubboctl-release.yaml
@@ -1,28 +1,24 @@
+# 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
#
-# 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.
+# 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.
name: dubboctl Release
on:
push:
tags:
- - 'v*' # 触发格式示例：v0.1.0、v1.0.0
+ - 'v*'
permissions:
contents: write
@@ -42,9 +38,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref_name }}
- release_name: "Release ${{ github.ref_name }}"
- body: |
- Automated release for ${{ github.ref_name }}
+ release_name: "${{ github.ref_name }}"
draft: false
prerelease: false
@@ -82,6 +76,7 @@ jobs:
make build-dubboctl GOOS=${GOOS} GOARCH=${GOARCH}
GIT_VERSION=${GIT_VERSION}
cp README.md LICENSE build/
mv bin/dubboctl* build/
+ mv bin/dubbo-cp.yaml build/
ls -ln build/
- name: Package files
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bafcf6be..68d4a265 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -16,12 +16,4 @@ The mailing list is the recommended way of pursuing a
discussion on almost anyth
### Reporting issue
-Please create an issue here https://github.com/apache/dubbo-kubernetes
-
-
-### Contribution flow
-
-A rough outline of an ideal contributors' workflow is as follows:
-
-
-Thanks for contributing!
\ No newline at end of file
+Please create an issue [here](https://github.com/apache/dubbo-kubernetes)
\ No newline at end of file
diff --git a/DEVELOPER.md b/DEVELOPER.md
deleted file mode 100644
index 25b14893..00000000
--- a/DEVELOPER.md
+++ /dev/null
@@ -1,28 +0,0 @@
-# Developer documentation
-
-The source code guidance of this project.
-
-With this documentation, developers can learn which part of the project they
need to change in order to fix a bug or
-introduce a new feature. How can they verify their codes work as expected
before submit a pull request,
-by running the project locally or running the test suite.
-
-## Run Dubbo Admin locally
-If you're using GoLand, you can run it locally by following steps:
-1. Click `Run configuration` on the top menu bar and add new configuration
-2. Fill the block with the config that screenshot shows below:
-
-3. Modify the config file(app/dubbo-cp/dubbo-cp.yaml), make sure that the
registry address, config_center,metadata_report address is valid.
-4. Run the application, you can open the browser and visit
localhost:8888/admin if everything works.
-
-
-## Project catalog
-We are currently restructuring the entire project, so the directory structure
of the project will be changed in the near future.
-We will roll out this part of documents once the catalog is stable.
-
-
-## Pull Request
-If you come up with a bug or introduce a new feature, you can follow the steps
to make it:
-1. Create a new issue and describe your bug/feature in detail.
-2. Fork this repository and use git to clone it to local.
-3. After local modifications, you can push the commit to your fork repo.
-4. Pull a request and associate with the corresponding issue, we will review
the pr and merge it.
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 0aab0fcf..ec3c0311 100644
--- a/Makefile
+++ b/Makefile
@@ -19,7 +19,7 @@ SHELL := /usr/bin/env bash
build-dubbo-cp:
CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(GOARCH) go build \
-ldflags "-X
github.com/apache/dubbo-kubernetes/pkg/version.gitTag=$(GIT_VERSION)" \
- -o bin/dubbo-cp app/dubbo-cp/main.go
+ -o bin/dubbo-cp app/dubbo-cp/main.go && cp app/dubbo-cp/dubbo-cp.yaml
bin/
.PHONY: build-dubboctl
build-dubboctl:
diff --git a/README.md b/README.md
index 43c7ce94..08ed64ed 100644
--- a/README.md
+++ b/README.md
@@ -2,61 +2,22 @@
The Dubbo Kubernetes Integration
</h1>
-<p align="center" style="color: red; font-weight: bold;">
-⚠️ This is still an alpha version. ⚠️
-</p>
-
[](https://github.com/apache/dubbo-kubernetes/actions/workflows/ci.yml)
[](https://codecov.io/gh/apache/dubbo-kubernetes)
-## Including Modules
-1. Dubboctl: **The operation and deployment tools**
-2. Dubbo Admin: **The universal Console and Control Plane(in roadmap) for
managing microservices on VM or Kubernetes.**
-3. Dubbo Kubernetes Integrations: **The Integrations of cloud native
middlewares and dubbo.**
+Provides observability features and supporting tools for building and
deploying Dubbo applications in various environments, including Kubernetes and
Alibaba Cloud ACK.
## Quick Start
Please refer to [official
website](https://cn.dubbo.apache.org/zh-cn/overview/home/)
-## Dubbo Microservice Architecture
-
-The architecture of microservcice based on Dubbo consists of two main
components:
-
-- The **`Dubbo Admin`** can configures and monitor the data plane from a
global perspective. The Dubbo Admin can be divided into two parts internally:
console and control-plane
- - Console: Users can view and manage microservices using Console UI.
- - Control Plane: The core component that manages different types of
resources(traffic rules, service info etc.) behind the scenes.
-- The **`Data Plane`** is the Dubbo application built by different language
SDKs running in VMs/containers, receiving the resources dispatched by Control
Plane(directly or indirectly) and turn them into specific functions, such as
service discovery, traffic routing, load balancing, etc.
-
-Dubbo Admin supports three runtime modes: **`kubernetes`**, **`Half`** and
**`Universal`**.
-
-### Kubernetes(In development, not supported yet)
-In kubernetes mode, the control plane will interact directly with the
Kubernetes API-SERVER, watching the kubernetes resources and transform them as
xDS resources for service discovery and traffic management configurations.
-
-
-
-We all know the `service` definitions of Kubernetes and Dubbo are different,
`Kubernetes Service` is more like an application concept run on a selected
group of pods while `Dubbo Service` can mean a specific RPC service inside the
application process. So how does dubbo control plane manages to bridge the
`interface-application` gap, check [here]() for more details.
-
-
-### Half
-In half mode, the dubbo applications are deployed in k8s cluster, while still
using Nacos or Zookeeper as registries for service discovery.
-In this mode, the control plane can retrieve and merge info from k8s and
registries. The traffic policies are dispatched by control plane through
registries.
-
-
-### Universal
-In Universal mode, the dubbo applications are deployed in VM, using Nacos or
Zookeeper as registries for service discovery,
-control plane then interact with registry directly.
-
-
-
## Roadmap
-1. Kubernetes mode support and sidecarless mesh development.
-2. Code robustness.
-3. More pathways of microservices observability.
-
+Kubernetes mode support and proxyless mesh development.
## Contributing
-If you're interested and want to dive into this project, you can follow these
docs:
-[Developer](./DEVELOPER.md)
-[Dubboctl](./docs/dubboctl/concepts.md)
+Refer to
[CONTRIBUTING.md](https://github.com/apache/dubbo-kubernetes/blob/master/CONTRIBUTING.md)
+
+## License
+Apache License 2.0, see
[LICENSE](https://github.com/apache/dubbo-kubernetes/blob/master/LICENSE).
\ No newline at end of file
diff --git a/README.md b/app/README.md
similarity index 50%
copy from README.md
copy to app/README.md
index 43c7ce94..0801de44 100644
--- a/README.md
+++ b/app/README.md
@@ -1,30 +1,10 @@
-<h1 align="center">
-The Dubbo Kubernetes Integration
-</h1>
-
-<p align="center" style="color: red; font-weight: bold;">
-⚠️ This is still an alpha version. ⚠️
-</p>
-
-[](https://github.com/apache/dubbo-kubernetes/actions/workflows/ci.yml)
-[](https://codecov.io/gh/apache/dubbo-kubernetes)
-
-
-## Including Modules
-1. Dubboctl: **The operation and deployment tools**
-2. Dubbo Admin: **The universal Console and Control Plane(in roadmap) for
managing microservices on VM or Kubernetes.**
-3. Dubbo Kubernetes Integrations: **The Integrations of cloud native
middlewares and dubbo.**
-
-## Quick Start
-Please refer to [official
website](https://cn.dubbo.apache.org/zh-cn/overview/home/)
-
-## Dubbo Microservice Architecture
+# dubbo-cp
The architecture of microservcice based on Dubbo consists of two main
components:
- The **`Dubbo Admin`** can configures and monitor the data plane from a
global perspective. The Dubbo Admin can be divided into two parts internally:
console and control-plane
- - Console: Users can view and manage microservices using Console UI.
- - Control Plane: The core component that manages different types of
resources(traffic rules, service info etc.) behind the scenes.
+ - Console: Users can view and manage microservices using Console UI.
+ - Control Plane: The core component that manages different types of
resources(traffic rules, service info etc.) behind the scenes.
- The **`Data Plane`** is the Dubbo application built by different language
SDKs running in VMs/containers, receiving the resources dispatched by Control
Plane(directly or indirectly) and turn them into specific functions, such as
service discovery, traffic routing, load balancing, etc.
Dubbo Admin supports three runtime modes: **`kubernetes`**, **`Half`** and
**`Universal`**.
@@ -39,24 +19,41 @@ We all know the `service` definitions of Kubernetes and
Dubbo are different, `Ku
### Half
In half mode, the dubbo applications are deployed in k8s cluster, while still
using Nacos or Zookeeper as registries for service discovery.
-In this mode, the control plane can retrieve and merge info from k8s and
registries. The traffic policies are dispatched by control plane through
registries.
+In this mode, the control plane can retrieve and merge info from k8s and
registries. The traffic policies are dispatched by control plane through
registries.
+
### Universal
-In Universal mode, the dubbo applications are deployed in VM, using Nacos or
Zookeeper as registries for service discovery,
+In Universal mode, the dubbo applications are deployed in VM, using Nacos or
Zookeeper as registries for service discovery,
control plane then interact with registry directly.
-## Roadmap
-1. Kubernetes mode support and sidecarless mesh development.
-2. Code robustness.
-3. More pathways of microservices observability.
+## Developer documentation
+
+The source code guidance of this project.
+
+With this documentation, developers can learn which part of the project they
need to change in order to fix a bug or
+introduce a new feature. How can they verify their codes work as expected
before submit a pull request,
+by running the project locally or running the test suite.
+
+### Run Dubbo Admin locally
+If you're using GoLand, you can run it locally by following steps:
+1. Click `Run configuration` on the top menu bar and add new configuration
+2. Fill the block with the config that screenshot shows below:
+
+3. Modify the config file(app/dubbo-cp/dubbo-cp.yaml), make sure that the
registry address, config_center,metadata_report address is valid.
+4. Run the application, you can open the browser and visit
localhost:8888/admin if everything works.
-## Contributing
-If you're interested and want to dive into this project, you can follow these
docs:
-[Developer](./DEVELOPER.md)
-[Dubboctl](./docs/dubboctl/concepts.md)
+### Project catalog
+We are currently restructuring the entire project, so the directory structure
of the project will be changed in the near future.
+We will roll out this part of documents once the catalog is stable.
+### Pull Request
+If you come up with a bug or introduce a new feature, you can follow the steps
to make it:
+1. Create a new issue and describe your bug/feature in detail.
+2. Fork this repository and use git to clone it to local.
+3. After local modifications, you can push the commit to your fork repo.
+4. Pull a request and associate with the corresponding issue, we will review
the pr and merge it.
\ No newline at end of file
diff --git a/docs/static/images/homepage/half-mode.png
b/app/docs/static/images/homepage/half-mode.png
similarity index 100%
rename from docs/static/images/homepage/half-mode.png
rename to app/docs/static/images/homepage/half-mode.png
diff --git a/docs/static/images/homepage/kubernetes-mode.png
b/app/docs/static/images/homepage/kubernetes-mode.png
similarity index 100%
rename from docs/static/images/homepage/kubernetes-mode.png
rename to app/docs/static/images/homepage/kubernetes-mode.png
diff --git a/docs/static/images/homepage/universal-mode.png
b/app/docs/static/images/homepage/universal-mode.png
similarity index 100%
rename from docs/static/images/homepage/universal-mode.png
rename to app/docs/static/images/homepage/universal-mode.png
diff --git a/docs/static/images/ide_configuration.png
b/app/docs/static/images/other/ide_configuration.png
similarity index 100%
rename from docs/static/images/ide_configuration.png
rename to app/docs/static/images/other/ide_configuration.png
