Browse code

Helper documentation for cloud images

Anish Swaminathan authored on 2015/08/18 09:39:41
Showing 1 changed files
... ...
@@ -1,4 +1,4 @@
1
-Supported Cloud Images
1
+#Supported Cloud Images
2 2
 
3 3
 GCE - Google Compute Engine
4 4
 AMI - Amazon Machine Image
... ...
@@ -7,75 +7,86 @@ OVA
7 7
 
8 8
 How to build cloud images
9 9
 
10
-sudo make cloud-image IMG_NAME=<image-name>
10
+sudo make cloud-image IMG_NAME=image-name
11 11
 
12 12
 image-name : gce/ami/azure/ova
13 13
 
14 14
 The output of the build process produces the following file formats:
15
+
15 16
 GCE - A tar file consisting of disk.raw as the raw disk file 
17
+
16 18
 AMI - A raw disk file
19
+
17 20
 Azure - A vhd file
21
+
18 22
 OVA - An ova file (vmdk + ovf)
19 23
 
20 24
 sudo make cloud-image-all builds all the cloud images
21 25
 
22 26
 
23
-How to create running instances in the cloud
27
+#How to create running instances in the cloud
24 28
 
25 29
 
26
-GCE
30
+##GCE
27 31
 
28 32
 The tar file can be uploaded to Google's cloud storage and an instance can be created after creating an image from the tar file. You will need Google Cloud sdk on host machine to upload the image and create instances
29 33
 
30
-# Install google cloud sdk on host machine
34
+####Install google cloud sdk on host machine
31 35
 curl https://sdk.cloud.google.com | bash
32 36
 
33
-#Upload the tar file
34
-gsutil cp photon-gce.tar.gz gs://<bucket-name>
37
+####Upload the tar file
38
+gsutil cp photon-gce.tar.gz gs://bucket-name
35 39
 
36
-#Create image
37
-gcloud compute --project <project-id> images create <image-name> --description <description> --source-uri https://storage.googleapis.com/<bucket-name>/photon-gce.tar.gz
40
+####Create image
41
+gcloud compute --project project-id images create image-name --description description --source-uri https://storage.googleapis.com/bucket-name/photon-gce.tar.gz
38 42
 
39
-#Create instance of GCE
40
-gcloud compute --project <project-id> instances create <instance-name> --zone "us-central1-f" --machine-type "n1-standard-1" <other-options>
43
+####Create instance of GCE
44
+gcloud compute --project project-id instances create instance-name --zone "us-central1-f" --machine-type "n1-standard-1" other-options
41 45
 
42 46
 You can create instances also from Google developer console
43 47
 
44 48
 
45
-AMI
49
+##AMI
46 50
 
47
-Install the AWS ClI : http://docs.aws.amazon.com/cli/latest/userguide/installing.html#install-bundle-other-os
51
+Install the [AWS CLI] (http://docs.aws.amazon.com/cli/latest/userguide/installing.html#install-bundle-other-os)
48 52
 
49
-#Bundle the image
50
-ec2-bundle-image -c <cert>.pem -k <private-key>.pem -u <AWS_USER_ID> --arch x86_64 --image photon-ami.raw --destination <directory-name>
53
+####Bundle the image
54
+ec2-bundle-image -c cert.pem -k private-key.pem -u $AWS_USER_ID --arch x86_64 --image photon-ami.raw --destination directory-name
51 55
 
52
-#Upload the bundle
53
-ec2-upload-bundle --manifest <directory-name>/photon-ami.raw.manifest.xml --bucket <bucket-name> --access-key $AWS_ACCESS_KEY --secret-key $AWS_SECRET_KEY
54
-#Register the AMI
55
-ec2-register <bucket-name>/photon-ami.raw.manifest.xml --name <name> --architecture x86_64 --virtualization-type hvm
56
+####Upload the bundle
57
+ec2-upload-bundle --manifest directory-name/photon-ami.raw.manifest.xml --bucket bucket-name --access-key $AWS_ACCESS_KEY --secret-key $AWS_SECRET_KEY
58
+####Register the AMI
59
+ec2-register bucket-name/photon-ami.raw.manifest.xml --name name --architecture x86_64 --virtualization-type hvm
56 60
 
57 61
 You can now launch instances using AWS console
58 62
 
59 63
 
60
-AZURE
64
+##AZURE
65
+
66
+Install the [Azure CLI] (https://www.npmjs.com/package/azure)
67
+
68
+Install [QEMU](https://en.wikibooks.org/wiki/QEMU/Installing_QEMU)
61 69
 
62
-Install the Azure CLI: https://www.npmjs.com/package/azure
63
-Install QEMU: https://en.wikibooks.org/wiki/QEMU/Installing_QEMU
64
-#Create the image
65
-azure vm image create <image_name> <path_to_vhd> -l "West US" -o linux
70
+####Create the image
71
+azure vm image create image_name path_to_vhd -l "West US" -o linux
66 72
 
67 73
 Create running VM instances using Azure management portal
68 74
 
69 75
 
70
-OVA
76
+##OVA
71 77
 
72 78
 The ova image uses a custom linux kernel, which is an optimized kernel based on version 4.1.3. The default password for the ova file is under support/cloud-image-builder/ova/vmdk_ova.json. The password should be changed using guest customization options when uploading to vCA.
73
-Pre-requisites
74
-QEMU: https://en.wikibooks.org/wiki/QEMU/Installing_QEMU
75
-VDDK 6.0: https://developercenter.vmware.com/web/sdk/60/vddk
79
+
80
+####Pre-requisites
81
+
82
+[QEMU] (https://en.wikibooks.org/wiki/QEMU/Installing_QEMU)
83
+
84
+[VDDK 6.0] (https://developercenter.vmware.com/web/sdk/60/vddk)
85
+
76 86
 	- You must copy the libraries to /usr/lib/vmware and run ldconfig
87
+
77 88
 	- Also copy the include files to /usr/include
78
-OVFTOOL: https://my.vmware.com/group/vmware/details?downloadGroup=OVFTOOL410&productId=491
79 89
 
90
+[OVFTOOL] (https://my.vmware.com/group/vmware/details?downloadGroup=OVFTOOL410&productId=491)
80 91
 
81 92