diff --git a/doc/source/_static/jquery.tweet.js b/doc/source/_static/jquery.tweet.js index c93fea87..79bf0bdb 100644 --- a/doc/source/_static/jquery.tweet.js +++ b/doc/source/_static/jquery.tweet.js @@ -1,5 +1,5 @@ (function($) { - + $.fn.tweet = function(o){ var s = { username: ["seaofclouds"], // [string] required, unless you want to display our tweets. :) it can be an array, just do ["username1","username2","etc"] @@ -17,9 +17,9 @@ loading_text: null, // [string] optional loading text, displayed while tweets load query: null // [string] optional search query }; - + if(o) $.extend(s, o); - + $.fn.extend({ linkUrl: function() { var returning = []; diff --git a/doc/source/client.rst b/doc/source/client.rst index 976e70b0..e03eb33a 100644 --- a/doc/source/client.rst +++ b/doc/source/client.rst @@ -67,7 +67,7 @@ Filtering Images Returned via ``get_images()`` and ``get_images_detailed()`` ---------------------------------------------------------------------------- Both the ``get_images()`` and ``get_images_detailed()`` methods take query -parameters that serve to filter the returned list of images. +parameters that serve to filter the returned list of images. When calling, simply pass an optional dictionary to the method containing the filters by which you wish to limit results, with the filter keys being one @@ -219,7 +219,7 @@ The method signature is as follows:: glance.client.Client.add_image(image_meta, image_data=None) -The `image_meta` argument is a mapping containing various image metadata. +The `image_meta` argument is a mapping containing various image metadata. The `image_data` argument is the disk image data and is an optional argument. The list of metadata that `image_meta` can contain are listed below. @@ -234,7 +234,7 @@ The list of metadata that `image_meta` can contain are listed below. * `id` - This key/value is optional. + This key/value is optional. When present, Glance will use the supplied identifier for the image. If the identifier already exists in that Glance node, then a diff --git a/doc/source/community.rst b/doc/source/community.rst index 7b73b649..730818a3 100644 --- a/doc/source/community.rst +++ b/doc/source/community.rst @@ -17,7 +17,7 @@ Getting Involved ================ -The Glance community is a very friendly group and there are places online to join in with the +The Glance community is a very friendly group and there are places online to join in with the community. Feel free to ask questions. This document points you to some of the places where you can communicate with people. @@ -26,14 +26,14 @@ How to Join the OpenStack Community Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup -and offer contributions through Launchpad, the wiki, or blogs. We welcome all types of contributions, -from blueprint designs to documentation to testing to deployment scripts. +and offer contributions through Launchpad, the wiki, or blogs. We welcome all types of contributions, +from blueprint designs to documentation to testing to deployment scripts. Contributing Code ----------------- To contribute code, sign up for a Launchpad account and sign a contributor license agreement, -available on the ``_. Once the CLA is signed you +available on the ``_. Once the CLA is signed you can contribute code through the Bazaar version control system which is related to your Launchpad account. #openstack on Freenode IRC Network @@ -41,8 +41,8 @@ can contribute code through the Bazaar version control system which is related t There is a very active chat channel at ``_. This is usually the best place to ask questions and find your way around. IRC stands for Internet Relay -Chat and it is a way to chat online in real time. You can also ask a question and come back to the -log files to read the answer later. Logs for the #openstack IRC channel are stored at +Chat and it is a way to chat online in real time. You can also ask a question and come back to the +log files to read the answer later. Logs for the #openstack IRC channel are stored at ``_. OpenStack Wiki @@ -58,7 +58,7 @@ Glance on Launchpad ------------------- Launchpad is a code hosting service that hosts the Glance source code. From -Launchpad you can report bugs, ask questions, and register blueprints (feature requests). +Launchpad you can report bugs, ask questions, and register blueprints (feature requests). * `Learn about how to use bzr with launchpad `_ * `Launchpad Glance Page `_ @@ -79,5 +79,5 @@ aggregation with your blog posts, there are instructions for `adding your blog < Twitter ------- -Because all the cool kids do it: `@openstack `_. Also follow the +Because all the cool kids do it: `@openstack `_. Also follow the `#openstack `_ tag for relevant tweets. diff --git a/doc/source/configuring.rst b/doc/source/configuring.rst index 1c9b011b..c64f616d 100644 --- a/doc/source/configuring.rst +++ b/doc/source/configuring.rst @@ -278,7 +278,7 @@ Can only be specified in configuration files. Sets the authentication URL supplied to Swift when making calls to its storage system. For more information about the Swift authentication system, please -see the `Swift auth `_ +see the `Swift auth `_ documentation and the `overview of Swift authentication `_. @@ -366,7 +366,7 @@ Default: s3.amazonaws.com Sets the main service URL supplied to S3 when making calls to its storage system. For more information about the S3 authentication system, please -see the `S3 documentation `_ +see the `S3 documentation `_ * ``s3_store_access_key=ACCESS_KEY`` diff --git a/doc/source/controllingservers.rst b/doc/source/controllingservers.rst index 870b0a37..9361c207 100644 --- a/doc/source/controllingservers.rst +++ b/doc/source/controllingservers.rst @@ -66,7 +66,7 @@ If no configuration file is found, you will see an error, like:: Here is an example showing how you can manually start the ``glance-api`` server and ``glance-registry`` in a shell.:: - $ sudo glance-api glance-api.conf --debug & + $ sudo glance-api glance-api.conf --debug & jsuh@mc-ats1:~$ 2011-04-13 14:50:12 DEBUG [glance-api] ******************************************************************************** 2011-04-13 14:50:12 DEBUG [glance-api] Configuration options gathered from config file: 2011-04-13 14:50:12 DEBUG [glance-api] /home/jsuh/glance-api.conf @@ -83,7 +83,7 @@ Here is an example showing how you can manually start the ``glance-api`` server 2011-04-13 14:50:12 DEBUG [routes.middleware] Initialized with method overriding = True, and path info altering = True 2011-04-13 14:50:12 DEBUG [eventlet.wsgi.server] (21354) wsgi starting up on http://65.114.169.29:9292/ - $ sudo glance-registry glance-registry.conf & + $ sudo glance-registry glance-registry.conf & jsuh@mc-ats1:~$ 2011-04-13 14:51:16 INFO [sqlalchemy.engine.base.Engine.0x...feac] PRAGMA table_info("images") 2011-04-13 14:51:16 INFO [sqlalchemy.engine.base.Engine.0x...feac] () 2011-04-13 14:51:16 DEBUG [sqlalchemy.engine.base.Engine.0x...feac] Col ('cid', 'name', 'type', 'notnull', 'dflt_value', 'pk') @@ -171,7 +171,7 @@ with the ``glance-control`` wrapper script. :: root 20039 6.0 0.1 25188 13356 ? Ss 12:51 0:00 /usr/bin/python /usr/bin/glance-registry /home/jsuh/glance-registry.conf jsuh 20042 0.0 0.0 3368 744 pts/1 S+ 12:51 0:00 grep glance - + The same configuration files are used by ``glance-control`` to start the Glance server programs, and you can specify (as the example above shows) a configuration file when starting the server. diff --git a/doc/source/formats.rst b/doc/source/formats.rst index a2c17179..eab52563 100644 --- a/doc/source/formats.rst +++ b/doc/source/formats.rst @@ -51,7 +51,7 @@ You can set your image's container format to one of the following: * **iso** - An archive format for the data contents of an optical disc (e.g. CDROM). + An archive format for the data contents of an optical disc (e.g. CDROM). * **qcow2** diff --git a/doc/source/glance.rst b/doc/source/glance.rst index 49ee9f41..0f4c30b9 100644 --- a/doc/source/glance.rst +++ b/doc/source/glance.rst @@ -410,9 +410,9 @@ custom image properties. The 'limit' and 'marker' options are used by the index and details commands to control pagination. The 'marker' indicates the last record that was seen by the user. The page of results returned will begin after the provided image -ID. The 'limit' param indicates the page size. Each request to the api will be +ID. The 'limit' param indicates the page size. Each request to the api will be restricted to returning a maximum number of results. Without the 'force' -option, the user will be prompted before each page of results is fetched +option, the user will be prompted before each page of results is fetched from the API. Results from index and details commands may be ordered using the 'sort_key' @@ -474,7 +474,7 @@ available in Glance, as shown below:: The ``show`` command -------------------- -The ``show`` command displays detailed information about a specific image, +The ``show`` command displays detailed information about a specific image, specified with ````, as shown below:: $> glance show 771c0223-27b4-4789-a83d-79eb9c166578 --host=65.114.169.29 diff --git a/doc/source/glanceapi.rst b/doc/source/glanceapi.rst index 0afc2b5e..73c38522 100644 --- a/doc/source/glanceapi.rst +++ b/doc/source/glanceapi.rst @@ -385,7 +385,7 @@ The list of metadata headers that Glance accepts are listed below. checksum of the image file data. When present, Glance will verify the checksum generated from the backend - store when storing your image against this value and return a + store when storing your image against this value and return a **400 Bad Request** if the values do not match. * ``x-image-meta-is-public`` diff --git a/doc/source/installing.rst b/doc/source/installing.rst index 51f1c68e..1c754504 100644 --- a/doc/source/installing.rst +++ b/doc/source/installing.rst @@ -89,12 +89,12 @@ Debian, Ubuntu to install the python-sphinx package 2. Clone Glance's trunk branch from GitHub:: - + $> git clone git://github.com/openstack/glance $> cd glance 3. Install Glance:: - + $> sudo python setup.py install Red Hat, Fedora diff --git a/doc/source/man/glance.rst b/doc/source/man/glance.rst index 13f6982c..4bab7ff9 100644 --- a/doc/source/man/glance.rst +++ b/doc/source/man/glance.rst @@ -125,7 +125,7 @@ OPTIONS Prevent select actions from requesting user confirmation **--dry-run** - Don't actually execute the command, just print output showing what + Don't actually execute the command, just print output showing what WOULD happen. **--can-share** diff --git a/doc/source/man/glancecachemanage.rst b/doc/source/man/glancecachemanage.rst index e32a99cb..14d1f2e6 100644 --- a/doc/source/man/glancecachemanage.rst +++ b/doc/source/man/glancecachemanage.rst @@ -56,7 +56,7 @@ OPTIONS **-h, --help** show this help message and exit - + **-v, --verbose** Print more verbose output diff --git a/doc/source/registries.rst b/doc/source/registries.rst index d76349c4..cb2a4f16 100644 --- a/doc/source/registries.rst +++ b/doc/source/registries.rst @@ -95,7 +95,7 @@ These two resources also accept sort parameters: Results will be sorted in the direction ``DIR``. Accepted values are ``asc`` for ascending or ``desc`` (default) for descending. - + ``POST /images`` ---------------- diff --git a/glance/registry/db/migrate_repo/versions/003_sqlite_downgrade.sql b/glance/registry/db/migrate_repo/versions/003_sqlite_downgrade.sql index 64ccaefe..c96cc53b 100644 --- a/glance/registry/db/migrate_repo/versions/003_sqlite_downgrade.sql +++ b/glance/registry/db/migrate_repo/versions/003_sqlite_downgrade.sql @@ -2,16 +2,16 @@ BEGIN; /* Make changes to the base images table */ CREATE TEMPORARY TABLE images_backup ( - id INTEGER NOT NULL, - name VARCHAR(255), - size INTEGER, - status VARCHAR(30) NOT NULL, - is_public BOOLEAN NOT NULL, - location TEXT, - created_at DATETIME NOT NULL, - updated_at DATETIME, - deleted_at DATETIME, - deleted BOOLEAN NOT NULL, + id INTEGER NOT NULL, + name VARCHAR(255), + size INTEGER, + status VARCHAR(30) NOT NULL, + is_public BOOLEAN NOT NULL, + location TEXT, + created_at DATETIME NOT NULL, + updated_at DATETIME, + deleted_at DATETIME, + deleted BOOLEAN NOT NULL, PRIMARY KEY (id) ); @@ -22,19 +22,19 @@ FROM images; DROP TABLE images; CREATE TABLE images ( - id INTEGER NOT NULL, - name VARCHAR(255), - size INTEGER, + id INTEGER NOT NULL, + name VARCHAR(255), + size INTEGER, type VARCHAR(30), - status VARCHAR(30) NOT NULL, - is_public BOOLEAN NOT NULL, - location TEXT, - created_at DATETIME NOT NULL, - updated_at DATETIME, - deleted_at DATETIME, - deleted BOOLEAN NOT NULL, - PRIMARY KEY (id), - CHECK (is_public IN (0, 1)), + status VARCHAR(30) NOT NULL, + is_public BOOLEAN NOT NULL, + location TEXT, + created_at DATETIME NOT NULL, + updated_at DATETIME, + deleted_at DATETIME, + deleted BOOLEAN NOT NULL, + PRIMARY KEY (id), + CHECK (is_public IN (0, 1)), CHECK (deleted IN (0, 1)) ); CREATE INDEX ix_images_deleted ON images (deleted); diff --git a/glance/registry/db/migrate_repo/versions/003_sqlite_upgrade.sql b/glance/registry/db/migrate_repo/versions/003_sqlite_upgrade.sql index 363c92e1..8914f54a 100644 --- a/glance/registry/db/migrate_repo/versions/003_sqlite_upgrade.sql +++ b/glance/registry/db/migrate_repo/versions/003_sqlite_upgrade.sql @@ -17,16 +17,16 @@ DROP TABLE tmp_type_records; /* Make changes to the base images table */ CREATE TEMPORARY TABLE images_backup ( - id INTEGER NOT NULL, - name VARCHAR(255), - size INTEGER, - status VARCHAR(30) NOT NULL, - is_public BOOLEAN NOT NULL, - location TEXT, - created_at DATETIME NOT NULL, - updated_at DATETIME, - deleted_at DATETIME, - deleted BOOLEAN NOT NULL, + id INTEGER NOT NULL, + name VARCHAR(255), + size INTEGER, + status VARCHAR(30) NOT NULL, + is_public BOOLEAN NOT NULL, + location TEXT, + created_at DATETIME NOT NULL, + updated_at DATETIME, + deleted_at DATETIME, + deleted BOOLEAN NOT NULL, PRIMARY KEY (id) ); @@ -37,20 +37,20 @@ FROM images; DROP TABLE images; CREATE TABLE images ( - id INTEGER NOT NULL, - name VARCHAR(255), - size INTEGER, - status VARCHAR(30) NOT NULL, - is_public BOOLEAN NOT NULL, - location TEXT, - created_at DATETIME NOT NULL, - updated_at DATETIME, - deleted_at DATETIME, - deleted BOOLEAN NOT NULL, + id INTEGER NOT NULL, + name VARCHAR(255), + size INTEGER, + status VARCHAR(30) NOT NULL, + is_public BOOLEAN NOT NULL, + location TEXT, + created_at DATETIME NOT NULL, + updated_at DATETIME, + deleted_at DATETIME, + deleted BOOLEAN NOT NULL, disk_format VARCHAR(20), container_format VARCHAR(20), - PRIMARY KEY (id), - CHECK (is_public IN (0, 1)), + PRIMARY KEY (id), + CHECK (is_public IN (0, 1)), CHECK (deleted IN (0, 1)) ); CREATE INDEX ix_images_deleted ON images (deleted); diff --git a/glance/registry/db/migrate_repo/versions/006_sqlite_downgrade.sql b/glance/registry/db/migrate_repo/versions/006_sqlite_downgrade.sql index 6be0adae..36b0cec4 100644 --- a/glance/registry/db/migrate_repo/versions/006_sqlite_downgrade.sql +++ b/glance/registry/db/migrate_repo/versions/006_sqlite_downgrade.sql @@ -5,14 +5,14 @@ BEGIN TRANSACTION; CREATE TEMPORARY TABLE image_properties_backup ( - id INTEGER NOT NULL, - image_id INTEGER NOT NULL, - key VARCHAR(255) NOT NULL, - value TEXT, - created_at DATETIME NOT NULL, - updated_at DATETIME, - deleted_at DATETIME, - deleted BOOLEAN NOT NULL, + id INTEGER NOT NULL, + image_id INTEGER NOT NULL, + key VARCHAR(255) NOT NULL, + value TEXT, + created_at DATETIME NOT NULL, + updated_at DATETIME, + deleted_at DATETIME, + deleted BOOLEAN NOT NULL, PRIMARY KEY (id) ); @@ -23,17 +23,17 @@ FROM image_properties; DROP TABLE image_properties; CREATE TABLE image_properties ( - id INTEGER NOT NULL, - image_id INTEGER NOT NULL, - key VARCHAR(255) NOT NULL, - value TEXT, - created_at DATETIME NOT NULL, - updated_at DATETIME, - deleted_at DATETIME, - deleted BOOLEAN NOT NULL, - PRIMARY KEY (id), - CHECK (deleted IN (0, 1)), - UNIQUE (image_id, key), + id INTEGER NOT NULL, + image_id INTEGER NOT NULL, + key VARCHAR(255) NOT NULL, + value TEXT, + created_at DATETIME NOT NULL, + updated_at DATETIME, + deleted_at DATETIME, + deleted BOOLEAN NOT NULL, + PRIMARY KEY (id), + CHECK (deleted IN (0, 1)), + UNIQUE (image_id, key), FOREIGN KEY(image_id) REFERENCES images (id) ); CREATE INDEX ix_image_properties_key ON image_properties (key); diff --git a/glance/registry/db/migrate_repo/versions/006_sqlite_upgrade.sql b/glance/registry/db/migrate_repo/versions/006_sqlite_upgrade.sql index 2e74d589..520706a2 100644 --- a/glance/registry/db/migrate_repo/versions/006_sqlite_upgrade.sql +++ b/glance/registry/db/migrate_repo/versions/006_sqlite_upgrade.sql @@ -5,14 +5,14 @@ BEGIN TRANSACTION; CREATE TEMPORARY TABLE image_properties_backup ( - id INTEGER NOT NULL, - image_id INTEGER NOT NULL, - name VARCHAR(255) NOT NULL, - value TEXT, - created_at DATETIME NOT NULL, - updated_at DATETIME, - deleted_at DATETIME, - deleted BOOLEAN NOT NULL, + id INTEGER NOT NULL, + image_id INTEGER NOT NULL, + name VARCHAR(255) NOT NULL, + value TEXT, + created_at DATETIME NOT NULL, + updated_at DATETIME, + deleted_at DATETIME, + deleted BOOLEAN NOT NULL, PRIMARY KEY (id) ); @@ -23,17 +23,17 @@ FROM image_properties; DROP TABLE image_properties; CREATE TABLE image_properties ( - id INTEGER NOT NULL, - image_id INTEGER NOT NULL, - name VARCHAR(255) NOT NULL, - value TEXT, - created_at DATETIME NOT NULL, - updated_at DATETIME, - deleted_at DATETIME, - deleted BOOLEAN NOT NULL, - PRIMARY KEY (id), - CHECK (deleted IN (0, 1)), - UNIQUE (image_id, name), + id INTEGER NOT NULL, + image_id INTEGER NOT NULL, + name VARCHAR(255) NOT NULL, + value TEXT, + created_at DATETIME NOT NULL, + updated_at DATETIME, + deleted_at DATETIME, + deleted BOOLEAN NOT NULL, + PRIMARY KEY (id), + CHECK (deleted IN (0, 1)), + UNIQUE (image_id, name), FOREIGN KEY(image_id) REFERENCES images (id) ); CREATE INDEX ix_image_properties_name ON image_properties (name);