@@ -1,96 +1,17 @@

-# Welcome to the VMware Photon Linux Release!

+![Photon](http://storage.googleapis.com/project-photon/vmw-logo-photon.svg "VMware Photon")

-## Introduction

+[ ![Download](https://api.bintray.com/packages/vmware/photon/iso/images/download.svg) ](https://bintray.com/vmware/photon/iso/_latestVersion)

+VMware Photon: Minimal Linux Container Host

+===========================================

-Photon is a small RPM-based Linux distribution that is optimized for running containers. This repository is intended for developers wishing to modify Photon and build their own customized ISO images. For those interested in an ISO image that is ready to use, please download from the following location: 

+Photon is a technology preview of a minimal Linux container host. It is designed to have a small footprint and boot extremely quickly on VMware platforms. Photon is intended to invite collaboration around running containerized applications in a virtualized environment.

-https://dl.bintray.com/vmware/photon/iso/1.0TP1/x86_64/

+- Optimized for vSphere - Validated on VMware product and provider platforms.

+- Container support - Supports Docker, rkt, and the Pivotal Garden container specifications.

+- Efficient lifecycle management - contains a new, open-source, yum-compatible package manager that will help make the system as small as possible, but preserve the robust yum package management capabilities.

-## Folder Layout

-```

-photon/

-├── Makefile

-├── README

-├── SPECS # RPM SPEC files

-├── cloud-init.md

-├── gce.md

-├── installer # Installer used at runtime

-└── support

-```

+This repository is intended for developers wishing to modify Photon and build their own customized ISO images.

-## How to build the ISO?

+Official ISOs are available for download at [Bintray](https://bintray.com/vmware/photon/iso/view).

-Assuming you checked out the workspace under `$HOME/workspaces/photon`.

-```

-cd $HOME/workspaces/photon

-sudo make iso

-```

-Deliverable will be created at `$HOME/workspaces/photon/stage/photon.iso`

-

-## How to use cached toolchain and RPMS?

-```

-mkdir $HOME/photon-cache

-sudo make iso PHOTON_CACHE_PATH=$HOME/photon-cache

-```

-Directory format of `PHOTON_CACHE_PATH` is as follows.

-```

-photon-cache/

-├──tools-build.tar.gz

-├──RPMS/x86-64/*.rpm

-└──RPMX/noarch/*.rpm

-```

-## How to use cached sources?

-```

-mkdir $HOME/photon-sources

-sudo make iso PHOTON_SOURCES_PATH=$HOME/photon-sources

-```

-Directory format of `PHOTON_SOURCES_PATH` is as follows.

-```

-photon-sources/

-├──src1.tar.gz

-├──src2.tar.gz

-└──...

-```

-## How to build the toolchain?

-

-1. Check toolchain pre-requisites

-```

-$HOME/workspaces/photon/support/toolchain/version-check.sh

-```

-2. Make toolchain

-```

-$HOME/workspaces/photon

-sudo make toolchain

-```

-

-Pre-requisites :

-

- * Build O/S : Ubuntu 14.04 (or later) 64 bit

- * Packages: bison, gawk, g++, createrepo, python-aptdaemon, genisoimage, texinfo, python-requests

-```

-sudo apt-get -y install bison gawk g++ createrepo python-aptdaemon genisoimage texinfo python-requests

-```

-

-### Settings:

-

-Make sure `/bin/sh` is a symbolic link pointing to `/bin/bash`

-

-If `/bin/sh` is pointing `/bin/dash`, execute the following:

-```

-rm -f /bin/sh

-ln -s /bin/bash /bin/sh

-```

-

-## Where are the build logs?

-```

-$HOME/workspaces/photon/stage/LOGS

-```

-

-## Complete build environment using Vagrant

-A `Vagrantfile` is available to ensure a quick standup of a development/build environment for Photon, this Vagrantfile uses a box called `photon-build-machine` box that is created through a [Packer](http://packer.io) template available under `support/packer-templates`, see the [README.md](https://github.com/vmware/photon/blob/master/support/packer-templates/README.md) for more information on how to build `photon-build-machine`.

-

-## Photon Vagrant box

-As with the build-machine a Packer template is available under `support/packer-templates` to build a Photon based Vagrant box running Docker, see the [README.md](https://github.com/vmware/photon/blob/master/support/packer-templates/README.md) for more information on how to build.

-

-## Automated build environment and Vagrant boxes

-Convenience make targets also exist to build both the `photon-build-machine` and the `photon` Packer templates as well as building a fresh ISO using the `photon-build-machine`. See the [README.md](https://github.com/vmware/photon/blob/master/support/packer-templates/README.md) for more details.

+An official Vagrant box is available on Hashicorp Atlas, to get started: `vagrant init vmware/photon`.

deleted file mode 100644

@@ -1,89 +0,0 @@

-Overview

-=================

-`cloud-init` is the defacto multi-distribution package that handles early initialization of a cloud instance.

-

-In-depth documentation for cloud-init is available here: https://cloudinit.readthedocs.org/en/latest/

-

-Supported installations

-=================

-<dl>

-<dt><code>Photon Container OS (Minimal)</code></dt>

-<dt><code>Photon Full OS (All)</code></dt>

-</dl>

-

-Supported capabilities

-=================

-`Photon` supports `cloud-init` starting with the following capabilities

-<dl>

-<dt><code>run commands</code></dt>

-<dd>execute a list of commands with output to console.</dd>

-<dt><code>configure ssh keys</code></dt>

-<dd>add entry to ~/.ssh/authorized_keys for the configured user</dd>

-<dt><code>install package</code></dt>

-<dd>install additional packages on first boot</dd>

-<dt><code>configure networking</code></dt>

-<dd>update /etc/hosts, hostname etc</dd>

-<dt><code>write files</code></dt>

-<dd>write arbitrary file(s) to disk</dd>

-<dt><code>add yum repo</code></dt>

-<dd>add a yum repository to /etc/yum.repos.d</dd>

-<dt><code>create groups and users</code></dt>

-<dd>add groups and users to the system. set user/group properties</dd>

-<dt><code>run yum upgrade</code></dt>

-<dd>upgrade all packages</dd>

-<dt><code>reboot</code></dt>

-<dd>reboot or power off when done with cloud-init</dd>

-</dl>

-

-Getting Started

-=================

-photon cloud config has `ec2 datasource` turned on by default so an `ec2` configuration is accepted. 

-However, for testing, the following methods provide ways to do `cloud-init` with `photon` standalone.

-

-Using a seed iso

-This will be using the `nocloud` datasource. In order to init this way, an iso file needs to be created 

-with a meta-data and an user-data file as shown below

-<code><pre>

-$ { echo instance-id: iid-local01; echo local-hostname: cloudimg; } > meta-data

-$ printf "#cloud-config\nhostname: testhost\n" > user-data

-$ genisoimage  -output seed.iso -volid cidata -joliet -rock user-data meta-data

-</pre>

-</code>

-

-Attach the above generated seed.iso to your machine and reboot for the init to take effect. 

-In this case, the hostname is set to `testhost`

-

-Using a seed disk file

-To init using local disk files, do the following

-<code><pre>

-mkdir /var/lib/cloud/seed/nocloud

-cd /var/lib/cloud/seed/nocloud

-$ { echo instance-id: iid-local01; echo local-hostname: cloudimg; } > meta-data

-$ printf "#cloud-config\nhostname: testhost\n" > user-data

-</pre></code>

-Reboot the machine and the hostname will be set to `testhost`

-

-Frequencies

-cloud-init modules have pre-determined frequencies. Based on the frequency setting, multiple runs will yield different results. 

-For the scripts to run always, remove instances folder before reboot.

-<code><pre>

-rm -rf /var/lib/cloud/instances

-</code></pre>

-

-Module frequency info

-Name  |  Frequency

-disable_ec2_metadata  | Always

-users_groups  | Instance

-write_files  | Instance

-update_hostname  | Always

-final_message  | Always

-resolv_conf  | Instance

-growpart  | Always

-update_etc_hosts  | Always

-power_state_change  | Instance

-phone_home  | Instance

deleted file mode 100644

@@ -1,19 +0,0 @@

-# Photon on Docker

-

-To create a Docker container image we need a Dockerfile that describes the base image and packages to be installed on the image. A Dockerfile lets you define and then create an image that can then be used to create container instances.

-A Photon Dockerfile is located at following location:

-

-```$HOME/workspace/photon/support/dockerfiles/photon```

-

-## Build new Photon Images

-To build new images you should have built all Photon RPMS using ```make all``` or ```make iso```. Also, the docker service should be running in the background.

-

-The ```./make-docker-image.sh``` command takes the path of the local repo and the type of image (i.e. minimal, micro or full) you want to create.

-

-```cd $HOME/workspace/photon/support/dockerfiles/photon```

-

-```./make-docker-image.sh $HOME/workspace minimal```

-

-## Running the Photon Container

-

-```docker run -it photon:minimal```

new file mode 100644

@@ -0,0 +1,88 @@

+## Folder Layout

+```

+photon/

+├── Makefile

+├── README

+├── SPECS # RPM SPEC files

+├── cloud-init.md

+├── gce.md

+├── installer # Installer used at runtime

+└── support

+```

+

+## How to build the ISO?

+

+Assuming you checked out the workspace under `$HOME/workspaces/photon`.

+```

+cd $HOME/workspaces/photon

+sudo make iso

+```

+Deliverable will be created at `$HOME/workspaces/photon/stage/photon.iso`

+

+## How to use cached toolchain and RPMS?

+```

+mkdir $HOME/photon-cache

+sudo make iso PHOTON_CACHE_PATH=$HOME/photon-cache

+```

+Directory format of `PHOTON_CACHE_PATH` is as follows.

+```

+photon-cache/

+├──tools-build.tar.gz

+├──RPMS/x86-64/*.rpm

+└──RPMX/noarch/*.rpm

+```

+## How to use cached sources?

+```

+mkdir $HOME/photon-sources

+sudo make iso PHOTON_SOURCES_PATH=$HOME/photon-sources

+```

+Directory format of `PHOTON_SOURCES_PATH` is as follows.

+```

+photon-sources/

+├──src1.tar.gz

+├──src2.tar.gz

+└──...

+```

+## How to build the toolchain?

+

+1. Check toolchain pre-requisites

+```

+$HOME/workspaces/photon/support/toolchain/version-check.sh

+```

+2. Make toolchain

+```

+$HOME/workspaces/photon

+sudo make toolchain

+```

+

+Pre-requisites :

+

+ * Build O/S : Ubuntu 14.04 (or later) 64 bit

+ * Packages: bison, gawk, g++, createrepo, python-aptdaemon, genisoimage, texinfo, python-requests

+```

+sudo apt-get -y install bison gawk g++ createrepo python-aptdaemon genisoimage texinfo python-requests

+```

+

+### Settings:

+

+Make sure `/bin/sh` is a symbolic link pointing to `/bin/bash`

+

+If `/bin/sh` is pointing `/bin/dash`, execute the following:

+```

+rm -f /bin/sh

+ln -s /bin/bash /bin/sh

+```

+

+## Where are the build logs?

+```

+$HOME/workspaces/photon/stage/LOGS

+```

+

+## Complete build environment using Vagrant

+A `Vagrantfile` is available to ensure a quick standup of a development/build environment for Photon, this Vagrantfile uses a box called `photon-build-machine` box that is created through a [Packer](http://packer.io) template available under `support/packer-templates`, see the [README.md](https://github.com/vmware/photon/blob/master/support/packer-templates/README.md) for more information on how to build `photon-build-machine`.

+

+## Photon Vagrant box

+As with the build-machine a Packer template is available under `support/packer-templates` to build a Photon based Vagrant box running Docker, see the [README.md](https://github.com/vmware/photon/blob/master/support/packer-templates/README.md) for more information on how to build.

+

+## Automated build environment and Vagrant boxes

+Convenience make targets also exist to build both the `photon-build-machine` and the `photon` Packer templates as well as building a fresh ISO using the `photon-build-machine`. See the [README.md](https://github.com/vmware/photon/blob/master/support/packer-templates/README.md) for more details.

new file mode 100644

@@ -0,0 +1,89 @@

+Overview

+=================

+`cloud-init` is the defacto multi-distribution package that handles early initialization of a cloud instance.

+

+In-depth documentation for cloud-init is available here: https://cloudinit.readthedocs.org/en/latest/

+

+Supported installations

+=================

+<dl>

+<dt><code>Photon Container OS (Minimal)</code></dt>

+<dt><code>Photon Full OS (All)</code></dt>

+</dl>

+

+Supported capabilities

+=================

+`Photon` supports `cloud-init` starting with the following capabilities

+<dl>

+<dt><code>run commands</code></dt>

+<dd>execute a list of commands with output to console.</dd>

+<dt><code>configure ssh keys</code></dt>

+<dd>add entry to ~/.ssh/authorized_keys for the configured user</dd>

+<dt><code>install package</code></dt>

+<dd>install additional packages on first boot</dd>

+<dt><code>configure networking</code></dt>

+<dd>update /etc/hosts, hostname etc</dd>

+<dt><code>write files</code></dt>

+<dd>write arbitrary file(s) to disk</dd>

+<dt><code>add yum repo</code></dt>

+<dd>add a yum repository to /etc/yum.repos.d</dd>

+<dt><code>create groups and users</code></dt>

+<dd>add groups and users to the system. set user/group properties</dd>

+<dt><code>run yum upgrade</code></dt>

+<dd>upgrade all packages</dd>

+<dt><code>reboot</code></dt>

+<dd>reboot or power off when done with cloud-init</dd>

+</dl>

+

+Getting Started

+=================

+photon cloud config has `ec2 datasource` turned on by default so an `ec2` configuration is accepted. 

+However, for testing, the following methods provide ways to do `cloud-init` with `photon` standalone.

+

+Using a seed iso

+----------------

+This will be using the `nocloud` datasource. In order to init this way, an iso file needs to be created 

+with a meta-data and an user-data file as shown below

+<code><pre>

+$ { echo instance-id: iid-local01; echo local-hostname: cloudimg; } > meta-data

+$ printf "#cloud-config\nhostname: testhost\n" > user-data

+$ genisoimage  -output seed.iso -volid cidata -joliet -rock user-data meta-data

+</pre>

+</code>

+

+Attach the above generated seed.iso to your machine and reboot for the init to take effect. 

+In this case, the hostname is set to `testhost`

+

+Using a seed disk file

+----------------

+To init using local disk files, do the following

+<code><pre>

+mkdir /var/lib/cloud/seed/nocloud

+cd /var/lib/cloud/seed/nocloud

+$ { echo instance-id: iid-local01; echo local-hostname: cloudimg; } > meta-data

+$ printf "#cloud-config\nhostname: testhost\n" > user-data

+</pre></code>

+Reboot the machine and the hostname will be set to `testhost`

+

+Frequencies

+-----------

+cloud-init modules have pre-determined frequencies. Based on the frequency setting, multiple runs will yield different results. 

+For the scripts to run always, remove instances folder before reboot.

+<code><pre>

+rm -rf /var/lib/cloud/instances

+</code></pre>

+

+Module frequency info

+---------------------

+Name  |  Frequency

+------|-------------

+disable_ec2_metadata  | Always

+users_groups  | Instance

+write_files  | Instance

+update_hostname  | Always

+final_message  | Always

+resolv_conf  | Instance

+growpart  | Always

+update_etc_hosts  | Always

+power_state_change  | Instance

+phone_home  | Instance

new file mode 100644

@@ -0,0 +1,19 @@

+# Photon on Docker

+

+To create a Docker container image we need a Dockerfile that describes the base image and packages to be installed on the image. A Dockerfile lets you define and then create an image that can then be used to create container instances.

+A Photon Dockerfile is located at following location:

+

+```$HOME/workspace/photon/support/dockerfiles/photon```

+

+## Build new Photon Images

+To build new images you should have built all Photon RPMS using ```make all``` or ```make iso```. Also, the docker service should be running in the background.

+

+The ```./make-docker-image.sh``` command takes the path of the local repo and the type of image (i.e. minimal, micro or full) you want to create.

+

+```cd $HOME/workspace/photon/support/dockerfiles/photon```

+

+```./make-docker-image.sh $HOME/workspace minimal```

+

+## Running the Photon Container

+

+```docker run -it photon:minimal```

new file mode 100644

@@ -0,0 +1,59 @@

+#FAQ

+

+#### Why can't I SSH in as root?

+

+By default Photon does not permit root login to ssh. To make yourself login as root using

+SSH set <code>PermitRootLogin yes</code> in /etc/ssh/sshd_config, and restart the sshd deamon.

+

+#### Why is netstat not working?

+

+netstat is deprecated, ss or ip (part of iproute2) should be used instead.

+

+## How do I install new packages?

+#### Why is the yum command not working in a Minimal installation of Photon?

+

+To install packages from cdrom, mount cdrom using following command

+

+```

+mount /dev/cdrom /media/cdrom

+```

+

+Then you can use ```tdnf``` to install new pacakges

+

+```

+tdnf install vim

+```

+

+#### How do I build a new RPM package?

+

+Assuming you have the Ubuntu development environment setup and got the latest code pull into /workspace.

+Lets assume your package name is foo with version 1.0.

+

+```

+cp foo-1.0.tar.gz /workspace/photon/SOURCES

+cp foo.spec /workspace/photon/SPECS/foo/

+cd /workspace/photon/support/package-builder

+sudo python ./build_package.py -i foo

+```

+

+#### I just booted into a freshly installed Photon, why is ```docker ps``` not working?

+

+Make sure the docker daemon is running, which by design is not started at boot time.

+

+#### What is the difference between the Micro/Minimal/Full installations of Photon?

+Micro is the smallest version of Photon, under 220MB (as of 03/30) to be used as base for customization.

+

+Minimal is Micro plus Docker and Cloud-init packages.

+

+Full contains all the packages shipped with ISO.

+

+#### What packages are included in Micro/Minimal?

+See [package_list.json](installer/package_list.json)

+

+#### Why is vi/vim is not working in a Minimal installation of Photon?

+

+We have `nano` installed by default for file editing in Minimal. Use `tdnf` to install `vim`.

+

+#### How do I transfer/share files between Photon and my host machine?

+

+We are working on supporting some standard options. Currently we recommend using [sshfs](https://wiki.archlinux.org/index.php/sshfs) for file sharing between hosts and Photon.

new file mode 100644

@@ -0,0 +1,146 @@

+#Photon on GCE

+## Google Compute Engine (GCE) Image background

+GCE is a service that lets user run virtual machines on Google's infrastructure. User can customize the virtual machine as much as they want, even can install their custom OS imsage apart from the publicly provided [images](https://cloud.google.com/compute/docs/operating-systems/). For any OS to be useable on GCE, it must match the Google's infrastructure needs. 

+Following are Google provided tools used for VM instances to behave properly.

+

+ *   __[Google startup scripts](https://cloud.google.com/compute/docs/startupscript)__: User can provide some startup script to configure their instances at startup.

+ *   __[Google Daemon](https://cloud.google.com/compute/docs/metadata)__: Google Daemon creates new accounts and configures ssh to accept public keys using the metadata server.

+ *   __[Google Cloud SDK](https://cloud.google.com/sdk/)__: Command line tools to manage your images, instances and other objects on GCE.

+

+Following is the list (extracted from [this link](https://cloud.google.com/compute/docs/tutorials/building-images )) of items must be done to make Photon work on GCE.

+

+ *   Install Google Compute Engine Image Packages

+ *   Install Google Cloud SDK

+ *   Change GPT partition table to MBR 

+ *   Update Grub config for new MBR and serial console output

+ *   Update ssh configuration

+ *   Delete ssh host keys

+ *   Set the time zone to UTC

+ *   Use the Google NTP server

+ *   Delete the hostname file.

+ *   Add Google hosts /etc/hosts

+ *   Set MTU to 1460. SSH will not work without it.

+ *   Create /etc/ssh/sshd_not_to_be_run with just the contents “GOOGLE\n”.

+

+## Creating Photon image for GCE

+##### 1. Prepare Photon Disk

+###### Install Photon Minimal on Fusion/Workstation and install some required packages.

+      mount /dev/cdrom /media/cdrom

+      tdnf install yum

+      tdnf install python2-libs

+      yum install ntp sudo wget tar which gptfdisk sed findutils grep gzip --nogpgcheck -y

+

+###### Photon installer installs GPT partition table by default but GCE only accepts MBR(msdos) type partition table. We need to convert GPT to MBR and update the grub. Following are commands to do that.

+  

+      # Change partition table to MBR from GPT

+      sgdisk -m 1:2 /dev/sda

+      grub-install /dev/sda

+      

+      # Enable serial console on grub for GCE.

+      cat << EOF >> /etc/default/grub

+      GRUB_CMDLINE_LINUX="console=ttyS0,38400n8"

+      GRUB_TERMINAL=serial

+      GRUB_SERIAL_COMMAND="serial --speed=38400 --unit=0 --word=8 --parity=no --stop=1"

+      EOF

+      

+      # Create new grub.cfg based on the settings in /etc/default/grub

+      grub-mkconfig -o /boot/grub/grub.cfg

+      

+##### 2. Install Google Cloud SDK and GCE Packages

+      yum install google-daemon google-startup-scripts

+      cp /usr/lib/systemd/system/google* /lib/systemd/system/

+      cd /lib/systemd/system/multi-user.target.wants/

+      

+      # Create links in multi-user.target to auto-start these scripts and services.

+      for i in ../google*; do  ln -s $i `basename $i`; done

+      

+      cd /tmp/; wget https://dl.google.com/dl/cloudsdk/release/google-cloud-sdk.tar.gz --no-check-certificate

+      tar -xf google-cloud-sdk.tar.gz

+      cd google-cloud-sdk

+      ./install.sh

+##### 3. Update /etc/hosts file with GCE values

+      echo "169.254.169.254 metadata.google.internal metadata" >> /etc/hosts

+##### 4. Remove all servers from ntp.conf and add Google's ntp server.

+      sed -i -e "/server/d" /etc/ntp.conf

+      cat /etc/ntp.conf

+      echo "server 169.254.169.254" >> /etc/ntp.conf

+      # Create ntpd.service to auto starting ntp server.

+      cat << EOF >> /lib/systemd/system/ntpd.service

+      [Unit]

+      Description=Network Time Service

+      After=network.target nss-lookup.target

+

+      [Service]

+      Type=forking

+      PrivateTmp=true

+      ExecStart=/usr/sbin/ntpd -g -u ntp:ntp

+      Restart=always

+      

+      [Install]

+      WantedBy=multi-user.target

+      EOF

+      

+      # Add link in multi-user.target.wants to auto start this service.

+      cd /lib/systemd/system/multi-user.target.wants/

+      ln -s ../ntpd.service ntpd.service

+      

+##### 5. Set UTC timezone

+      ln -sf /usr/share/zoneinfo/UTC /etc/localtime

+

+##### 6. Update /etc/resolv.conf

+      echo "nameserver 8.8.8.8" >> /etc/resolv.conf

+

+##### 7. Remove ssh host keys and add script to regenerate them at boot time.

+      rm /etc/ssh/ssh_host_*

+      # Depending on the installation, you may need to purge the following keys

+      rm /etc/ssh/ssh_host_rsa_key*

+      rm /etc/ssh/ssh_host_dsa_key*

+      rm /etc/ssh/ssh_host_ecdsa_key*

+

+      sed -i -e "/exit 0/d" /etc/rc.local

+      echo "[ -f /etc/ssh/ssh_host_key ] && echo 'Keys found.' || ssh-keygen -A" >> /etc/rc.local

+      echo "exit 0" >> /etc/rc.local

+      printf "GOOGLE\n" > /etc/ssh/sshd_not_to_be_run

+      

+      # Edit sshd_config and ssh_config as per instructions on [this link](https://cloud.google.com/compute/docs/tutorials/building-images ).

+      

+##### 8. Change MTU to 1460 for network interface.

+      # Create a startup service in systemd that will change MTU and exits

+      cat << EOF >> /lib/systemd/system/eth0.service

+      [Unit]

+      Description=Network interface initialization

+      After=local-fs.target network-online.target network.target

+      Wants=local-fs.target network-online.target network.target

+

+      [Service]

+      ExecStart=/bin/ifconfig eth0 mtu 1460 up

+      Type=oneshot

+

+      [Install]

+      WantedBy=multi-user.target

+      EOF

+      # Make this service auto-start at boot.

+      cd /lib/systemd/system/multi-user.target.wants/

+      ln -s ../eth0.service eth0.service

+

+##### 9. Pack and Upload to GCE.

+###### Shutdown the Photon VM and copy its disk to tmp folder.       

+      # You will need to install Google Cloud SDK on host machine to upload the image and play with GCE.

+      cp Virtual\ Machines.localized/photon.vmwarevm/Virtual\ Disk.vmdk /tmp/disk.vmdk

+      cd /tmp

+      # GCE needs disk to be named as disk.raw with raw format.

+      qemu-img convert -f vmdk -O raw disk.vmdk disk.raw

+      

+      # ONLY GNU tar will work to create acceptable tar.gz file for GCE. MAC's default tar is BSDTar which will not work. 

+      # On Mac OS X ensure that you have gtar "GNU Tar" installed. exmaple: gtar -Szcf photon.tar.gz disk.raw 

+

+      gtar -Szcf photon.tar.gz disk.raw 

+      

+      # Upload

+      gsutil cp photon.tar.gz gs://photon-bucket

+      

+      # Create image

+      gcloud compute --project "<project name>" images create "photon-beta-vYYYYMMDD" --description "Photon Beta" --source-uri https://storage.googleapis.com/photon-bucket/photon032315.tar.gz

+      

+      # Create instance on GCE of photon image

+      gcloud compute --project "photon" instances create "photon" --zone "us-central1-f" --machine-type "n1-standard-1" --network "default" --maintenance-policy "MIGRATE" --scopes "https://www.googleapis.com/auth/devstorage.read_only" "https://www.googleapis.com/auth/logging.write" --image "https://www.googleapis.com/compute/v1/projects/photon/global/images/photon" --boot-disk-type "pd-standard" --boot-disk-device-name "photon"

new file mode 100644

@@ -0,0 +1,77 @@

+Running Rocket containers on Photon

+===================================

+

+Rocket is a new container runtime, created by [CoreOS](http://coreos.com) and designed for composability, security, and speed. 

+

+rkt (pronounced _"rock-it"_) is a CLI for running app containers, and an implementation of the [App Container Spec](https://github.com/coreos/rkt/blob/master/Documentation/app-container.md).

+

+rkt is available as an optional package in Photon, to install it:

+

+```

+mount /dev/cdrom /media/cdrom

+

+tdnf install rocket

+```

+

+### Running an App Container Image (ACI)

+

+rkt uses content addressable storage (CAS) for storing an ACI on disk. In this example, the image is downloaded and added to the CAS.

+

+Since rkt verifies signatures by default, you will need to first [trust](https://github.com/coreos/rkt/blob/master/Documentation/signing-and-verification-guide.md#establishing-trust) the [CoreOS public key](https://coreos.com/dist/pubkeys/aci-pubkeys.gpg) used to sign the image:

+

+```

+$ sudo rkt trust --prefix coreos.com/etcd

+Prefix: "coreos.com/etcd"

+Key: "https://coreos.com/dist/pubkeys/aci-pubkeys.gpg"

+GPG key fingerprint is: 8B86 DE38 890D DB72 9186  7B02 5210 BD88 8818 2190

+        CoreOS ACI Builder <release@coreos.com>

+Are you sure you want to trust this key (yes/no)? yes

+Trusting "https://coreos.com/dist/pubkeys/aci-pubkeys.gpg" for prefix "coreos.com/etcd".

+Added key for prefix "coreos.com/etcd" at "/etc/rkt/trustedkeys/prefix.d/coreos.com/etcd/8b86de38890ddb7291867b025210bd8888182190"

+```

+

+Now that we've trusted the CoreOS public key, we can bring up a simple etcd instance using the ACI format:

+

+```

+$ privateIp=$(ip -4 -o addr show eth0 | cut -d' ' -f7 | cut -d'/' -f1)

+$ sudo rkt run coreos.com/etcd:v2.0.4 -- -name vmware-cna \

+> -listen-client-urls http://0.0.0.0:2379 \

+> -advertise-client-urls http://${privateIp}:2379 \

+> -listen-peer-urls http://0.0.0.0:2380 \

+> -initial-advertise-peer-urls http://${privateIp}:2380 \

+> -initial-cluster vmware-cna=http://${privateIp}:2380 \

+> -initial-cluster-state new

+

+rkt: searching for app image coreos.com/etcd:v2.0.4

+rkt: fetching image from https://github.com/coreos/etcd/releases/download/v2.0.4/etcd-v2.0.4-linux-amd64.aci

+Downloading signature from https://github.com/coreos/etcd/releases/download/v2.0.4/etcd-v2.0.4-linux-amd64.aci.asc

+Downloading ACI: [========================================     ] 3.38 MB/3.76 MB

+rkt: signature verified:

+  CoreOS ACI Builder <release@coreos.com>

+Timezone UTC does not exist in container, not updating container timezone.

+2015/04/02 13:18:39 no data-dir provided, using default data-dir ./vmware-cna.etcd

+2015/04/02 13:18:39 etcd: listening for peers on http://0.0.0.0:2380

+2015/04/02 13:18:39 etcd: listening for client requests on http://0.0.0.0:2379

+2015/04/02 13:18:39 etcdserver: name = vmware-cna

+2015/04/02 13:18:39 etcdserver: data dir = vmware-cna.etcd

+2015/04/02 13:18:39 etcdserver: member dir = vmware-cna.etcd/member

+2015/04/02 13:18:39 etcdserver: heartbeat = 100ms

+2015/04/02 13:18:39 etcdserver: election = 1000ms

+2015/04/02 13:18:39 etcdserver: snapshot count = 10000

+2015/04/02 13:18:39 etcdserver: advertise client URLs = http://192.168.35.246:2379

+2015/04/02 13:18:39 etcdserver: initial advertise peer URLs = http://192.168.35.246:2380

+2015/04/02 13:18:39 etcdserver: initial cluster = vmware-cna=http://192.168.35.246:2380

+2015/04/02 13:18:39 etcdserver: start member 8f79fa9a50a1689 in cluster 75c533bd1f49730b

+2015/04/02 13:18:39 raft: 8f79fa9a50a1689 became follower at term 0

+2015/04/02 13:18:39 raft: newRaft 8f79fa9a50a1689 [peers: [], term: 0, commit: 0, applied: 0, lastindex: 0, lastterm: 0]

+2015/04/02 13:18:39 raft: 8f79fa9a50a1689 became follower at term 1

+2015/04/02 13:18:39 etcdserver: added local member 8f79fa9a50a1689 [http://192.168.35.246:2380] to cluster 75c533bd1f49730b

+2015/04/02 13:18:41 raft: 8f79fa9a50a1689 is starting a new election at term 1

+2015/04/02 13:18:41 raft: 8f79fa9a50a1689 became candidate at term 2

+2015/04/02 13:18:41 raft: 8f79fa9a50a1689 received vote from 8f79fa9a50a1689 at term 2

+2015/04/02 13:18:41 raft: 8f79fa9a50a1689 became leader at term 2

+2015/04/02 13:18:41 raft.node: 8f79fa9a50a1689 elected leader 8f79fa9a50a1689 at term 2

+2015/04/02 13:18:41 etcdserver: published {Name:vmware-cna ClientURLs:[http://192.168.35.246:2379]} to cluster 75c533bd1f49730b

+```

+

+At any time you can press ^] three times to kill container.

\ No newline at end of file

new file mode 100644

@@ -0,0 +1,28 @@

+#default package manager in photon - tdnf(tyum)

+

+##Introduction

+tdnf(tyum) is tiny dnf (tiny yum) implementing dnf commands in C without python dependencies. 

+dnf is the next upcoming major version of yum. tyum(tdnf) is included in photon micro, photon minimal and photon full. 

+tyum(tdnf) will read yum repositories and work just like yum. If you need yum, its just as easy as ```tdnf install yum```

+

+##How to configure a repository

+photon comes pre-configured with ```photon-iso``` repository which is in ```\etc\yum.repos.d```

+If you get an access error message when working with this repository, it is usually because you dont have the

+photon iso mounted. If you have the photon iso, you can mount and makecache to read metadata.

+

+```

+mount /dev/cdrom /media/cdrom

+tdnf makecache

+```

+

+##How to install a package?

+```tdnf install pkgname```

+

+##How to remove a package

+```tdnf erase pkgname```

+

+##How to list enabled repositories

+```tdnf repolist```

+

+##Other commands

+tdnf implements all dnf commands as listed here: http://dnf.readthedocs.org/en/latest/

deleted file mode 100644

@@ -1,59 +0,0 @@

-#FAQ

-

-#### Why can't I SSH in as root?

-

-By default Photon does not permit root login to ssh. To make yourself login as root using

-SSH set <code>PermitRootLogin yes</code> in /etc/ssh/sshd_config, and restart the sshd deamon.

-

-#### Why is netstat not working?

-

-netstat is deprecated, ss or ip (part of iproute2) should be used instead.

-

-## How do I install new packages?

-#### Why is the yum command not working in a Minimal installation of Photon?

-

-To install packages from cdrom, mount cdrom using following command

-

-```

-mount /dev/cdrom /media/cdrom

-```

-

-Then you can use ```tdnf``` to install new pacakges

-

-```

-tdnf install vim

-```

-

-#### How do I build a new RPM package?

-

-Assuming you have the Ubuntu development environment setup and got the latest code pull into /workspace.

-Lets assume your package name is foo with version 1.0.

-

-```

-cp foo-1.0.tar.gz /workspace/photon/SOURCES

-cp foo.spec /workspace/photon/SPECS/foo/

-cd /workspace/photon/support/package-builder

-sudo python ./build_package.py -i foo

-```

-

-#### I just booted into a freshly installed Photon, why is ```docker ps``` not working?

-

-Make sure the docker daemon is running, which by design is not started at boot time.

-

-#### What is the difference between the Micro/Minimal/Full installations of Photon?

-Micro is the smallest version of Photon, under 220MB (as of 03/30) to be used as base for customization.

-

-Minimal is Micro plus Docker and Cloud-init packages.

-

-Full contains all the packages shipped with ISO.

-

-#### What packages are included in Micro/Minimal?

-See [package_list.json](installer/package_list.json)

-

-#### Why is vi/vim is not working in a Minimal installation of Photon?

-

-We have `nano` installed by default for file editing in Minimal. Use `tdnf` to install `vim`.

-

-#### How do I transfer/share files between Photon and my host machine?

-

-We are working on supporting some standard options. Currently we recommend using [sshfs](https://wiki.archlinux.org/index.php/sshfs) for file sharing between hosts and Photon.

deleted file mode 100644

@@ -1,146 +0,0 @@

-#Photon on GCE

-## Google Compute Engine (GCE) Image background

-GCE is a service that lets user run virtual machines on Google's infrastructure. User can customize the virtual machine as much as they want, even can install their custom OS imsage apart from the publicly provided [images](https://cloud.google.com/compute/docs/operating-systems/). For any OS to be useable on GCE, it must match the Google's infrastructure needs. 

-Following are Google provided tools used for VM instances to behave properly.

-

- *   __[Google startup scripts](https://cloud.google.com/compute/docs/startupscript)__: User can provide some startup script to configure their instances at startup.

- *   __[Google Daemon](https://cloud.google.com/compute/docs/metadata)__: Google Daemon creates new accounts and configures ssh to accept public keys using the metadata server.

- *   __[Google Cloud SDK](https://cloud.google.com/sdk/)__: Command line tools to manage your images, instances and other objects on GCE.

-

-Following is the list (extracted from [this link](https://cloud.google.com/compute/docs/tutorials/building-images )) of items must be done to make Photon work on GCE.

-

- *   Install Google Compute Engine Image Packages

- *   Install Google Cloud SDK

- *   Change GPT partition table to MBR 

- *   Update Grub config for new MBR and serial console output

- *   Update ssh configuration

- *   Delete ssh host keys

- *   Set the time zone to UTC

- *   Use the Google NTP server

- *   Delete the hostname file.

- *   Add Google hosts /etc/hosts

- *   Set MTU to 1460. SSH will not work without it.

- *   Create /etc/ssh/sshd_not_to_be_run with just the contents “GOOGLE\n”.

-

-## Creating Photon image for GCE

-##### 1. Prepare Photon Disk

-###### Install Photon Minimal on Fusion/Workstation and install some required packages.

-      mount /dev/cdrom /media/cdrom

-      tdnf install yum

-      tdnf install python2-libs

-      yum install ntp sudo wget tar which gptfdisk sed findutils grep gzip --nogpgcheck -y

-

-###### Photon installer installs GPT partition table by default but GCE only accepts MBR(msdos) type partition table. We need to convert GPT to MBR and update the grub. Following are commands to do that.

-  

-      # Change partition table to MBR from GPT

-      sgdisk -m 1:2 /dev/sda

-      grub-install /dev/sda

-      

-      # Enable serial console on grub for GCE.

-      cat << EOF >> /etc/default/grub

-      GRUB_CMDLINE_LINUX="console=ttyS0,38400n8"

-      GRUB_TERMINAL=serial

-      GRUB_SERIAL_COMMAND="serial --speed=38400 --unit=0 --word=8 --parity=no --stop=1"

-      EOF

-      

-      # Create new grub.cfg based on the settings in /etc/default/grub

-      grub-mkconfig -o /boot/grub/grub.cfg

-      

-##### 2. Install Google Cloud SDK and GCE Packages

-      yum install google-daemon google-startup-scripts

-      cp /usr/lib/systemd/system/google* /lib/systemd/system/

-      cd /lib/systemd/system/multi-user.target.wants/

-      

-      # Create links in multi-user.target to auto-start these scripts and services.

-      for i in ../google*; do  ln -s $i `basename $i`; done

-      

-      cd /tmp/; wget https://dl.google.com/dl/cloudsdk/release/google-cloud-sdk.tar.gz --no-check-certificate

-      tar -xf google-cloud-sdk.tar.gz

-      cd google-cloud-sdk

-      ./install.sh

-##### 3. Update /etc/hosts file with GCE values

-      echo "169.254.169.254 metadata.google.internal metadata" >> /etc/hosts

-##### 4. Remove all servers from ntp.conf and add Google's ntp server.

-      sed -i -e "/server/d" /etc/ntp.conf

-      cat /etc/ntp.conf

-      echo "server 169.254.169.254" >> /etc/ntp.conf