Skip to content

Commit f04ad8f

Browse files
committed
add emctl proposal
1 parent 6614b79 commit f04ad8f

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

docs/OWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
approvers:
2+
- Poorunga
3+
reviewers:
4+
- Poorunga

docs/images/proposals/emctl.png

13.7 KB
Loading

docs/proposals/emctl.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# emctl
2+
3+
EdgeMesh provides a command line tool for deployment, uninstallation, status detection and interaction with the cluster: `emctl`.
4+
5+
## Installation
6+
TODO
7+
8+
## Commands
9+
10+
|Command|Syntax|Description|
11+
|----|----|-------|
12+
|[install](#install)|`cmctl install [flags]`|Deploy EdgeMesh system in the cluster, including components: edgemesh-server and edgemesh-agent.|
13+
|[uninstall](#uninstall)|`cmctl uninstall [flags]`|Remove EdgeMesh system from the cluster.|
14+
15+
### install
16+
<img src="../images/proposals/emctl.png"/>
17+
18+
The `install` command deploy EdgeMesh system in the cluster, including components: edgemesh-server and edgemesh-agent.
19+
20+
Tool `emctl` will do the following things:
21+
- Check if KubeEdge version is >=1.6
22+
- Enable the `dynamicController` module of CloudCore
23+
- Deploy the `emctl-servant` pod to each node
24+
- After the node is prepared, create the corresponding configmap, deploy edgemesh-server and edgemesh-agent
25+
26+
Pod `emctl-servant` will do the following things:
27+
- Check if KubeEdge version is >=1.6
28+
- Enable `metaServer` module and disable `edgeMesh` module of EdgeCore
29+
- Feedback the task completion status to `emctl`
30+
31+
### uninstall
32+
TODO

0 commit comments

Comments
 (0)