Skip to content

Commit a993eba

Browse files
author
江博
committed
Add device plugin docs
1 parent 0e96035 commit a993eba

File tree

4 files changed

+561
-2
lines changed

4 files changed

+561
-2
lines changed

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README-zh_CN.md

+169
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
[English](./README.md) | 简体中文
2+
3+
# 介绍
4+
sgx-device-plugin 由阿里云容器服务团队和蚂蚁金服安全计算团队针对 Intel SGX 联合开发的 Kubernetes Device Plugin，可以帮助用户更容易的在容器中使用 SGX。
5+
6+
Intel(R) Software Guard Extensions (Intel(R) SGX) 是 Intel 为软件开发者提供的安全技术，用于防止指定的代码和数据的窃取和恶意篡改。详情可参考[官方链接](https://software.intel.com/en-us/sgx) 。
7+
8+
# 功能
9+
* 无需开启容器特权模式即可使用 SGX；
10+
* 支持 EPC 内存大小自动获取；
11+
* 支持容器声明式 EPC 内存分配。
12+
13+
# 依赖
14+
* [Intel SGX Drivers](https://github.com/intel/linux-sgx-driver)
15+
* [Intel SGX PSW(Platform Software)](https://github.com/intel/linux-sgx) (如果你需要 AESM 服务)
16+
* Kubernetes 版本 >= 1.10
17+
* Go 版本 >= 1.10
18+
19+
# ACK-TEE 简介
20+
TEE(Trusted Execution Environmenet) ，中文名：可信执行环境，是把用户应用程序代码和数据运行在一个通过硬件孤岛和内存加密技术（Hardware Isolotion and memory encryption Technology）创建的特殊执行上线文环境 Enclave 中，任何其他应用、OS Kernel、BIOS、甚至 CPU 之外的其他硬件均无法访问，主要用于防止用户的机密数据、隐私数据被恶意修改、窥探和窃取。
21+
22+
在 [阿里云ACK(Alibaba Cloud Container Service for Kubernetes)](https://www.aliyun.com/product/kubernetes) 上可以创建一个基于 Intel® SGX 的机密计算托管 Kubernetes 集群，节点型号是支持 Intel® SGX 的裸金属服务器 `ecs.ebmhfg5.2xlarge`, 相对于 VM，裸金属的 Overhead 开销更小，性能更优，性能抖动更小。每个节点上默认都会自动安装 containerd、SGX Driver、SGX PSW(Platform Software) 以及 SGX-Device-Plugin。
23+
24+
# 编译&打包镜像（可选）
25+
Step1: 下载源码并编译。
26+
```bash
27+
$ mkdir -p $GOPATH/src/github.com/AliyunContainerService
28+
$ git clone https://github.com/AliyunContainerService/sgx-device-plugin.git $GOPATH/src/github.com/AliyunContainerService/sgx-device-plugin
29+
$ cd $GOPATH/src/github.com/AliyunContainerService/sgx-device-plugin/
30+
$ make
31+
$ ls -l _output/sgx-device-plugin
32+
```
33+
34+
Step2： 镜像打包
35+
```bash
36+
$ docker build -t {SGX_DEVICE_PLUGIN_IMAGE} . -f Dockerfile
37+
$ docker push {SGX_DEVICE_PLUGIN_IMAGE}
38+
```
39+
40+
# 部署 sgx-device-plugin
41+
在创建ACK机密计算托管集群时，默认会自动安装 sgx-device-plugin DaemonSet。当然你也可以在你自己支持 SGX 的 Kubernetes 中选择手动安装:
42+
43+
```bash
44+
$ cat <<EOF | kubectl create -f -
45+
apiVersion: extensions/v1beta1
46+
kind: DaemonSet
47+
metadata:
48+
name: sgx-device-plugin-ds
49+
namespace: kube-system
50+
spec:
51+
selector:
52+
matchLabels:
53+
k8s-app: sgx-device-plugin
54+
template:
55+
metadata:
56+
annotations:
57+
scheduler.alpha.kubernetes.io/critical-pod: ""
58+
labels:
59+
k8s-app: sgx-device-plugin
60+
spec:
61+
containers:
62+
- image: registry.cn-hangzhou.aliyuncs.com/acs/sgx-device-plugin:v1.0.0-6e13136-aliyun
63+
imagePullPolicy: IfNotPresent
64+
name: sgx-device-plugin
65+
securityContext:
66+
allowPrivilegeEscalation: false
67+
capabilities:
68+
drop:
69+
- ALL
70+
volumeMounts:
71+
- mountPath: /var/lib/kubelet/device-plugins
72+
name: device-plugin
73+
- mountPath: /dev
74+
name: dev
75+
tolerations:
76+
- effect: NoSchedule
77+
key: alibabacloud.com/sgx_epc_MiB
78+
operator: Exists
79+
volumes:
80+
- hostPath:
81+
path: /var/lib/kubelet/device-plugins
82+
type: DirectoryOrCreate
83+
name: device-plugin
84+
- hostPath:
85+
path: /dev
86+
type: Directory
87+
name: dev
88+
EOF
89+
$ kubectl -n kube-system -l k8s-app=sgx-device-plugin
90+
NAME READY STATUS RESTARTS AGE
91+
sgx-device-plugin-ds-5brgs 1/1 Running 0 5d5h
92+
sgx-device-plugin-ds-b467q 1/1 Running 0 5d5h
93+
sgx-device-plugin-ds-vl7sm 1/1 Running 0 5d5h
94+
$
95+
```
96+
97+
插件成功运行后，会发现 Node 的 `.status.capacity` 或 `.status.allocatable` 多了一种新资源 **`alibabacloud.com/sgx_epc_MiB`**:
98+
99+
```bash
100+
$ kubectl get node {NODE_NAME} -o yaml
101+
...
102+
allocatable:
103+
alibabacloud.com/sgx_epc_MiB: "93"
104+
cpu: "8"
105+
...
106+
$
107+
```
108+
109+
# 运行 SGX 应用容器
110+
首先你的应用须通过 Intel SGX SDK 或 SGX LibOS 进行编译、签名和镜像打包。
111+
112+
```yaml
113+
apiVersion: v1
114+
kind: Pod
115+
metadata:
116+
name: {POD_NAME}
117+
namespace: default
118+
spec:
119+
containers:
120+
- image: {CONTAINER_IMAGE}
121+
imagePullPolicy: IfNotPresent
122+
name: {CONTAINER_NAME}
123+
resources:
124+
requests:
125+
alibabacloud.com/sgx_epc_MiB: 20
126+
limits:
127+
alibabacloud.com/sgx_epc_MiB: 20
128+
```
129+
130+
如果你的应用需要 Remote Attestation，那么需要访问 AESM，这时可以把 `/var/run/aesmd/aesm.socket` 挂载到你的容器中:
131+
```yaml
132+
apiVersion: v1
133+
kind: Pod
134+
metadata:
135+
name: {POD_NAME}
136+
namespace: default
137+
spec:
138+
containers:
139+
- image: {CONTAINER_IMAGE}
140+
imagePullPolicy: IfNotPresent
141+
name: {CONTAINER_NAME}
142+
resources:
143+
requests:
144+
alibabacloud.com/sgx_epc_MiB: 20
145+
limits:
146+
alibabacloud.com/sgx_epc_MiB: 20
147+
volumeMounts:
148+
- mountPath: /var/run/aesmd/aesm.socket
149+
name: aesmsocket
150+
volumes:
151+
- hostPath:
152+
path: /var/run/aesmd/aesmd/aesm.socket
153+
type: Socket
154+
name: aesmsocket
155+
156+
```
157+
158+
# FAQ
159+
* **我可以把这个插件部署到自己的私有 kubernetes 集群中吗 ?**
160+
当然可以，这个插件是云原生、云平台无关的，你可以把它部署在任何 kubernetes 上，但它只能运行在 sgx 的节点上。
161+
162+
* **这个插件是否可以真的帮助应用限制 EPC 大小 ？**
163+
不可以，`alibabacloud.com/sgx_epc_MiB` 里指定的 EPC 大小限制仅用于 K8s 的调度, 因为 SGX 驱动目前还不支持 EPC 大小限制。
164+
165+
# 许可证
166+
本软件许可证为 [Apache 2.0](./LICENSE)。
167+
168+
# Contributing
169+
详情请参考 [CONTRIBUTING.md](./docs/en/CONTRIBUTING.md)。

0 commit comments

Comments
 (0)