Change-Id: I236edf5946e2abebe61eac54842230b1d9755ea3
Reviewed-on: http://photon-jenkins.eng.vmware.com/1154
Reviewed-by: Steve Hoenisch <shoenisch@vmware.com>
Tested-by: Steve Hoenisch <shoenisch@vmware.com>
... | ... |
@@ -1,20 +1,22 @@ |
1 | 1 |
#Compatible Cloud Images |
2 | 2 |
|
3 |
- 1. GCE - Google Compute Engine |
|
3 |
+The [Bintray website](https://bintray.com/vmware/photon/) contains the following cloud-ready images of Photon OS: |
|
4 | 4 |
|
5 |
- 2. AMI - Amazon Machine Image |
|
5 |
+1. GCE - Google Compute Engine |
|
6 | 6 |
|
7 |
- 3. Azure |
|
7 |
+1. AMI - Amazon Machine Image |
|
8 | 8 |
|
9 |
- 4. OVA |
|
9 |
+1. OVA |
|
10 | 10 |
|
11 |
- 5. Photon-bosh-stemcell |
|
11 |
+Because the cloud-ready images of Photon OS are built to be compatible with their corresponding cloud platform or format, you typically do not need to build a cloud image--just go to Bintray and download the image for the platform that you are working on. |
|
12 | 12 |
|
13 |
-#How to build cloud images |
|
13 |
+If, however, you want to build your own cloud image, perhaps because you seek to customize the code, see the next section on how to build cloud images. |
|
14 | 14 |
|
15 |
-sudo make cloud-image IMG_NAME=image-name |
|
15 |
+## How to build cloud images |
|
16 | 16 |
|
17 |
-image-name : gce/ami/azure/ova |
|
17 |
+ sudo make cloud-image IMG_NAME=image-name |
|
18 |
+ |
|
19 |
+ image-name: gce/ami/azure/ova |
|
18 | 20 |
|
19 | 21 |
The output of the build process produces the following file formats: |
20 | 22 |
|
... | ... |
@@ -22,54 +24,69 @@ GCE - A tar file consisting of disk.raw as the raw disk file |
22 | 22 |
|
23 | 23 |
AMI - A raw disk file |
24 | 24 |
|
25 |
-Azure - A vhd file |
|
25 |
+<!-- Azure - A vhd file --> |
|
26 | 26 |
|
27 | 27 |
OVA - An ova file (vmdk + ovf) |
28 | 28 |
|
29 |
-sudo make cloud-image-all builds all the cloud images |
|
29 |
+If you want, you can build all the cloud images by running the following command: |
|
30 |
+ |
|
31 |
+ sudo make cloud-image-all |
|
30 | 32 |
|
31 |
-###How to build Photon bosh-stemcell |
|
33 |
+<!-- ###How to build Photon bosh-stemcell |
|
32 | 34 |
|
33 |
-Please follow the link to [ build ] (https://github.com/cloudfoundry/bosh/blob/develop/bosh-stemcell/README.md) Photon bosh-stemcell |
|
35 |
+Please follow the link to [build](https://github.com/cloudfoundry/bosh/blob/develop/bosh-stemcell/README.md) Photon bosh-stemcell |
|
36 |
+--> |
|
34 | 37 |
|
38 |
+## How to create running instances in the cloud |
|
35 | 39 |
|
36 |
-#How to create running instances in the cloud |
|
40 |
+The following sections contain some high-level instructions on how to create instances of Photon OS in the Google Compute Engine (GCE) and Amazon Elastic Cloud Compute (EC2). For more information, see the Amazon or Google cloud documentation. |
|
37 | 41 |
|
42 |
+### GCE |
|
38 | 43 |
|
39 |
-##GCE |
|
44 |
+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 the Google Cloud SDK on your host machine to upload the image and create instances. |
|
40 | 45 |
|
41 |
-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 |
|
46 |
+####Install Google cloud SDK on host machine |
|
42 | 47 |
|
43 |
-####Install google cloud sdk on host machine |
|
44 |
-curl https://sdk.cloud.google.com | bash |
|
48 |
+ curl https://sdk.cloud.google.com | bash |
|
45 | 49 |
|
46 | 50 |
####Upload the tar file |
47 |
-gsutil cp photon-gce.tar.gz gs://bucket-name |
|
51 |
+ |
|
52 |
+ gsutil cp photon-gce.tar.gz gs://bucket-name |
|
48 | 53 |
|
49 | 54 |
####Create image |
50 |
-gcloud compute --project project-id images create image-name --description description --source-uri https://storage.googleapis.com/bucket-name/photon-gce.tar.gz |
|
55 |
+ |
|
56 |
+ gcloud compute --project project-id images create image-name --description description --source-uri https://storage.googleapis.com/bucket-name/photon-gce.tar.gz |
|
51 | 57 |
|
52 | 58 |
####Create instance of GCE |
53 |
-gcloud compute --project project-id instances create instance-name --zone "us-central1-f" --machine-type "n1-standard-1" other-options |
|
54 | 59 |
|
55 |
-You can create instances also from Google developer console |
|
60 |
+ gcloud compute --project project-id instances create instance-name --zone "us-central1-f" --machine-type "n1-standard-1" other-options |
|
56 | 61 |
|
62 |
+(You can also create instances from the Google developer console.) |
|
57 | 63 |
|
58 |
-##AMI |
|
64 |
+For more information, see [Running a Photon OS Machine on GCE](https://github.com/vmware/photon/blob/master/docs/photon-admin-guide.md#running-a-photon-os-machine-on-gce). |
|
59 | 65 |
|
60 |
-Install the [AWS CLI] (http://docs.aws.amazon.com/cli/latest/userguide/installing.html#install-bundle-other-os) |
|
66 |
+### AWS EC2 |
|
67 |
+ |
|
68 |
+Install the [AWS CLI](http://docs.aws.amazon.com/cli/latest/userguide/installing.html#install-bundle-other-os) and [EC2 CLI](http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/set-up-ec2-cli-linux.html) tools. |
|
61 | 69 |
|
62 | 70 |
####Bundle the image |
63 |
-ec2-bundle-image -c cert.pem -k private-key.pem -u $AWS_USER_ID --arch x86_64 --image photon-ami.raw --destination directory-name |
|
71 |
+ |
|
72 |
+ ec2-bundle-image -c cert.pem -k private-key.pem -u $AWS_USER_ID --arch x86_64 --image photon-ami.raw --destination directory-name |
|
64 | 73 |
|
65 | 74 |
####Upload the bundle |
66 |
-ec2-upload-bundle --manifest directory-name/photon-ami.raw.manifest.xml --bucket bucket-name --access-key $AWS_ACCESS_KEY --secret-key $AWS_SECRET_KEY |
|
75 |
+ |
|
76 |
+ ec2-upload-bundle --manifest directory-name/photon-ami.raw.manifest.xml --bucket bucket-name --access-key $AWS_ACCESS_KEY --secret-key $AWS_SECRET_KEY |
|
77 |
+ |
|
67 | 78 |
####Register the AMI |
68 |
-ec2-register bucket-name/photon-ami.raw.manifest.xml --name name --architecture x86_64 --virtualization-type hvm |
|
69 | 79 |
|
70 |
-You can now launch instances using AWS console |
|
80 |
+ ec2-register bucket-name/photon-ami.raw.manifest.xml --name name --architecture x86_64 --virtualization-type hvm |
|
71 | 81 |
|
82 |
+You can now launch instances using the AWS console. |
|
72 | 83 |
|
84 |
+For more information, see [Customizing a Photon OS Machine on EC2](https://github.com/vmware/photon/blob/master/docs/photon-admin-guide.md#customizing-a-photon-os-machine-on-ec2). |
|
85 |
+ |
|
86 |
+ |
|
87 |
+<!-- |
|
73 | 88 |
##AZURE |
74 | 89 |
|
75 | 90 |
Install the [Azure CLI] (https://www.npmjs.com/package/azure) |
... | ... |
@@ -80,34 +97,25 @@ Install [QEMU](https://en.wikibooks.org/wiki/QEMU/Installing_QEMU) |
80 | 80 |
azure vm image create image_name path_to_vhd -l "West US" -o linux |
81 | 81 |
|
82 | 82 |
Create running VM instances using Azure management portal |
83 |
+--> |
|
83 | 84 |
|
85 |
+###OVA |
|
84 | 86 |
|
85 |
-##OVA |
|
86 |
- |
|
87 |
-The ova image uses a custom linux kernel, which is an optimized kernel based on version 4.1.3. Two ova files are generated from build - photon-ova.ova and photon-custom.ova. The password for photon-ova.ova should be changed using guest customization options when uploading to vCA. Photon-custom.ova is generated with the password changeme, intended for use with Fusion/Workstation. |
|
88 |
- |
|
89 |
-####Pre-requisites |
|
87 |
+The OVA image uses an optimized version of the 4.4.8 Linux kernel. Two ova files are generated from the build: photon-ova.ova, which is the full version of Photon OS, and photon-custom.ova, which is the minimal version of Photon OS. The password for photon-ova.ova should be changed using guest customization options when you upload it to VMware vCenter. Photon-custom.ova comes with the default password set to `changeme`; you must change it the first time you log in. |
|
90 | 88 |
|
91 |
-[VDDK 6.0] (https://developercenter.vmware.com/web/sdk/60/vddk) |
|
89 |
+#### OVA Prerequisites |
|
92 | 90 |
|
93 |
- - You must copy the libraries to /usr/lib/vmware and run ldconfig |
|
91 |
+[VDDK 6.0](https://developercenter.vmware.com/web/sdk/60/vddk) |
|
94 | 92 |
|
95 |
- - Also copy the include files to /usr/include |
|
93 |
+You must copy the libraries to /usr/lib/vmware and run ldconfig. You must also copy the include files to /usr/include. |
|
96 | 94 |
|
97 |
-[OVFTOOL] (https://my.vmware.com/group/vmware/details?downloadGroup=OVFTOOL410&productId=491) |
|
95 |
+[OVFTOOL](https://my.vmware.com/group/vmware/details?downloadGroup=OVFTOOL410&productId=491) |
|
98 | 96 |
|
97 |
+<!-- |
|
99 | 98 |
##Photon Bosh |
100 | 99 |
|
101 | 100 |
Please refer [bosh docs] (http://bosh.io/docs) to deploy BOSH on Photon |
101 |
+--> |
|
102 | 102 |
|
103 |
-##Links to the pre-built TP2 images |
|
104 |
-[GCE] (https://dl.bintray.com/vmware/photon/gce/1.0TP2/x86_64/photon-1.0TP2.tar.gz) Alternatively, you can download the source tar file from the [following] (https://console.developers.google.com/m/cloudstorage/b/photon-1-0-tp2/o/photon-gce.tar.gz) Google cloud storage bucket location |
|
105 |
- |
|
106 |
-[Azure] (https://dl.bintray.com/vmware/photon/azure/1.0TP2/x86_64/photon-1.0TP2.vhd) |
|
107 |
- |
|
108 |
-[AMI] (https://dl.bintray.com/vmware/photon/ami/1.0TP2/x86_64/photon-1.0TP2.tar.gz) |
|
109 |
- |
|
110 |
-[OVA for Workstation/Fusion] (https://dl.bintray.com/vmware/photon/ova/1.0TP2/x86_64/photon-1.0TP2.ova) |
|
111 | 103 |
|
112 |
-[vSphere Photon bosh-stemcell] (https://bintray.com/artifact/download/vmware/photon/vSpherePhotonStemcell/1.0TP2/bosh-stemcell-0000-vsphere-esxi-photon-TP2-go_agent.tgz) |
|
113 | 104 |
|