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 a6fa4da1 Update README (#862)
a6fa4da1 is described below
commit a6fa4da18113d174350d1358464fa8b1711c9e22
Author: mfordjody <[email protected]>
AuthorDate: Thu Feb 5 00:29:50 2026 +0800
Update README (#862)
* Update README
* Update content
* Update content
---
README.md | 33 +++++++++++++++++++++++----------
pkg/pixiu/config.go | 16 ++++++++++++++++
2 files changed, 39 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 11bf2c43..ff0f37ba 100644
--- a/README.md
+++ b/README.md
@@ -19,23 +19,36 @@
<h2 align="center">Dubbo Service Mesh for Kubernetes</h2>
-Implement an open-source service mesh for Dubbo in a Kubernetes cluster,
integrate applications directly into the service mesh through the SDK, secure,
connect, and observe services in a unified, lighter, and more efficient way,
and support load balancing and service-to-service authentication.
+Dubbo gRPC open source service mesh implemented for the underlying cluster
management platform can directly receive policies from the control plane and
obtain features such as load balancing, service discovery, and observability
without requiring a sidecar proxy.
+- For more detailed information on how to use it, please visit
[dubbo.apache.org](https://cn.dubbo.apache.org/zh-cn/overview/mesh/)
-## Project Core
+## Introduction
-- **api** — API definitions for Dubbo.
-- **client-go** — Go client library for the Dubbo API.
-- **dubboctl** — Command-line tool that provides control plane management.
-- **dubbod** — The control plane, communicating based on gRPC and xDS APIs.
-- **operator** — Provides user-friendly options for operating the service mesh.
+Dubbo’s control plane provides an abstraction layer over the underlying
cluster management platform.
-## Quick Start
+Dubbo component composition:
-Please refer to [official
website](https://cn.dubbo.apache.org/zh-cn/overview/mesh/)
+- **dubbod** — Dubbo xDS control plane. It provides service discovery,
configuration and certificate issuance.
+
+- **dubbo-go-pixiu** — Used for ingress/egress traffic between services in the
cluster and external services.
+
+## Directory Repositories
+
+Projects are distributed across the code directory repositories:
+
+- [dubbo/api](./api). — Defines the component level APIs for the Dubbo control
plane.
+
+- [dubbo/client-go](./client-go). — Defines the Kubernetes clients
automatically generated for Dubbo control plane resources.
+
+- [dubbo/dubboctl](./dubboctl). — Provides command line tools for control
plane management and other operations.
+
+- [dubbo/dubbod](./dubbod) — The main code directory for the Dubbo control
plane.
+
+- [dubbo/operator](./operator). — Provides user friendly options for operating
the service mesh.
## Contributing
-Refer to
[CONTRIBUTING.md](https://github.com/apache/dubbo-kubernetes/blob/master/CONTRIBUTING.md)
+Refer to [CONTRIBUTING.md](./CONTRIBUTING.md)
## License
diff --git a/pkg/pixiu/config.go b/pkg/pixiu/config.go
index 0938c003..37f9c7bc 100644
--- a/pkg/pixiu/config.go
+++ b/pkg/pixiu/config.go
@@ -1,3 +1,19 @@
+//
+// 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.
+
package pixiu
// PixiuBootstrap represents Pixiu Bootstrap configuration
