Add documentation for building EC2 instancessalmon_18.90.0salmon/18.90.018.90.0

This adds the documentation for building and uploading EC2 images (AMIs)
that can run on graviton instances.

Bug-AGL: SPEC-5181
Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: I824db52579247c731b7e0e34f755f80ffa338ed6
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30054

6 files changed, 155 insertions, 0 deletions

diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/11_Building_for_EC2_arm64_and_x86-64.md b/docs/01_Getting_Started/02_Building_AGL_Image/11_Building_for_EC2_arm64_and_x86-64.md
new file mode 100644
index 0000000..8e22274
--- /dev/null
+++ b/docs/01_Getting_Started/02_Building_AGL_Image/11_Building_for_EC2_arm64_and_x86-64.md
@@ -0,0 +1,155 @@
+---
+title: Building for AWS EC2 (arm64 or x86-64)
+---
+
+Building an image for emulation allows you to simulate your
+image without actual target hardware. In this case using an EC2 instance.
+
+This section describes the steps you need to take to build the
+AGL demo image for emulation using EC2 either for arm64 or x86-64.
+
+In the commanline examples below, we will focus on aws-ec2-arm64 primarily.
+If you need x86-64, then replace it with aws-ec2-x86-64 likewise.
+
+## 1. Making Sure Your Build Environment is Correct
+
+The
+"[Initializing Your Build Environment](./04_Initializing_Your_Build_Environment.md)"
+section presented generic information for setting up your build environment
+using the `aglsetup.sh` script.
+If you are building the AGL demo image for emulation, you need to specify some
+specific options when you run the script:
+
+**Sample Qt based IVI demo :**
+
+```sh
+$ source meta-agl/scripts/aglsetup.sh -f -m aws-ec2-arm64 -b build-aws-ec2 agl-demo agl-devel
+$ echo "# reuse download directories" >> $AGL_TOP/site.conf
+$ echo "DL_DIR = \"$HOME/downloads/\"" >> $AGL_TOP/site.conf
+$ echo "SSTATE_DIR = \"$AGL_TOP/sstate-cache/\"" >> $AGL_TOP/site.conf
+$ ln -sf $AGL_TOP/site.conf conf/
+```
+
+**IVI-EG Flutter based demo :**
+
+```
+$ source meta-agl/scripts/aglsetup.sh -f -m aws-ec2-arm64 -b build-aws-ec2 agl-demo agl-devel
+$ echo "# reuse download directories" >> $AGL_TOP/site.conf
+$ echo "DL_DIR = \"$HOME/downloads/\"" >> $AGL_TOP/site.conf
+$ echo "SSTATE_DIR = \"$AGL_TOP/sstate-cache/\"" >> $AGL_TOP/site.conf
+$ ln -sf $AGL_TOP/site.conf conf/
+```
+
+The "-m" option specifies the "aws-ec2-arm64" machine.
+The list of AGL features used with script are appropriate for development of
+the AGL demo image. For production use, you need to omit agl-devel and tailor your image.
+
+## 2. Using BitBake
+
+Start the build using the `bitbake` command.
+
+**NOTE:** An initial build can take many hours depending on your
+CPU and and Internet connection speeds.
+The build also takes approximately 100G-bytes of free disk space.
+
+**Sample Qt based IVI demo :**
+The target is `agl-ivi-demo-qt`.
+
+```
+$ time bitbake agl-ivi-demo-qt
+```
+
+By default, the build process puts the resulting image in the Build Directory and further exporting that as `$IMAGE_NAME`:
+
+```
+<build_directory>/tmp/deploy/images/aws-ec2-arm64/agl-ivi-demo-qt-aws-ec2-arm64.rootfs.wic.vhd
+$ export IMAGE_NAME=agl-ivi-demo-qt
+```
+
+**IVI-EG Flutter based demo :**
+The target is `agl-ivi-demo-flutter`.
+
+```
+$ time bitbake agl-ivi-demo-flutter
+```
+
+By default, the build process puts the resulting image in the Build Directory and further exporting that as $IMAGE_NAME:
+
+
+```
+<build_directory>/tmp/deploy/images/aws-ec2-arm64/agl-ivi-demo-flutter-aws-ec2-arm64.rootfs.wic.vhd
+$ export IMAGE_NAME=agl-ivi-demo-flutter
+```
+
+
+## 3. Deploying the AGL Demo Image
+
+Deploying the image consists of uploading the image to S3 and
+conversion to to an AMI image. The whole process is done using
+a script out of meta-aws . Next you need to start a new instance
+using your new image.
+The image is setup to expose its screen over rdp. This is ok for
+development, but you need to keep security in mind when configuring
+the EC2 security groups and/or tunnel over ssh.
+
+
+
+### 3.1 Uploading using create-ec2-ami.sh
+
+The script required to upload the resulting image is part of meta-aws in the subfolder scripts/ec2-ami/.
+
+**It has a few requirements that you need to setup first.**
+
+**These are documented in the [Readme there](https://github.com/aws4embeddedlinux/meta-aws/blob/scarthgap/scripts/ec2-ami/README.md).**
+
+**Read it and set it up accordingly.**
+
+The script itself is called creat-ec2-ami.sh and takes 4 arguments:
+* your S3 bucket name
+* the size of the AMI (don't make it too small)
+* the target image name
+* the machine name
+
+```
+Example run
+../bsp/meta-aws/scripts/ec2-ami/create-ec2-ami.sh my_s3_bucket 8 agl-ivi-demo-flutter aws-ec2-arm64
+```
+
+After this process is complete, your image is available as AMI to you (only to you).
+
+### 3.2 Configuring within AWS EC2
+
+In your EC2 dashboard go the the same region as you configured the upload for, 
+select "Launch instance" and enter a name.
+
+![ec2-dashboard](images/1_EC2_dashboard.png)
+
+Select under "My AMIs" the uploaded AGL image in question. Select an instance type
+that is big enough (>= 4GB RAM, 8GB RAM recommended). 
+
+![ec2-instance-1](images/2_start-instance-1.png)
+
+Select your key pair, select the security group.
+
+![ec2-instance-2](images/3_start_instance-2.png)
+
+Finally start the instance.
+
+**Note1: AWS serial console does not help as you have no root password available until you reset it.**
+
+**Note2: You cannot connect as 'root' (as shown in the connect tab) - you have to substitute 'root' with 'user'.**
+
+**Note3: There is no web output, you need to use RDP. See below ...**
+
+
+### 3.3 Connecting via RDP
+
+For security reasons, you should always tunnel over ssh.
+
+For this, connect using 'ssh -i "yourkey.pem" -L 3389:localhost:3389 user@publicIPofSERVER' .
+
+Then use an rdp client and connect to 'localhost' .
+
+### 3.4 Security considerations
+
+As mentioned above, do not expose port 3389 to the internet by opening up the port.
diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/11_Available_Demo_Images.md b/docs/01_Getting_Started/02_Building_AGL_Image/21_Available_Demo_Images.md
index 32ebb6c..32ebb6c 100644
--- a/docs/01_Getting_Started/02_Building_AGL_Image/11_Available_Demo_Images.md
+++ b/docs/01_Getting_Started/02_Building_AGL_Image/21_Available_Demo_Images.md
diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/12_Available_KVM_Demo_Images.md b/docs/01_Getting_Started/02_Building_AGL_Image/22_Available_KVM_Demo_Images.md
index ce8bb44..ce8bb44 100644
--- a/docs/01_Getting_Started/02_Building_AGL_Image/12_Available_KVM_Demo_Images.md
+++ b/docs/01_Getting_Started/02_Building_AGL_Image/22_Available_KVM_Demo_Images.md
diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/images/1_EC2_dashboard.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/1_EC2_dashboard.png
new file mode 100644
index 0000000..6a5341b
--- /dev/null
+++ b/docs/01_Getting_Started/02_Building_AGL_Image/images/1_EC2_dashboard.png
diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/images/2_start-instance-1.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/2_start-instance-1.png
new file mode 100644
index 0000000..89e38ad
--- /dev/null
+++ b/docs/01_Getting_Started/02_Building_AGL_Image/images/2_start-instance-1.png
diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/images/3_start_instance-2.png b/docs/01_Getting_Started/02_Building_AGL_Image/images/3_start_instance-2.png
new file mode 100644
index 0000000..3387182
--- /dev/null
+++ b/docs/01_Getting_Started/02_Building_AGL_Image/images/3_start_instance-2.png