Skip to content

Commit a6fa4da

Browse files
authored
Update README (#862)
* Update README * Update content * Update content
1 parent 50857d5 commit a6fa4da

File tree

2 files changed

+39
-10
lines changed

2 files changed

+39
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,36 @@
1919

2020
<h2 align="center">Dubbo Service Mesh for Kubernetes</h2>
2121

22-
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.
22+
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.
23+
- For more detailed information on how to use it, please visit [dubbo.apache.org](https://cn.dubbo.apache.org/zh-cn/overview/mesh/)
2324

24-
## Project Core
25+
## Introduction
2526

26-
- **api** — API definitions for Dubbo.
27-
- **client-go** — Go client library for the Dubbo API.
28-
- **dubboctl** — Command-line tool that provides control plane management.
29-
- **dubbod** — The control plane, communicating based on gRPC and xDS APIs.
30-
- **operator** — Provides user-friendly options for operating the service mesh.
27+
Dubbo’s control plane provides an abstraction layer over the underlying cluster management platform.
3128

32-
## Quick Start
29+
Dubbo component composition:
3330

34-
Please refer to [official website](https://cn.dubbo.apache.org/zh-cn/overview/mesh/)
31+
- **dubbod** — Dubbo xDS control plane. It provides service discovery, configuration and certificate issuance.
32+
33+
- **dubbo-go-pixiu** — Used for ingress/egress traffic between services in the cluster and external services.
34+
35+
## Directory Repositories
36+
37+
Projects are distributed across the code directory repositories:
38+
39+
- [dubbo/api](./api). — Defines the component level APIs for the Dubbo control plane.
40+
41+
- [dubbo/client-go](./client-go). — Defines the Kubernetes clients automatically generated for Dubbo control plane resources.
42+
43+
- [dubbo/dubboctl](./dubboctl). — Provides command line tools for control plane management and other operations.
44+
45+
- [dubbo/dubbod](./dubbod) — The main code directory for the Dubbo control plane.
46+
47+
- [dubbo/operator](./operator). — Provides user friendly options for operating the service mesh.
3548

3649
## Contributing
3750

38-
Refer to [CONTRIBUTING.md](https://github.com/apache/dubbo-kubernetes/blob/master/CONTRIBUTING.md)
51+
Refer to [CONTRIBUTING.md](./CONTRIBUTING.md)
3952

4053
## License
4154

pkg/pixiu/config.go

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
//
2+
// Licensed to the Apache Software Foundation (ASF) under one or more
3+
// contributor license agreements. See the NOTICE file distributed with
4+
// this work for additional information regarding copyright ownership.
5+
// The ASF licenses this file to You under the Apache License, Version 2.0
6+
// (the "License"); you may not use this file except in compliance with
7+
// the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing, software
12+
// distributed under the License is distributed on an "AS IS" BASIS,
13+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
// See the License for the specific language governing permissions and
15+
// limitations under the License.
16+
117
package pixiu
218

319
// PixiuBootstrap represents Pixiu Bootstrap configuration

0 commit comments

Comments
 (0)