Chef Cookbook - OpenStack Image
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lance Albertson e7e76f07a2 CentOS 8 support 1 year ago
.delivery Stein fixes 3 years ago
attributes Chef 17 support 1 year ago
files/default sync with rcbops/master as of f481cd8a322dc21526da3158d957f034a33e51fd 11 years ago
providers Chef 17 support 1 year ago
recipes Chef 17 support 1 year ago
resources Chef 17 support 1 year ago
spec CentOS 8 support 1 year ago
.gitignore Initial kilo updates 8 years ago
.gitreview OpenDev Migration Patch 4 years ago
.rubocop.yml Chef 17 support 1 year ago
.rubocop_todo.yml Updates for Train 3 years ago
.zuul.yaml Rename openstack-chef-repo references to openstack-chef 4 years ago
Berksfile Chef 17 support 1 year ago Moving IRC network reference to OFTC 1 year ago
LICENSE image refactor for Pike and Chef 13 5 years ago
README.rst Chef 17 support 1 year ago
Rakefile Updates for rocky 3 years ago Sync stackforge/cookbook* to openstack/cookbook* for glance cookbook 8 years ago
metadata.rb Chef 17 support 1 year ago


OpenStack Chef Cookbook - image



This cookbook installs the OpenStack Image service Glance as part of an OpenStack reference deployment Chef for OpenStack. The OpenStack chef-repo contains documentation for using this cookbook in the context of a full OpenStack deployment. Glance is installed from packages, optionally populating the repository with default images.


  • Chef 16 or higher
  • Chef Workstation 21.10.640 for testing (also includes Berkshelf for cookbook dependency resolution)


  • ubuntu
  • redhat
  • centos


The following cookbooks are dependencies:

  • 'openstackclient'
  • 'openstack-common', '>= 20.0.0'
  • 'openstack-identity', '>= 20.0.0'


Please see the extensive inline documentation in attributes/*.rb for descriptions of all the settable attributes for this cookbook.

Note that all attributes are in the default['openstack'] "namespace"

The usage of attributes to generate the glance-api.conf is described in the openstack-common cookbook.



  • Installs the glance-api server


  • Registers the API endpoint and glance service Keystone user


  • Upload image to glance. If you want to upload image during openstack installation, you need to add this recipe or the os-image role to the run list in a certain role and ensure before this recipe or the os-image role glance api recipes have been executed.


  • Install and configure swift glance packages

Glance Backend

The Glance cookbook currently supports file, swift, and Rackspace Cloud Files (swift API compliant) backing stores. NOTE: changing the storage location from cloudfiles to swift (and vice versa) requires that you manually export and import your stored images.

To enable these features set the following in the default attributes section in your environment:


"openstack": {
  "image": {
    "api": {
     "default_store": "file"
    "upload_images": [


"openstack": {
  "image": {
    "api": {
      "default_store": "swift"
    "upload_images": [

Custom Resources


Action: :upload

  • :image_url: Location of the image to be loaded into Glance.
  • :image_name: A name for the image.
  • :image_type: unknown, qcow, ami, vhd, vmdk, vdi, iso, raw. Defaults of unknown will use file extension '.gz', '.tgz' = ami, '.qcow2', '.img' = qcow.
  • :image_public: Set image to be public or private
  • :image_id: Set the image ID
  • :identity_user: Username of the Keystone admin user.
  • :identity_pass: Password for the Keystone admin user.
  • :identity_tenant: Name of the Keystone admin user's tenant.
  • :identity_uri: URI of the Identity API endpoint.
  • :identity_user_domain_name: User domain name for Keystone admin user.
  • :identity_project_domain_name: Project domain name for Keystone admin user.

License and Author

Author Justin Shepherd (
Author Jason Cannavale (
Author Ron Pedde (
Author Joseph Breu (
Author William Kelly (
Author Darren Birkett (
Author Evan Callicoat (
Author Matt Ray (
Author Jay Pipes (
Author John Dewey (
Author Craig Tracey (
Author Sean Gallagher (
Author Mark Vanderwiel (
Author Salman Baset (
Author Chen Zhiwei (
Author Eric Zhou (
Author Jian Hua Geng (
Author Ionut Artarisi (
Author Imtiaz Chowdhury (
Author Jan Klare (
Author Christoph Albers (
Author Lance Albertson (
Copyright Copyright (c) 2012, Rackspace US, Inc.
Copyright Copyright (c) 2012-2013, Opscode, Inc.
Copyright Copyright (c) 2012-2013, AT&T Services, Inc.
Copyright Copyright (c) 2013, Craig Tracey
Copyright Copyright (c) 2013-2014, IBM Corp.
Copyright Copyright (c) 2014, SUSE Linux, GmbH.
Copyright Copyright (c) 2019-2021, Oregon State University

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.