Skip to content
Open
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: 4 additions & 0 deletions docs/OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
approvers:
- Poorunga
reviewers:
- Poorunga
Binary file added docs/images/proposals/emctl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions docs/proposals/emctl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# emctl

EdgeMesh provides a command line tool for deployment, uninstallation, status detection and interaction with the cluster: `emctl`.

## Installation
TODO

## Commands

|Command|Syntax|Description|
|----|----|-------|
|[install](#install)|`cmctl install [flags]`|Deploy EdgeMesh system in the cluster, including components: edgemesh-server and edgemesh-agent.|
|[uninstall](#uninstall)|`cmctl uninstall [flags]`|Remove EdgeMesh system from the cluster.|

### install
<img src="../images/proposals/emctl.png"/>

The `install` command deploy EdgeMesh system in the cluster, including components: edgemesh-server and edgemesh-agent.

Tool `emctl` will do the following things:
- Check if KubeEdge version is >=1.6
- Enable the `dynamicController` module of CloudCore
- Deploy the `emctl-servant` pod to each node
- After the node is prepared, create the corresponding configmap, deploy edgemesh-server and edgemesh-agent

Pod `emctl-servant` will do the following things:
- Check if KubeEdge version is >=1.6
- Enable `metaServer` module and disable `edgeMesh` module of EdgeCore
- Feedback the task completion status to `emctl`

### uninstall
TODO