Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documents #424

Merged
merged 2 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing Giude
# Contributing Guide

- Before you get started
- Code of Conduct
Expand Down Expand Up @@ -38,7 +38,7 @@ This is a rough outline of what a contributor's workflow looks like:

## Creating Pull Requests

Fabedge generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process.
FabEdge generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process.

## Code Review

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ FabEdge is a sandbox project of the Cloud Native Computing Foundation (CNCF).

* The cloud can be any Kubernetes cluster with supported CNI network plug-in, including Calico, Flannel, etc.
* FabEdge builds a layer-3 data plane with tunnels in additional to the control plan managed by KubeEdge, SuperEdge, OpenYurt,etc.
* Fabedge consists of **Operators, Connector, Agent, Cloud-Agent**.
* Operator monitors k8s resources such as node, service, and endpoint in the cloud, and creates a configmap for each edge node, which contains the configuration information such as the subnet, tunnel, and load balancing rules. The operator is also responsible to manage the life cycle of agent pod for each edge node.
* FabEdge consists of **Operators, Connector, Agent, Cloud-Agent**.
* Operator monitors k8s resources such as nodes, services, and endpoints in the cloud, and creates a configmap for each edge node, which contains the configuration information such as the subnet, tunnel, and load balancing rules. The operator is also responsible to manage the life cycle of agent pod for each edge node.
* Connector is responsible to terminate the tunnels from edge nodes, and forward traffic between the cloud and the edge. It relies on the cloud CNI plug-in to forward traffic to other non-connector nodes in the cloud.
* Cloud-Agent runs on the non-connector nodes in the cluster and manages the routes to remote peers.
* Each edge node runs an agent and consumes its own configmap including the following functions:
Expand All @@ -54,7 +54,7 @@ FabEdge is a sandbox project of the Cloud Native Computing Foundation (CNCF).

## FabEdge vs. Calico/Flannel/etc

Fabedge is not to replace the traditional Kubernetes network plugins such as Calico/Flannel. As in the above architecture diagram, Calico/Flannel is used within the cloud for communication between cloud nodes, while Fabedge is a complement to it for the edge-cloud, edge-edge communication.
FabEdge is not to replace the traditional Kubernetes network plugins such as Calico/Flannel. As in the above architecture diagram, Calico/Flannel is used within the cloud for communication between cloud nodes, while FabEdge is a complement to it for the edge-cloud, edge-edge communication.

## Documentation

Expand Down
28 changes: 13 additions & 15 deletions cmd/connector/main.go
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
/*
Copyright © 2021 NAME HERE <EMAIL ADDRESS>

Licensed 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.
*/
// Copyright 2021 FabEdge Team
//
// Licensed 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 main

Expand Down
4 changes: 2 additions & 2 deletions docs/manually-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,9 @@ agent:
ENABLE_DNS: "true"
```
*PS: The `values.yaml` in the example is not complete, you can get the complete `values.yaml` example by executing `helm show values fabedge/fabedge`.*
*P.S.: The code snippet above shows part of `values.yaml`, while you can get the complete `values.yaml` example by executing `helm show values fabedge/fabedge`.*

8. Deploy Fabedge
8. Deploy FabEdge

```shell
helm install fabedge fabedge/fabedge -n fabedge --create-namespace -f values.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/manually-install_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ agent:

*注: 示例的`values.yaml`并非完整内容,完整的values文件可以通过执行`helm show values fabedge/fabedge`的方式获取。*

8. 安装Fabedge
8. 安装FabEdge

```shell
helm install fabedge fabedge/fabedge -n fabedge --create-namespace -f values.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/roadmap.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fabedge Roadmap
# FabEdge Roadmap

## Q3 2021

Expand Down
2 changes: 1 addition & 1 deletion pkg/operator/options.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2021 BoCloud
// Copyright 2021 FabEdge Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Loading