Skip to content
This repository was archived by the owner on Jun 6, 2024. It is now read-only.

Commit d8dd754

Browse files
committed
Documentation Updates for rel 21.12.02
1 parent 38faa7e commit d8dd754

File tree

4 files changed

+76
-10
lines changed

4 files changed

+76
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Find complete documentation for all experience kits in the
4949

5050
## Release Notes
5151
- [Product-level release notes](https://smart-edge-open.github.io/release-notes/)
52-
- [Release notes for the Developer Experience Kit](https://github.com/smart-edge-open/docs/blob/main/release-notes/release-notes-se-open-DEK-21-09.md), including specs of the hardware used to validate the experience kit.
52+
- [Release notes for the Developer Experience Kit](https://github.com/smart-edge-open/docs/blob/smart-edge-open-21.12/release-notes/release-notes-se-open-DEK-21-12.md), including specs of the hardware used to validate the experience kit.
5353
- [Release notes](https://github.com/smart-edge-open/ido-specs/blob/master/smartedge-open_releasenotes.md)
5454
for experience kits formerly available as OpenNESS 21.03 and earlier
5555

components/security/application-security-using-sgx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,4 +118,4 @@ To subscribe follow the steps below
118118

119119
7.) Now on the next page, scroll down to "Intel® Software Guard Extensions Provisioning Certification Service subscription" section and click on any of the "Show" links to reveal your corresponding API key
120120
### How to test SGX functionality
121-
Test SGX functionality using gramine based sample OpenVino [application](https://github.com/smart-edge-open/edgeapps/blob/master/applications/sgx/openvino-ssd/README.md)
121+
Test SGX functionality using gramine based sample OpenVino [application](https://github.com/smart-edge-open/edgeapps/blob/smart-edge-open-21.12/applications/sgx/openvino-ssd/README.md)

experience-kits/developer-experience-kit.md

Lines changed: 73 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,6 @@ If you choose to enable security features in your installation, you will also ne
9898
- Hard drive: At least 20 GB
9999
- USB flash drive
100100
- Operating system: Ubuntu 20.04 LTS
101-
- Git
102-
- Docker and Docker Compose
103-
- **NOTE:** You must install Docker from the [Docker repository](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository). Installation by Docker package is not supported.
104-
- Python 3.6 or later, with the PyYAML module installed
105101
- Internet access
106102

107103
> **NOTE:** You must add the user account on the provisioning system to /etc/sudoers.
@@ -160,6 +156,9 @@ The installation instructions assume basic knowledge of operating system adminis
160156

161157
### Install the Developer Experience Kit
162158

159+
#### Prepare the Provisioning System
160+
161+
The ESP is used by all experience kits to provision the system used to host the edge cluster. For more details about the ESP, including troubleshooting suggestions, please refer to the [Smart Edge Open Provisioning Process](https://smart-edge-open.github.io/docs/experience-kits/provisioning/provisioning/).
163162
The Developer Experience Kit provides a command line utility (`dek_provision.py`) that uses the
164163
Intel® Edge Software Provisioner toolchain to deliver a smooth installation experience.
165164

@@ -172,20 +171,86 @@ people new to the Smart Edge Open solution.
172171

173172
<!-- #### Quick Start (Default Configuration) -->
174173

175-
You must be logged in as root on the provisioning system for the following steps. To become the root user, run the following command:
174+
> **NOTE:** In order for the provisioning script to have the proper permissions, you must run the `sudo` command as shown above. Using `sudo` with the `dek_provision.py` command will not work.
175+
176+
The following steps will walk you through installing software to the provisioning system, including Git, Docker and Docker Compose, and Python.
177+
You must be logged in as root on the provisioning system for the following steps. To become the root user, run the following command on the provisioning system:
176178

177179
```Shell.bash
178180
[Provisioning System] $ sudo su -
179181
```
180-
> **NOTE:** In order for the provisioning script to have the proper permissions, you must run the `sudo` command as shown above. Using `sudo` with the `dek_provision.py` command will not work.
181182

183+
##### Install Git
184+
185+
Install Git to the target system using the following command:
186+
187+
```Shell.bash
188+
apt-get install git
189+
```
190+
191+
##### Install Docker and Docker Compose
192+
193+
In the next steps you will install Docker, configure it to use a proxy server, and install Docker Compose.
194+
195+
###### Install Docker from the Docker Repository
196+
197+
Follow the installation instructions at the [Docker repository](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository). Installation by package manager is not supported at this time and will result in errors. Please refer to [official installation guide](https://docs.docker.com/engine/install/ubuntu/)
198+
199+
###### Configure Docker to Use a Proxy Server
200+
201+
Create or edit the Docker configuration file ~/.docker/config.json
202+
203+
```Shell.bash
204+
{
205+
"proxies":
206+
{
207+
"default":
208+
{
209+
"httpProxy":"http://myproxy.hostname:8080",
210+
"httpsProxy": "http://myproxy.hostname:8080"
211+
}
212+
}
213+
}
214+
```
215+
216+
Set your environment variables. Replace `myproxy.hostname` in the example with the information for your own proxy.
217+
218+
```Shell.bash
219+
vi /etc/systemd/system/docker.service.d/proxy.conf
220+
[Service]
221+
Environment="HTTP_PROXY=http://myproxy.hostname:8080"
222+
Environment="HTTPS_PROXY=https://myproxy.hostname:8080/"
223+
Environment="NO_PROXY="localhost,127.0.0.1,::1"
224+
```
225+
226+
Reload the file and restart the Docker service
227+
228+
```Shell.bash
229+
systemctl daemon-reload
230+
systemctl restart docker.service
231+
```
232+
233+
###### Install Docker Compose
234+
235+
Follow the docker [official guide](https://docs.docker.com/compose/install/).
236+
237+
##### Install Python3 and Related Libraries
238+
239+
Run the following commands to install Python3 and related libraries:
240+
241+
```Shell.bash
242+
apt-get update
243+
apt-get install python3
244+
apt-get install python3-pip
245+
pip3 install PyYAML
246+
```
182247
183248
#### Clone the Developer Experience Kit Repository
184249
185250
Clone the [Developer Experience Kit repo](https://github.com/smart-edge-open/open-developer-experience-kits) to the provisioning system:
186251
187252
```Shell.bash
188-
# git clone https://github.com/smart-edge-open/open-developer-experience-kits.git --branch=smart-edge-open-21.12 ~/dek
253+
# git clone https://github.com/smart-edge-open/open-developer-experience-kits.git --branch=smart-edge-open-21.12.02 ~/dek
189254
# cd ~/dek
190255
```
191256
@@ -223,6 +288,7 @@ edgenode_group:
223288
- If you are enabling platform attestation with Intel® SecL - DC, update `deployments/verification_controller/all.yml` with following changes
224289
1. IP addresses of edge nodes(where trust agents run) in `isecl_ta_san_list`
225290
2. Make sure `platform_attestation_controller` is set to `true`
291+
3. Set `isecl_control_plane_ip` to AWS instance public ip in `inventory/default/group_vars/all/10-default.yml`
226292
- If you are enabling Intel® SGX, set `pccs_enable` to `true` in `deployments/verification_controller/all.yml`
227293
228294
Developer Experiance Kit users can disable certain features to be automatically provisioned and deployed during the setup. This is made available to the users using the "Exclude List" feature. As an example if user wants to exclude Platform Attestation with IsecL or/and SGX then following steps needs to be followed:

experience-kits/provisioning/provisioning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ use the provisioning instruction published with the release to avoid incompatibi
7070
For convenience, you can change the current directory to the directory the kit is cloned to, e.g.:
7171

7272
```Shell.bash
73-
[Provisioning System] # git clone https://github.com/smart-edge-open/open-developer-experience-kits.git --branch=smart-edge-open-21.09 ~/dek
73+
[Provisioning System] # git clone https://github.com/smart-edge-open/open-developer-experience-kits.git --branch=smart-edge-open-21.12.02 ~/dek
7474
[Provisioning System] # cd ~/dek
7575
```
7676

0 commit comments

Comments
 (0)