deleted file mode 100644

@@ -1,16 +0,0 @@

-An official Vagrant box is available on Hashicorp Atlas. To get started: 

-

-	vagrant init vmware/photon

-

-Add the following lines to the Vagrantfile: 

-

-	config.vm.provider "virtualbox" do |v|

-	  v.customize ['modifyvm', :id, '--acpi', 'off']

-	end

-

-Install vagrant-guests-photon plugin which provides VMware Photon OS guest support.

-It is available at https://github.com/vmware/vagrant-guests-photon.

-

-Requires VirtualBox 4.3 or later version. If you have issues, please check your version.

-

-

deleted file mode 100644

@@ -1,15 +0,0 @@

-# Downloading Photon OS

-

-You download Photon OS from https://github.com/vmware/photon/wiki/Downloading-Photon-OS.

-

-Photon OS is available in the following pre-packaged, binary formats.

-

-### Download Formats ####

-

-| Format | Description |

-| --- | --- |

-| ISO Image | Contains everything needed to install either the minimal or full installation of Photon OS. The bootable ISO has a manual installer or can be used with PXE/kickstart environments for automated installations. |

-| OVA | Pre-installed minimal environment, customized for VMware hypervisor environments. These customizations include a highly sanitized and optimized kernel to give improved boot and runtime performance for containers and Linux applications. Since an OVA is a complete virtual machine definition, we've made available a Photon OS OVA that has virtual hardware version 11; this will allow for compatibility with several versions of VMware platforms or allow for the latest and greatest virtual hardware enhancements. |

-| Amazon AMI | Pre-packaged and tested version of Photon OS made ready to deploy in your Amazon EC2 cloud environment. Previously, we'd published documentation on how to create an Amazon compatible instance, but, now we've done the work for you. |

-| Google GCE Image | Pre-packaged and tested Google GCE image that is ready to deploy in your Google Compute Engine Environment, with all modifications and package requirements for running Photon OS in GCE. | 

-| Azure VHD | Pre-packaged and tested Azure HD image that is ready to deploy in your Microsoft Azure Cloud, with all modifications and package requirements for running Photon OS in Azure. |

\ No newline at end of file

deleted file mode 100644

@@ -1,38 +0,0 @@

-# Installing the Lightwave Client on a Photon Image and Joining the Client to a Domain

-

-After you have set up a Lightwave domain controller, you can join Photon clients to that domain. You install the Lightwave client first. After the client is installed, you join the client to the domain.

-

-## Prerequisites

-

-- Prepare a Photon OS client for the Lightwave client installation.

-- Verify that the hostname of the client can be resolved.

-- Verify that you have 184 MB free for the Lightwave client installation.

-

-## Procedure

-

-1. Log in to your Photon OS client over SSH.

-2. Install the Lightwave client by running the following command. 

-	

-	`# tdnf install lightwave-client -y`

-

-3. Edit the `iptables` firewall rules configuration file to allow connections on port `2020` as a default setting.

-	

-	The default Photon OS 2.0 firewall settings block all incoming, outgoing, and forwards so that you must configure the rules.

-

-	1. Open the  iptables settings file.

-	

-	`# vi /etc/systemd/scripts/iptables`

-

-	2. Add allow information over tcp for port 2020 in the end of the file, save, and close the file.

-

-	`iptables -A INPUT -p tcp -m tcp --dport 2020 -j ACCEPT`

-

-	3. Run the following command to allow the required connections without restarting the client.

-

-	`# iptables -A INPUT -p tcp -m tcp --dport 2020 -j ACCEPT`

-

-4. Join the client to the domain by running the `domainjoin.sh` script and configuring the domain controller FQDN, domain, and the password for the `administrator` user.

-

-	`# domainjoin.sh --domain-controller <lightwave-server-FQDN> --domain <your-domain> --password '<administrator-user-password>`

-

-5. In a browser, go to https://*Lightwave-Server-FQDN* to verify that the client appears under the tenants list for the domain.

\ No newline at end of file

deleted file mode 100644

@@ -1,34 +0,0 @@

-# Installing the Lightwave Server and Configuring It as a Domain Controller on a Photon Image

-

-You can configure Lightwave server as domain controller on a Photon client. You install the Lightwave server first. After the server is installed, you configure a new domain. 

-

-## Prerequisites

-

-- Prepare a Photon OS client for the Lightwave server installation.

-- Verify that the hostname of the client can be resolved.

-- Verify that you have 500 MB free for the Lightwave server installation.

-

-## Procedure

-

-1. Log in to your Photon OS client over SSH as an administrator.

-2. Install the Lightwave server by running the following command. 

-	

-	`# tdnf install lightwave -y`

-3. Configure the Lightwave server as domain controller by selecting a domain name and password for the `administrator` user.

-	

-	The minimum required password complexity is 8 characters, one symbol, one upper case letter, and one lower case letter. 

-	Optionally, if you want to access the domain controller over IP, configure the ip under the `--ssl-subject-alt-name` parameter.

-	`# configure-lightwave-server --domain <your-domain> --password '<administrator-user-password>' --ssl-subject-alt-name <machine-ip-address>`

-4. Edit `iptables` rules to allow connections to and from the client.

-

-	The default Photon OS 2.0 firewall settings block all incoming, outgoing, and forwards so that you must reconfigure them.

