summaryrefslogtreecommitdiff
path: root/build
diff options
context:
space:
mode:
authorCharles <17763040192@163.com>2021-11-25 17:19:39 +0800
committerCharlesLvw <17763040192@163.com>2021-11-26 13:52:14 +0800
commit327362e0b0d01a6069e3c069be5b9f5209274f58 (patch)
tree27ef4aa8409d4f38f392918759f37ddcbdb5936b /build
parentMerge pull request #3375 from TianTianBigWang/fix/membership-get-log (diff)
downloadkubeedge-327362e0b0d01a6069e3c069be5b9f5209274f58.tar.gz
add build/README
Signed-off-by: CharlesLvw <17763040192@163.com>
Diffstat (limited to 'build')
-rw-r--r--build/README.md78
-rw-r--r--build/README_zh.md4
2 files changed, 80 insertions, 2 deletions
diff --git a/build/README.md b/build/README.md
new file mode 100644
index 000000000..0df10fa6f
--- /dev/null
+++ b/build/README.md
@@ -0,0 +1,78 @@
+# build description
+
+```
+# tree build/
+build/
+├── cloud
+│   ├── 01-namespace.yaml
+│   ├── 02-serviceaccount.yaml
+│   ├── 03-clusterrole.yaml
+│   ├── 04-clusterrolebinding.yaml
+│   ├── 05-configmap.yaml
+│   ├── 07-deployment.yaml
+│   ├── 08-service.yaml.example
+│   ├── Dockerfile
+│   ├── README.md
+│   └── README_zh.md
+├── crds
+│   └── devices
+│   ├── devices_v1alpha2_devicemodel.yaml
+│   └── devices_v1alpha2_device.yaml
+├── crd-samples
+│   └── devices
+│   ├── create-device-instance.yaml
+│   └── create-device-model.yaml
+├── deployment.yaml
+├── edge
+│   ├── docker-compose.yaml
+│   ├── Dockerfile
+│   ├── kubernetes
+│   │   ├── 01-namespace.yaml
+│   │   ├── 02-edgenode.yaml
+│   │   ├── 03-configmap-edgenodeconf.yaml
+│   │   ├── 04-deployment-edgenode.yaml
+│   │   ├── README.md
+│   │   └── README_zh.md
+│   ├── README.md
+│   ├── README_zh.md
+│   └── run_daemon.sh
+├── node.json
+└── tools
+ └── certgen.sh
+```
+
+- cloud
+- crds
+- crd-samples
+- deployment.yaml
+- edge
+- node.json
+- tools
+
+## cloud
+Relevant steps and instructions for cloudcore deployment with kubernetes deployment
+
+
+## crds
+
+## crd-samples
+
+## edge
+Relevant steps and instructions for edgecore deployment with kubernetes deployment (Only for test)
+
+## node.json
+Example of creating node resources
+
+## tools
+`certgen.sh` used to generate certificates and keys, mainly used in two places
+- Generate cloud and edge certificates, the generated path is in `/etc/kubeedge/ca` and `/etc/kubeedge/certs`
+ ```
+ certgen.sh genCertAndKey edge
+ ```
+- used to generate `06-secret.yaml`
+
+## deployment.yaml
+deployment template, used to deploy nginx to edge node
+
+## rpm
+Make rpm package related files, such as `kubeedge.spec`
diff --git a/build/README_zh.md b/build/README_zh.md
index b35d295b5..c72fcca08 100644
--- a/build/README_zh.md
+++ b/build/README_zh.md
@@ -50,14 +50,14 @@ build/
- tools
## cloud
-edegcontroller以deployment部署的相关步骤及说明
+cloudcore使用kubernetes deployment部署的相关步骤及说明
## crds
## crd-samples
## edge
-edgecore以deployment部署的相关步骤及说明
+edgecore使用kubernetes deployment部署的相关步骤及说明(仅测试环境使用)
## node.json
创建node资源的示例