Differences between revisions 2 and 39 (spanning 37 versions)
Revision 2 as of 2013-04-22 11:39:44
Size: 2755
Editor: BrianGupta
Comment: Incorporated Jimmy's first email into content
Revision 39 as of 2014-09-23 18:51:04
Size: 7303
Editor: MishaBrukman
Comment: Remove spaces from the link to GoogleComputeEngine page.
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
Cloud/[[Google Compute Engine]] Image lists for Google Compute Engine Cloud/[[GoogleComputeEngine]] Image lists for Google Compute Engine
Line 4: Line 4:
== Official Debian AMIs ==
(Work in Progress)

For discussion about Debian on various cloud providers, please visit [[http://lists.debian.org/debian-cloud/|Debian-Cloud mailing list]].

== Image build script ==

Anders Ingemann has created a build script for bootstrapping instances. The script runs fully automatic and needs no user interaction, custom scripts can be attached to the process as well. You can download or clone the script on [[https://github.com/andsens/build-debian-cloud | github]]. Any bugs or suggestions should be reported via the github issue tracker.

== Procedure to build images ==

== Future Plans ==


== User contributed images ==

== Notes on Kernel ==
You may notice that all Google Compute Engine images are booted using an
injected Linux 3.3.8 kernel using a configuration to reduce security
vulnerabilities. Most notably, that configuration disables modules and access
to /dev/mem. We are working to add support for booting from arbitrary kernels,
as we know it’s an important freedom. In the meantime, /proc/config.gz will
show the enabled options. Kernel source code is available here:

https://developers.google.com/compute/docs/kernels#source

== SSH user accounts ==
One intentional difference from the Amazon EC2 images is that, instead of
sshing in via a default “admin” account, we install a cron job in /etc/cron.d
to manage accounts in line with the Google Compute Engine documentation. See
here for how ssh works:
https://developers.google.com/compute/docs/hello_world#ssh

== GCE Documentation ==
== Google Compute Engine Documentation ==
Line 41: Line 8:
== Debian Images ==

These images result from a collaboration between Debian and Google. Debian community members are welcome to help improve and maintain the images in Google Compute Engine. This includes directly uploading the Debian images which Google publicizes to Google Compute Engine customers.

The images deviate in these ways from official Debian images:
 * Certain non-Debian software is installed to facilitate integration, all freely licensed under the Apache License 2.0:
  * Three debs: google-startup-scripts, google-compute-daemon, image-bundle (these are mostly or completely replaceable with cloud-init if someone does the work)
  * Two unpackaged command-line utilities installed in /usr/local/share/google and symlinked into /usr/local/bin: gcutil and gsutil (optimal packaging situation TBD)
  * The google-startup-scripts deb manages user accounts by default - see below.

Google is interested in working with Debian to make the images even more standard and achieve official Debian image status. In the meantime, Debian has indicated that it's okay to label these images as Debian instead of Debian-based.

For discussion about Debian on various cloud providers, please visit the [[http://lists.debian.org/debian-cloud/|debian-cloud mailing list]].

=== SSH user accounts ===
One intentional difference from Debian's Amazon EC2 images is that, instead of
sshing in via a default “admin” account, we install a cron job in /etc/cron.d
to manage accounts in line with the Google Compute Engine documentation. For more information, review [[https://developers.google.com/compute/docs/hello_world#ssh|how ssh works|target="_blank"]] on Google Compute Engine. The cron job can be safely removed or disabled to use alternative ways of managing accounts.

== Listing Current Images ==

To list the currently-recommended, newest versions of Debian images on Google Compute Engine, use [[https://developers.google.com/cloud/sdk/gcloud/|gcloud]]:

{{{
gcloud compute images list --project=debian-cloud --no-standard-images
}}}

As of 23 Sep 2014, the current images are:

{{{
NAME PROJECT DEPRECATED STATUS
backports-debian-7-wheezy-v20140904 debian-cloud READY
debian-7-wheezy-v20140828 debian-cloud READY
}}}

See also: [[https://developers.google.com/cloud/sdk/gcloud/reference/compute/images/list|gcloud compute images list]] command reference.

== Using An Image ==

To use an image, use [[https://developers.google.com/cloud/sdk/gcloud/|gcloud]]:

{{{
gcloud compute instances create "<instance-name>" --image="<image-name>" --image-project=debian-cloud --zone="<zone>" --machine-type="<machine-type>"
}}}

See also: [[https://developers.google.com/cloud/sdk/gcloud/reference/compute/instances/create|gcloud compute instances create]] command reference.

== Listing Older and Deprecated Images ==

As Google Compute Engine releases new images, older images will be deprecated and eventually removed. When this happens, Google Compute Engine sets the deprecation status on an image and if your instances or disks uses a deprecated image, you will need to restart them with a newer, non-deprecated image.

Use [[https://developers.google.com/cloud/sdk/gcloud/|gcloud]] to list images and review their deprecation status, if any:

{{{
gcloud compute images list --project=debian-cloud --no-standard-images --show-deprecated
}}}

A list of deprecation statuses are available in the [[https://developers.google.com/compute/docs/reference/latest/images|Images reference|target="_blank"]] documentation.

== Building a Google Compute Engine Image ==

To build a Debian image for Google Compute Engine, follow these instructions:

 1. '''Request access to Google Compute Engine'''
  If you want to help with the Cloud/GoogleComputeEngineImage effort and don't already have a Google Compute Engine space to work in, contact David (cache@google.com) and Jimmy (jkaplowitz@google.com).
  Be sure to provide the following information in your email:

      * A description of how you can help
      * The email of your Google account (Google Apps and consumer accounts are both fine)

  We will add people to the appropriate projects, within certain constraints. See "Access To Test Account for Debian Developers" below for more information.

 1. '''Create images using the build script (see below) on any Linux machine'''
  Example command line (root access is needed for the loopback mounting process):

  {{{
# Either squeeze or wheezy should work.
sudo ./build-debian-cloud gce --codename wheezy
  }}}

 1. '''Follow the steps to upload and use a custom image'''

  The image will end up in the same directory. From there, follow the steps to [[https://developers.google.com/compute/docs/images#installinganimage|upload and use a custom image|target="_blank"]] in Google Compute Engine, beginning with step 4.

  Note the linked instructions tell you to run:
   * gcutil --project=''<project-id>'' addimage ''<image-name>'' ''<image-uri>'' --preferred_kernel=/projects/google/global/kernels/''<kernel-name>''

  To find the correct <kernel-name>, choose from a list of available kernels:
    * gcutil listkernels --project=google (rather than your own project)

  If you omit --preferred_kernel, simply choose the newest available kernel when prompted by gcutil.

=== Image Build Script ===

Anders Ingemann has created a build script for bootstrapping instances that runs automatically and needs no user interaction. You can also attach custom scripts to the script as well. Download or clone the script on [[https://github.com/andsens/build-debian-cloud | GitHub]]. Any bugs or suggestions should be reported via the !GitHub issue tracker or discussed on debian-cloud.

Note: [[https://github.com/google/build-debian-cloud | Google's fork]] of Anders' repository may sometimes have newer changes specific to Google Compute Engine, including ones used to build Debian images. Pull requests are regularly submitted to Anders and merged upstream in his repository.

== Future Plans ==
Not yet available
Line 43: Line 111:
If you have any questions, concerns, or general feedback, please don’t hesitate
to contact the Google Compute team (gc-team@google.com) or David McWherter
(cache@google.com) or me (jimmy@debian.org or jkaplowitz@google.com) directly
about this effort.
If you have any questions, concerns, or general feedback, please don’t hesitate to contact the Google Compute team (gc-team@google.com) or David !McWherter (cache@google.com) or Jimmy Kaplowitz (jimmy@debian.org or jkaplowitz@google.com) directly about this effort.
Line 48: Line 113:
== Unsorted notes == == Access to test account, for Debian Developers interested in testing, or working on Debian images ==
Line 50: Line 115:
Gaining access: We’ve created two projects for Debian’s use for Google Compute
Engine. Billing for Compute and Storage has been waived on these projects.
The first project, ‘debian-cloud’ is intended for pushing new images for
customers. The second project ‘debian-cloud-experiments’ is intended for
Debian volunteers to experiment with the project. It has a small quota and
must be shared. We can work with Debian to maintain who can use these
projects, or we can push management off to trusted parties in Debian. Google
Compute Engine is working toward toward general availability, so over time it
will become easier for anyone to get involved.
Google has created two Google Compute Engine projects for Debian’s use. Billing for Google Compute Engine and Google Cloud Storage has been waived on these projects. The first project, ‘debian-cloud’, is intended for pushing new images to customers. The second project, ‘debian-cloud-experiments’, is intended for Debian volunteers to experiment with the project. It has a small quota and must be shared. Google will work with Debian to manage access to these projects.

Cloud/GoogleComputeEngine Image lists for Google Compute Engine

Google Compute Engine Documentation

Google Compute Engine home page, including documentation: https://developers.google.com/compute/

Debian Images

These images result from a collaboration between Debian and Google. Debian community members are welcome to help improve and maintain the images in Google Compute Engine. This includes directly uploading the Debian images which Google publicizes to Google Compute Engine customers.

The images deviate in these ways from official Debian images:

  • Certain non-Debian software is installed to facilitate integration, all freely licensed under the Apache License 2.0:
    • Three debs: google-startup-scripts, google-compute-daemon, image-bundle (these are mostly or completely replaceable with cloud-init if someone does the work)
    • Two unpackaged command-line utilities installed in /usr/local/share/google and symlinked into /usr/local/bin: gcutil and gsutil (optimal packaging situation TBD)
    • The google-startup-scripts deb manages user accounts by default - see below.

Google is interested in working with Debian to make the images even more standard and achieve official Debian image status. In the meantime, Debian has indicated that it's okay to label these images as Debian instead of Debian-based.

For discussion about Debian on various cloud providers, please visit the debian-cloud mailing list.

SSH user accounts

One intentional difference from Debian's Amazon EC2 images is that, instead of sshing in via a default “admin” account, we install a cron job in /etc/cron.d to manage accounts in line with the Google Compute Engine documentation. For more information, review how ssh works on Google Compute Engine. The cron job can be safely removed or disabled to use alternative ways of managing accounts.

Listing Current Images

To list the currently-recommended, newest versions of Debian images on Google Compute Engine, use gcloud:

gcloud compute images list --project=debian-cloud --no-standard-images

As of 23 Sep 2014, the current images are:

NAME                                PROJECT      DEPRECATED STATUS
backports-debian-7-wheezy-v20140904 debian-cloud            READY
debian-7-wheezy-v20140828           debian-cloud            READY

See also: gcloud compute images list command reference.

Using An Image

To use an image, use gcloud:

gcloud compute instances create "<instance-name>" --image="<image-name>" --image-project=debian-cloud --zone="<zone>" --machine-type="<machine-type>"

See also: gcloud compute instances create command reference.

Listing Older and Deprecated Images

As Google Compute Engine releases new images, older images will be deprecated and eventually removed. When this happens, Google Compute Engine sets the deprecation status on an image and if your instances or disks uses a deprecated image, you will need to restart them with a newer, non-deprecated image.

Use gcloud to list images and review their deprecation status, if any:

gcloud compute images list --project=debian-cloud --no-standard-images --show-deprecated

A list of deprecation statuses are available in the Images reference documentation.

Building a Google Compute Engine Image

To build a Debian image for Google Compute Engine, follow these instructions:

  1. Request access to Google Compute Engine

    • If you want to help with the Cloud/GoogleComputeEngineImage effort and don't already have a Google Compute Engine space to work in, contact David (cache@google.com) and Jimmy (jkaplowitz@google.com). Be sure to provide the following information in your email:

      • A description of how you can help
      • The email of your Google account (Google Apps and consumer accounts are both fine)
      We will add people to the appropriate projects, within certain constraints. See "Access To Test Account for Debian Developers" below for more information.
  2. Create images using the build script (see below) on any Linux machine

    • Example command line (root access is needed for the loopback mounting process):
      # Either squeeze or wheezy should work.
      sudo ./build-debian-cloud gce --codename wheezy
  3. Follow the steps to upload and use a custom image

    • The image will end up in the same directory. From there, follow the steps to upload and use a custom image in Google Compute Engine, beginning with step 4. Note the linked instructions tell you to run:

      • gcutil --project=<project-id> addimage <image-name> <image-uri> --preferred_kernel=/projects/google/global/kernels/<kernel-name>

      To find the correct <kernel-name>, choose from a list of available kernels:

      • gcutil listkernels --project=google (rather than your own project)
      If you omit --preferred_kernel, simply choose the newest available kernel when prompted by gcutil.

Image Build Script

Anders Ingemann has created a build script for bootstrapping instances that runs automatically and needs no user interaction. You can also attach custom scripts to the script as well. Download or clone the script on GitHub. Any bugs or suggestions should be reported via the GitHub issue tracker or discussed on debian-cloud.

Note: Google's fork of Anders' repository may sometimes have newer changes specific to Google Compute Engine, including ones used to build Debian images. Pull requests are regularly submitted to Anders and merged upstream in his repository.

Future Plans

Not yet available

Google Contacts

If you have any questions, concerns, or general feedback, please don’t hesitate to contact the Google Compute team (gc-team@google.com) or David McWherter (cache@google.com) or Jimmy Kaplowitz (jimmy@debian.org or jkaplowitz@google.com) directly about this effort.

Access to test account, for Debian Developers interested in testing, or working on Debian images

Google has created two Google Compute Engine projects for Debian’s use. Billing for Google Compute Engine and Google Cloud Storage has been waived on these projects. The first project, ‘debian-cloud’, is intended for pushing new images to customers. The second project, ‘debian-cloud-experiments’, is intended for Debian volunteers to experiment with the project. It has a small quota and must be shared. Google will work with Debian to manage access to these projects.