-	

-	`# iptables -P INPUT ACCEPT`

-

-	`# iptables -P OUTPUT ACCEPT`

-

-	`# iptables -P FORWARD ACCEPT`

-

-5. In a browser, go to https://*lightwave-server-FQDN* to verify that you can log in to the newly created domain controller.

-	1. On the Cascade Identity Services page, enter the domain that you configured and click **Take me to Lightwave Admin**.

-	2. On the Welcome page, enter administrator@your-domain as user name and the password that you set during the domain controller configuration and click **LOGIN**.

\ No newline at end of file

deleted file mode 100644

@@ -1,11 +0,0 @@

-# Installing and Using Lightwave on Photon OS #

-

-Project Lightwave is an open-sourced project that provides enterprise-grade identity and access management services, and can be used to solve key security, governance, and compliance challenges for a variety of use cases within the enterprise. Through integration between Photon OS and Project Lightwave, organizations can enforce security and governance on container workloads, for example, by ensuring only authorized containers are run on authorized hosts, by authorized users. For more details about Lightwave, see the [project Lightwave page on GitHub](https://github.com/vmware/lightwave).

-

-## Procedure

-

-1. [Installing the Lightwave Server and Configuring It as a Domain Controller on a Photon Image](Installing-Lightwave-Server-and-Setting-Up-a-Domain.md)

-2. [Installing the Lightwave Client on a Photon Image and Joining the Client to a Domain](Installing-Lightwave-Client-and-Joining-a-Domain.md)

-3. [Installing the Photon Management Daemon on a Lightwave Client](Installing-the-Photon-Management-Daemon-on-a-Lightwave-Client.md)

-4. [Remotely Upgrade a Single Photon OS Machine With Lightwave Client and Photon Management Daemon Installed](Remotely-Upgrade-a-Photon-OS-Machine-With-Lightwave-Client-and-Photon-Management-Daemon-Installed.md)

-5. [Remotely Upgrade Multiple Photon OS Machines With Lightwave Client and Photon Management Daemon Installed](Remotely-Upgrade-Photon-OS-Machine-With-Lightwave-Client-and-Photon-Management-Daemon-Installed.md)

deleted file mode 100644

@@ -1,35 +0,0 @@

-# Installing the Photon Management Daemon on a Lightwave Client 

-

-After you have installed and configured a domain on Lightwave, and joined a client to the domain, you can install the Photon Management Daemon on that client so that you can remotely manage it.

-

-## Prerequisites

-

-- Have an installed Lightwave server with configured domain controller on it.

-- Have an installed Lightwave client that is joined to the domain.

-- Verify that you have 100 MB free for the daemon installation on the client.

-

-## Procedure

-

-1. Log in to a machine with installed Lightwave client over SSH as an administrator.

-2. Install the Photon Management Daemon.

-	

-	`# tdnf install pmd -y`

-2. Start the Photon Management Daemon.

-	 

-	`# systemctl start pmd`

-3. Verify that the daemon is in an `active` state.

-

-	`# systemctl status pmd`

-4. (Optional) In a new console, use `curl` to verify that the Photon Management Daemon returns information.

-

-	Use the root credentials for the local client to authenticate against the daemon service.

-	`# curl https://<lightwave-client-FQDN>:2081/v1/info -ku root`

-

-5. (Optional) Create an administrative user for the Photon Management Daemon for your domain and assign it the domain administrator role.

-	1. In a browser, go to https://*lightwave-server-FQDN*.

-	1. On the Cascade Identity Services page, enter your domain name and click **Take me to Lightwave Admin**.

-	2. On the Welcome page, enter administrative credentials for your domain and click **Login**.

-	2. Click **Users & Groups** and click **Add** to create a new user.

-	3. On the Add New User page, enter user name, at least one name, password, and click **Save**.

-	3. Click the **Groups** tab, select the Administrators group, and click  **Membership**  to add the new user to the group.

-	4. On the View Members page, select the user that you created, click **Add Member**, click **Save**, and click **Cancel** to return to the previous page.

\ No newline at end of file

@@ -1,6 +1,6 @@

 # Overview of Photon OS

-*Overview of Photon OS* provides an introduction to Photon OS, it versions, and distinguishing features.

+*Overview of Photon OS* provides an introduction to Photon OS, its versions, and distinguishing features.

 **Product version: 3.0**

deleted file mode 100644

@@ -1,97 +0,0 @@

-# Network PXE Boot

-

-Photon OS supports the Preboot Execution Environment, or PXE, over a network connection. This document describes how to set up a PXE boot server to install Photon OS.

-

-# Server Setup

-

-To set up a PXE server, you will need to have the following:

-

-* A DHCP server to allow hosts to get an IP address.

-* A TFTP server, which is a file transfer protocol similar to FTP with no authentication.

-* Optionally, an HTTP server. The HTTP server will serve the RPMs yum repo, or you can use the official Photon OS repo on Bintray. Also, this HTTP server can be used if you want to provide a kickstart config for unattended installation.

-

-The instructions to set up the servers assume you have an Ubuntu 14.04 machine with a static IP address of `172.16.78.134`.

-

-## DHCP Setup

-* Install the DHCP server:

-```

-  sudo apt-get install isc-dhcp-server

-```

-* Edit the Ethernet interface in `/etc/default/isc-dhcp-server` to `INTERFACES="eth0"`

-* Edit the DHCP configuration in `/etc/dhcp/dhcpd.conf` to allow machines to boot and get an IP address via DHCP in the range `172.16.78.230 - 172.16.78.250`

-```

-  subnet 172.16.78.0 netmask 255.255.255.0 {

-    range 172.16.78.230 172.16.78.250;

-    option subnet-mask 255.255.255.0;

-    option routers 172.16.78.134;

-    option broadcast-address 172.16.78.255;

-    filename "pxelinux.0";

-    next-server 172.16.78.134;

-  }

-

-```

-* Restart the DHCP server: 

-```

-  sudo service isc-dhcp-server restart

-```

-

-## TFTP Setup

-* Install the TFTP server:

-```

-  sudo apt-get install tftpd-hpa

-```

-* Enable the boot service and restart the service:

-```

-  sudo update-inetd --enable BOOT

-  sudo service tftpd-hpa restart

-```

-

-## Optional: HTTP server setup

-

-This step is only needed if you are planning to serve the ks (kickstart) config file through this server; refer to [Kickstart support](kickstart.md) for details.

-* Serving your local yum repo.

-You can install apache http web server

-```

-sudo apt-get install apache2

-```

-Mount the Photon iso to get the RPMS repo and sample ks config file.

-```

-mkdir /mnt/photon-iso

-sudo mount <photon_iso> /mnt/photon-iso/

-```

-Copy the RPMS repo.

-```

-cp -r /mnt/photon-iso/RPMS /var/www/html/

-```

-To support ks, you can copy the sample config file from the iso and edit it; refer to [Kickstart support](kickstart.md) for details.

-```

-cp /mnt/photon-iso/isolinux/sample_ks.cfg /var/www/html/my_ks.cfg

-```

-

-## PXE boot files setup

-* Mount photon.iso to get Linux and initrd images:

-```

-mkdir /mnt/photon-iso

-sudo mount <photon_iso> /mnt/photon-iso/

-```

-* Setting the PXE boot files:

-```

-wget https://www.kernel.org/pub/linux/utils/boot/syslinux/syslinux-6.03.tar.gz

-tar -xvf syslinux-6.03.tar.gz

-pushd /var/lib/tftpboot

-cp -r /mnt/photon-iso/isolinux/* .

-cp ~/syslinux-6.03/bios/com32/elflink/ldlinux/ldlinux.c32 .

-cp ~/syslinux-6.03/bios/com32/lib/libcom32.c32 .

-cp ~/syslinux-6.03/bios/com32/libutil/libutil.c32 .

-cp ~/syslinux-6.03/bios/com32/menu/vesamenu.c32 .

-cp ~/syslinux-6.03/bios/core/pxelinux.0 .

-mkdir pxelinux.cfg

-mv isolinux.cfg pxelinux.cfg/default

-```

-* Update repo param to point to http yum repo; you may pass official photon bintray repo.

-```

-sed -i "s/append/append repo=http:\/\/172.16.78.134\/RPMS/g" menu.cfg

-popd

-```

-* Optionally, you can add your ks config file; see [Kickstart support](kickstart.md) for details.

-

new file mode 100644

@@ -0,0 +1,7 @@

+# Versions

+

+Photon OS consists of a minimal version and a full version. 

+

+The minimal version of Photon OS is lightweight container host runtime environment that is suited to managing and hosting containers. The minimal version contains just enough packaging and functionality to manage and modify containers while remaining a fast runtime environment. The minimal version is ready to work with appliances. 

+

+The full version of Photon OS includes additional packages to help you customize the system and create containerized applications. For running containers, the full version is excessive. The full version is helps you create, develop, test, and package an application that runs a container. 

\ No newline at end of file

@@ -10,7 +10,15 @@ This documentation applies to all 3.0.x releases.

 ## Intended Audiences

-This information is intended for Photon OS administrators and developers.

+This information is intended for Photon OS administrators and developers:

+

+|**Description of Task**|**Relevant Documentation**|

+|---|---|

+|Understand Photon OS.|[Overview of Photon OS](README.md)|

+|Download and Install Photon OS.|[Installation Guide](photon_installation/README.md)|

+|Fundamentals of administering Photon OS. Basics of managing packages, controlling services with systemd, setting up networking, and initializing Photon OS. |[Administration Guide](photon_admin/README.md)|

+|Use Photon OS.|[User Guide](photon_user/README.md)|

+|Solutions for common problems that you might encounter while using Photon OS.|[Troubleshooting Guide](photon_troubleshoot/README.md)|

 ----------

deleted file mode 100644

@@ -1,49 +0,0 @@

-# Remotely Upgrade Multiple Photon OS Machines With Lightwave Client and Photon Management Daemon Installed

-

-After you have a configured the Photon Management Daemon (PMD) on multiple machines, you can remotely upgrade any installed package on these machines.

-

-Upgrade process uses `copenapi_cli` that is supported from both Lightwave and Photon Management Daemon. You can initiate the upgrade process from any machine that has Photon Management Daemon installed.   

-

-## Prerequisites

-

-- Have an installed Lightwave server with configured domain controller on it.

-- Have installed Lightwave clients that are joined to the domain.

-- Have installed Photon Management Daemon on the clients.

-

-## Procedure

-

-1. To initiate remote upgrade, log in to a Photon OS machine over SSH to install the Photon Management Daemon CLI.

-

-	`# tdnf install pmd-cli` 

-2. Edit the `copenapi_cli` spec files so that you can specify the machines you want to upgrade and credentials to be used.

-	1. Edit the `.netrc` file to specify machines to be upgraded and credentials for the PMD service.

-

-		`# vi ~/.netrc`  

-	3. In the file, enter the IP addresses for the machines and administrative credentials, save and close the file.

-

-		`# machine <IP-address> login <pmd-administrative-user> password <pmd-administrative user-password>`

-

-	1. (Optional) Get the location of the `restapispec.json` file.

-

-		`# cat ~/.copenapi`

-

-		This command returns `apispec=/root/restapispec.json` as path for the spec file.

- 

-	3. Edit the `restapispec.json` file to enter the IP address of the machine to be upgraded.

-	

-		`# vi /root/restapispec.json`

-	4. Change the `host` value to the IP address or the hostname of the machine, leave the port number, and save and close the file.

-	

-		`"host":"<ip-address>:2081"` 

-	

-

-4. Initiate the upgrade, in this example of the `sed` package and wait for the command to complete.

-

-	Specify `-k` to force blind trust of certificates and `-n` to use the credentials from the `.netrc` file. 

-	`# copenapi_cli pkg update --packages sed -kn`

-

-5. (Optional) Verify that the package was upgraded successfully.

-	1. Log in to the machine that was upgraded over SSH.

-	2. List the installed version of the `sed` package.

-		

-		`# tdnf list installed sed`

\ No newline at end of file

deleted file mode 100644

@@ -1,35 +0,0 @@

-# Remotely Upgrade a Single Photon OS Machine With Lightwave Client and Photon Management Daemon Installed 

-

-After you have a configured the Photon Management Daemon on a machine, you can remotely upgrade any installed package on that machine. You can use the `root` user credentials.

-

-Upgrade process uses `pmd-cli` that is supported from both Lightwave and Photon Management Daemon. You can initiate the upgrade process from any machine that has Photon Management Daemon CLI installed.

-

-## Prerequisites

-

-- Have an installed Lightwave server with configured domain controller on it.

-- Have an installed Lightwave client that is joined to the domain.

-- Have an installed Photon Management Daemon on the client.

-- Have in installed Photon Management Daemon CLI (pmd-cli) on a machine from which you perform the updates.

-

-## Procedure

-

-1. To initiate remote upgrade, log in to a machine that has Photon Management Daemon CLI installed over SSH.

-2. Identify packages that can be upgraded on the client machine.

-	2. List the available updates for the machine.

-		

-		`# pmd-cli --server-name <machine-IP-address> --user root pkg list updates`

-	3. Verify the currently installed version of a package, for example `sed`.

-

-		`# `# pmd-cli --server-name <machine-IP-address> --user root pkg installed sed`

-		The installed version number shows as earlier than the one listed under the available updates.

-

-

-4. Initiate the upgrade, in this example of the `sed` package, enter password, and wait for the command to complete.

- 

-	`# pmd-cli --server-name <machine-IP-address> --user root pkg update sed`

-

-5. (Optional) Verify that the client machine package was upgraded successfully.

-	1. Log in to the machine that was upgraded over SSH.

-	2. List the installed version of the `sed` package.

-		

-		`# pmd-cli --server-name <machine-IP-address> --user root pkg installed sed`

\ No newline at end of file

deleted file mode 100644

@@ -1,46 +0,0 @@

-# Remotely Upgrade Multiple Photon OS Machines With Lightwave Client and Photon Management Daemon Installed

-

-After you have a configured the Photon Management Daemon (PMD) on multiple machines, you can remotely upgrade any installed package on these machines.

-

-Upgrade process uses `copenapi_cli` that is supported from both Lightwave and Photon Management Daemon. You can initiate the upgrade process from any machine that has Photon Management Daemon installed.   

-

-## Prerequisites

-

-- Have an installed Lightwave server with configured domain controller on it.

-- Have installed Lightwave clients that are joined to the domain.

-- Have installed Photon Management Daemon on the clients.

-

-## Procedure

-

-1. To initiate remote upgrade, log in to a Photon OS machine over SSH to install the Photon Management Daemon CLI.

-

-	`# tdnf install pmd-cli` 

-2. Edit the `copenapi_cli` spec files so that you can specify the machines you want to upgrade and credentials to be used.

-	1. Edit the `.netrc` file to specify machines to be upgraded and credentials for the PMD service.

-

-		`# vi ~/.netrc`  

-	2. In the file, enter the IP addresses for the machines and administrative credentials, save and close the file.

-

-		`# machine <IP-address> login <pmd-administrative-user> password <pmd-administrative user-password>`

-

-	3. Go to [https://raw.githubusercontent.com/vmware/pmd/master/conf/restapispec.json](https://raw.githubusercontent.com/vmware/pmd/master/conf/restapispec.json "the following link") and save the `restapispec.json` file locally to the `root` folder.

-

- 

-	4. Edit the `restapispec.json` file to enter the IP address of the machine to be upgraded.

-	

-		`# vi /root/restapispec.json`

-	5. Change the `host` value to the IP address or the hostname of the machine, leave the port number, and save and close the file.

-	

-		`"host":"<ip-address>:2081"` 

-	

-

-4. Initiate the upgrade, in this example of the `sed` package and wait for the command to complete.

-

-	Specify `-k` to force blind trust of certificates and `-n` to use the credentials from the `.netrc` file. 

-	`# copenapi_cli pkg update  --packages sed -kn`

-

-5. (Optional) Verify that the client machine package was upgraded successfully.

-	1. Log in to the machine that was upgraded over SSH.

-	2. List the installed version of the `sed` package.

-		

-		`# tdnf list installed sed`

\ No newline at end of file

deleted file mode 100644

@@ -1,35 +0,0 @@

-# Remotely Upgrade a Single Photon OS Machine With Lightwave Client and Photon Management Daemon Installed

-

-After you have a configured the Photon Management Daemon on a machine, you can remotely upgrade any installed package on that machine. You can use the `root` user credentials.

-

-Upgrade process uses `pmd-cli` that is supported from both Lightwave and Photon Management Daemon. You can initiate the upgrade process from any machine that has Photon Management Daemon CLI installed.

-

-## Prerequisites

-

-- Have an installed Lightwave server with configured domain controller on it.

-- Have an installed Lightwave client that is joined to the domain.

-- Have an installed Photon Management Daemon on the client.

-- Have in installed Photon Management Daemon CLI (pmd-cli) on a machine from which you perform the updates.

-

-## Procedure

-

-1. To initiate remote upgrade, log in to a machine that has Photon Management Daemon CLI installed over SSH.

-2. Identify packages that can be upgraded on the client machine.

-	2. List the available updates for the machine.

-		

-		`# pmd-cli --server-name <machine-IP-address> --user root pkg list updates`

-	3. Verify the currently installed version of a package, for example `sed`.

-

-		`# `# pmd-cli --server-name <machine-IP-address> --user root pkg installed sed`

-		The installed version number shows as earlier than the one listed under the available updates.

-

-

-4. Initiate the upgrade, in this example of the `sed` package, enter password, and wait for the command to complete.

- 

-	`# pmd-cli --server-name <machine-IP-address> --user root pkg update sed`

-

-5. (Optional) Verify that the client machine package was upgraded successfully.

-	1. Log in to the machine that was upgraded over SSH.

-	2. List the installed version of the `sed` package.

-		

-		`# pmd-cli --server-name <machine-IP-address> --user root pkg installed sed`

\ No newline at end of file

deleted file mode 100644

@@ -1,262 +0,0 @@

-# Running Photon OS on Amazon Elastic Cloud Compute

-

-This guide describes how to get Photon OS up and running on Amazon Web Services Elastic Cloud Compute (EC2), customize Photon with cloud-init, connect to it with SSH, and run a containerized application.

- 

-## About Photon OS?

-Photon OS™ is an open source Linux container host optimized for cloud-native applications, cloud platforms, and VMware infrastructure. Photon OS provides a secure run-time environment for efficiently running containers. For an overview, see [https://vmware.github.io/photon/](#https://vmware.github.io/photon/).

-

-## Prerequisites

-

-Using Photon OS within AWS EC2 requires the following resources:

-

-- **AWS account**. Working with EC2 requires an Amazon account for AWS with valid payment information. Keep in mind that, if you try the examples in this document, you will be charged by Amazon. See [Setting Up with Amazon EC2](#http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/get-set-up-for-amazon-ec2.html).

-- **Amazon tools**. The following examples also assume that you have installed and configured the Amazon AWS CLI and the EC2 CLI and AMI tools, including ec2-ami-tools.

-

-See [Installing the AWS Command Line Interface](#http://docs.aws.amazon.com/cli/latest/userguide/installing.html), [Setting Up the Amazon EC2 Command Line Interface Tools on Linux](#http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/set-up-ec2-cli-linux.html), and [Configuring AWS Command-Line Interface](#http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). Also see [Setting Up the AMI Tools](#http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-up-ami-tools.html).

-This article uses an Ubuntu 14.04 workstation to generate the keys and certificates that AWS requires.

-

-## Downloading the Photon OS Image for Amazon

-

-VMware packages Photon OS as a cloud-ready Amazon machine image (AMI) that you can download for free from [Bintray](https://bintray.com/vmware/photon).

-

-Download the Photon OS AMI now and save it on your workstation. For instructions, see [Downloading Photon OS](Downloading-Photon-OS.md).

-

-**Note**: The AMI version of Photon is a virtual appliance with the information and packages that Amazon needs to launch an instance of Photon in the cloud. To build the AMI version, VMware starts with the minimal version of Photon OS and adds the sudo and tar packages to it. 

-

-## Getting Photon OS Up and Running on EC2

-

-To run Photon OS on EC2, you must use cloud-init with an EC2 data source. The cloud-init service configures the cloud instance of a Linux image. An _instance_ is a virtual server in the Amazon cloud. 

-

-The examples in this article show how to generate SSH and RSA keys for your Photon instance, upload the Photon OS `.ami` image to the Amazon cloud, and configure it with cloud-init. In many of the examples, you must replace information with your own paths, account details, or other information from Amazon. 

-

-### Step 1: Create a Key Pair

-

-The first step is to generate SSH keys on, for instance, an Ubuntu workstation: 

-

-	ssh-keygen -f ~/.ssh/mykeypair

-

-The command generates a public key in the file with a `.pub` extension and a private key in a file with no extension. Keep the private key file and remember the name of your key pair; the name is the file name of the two files without an extension. You'll need the name later to connect to the Photon instance.

-

-Change the mode bits of the public key pair file to protect its security. In the command, include the path to the file if you need to. 

-

-	chown 600 mykeypair.pub

-

-Change the mode bits on your private key pair file so that only you can view it:

-

-	chmod 400 mykeypair

-

-To import your public key pair file (but not your private key pair file), connect to the EC2 console at https://console.aws.amazon.com/ec2/ and select the region for the key pair. A key pair works in only one region, and the instance of Photon that will be uploaded later must be in the same region as the key pair. Select `key pairs` under `Network & Security`, and then import the public key pair file that you generated earlier. 

-

-For more information, see [Importing Your Own Key Pair to Amazon EC2](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#how-to-generate-your-own-key-and-import-it-to-aws).

-

-### Step 2: Generate a Certificate

-

-When you bundle up an image for EC2, Amazon requires an RSA user signing certificate. You create the certificate by using openssl to first generate a private RSA key and then to generate the RSA certificate that references the private RSA key. Amazon uses the pairing of the private key and the user signing certificate for  handshake verification. 

-

-First, on Ubuntu 14.04 or another workstation that includes openssl, run the following command to generate a private key. If you change the name of the key, keep in mind that you will need to include the name of the key in the next command, which generates the certificate. 

-

-	openssl genrsa 2048 > myprivatersakey.pem

-

-Remember where you store your private key locally; you'll need it again later. 

-

-Second, run the following command to generate the certificate. The command prompts you to provide more information, but because you are generating a user signing certificate, not a server certificate, you can just type `Enter` for each prompt to leave all the fields blank. 

-

-	openssl req -new -x509 -nodes -sha256 -days 365 -key myprivatersakey.pem -outform PEM -out certificate.pem

-

-For more information, see the Create a Private Key and the Create the User Signing Certificate sections of [Setting Up the AMI Tools](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-up-ami-tools.html#ami-upload-bundle).

-

-Third, upload to AWS the certificate value from the `certificate.pem` file that you created in the previous command. Go to the Identity and Access Management console at https://console.aws.amazon.com/iam/, navigate to the name of your user, open the `Security Credentials` section, click `Manage Signing Certificates`, and then click `Upload Signing Certificate`. Open `certificate.pem` in a text editor, copy and paste the contents of the file into the `Certificate Body` field, and then click `Upload Signing Certificate`.

-

-For more information, see the Upload the User Signing Certificate section of [Setting Up the AMI Tools](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-up-ami-tools.html#ami-upload-bundle).

-

-### Step 3: Create a Security Group

-

-The next prerequisite is to create a security group and set it to allow SSH, HTTP, and HTTPS connections over ports 22, 80, and 443, respectively. Connect to the EC2 command-line interface and run the following commands: 

-

-	aws ec2 create-security-group --group-name photon-sg --description "My Photon security group"

-	{

-	    "GroupId": "sg-d027efb4"

-	}

-	aws ec2 authorize-security-group-ingress --group-name photon-sg --protocol tcp --port 22 --cidr 0.0.0.0/0

-

-The `GroupId` is returned by EC2. Write it down; you'll need it later.

-

-By using `0.0.0.0/0` for SSH ingress on Port 22, you are opening the port to all IP addresses--which is not a security best practice but a convenience for the examples in this article. For a production instance or other instances that are anything more than temporary machines, you should authorize only a specific IP address or range of addresses. See Amazon's document on [Authorizing Inbound Traffic for Linux Instances](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/authorizing-access-to-an-instance.html).

-

-Repeat the command to allow incoming traffic on Port 80 and on Port 443: 

-

-	aws ec2 authorize-security-group-ingress --group-name photon-sg --protocol tcp --port 80 --cidr 0.0.0.0/0

-

-	aws ec2 authorize-security-group-ingress --group-name photon-sg --protocol tcp --port 443 --cidr 0.0.0.0/0

-

-Check your work: 

-

-	aws ec2 describe-security-groups --group-names photon-sg

-

-### Step 4: Extract the Tarball 

-

-Next, make a directory to store the image, and then extract the Photon OS image from its archive by running the following `tar` command. (You might have to change the file name to match the version you have.)    

-

-	mkdir bundled

-	tar -zxvf ./photon-ami.tar.gz

-

-### Step 5: Bundle the Image

-

-The next step is to run the `ec2-bundle-image` command to create an instance store-backed Linux AMI from the Photon OS image that you extracted in the previous step. The result of the `ec2-bundle-image` command is a manifest that describes the machine in an XML file. 

-

-The command uses the certificate path to your PEM-encoded RSA public key certificate file; the path to your PEM-encoded RSA private key file; your EC2 user account ID; the correct architecture for Photon OS; the path to the Photon OS AMI image extracted from its tar file; and the `bundled` directory from the previous step. 

-

-You must replace the values of the certificate path, the private key, and the user account with your own values.

-

-	$ ec2-bundle-image --cert certificate.pem --privatekey myprivatersakey.pem --user <EC2 account id>  --arch x86_64 --image photon-ami.raw --destination ./bundled/

-

-### Step 6: Put the Bundle in a Bucket

-

-Next, make an S3 bucket, replacing `<bucket-name>` with the name that you want. The command creates the bucket in the region specified in your Amazon configuration file, which should be the same region in which you are using your key pair file: 

-

-	$ aws s3 mb s3://<bucket-name>

-

-Now upload the bundle to the Amazon S3 cloud. The following command includes the path to the XML file containing the manifest for the Photon OS machine created during the previous step, though you might have to change the file name to match the version you have. The manifest file is typically located in the same directory as the bundle. 

-

-The command also includes the name of the Amazon S3 bucket in which the bundle is to be stored; your AWS access key ID; and your AWS secret access key.

-

-	$ ec2-upload-bundle --manifest ./bundled/photon-ami.manifest.xml --bucket <bucket-name> --access-key <Account Access Key> --secret-key <Account Secret key>

-

-### Step 7: Register the Image

-

-The final step in creating an AMI before you can launch it is to register it. The following command includes a name for the AMI, its architecture, and its virtualization type. The virtualization type for Photon OS is `hvm`.

-

-	$ ec2-register <bucket-name>/photon-ami.manifest.xml --name photon-ami --architecture x86_64 --virtualization-type hvm

-

-Once registered, you can launch as many new instances as you want.

-

-### Step 8: Run an Instance of the Image with Cloud-Init

-

-Now things get a little tricky. In the following command, the `user-data-file` option instructs cloud-init to import the cloud-config data in `user-data.txt`.  

-

-The command also includes the ID of the AMI, which you can obtain by running `ec2-describe-images`; the instance type of `m3.medium`, which is a general purpose instance type; and the name of key pair, which should be replaced with your own--otherwise, you won't be able to connect to the instance. 

-

-Before you run the command, change directories to the directory containing the `mykeypair` file and add the path to the `user-data.txt`. 

-

-	$ ec2-run-instances <ami-ID> --instance-type m3.medium -g photon-sg --key mykeypair --user-data-file user-data.txt

-

-Here are the contents of the `user-data.txt` file that cloud-init applies to the machine the first time it boots up in the cloud.  

-

-	#cloud-config

-	hostname: photon-on-01

-	groups:

-	- cloud-admins

-	- cloud-users

-	users:

-	- default

-	- name: photonadmin

-	   gecos: photon test admin user

-	   primary-group: cloud-admins

-	   groups: cloud-users

-	   lock-passwd: false

-	   passwd: vmware

-	- name: photonuser

-	   gecos: photon test user

-	   primary-group: cloud-users

-	   groups: users

-	   passwd: vmware

-	packages:

-	- vim

-

-### Step 9: Get the IP Address of Your Image

-

-Now run the following command to check on the state of the instance that you launched: 

-

-	$ ec2-describe-instances

-

-Finally, you can obtain the external IP address of the instance by running the following query: 

-

-	$ aws ec2 describe-instances --instance-ids <instance-id> --query 'Reservations[*].Instances[*].PublicIpAddress' --output=text

-

-If need be, check the cloud-init output log file on EC2 at `/var/log/cloud-init-output.log` to see how EC2 handled the settings in the cloud-init data file. 

-

-For more information on using cloud-init user data on EC2, see [Running Commands on Your Linux Instance at Launch](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html).

-

-## Deploy a Containerized Application in Photon OS

-

-This section shows you how to connect to the Photon instance by using SSH and to launch a web server by running it in Docker.

-

-### Step 1: Connect with SSH

-

-Connect to the instance over SSH by specifying the private key (.pem) file and the user name for the Photon machine, which is `root`:

-

-	ssh -i ~/.ssh/mykeypair root@<public-ip-address-of-instance>

-

-For complete instructions, see [Connecting to Your Linux Instance Using SSH](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html). 

-

-### Step 2: Run Docker

-

-On the minimal version of Photon OS, the docker engine is enabled and running by default, which you can see by running the following command: 

-

-	systemctl status docker

-

-### Step 3: Start the Web Server

-

-**Note**: Please make sure that the proper security policies have been enabled on the Amazon AWS side to enable traffic to port 80 on the VM. 

-

-Since Docker is running, you can run an application in a container--for example, the Nginx Web Server. This example uses the popular open source web server Nginx. The Nginx application has a customized VMware package that the Docker engine can download directly from the Docker Hub.

-

-To pull Nginx from its Docker Hub and start it, run the following command: 

-

-	docker run -p 80:80 vmwarecna/nginx

-

-The Nginx web server should be bound to the public DNS value for  the instance of Photon OS--that is, the same address with which you connected over SSH. 

-

-### Step 4: Test the Web Server

-

-On your local workstation, open a web browser and go to the the public address of the Photon OS instance running Docker. The following screen should appear, showing that the web server is active:

-

-![Nginx](images/Nginx.jpg)

-

-When you're done, halt the Docker container by typing `Ctrl+c` in the SSH console where you are connected to EC2. 

-

-You can now run other containerized applications from the Docker Hub or your own containerized application on Photon OS in the Amazon cloud. 

-

-## Launching the Web Server with Cloud-Init

-

-To eliminate the manual effort of running Docker, you can add `docker run` and its arguments to the cloud-init user data file by using `runcmd`: 

-

-	#cloud-config

-	hostname: photon-on-01

-	groups:

-	- cloud-admins

-	- cloud-users

-	users:

-	- default

-	- name: photonadmin

-	   gecos: photon test admin user

-	   primary-group: cloud-admins

-	   groups: cloud-users

-	   lock-passwd: false

-	   passwd: vmware

-	- name: photonuser

-	   gecos: photon test user

-	   primary-group: cloud-users

-	   groups: users

-	   passwd: vmware

-	packages:

-	- vim

-	runcmd:

-	- docker run -p 80:80 vmwarecna/nginx

-

-To try this addition, you'll have to run another instance with this new cloud-init data source and then get the instance's public IP address to check that the Nginx web server is running. 

-

-## Terminating the AMI Instance

-

-Because Amazon charges you while the instance is running, make sure to shut it down when you're done.  

-

-First, get the ID of the AMI so you can terminate it: 

-

-	$ ec2-describe-instances

-

-Finally, terminate the Photon OS instance by running the following command, replacing the placeholder with the ID that the `ec2-describe-images` command returned. If you ran a second instance of Photon OS with the cloud-init file that runs docker, terminate that instance, too. 

-

-	$ ec2-terminate-instances <instance-id>

-

-

-

deleted file mode 100644

@@ -1,117 +0,0 @@

-# Running Photon OS on Google Compute Engine

-

-This guide describes how to get started using Photon OS as a virtual machine on Google Compute Engine (GCE). Once Photon OS is installed as an image on GCE, this document shows how to deploy a containerized application in Docker with a single command.

-

-- [About Photon OS](#about-photon-os)

-- [Prerequisites for Photon OS on GCE](#prerequisites-for-photon-os-on-gce)

-- [Downloading Photon OS](#downloading-photon-os)

-- [Installing Photon OS on Google Compute Engine](#installing-photon-os-on-google-compute-engine)

-- [Deploying a Containerized Application in Photon OS](#deploying-a-containerized-application-in-photon-os)

-

-## About Photon OS

-

-Photon OS™ is an open source Linux container host optimized for cloud-native applications, cloud platforms, and VMware infrastructure. Photon OS provides a secure run-time environment for efficiently running containers. For an overview, see  [https://vmware.github.io/photon/](https://vmware.github.io/photon/).

-

-## Prerequisites for Photon OS on GCE

-

-Using Photon OS on Google Compute Engine requires the following resources:

-

-* An account on Google Compute Engine

-* The Google Cloud SDK

-* The Photon OS image for GCE

-

-Keep in mind that, if you try the examples in this document, Google will charge your account for the cloud services that you use. The GCE-ready version of Photon OS, however, comes for free.

-

-## Downloading Photon OS

-

-VMware recommends that administrators use the Photon OS image for Google Compute Engine (GCE) to create Photon OS instances on GCE. Although earlier releases of Photon OS required heavy modification of the Photon instance to make the image compatible with GCE, Photon OS 1.0 comes with pre-modified images for popular cloud providers, including GCE.

-

-You can download the Photon OS image for GCE from the following URL:

-

-[https://bintray.com/vmware/photon](https://bintray.com/vmware/photon)

-

-For instructions, see [Downloading Photon OS](Downloading-Photon-OS.md).

-

-## Installing Photon OS on Google Compute Engine

-

-After you download the Photon OS image for GCE, log into GCE and complete the following steps.

-

-### Step 1: Create a New Bucket

-

-Create a new bucket to store your Photon OS image for GCE.

-

-![gce1](images/gce1.jpg)

-

-### Step 2: Upload the Photon OS Image

-

-Once you’ve created the bucket, you’re ready to upload the Photon OS image. While viewing the bucket that you’ve created, click the `Upload files` button, navigate to your Photon OS image and click the `Choose` button. 

-

-As the image below shows, when the upload finishes, you should see your Photon OS compressed image in the file list for the bucket that you created.

-

-![gce2](images/gce2.jpg)

-

-### Step 3: Create a New Image

-

-Next, you need to create a new image. Click on `Images` in the `Compute` category in the left panel; then, click on the `New Image` button. 

-

-Enter a name for the image in the `Name` field and change the `Source` to `Cloud Storage file` using the pull-down menu. Then, in the `Cloud Storage file` field, enter the bucket name and filename as the path to the Photon OS image for GCE. In this example, where the bucket was named `photon_storage,` the path is as follows:

- 

-	photon_storage/photon-gce-2.0-tar.gz

-

-*Note: The new image form will autopopulate the `gs://` file path prefix.*

-

-After you’re finished completing the name and Cloud Storage object path, click the `Create` button to create your image. You should be returned to your Images catalog and your Photon OS image should be at the top of the list. 

-

-### Step 4: Create a New Instance

-

-To create an instance, check the box next to the Photon OS image and click the `Create Instance` button. 

-

-On the `Create a new instance` form, provide a name for this instance, confirm the zone into which this instance is to be deployed and, before clicking `Create,` place a check in the boxes for `Allow HTTP traffic` and `Allow HTTPS traffic.` 

-

-Outside of this demo, your application may or may not require these firewall rules. Please choose accordingly outside of this demo. However, since we will demonstrate a running web server container, we want these ports to be open for our instance.