diff --git a/doc/common/app_support.xml b/doc/common/app_support.xml index c7c69aa40e..e087a84994 100644 --- a/doc/common/app_support.xml +++ b/doc/common/app_support.xml @@ -4,21 +4,28 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="app_community_support"> - Community Support + Community support - There are many resources available that will help you - further with running and using OpenStack. Many OpenStack - community members can answer questions and help with bug - suspicions. We are constantly improving and adding to the main - features of OpenStack, but if you have any problems, do not - hesitate to ask. Use the following resources to get OpenStack - support and troubleshoot your existing installations. + To help you run and use OpenStack, many resources are + available. Many OpenStack community members can answer + questions and help with bug suspicions. We are constantly + improving and adding to the main features of OpenStack, but if + you have any problems, do not hesitate to ask. Use the + following resources to get OpenStack support and troubleshoot + your existing installations.
Documentation For the available OpenStack documentation, see docs.openstack.org. + To provide feedback on documentation, join and use the + openstack-docs@lists.openstack.org + mailing list at OpenStack Documentation Mailing List, or report a bug. The following books explain how to install an OpenStack cloud and its components: @@ -112,6 +119,41 @@ + The following documentation provides reference and + guidance information for the OpenStack APIs: + OpenStack API Reference + + OpenStack Block Storage + Service API v2 + Reference + + + OpenStack Compute API v2 and Extensions Reference + + + OpenStack Identity Service API v2.0 Reference + + + OpenStack Image Service API v2 Reference + + + OpenStack Networking API v2.0 Reference + + + OpenStack Object Storage API v1 Reference +
@@ -148,7 +190,7 @@ and so on. >http://wiki.openstack.org/MailingLists.
- The OpenStack Wiki + The OpenStack wiki The OpenStack wiki contains content on a broad range of topics but some of it sits a bit below the @@ -242,10 +284,9 @@ xlink:href="https://bugs.launchpad.net/ceilometer" The OpenStack IRC channel The OpenStack community lives and breathes in the #openstack IRC channel on the Freenode network. You can - come by to hang out, ask questions, or get immediate - feedback for urgent and pressing issues. To get into the - IRC channel, you must install an IRC client or use a - browser-based client by going to http://webchat.freenode.net/. You can also use Colloquy (Mac OS X, https://wiki.openstack.org/wiki/IRC.
-
- Documentation feedback - - To provide feedback on documentation, join and use the - openstack-docs@lists.openstack.org - mailing list at OpenStack Documentation Mailing List, - or report a bug. - -
diff --git a/doc/common/section_cinder_cli_manage_volumes.xml b/doc/common/section_cinder_cli_manage_volumes.xml old mode 100644 new mode 100755 diff --git a/doc/common/section_cli_overview.xml b/doc/common/section_cli_overview.xml index 76e8245d0b..e54e971346 100644 --- a/doc/common/section_cli_overview.xml +++ b/doc/common/section_cli_overview.xml @@ -34,10 +34,9 @@ ceilometer - (python-ceilometerclient). - Client for Monitoring/Metering - API that lets you create and collect measurements - across all OpenStack components. + (python-ceilometerclient). + Client for the Metering API that lets you create and + collect measurements across OpenStack. cinder diff --git a/doc/install-guide/section_heat-verify.xml b/doc/install-guide/section_heat-verify.xml index 68afa97a93..729a4bad09 100644 --- a/doc/install-guide/section_heat-verify.xml +++ b/doc/install-guide/section_heat-verify.xml @@ -14,6 +14,6 @@ # source openrc Next you can try creating some stacks, using the samples. - + diff --git a/doc/pom.xml b/doc/pom.xml index 2d6ca0fc9d..ec1f4ca6f1 100644 --- a/doc/pom.xml +++ b/doc/pom.xml @@ -47,7 +47,7 @@ com.rackspace.cloud.api clouddocs-maven-plugin - 1.11.0 + 1.11.1 diff --git a/doc/user-guide/ch_cli.xml b/doc/user-guide/ch_cli.xml index f69744dee5..fd1840b15e 100644 --- a/doc/user-guide/ch_cli.xml +++ b/doc/user-guide/ch_cli.xml @@ -37,8 +37,8 @@ - - + + diff --git a/doc/user-guide/section_ceilometer_cli.xml b/doc/user-guide/section_ceilometer_cli.xml index 0e89051ad3..a3d72597d0 100644 --- a/doc/user-guide/section_ceilometer_cli.xml +++ b/doc/user-guide/section_ceilometer_cli.xml @@ -5,17 +5,25 @@ xmlns:svg="http://www.w3.org/2000/svg" xmlns:html="http://www.w3.org/1999/xhtml" version="5.0" xml:id="ceilometer_cli_commands"> - Metering - Metering is the service that measures cloud resources within OpenStack. It collects information about what, who, when and how much regarding anything that can be billed. For Havana, metering is available to the user using only the CLI. - As an example, we create a heat autoscaling stack and see some of the ceilometer command outputs. + Measure cloud resources + The Metering service measures cloud resources within + OpenStack. + It collects information about how much, who, what, and when + with regards to billing. For Havana, metering is available + through only the ceilometer command-line interface + (CLI). + The following example uses the heat client to create an + auto-scaling stack and the ceilometer client to measure + resources. - Create a heat autoscaling stack, using the following command: - $ heat stack-create -f cfn/F17/AutoScalingCeilometer.yaml -P "KeyName=heat_key" - - To see the list of heat resources created, run the following command: - $ heat resource-list - -+--------------------------+-----------------------------------------+-----------------+----------------------+ + + Create an auto-scaling stack: + $ heat stack-create -f cfn/F17/AutoScalingCeilometer.yaml -P "KeyName=heat_key" + + + List the heat resources that were created: + $ heat resource-list ++--------------------------+-----------------------------------------+-----------------+----------------------+ | resource_name | resource_type |resource_status | updated_time | +--------------------------+-----------------------------------------+-----------------+----------------------+ | CfnUser | AWS::IAM::User |CREATE_COMPLETE | 2013-10-02T05:53:41Z | @@ -28,47 +36,45 @@ | CPUAlarmHigh | OS::Ceilometer::Alarm |CREATE_COMPLETE | 2013-10-02T05:56:02Z | | CPUAlarmLow | OS::Ceilometer::Alarm |CREATE_COMPLETE | 2013-10-02T05:56:02Z | +--------------------------+-----------------------------------------+-----------------+----------------------+ - - To see the list of alarms set, run the following command: - $ ceilometer alarm-list - -+--------------------------------------+------------------------------+-------------------+---------+------------+-------------------------------+ + + + List the alarms that are set: + $ ceilometer alarm-list ++--------------------------------------+------------------------------+-------------------+---------+------------+-------------------------------+ | Alarm ID | Name | State | Enabled | Continuous | Alarm condition | +--------------------------------------+------------------------------+-------------------+---------+------------+-------------------------------+ | 4f896b40-0859-460b-9c6a-b0d329814496 | as-CPUAlarmLow-i6qqgkf2fubs | insufficient data | True | False | cpu_util < 15.0 during 1x 60s | -| 75d8ecf7-afc5-4bdc-95ff-19ed9ba22920 | as-CPUAlarmHigh-sf4muyfruy5m | insufficient data | True | False | cpu_util > 50.0 during 1x 60s | - +--------------------------------------+------------------------------+-------------------+---------+------------+-----------------------------+ - - To see the list of meters set, run the following command: - $ ceilometer meter-list - - -+--------------------------+------------+----------+-----------------------------------------------------------------------+------------------------------------+ +| 75d8ecf7-afc5-4bdc-95ff-19ed9ba22920 | as-CPUAlarmHigh-sf4muyfruy5m | insufficient data | True | False | cpu_util > 50.0 during 1x 60s | ++--------------------------------------+------------------------------+-------------------+---------+------------+-----------------------------+ + + + List the meters that are set: + $ ceilometer meter-list ++--------------------------+------------+----------+-----------------------------------------------------------------------+------------------------------------+ | Name | Type | Unit | Resource ID | User ID | Project ID | +--------------------------+------------+----------+-----------------------------------------------------------------------+------------------------------------+ | cpu | cumulative | ns | 3965b41b-81b0-4386-bea5-6ec37c8841c1 | d1a2996d3b1f4e0e8645ba9650308011 | bf03bf32e3884d489004ac995ff7a61c | | cpu | cumulative | ns | 62520a83-73c7-4084-be54-275fe770ef2c | d1a2996d3b1f4e0e8645ba9650308011 | bf03bf32e3884d489004ac995ff7a61c | | cpu_util | gauge | % | 3965b41b-81b0-4386-bea5-6ec37c8841c1 | d1a2996d3b1f4e0e8645ba9650308011 | bf03bf32e3884d489004ac995ff7a61c | +--------------------------+------------+----------+-----------------------------------------------------------------------+------------------------------------+ - - To see the list of samples, run the following command: -$ ceilometer sample-list -m cpu_util - -+--------------------------------------+----------+-------+---------------+------+---------------------+ + + + List samples: + $ ceilometer sample-list -m cpu_util ++--------------------------------------+----------+-------+---------------+------+---------------------+ | Resource ID | Name | Type | Volume | Unit | Timestamp | +--------------------------------------+----------+-------+---------------+------+---------------------+ | 3965b41b-81b0-4386-bea5-6ec37c8841c1 | cpu_util | gauge | 3.98333333333 | % | 2013-10-02T10:50:12 | +--------------------------------------+----------+-------+---------------+------+---------------------+ - - To see the statistics, run the following command: -$ ceilometer statistics -m cpu_util - - -+--------+---------------------+---------------------+-------+---------------+---------------+---------------+---------------+----------+---------------------+---------------------+ + + + View statistics: + $ ceilometer statistics -m cpu_util ++--------+---------------------+---------------------+-------+---------------+---------------+---------------+---------------+----------+---------------------+---------------------+ | Period | Period Start | Period End | Count | Min | Max | Sum | Avg | Duration | Duration Start | Duration End | +--------+---------------------+---------------------+-------+---------------+---------------+---------------+---------------+----------+---------------------+---------------------+ | 0 | 2013-10-02T10:50:12 | 2013-10-02T10:50:12 | 1 | 3.98333333333 | 3.98333333333 | 3.98333333333 | 3.98333333333 | 0.0 | 2013-10-02T10:50:12 | 2013-10-02T10:50:12 | +--------+---------------------+---------------------+-------+---------------+---------------+---------------+---------------+----------+---------------------+---------------------+ - + - \ No newline at end of file + diff --git a/doc/user-guide/section_cinder_cli_manage_volumes.xml b/doc/user-guide/section_cinder_cli_manage_volumes.xml deleted file mode 100644 index 77cc5bad10..0000000000 --- a/doc/user-guide/section_cinder_cli_manage_volumes.xml +++ /dev/null @@ -1,186 +0,0 @@ - -
- Manage volumes - A volume is a detachable block storage device, similar to a - USB hard drive. You can attach a volume to only one instance. - To create and manage volumes, you use a combination of nova - and cinder client commands. - This example creates a volume named - my-volume based on an image. - - To list volumes - - To determine which image to use for your volume, - list images: - $ nova image-list - +--------------------------------------+---------------------------------+--------+--------------------------------------+ -| ID | Name | Status | Server | -+--------------------------------------+---------------------------------+--------+--------------------------------------+ -| 397e713c-b95b-4186-ad46-6126863ea0a9 | cirros-0.3.1-x86_64-uec | ACTIVE | | -| df430cc2-3406-4061-b635-a51c16e488ac | cirros-0.3.1-x86_64-uec-kernel | ACTIVE | | -| 3cf852bd-2332-48f4-9ae4-7d926d50945e | cirros-0.3.1-x86_64-uec-ramdisk | ACTIVE | | -| 7e5142af-1253-4634-bcc6-89482c5f2e8a | myCirrosImage | ACTIVE | 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 | -| 89bcd424-9d15-4723-95ec-61540e8a1979 | mysnapshot | ACTIVE | f51ebd07-c33d-4951-8722-1df6aa8afaa4 | -+--------------------------------------+---------------------------------+--------+--------------------------------------+ - Note the ID of the image that you want to - use. - - - To determine which availability zone are available - in which to create your volume, list the availability - zones: - $ nova availability-zone-list - +-----------------------+----------------------------------------+ -| Name | Status | -+-----------------------+----------------------------------------+ -| internal | available | -| |- devstack-grizzly | | -| | |- nova-conductor | enabled :-) 2013-07-25T16:50:44.000000 | -| | |- nova-consoleauth | enabled :-) 2013-07-25T16:50:44.000000 | -| | |- nova-scheduler | enabled :-) 2013-07-25T16:50:44.000000 | -| | |- nova-cert | enabled :-) 2013-07-25T16:50:44.000000 | -| | |- nova-network | enabled :-) 2013-07-25T16:50:44.000000 | -| nova | available | -| |- devstack-grizzly | | -| | |- nova-compute | enabled :-) 2013-07-25T16:50:39.000000 | -+-----------------------+----------------------------------------+ - Note the name of an available availability zone that - you want to use. - - - Create a volume with 8 GBs of space in the desired - availability zone and based on the desired image, as - follows: - $ cinder create 8 --display-name my-new-volume --image-id 397e713c-b95b-4186-ad46-6126863ea0a9 --availability-zone nova - +---------------------+--------------------------------------+ -| Property | Value | -+---------------------+--------------------------------------+ -| attachments | [] | -| availability_zone | nova | -| bootable | false | -| created_at | 2013-07-25T17:02:12.472269 | -| display_description | None | -| display_name | my-new-volume | -| id | 573e024d-5235-49ce-8332-be1576d323f8 | -| image_id | 397e713c-b95b-4186-ad46-6126863ea0a9 | -| metadata | {} | -| size | 8 | -| snapshot_id | None | -| source_volid | None | -| status | creating | -| volume_type | None | -+---------------------+--------------------------------------+ - - - To verify that your volume was created successfully, - list the available volumes: - $ cinder list - +--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ -| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to | -+--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ -| 573e024d-5235-49ce-8332-be1576d323f8 | available | my-new-volume | 8 | None | true | | -| bd7cf584-45de-44e3-bf7f-f7b50bf235e3 | available | my-bootable-vol | 8 | None | true | | -+--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ - If your volume was created successfully, its status - is available. If its status is - error, you might have tried to - create a volume outside of your quota. - - - Attach your volume to a server: - $ nova volume-attach 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 573e024d-5235-49ce-8332-be1576d323f8 /dev/vdb - +----------+--------------------------------------+ -| Property | Value | -+----------+--------------------------------------+ -| device | /dev/vdb | -| serverId | 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 | -| id | 573e024d-5235-49ce-8332-be1576d323f8 | -| volumeId | 573e024d-5235-49ce-8332-be1576d323f8 | -+----------+--------------------------------------+ - Note the ID of your volume. - If you see any I/O errors when attaching a volume, it is possible that the backend driver needs to be - configured for a custom block size, or that you are running an older version of libvirt. (Version 0.10.2+ - is required for backends, such as SolidFire, that set a custom block size). Block Storage supports custom - block sizes on KVM and QEMU. - - - - Show information for your volume: - $ cinder show 573e024d-5235-49ce-8332-be1576d323f8 - +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Property | Value | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| attachments | [{u'device': u'/dev/vdb', u'server_id': u'84c6e57d-a6b1-44b6-81eb-fcb36afd31b5', u'id': u'573e024d-5235-49ce-8332-be1576d323f8', u'volume_id': u'573e024d-5235-49ce-8332-be1576d323f8'}] | -| availability_zone | nova | -| bootable | true | -| created_at | 2013-07-25T17:02:12.000000 | -| display_description | None | -| display_name | my-new-volume | -| id | 573e024d-5235-49ce-8332-be1576d323f8 | -| metadata | {} | -| os-vol-host-attr:host | devstack-grizzly | -| os-vol-tenant-attr:tenant_id | 66265572db174a7aa66eba661f58eb9e | -| size | 8 | -| snapshot_id | None | -| source_volid | None | -| status | in-use | -| volume_image_metadata | {u'kernel_id': u'df430cc2-3406-4061-b635-a51c16e488ac', u'image_id': u'397e713c-b95b-4186-ad46-6126863ea0a9', u'ramdisk_id': u'3cf852bd-2332-48f4-9ae4-7d926d50945e', u'image_name': u'cirros-0.3.1-x86_64-uec'} | -| volume_type | None | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - From the output, you can see that the volume is - attached to the server with ID - 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5, - is in the nova availability zone, and is - bootable. - - - To delete your volume, you must first detach it from - the server. - To detach the volume from your server, pass the - server ID and volume ID to the command, as - follows: - $ nova volume-detach 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 573e024d-5235-49ce-8332-be1576d323f8 - The volume-detach command does - not return any output. - - - List volumes: - $ cinder list - +--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ -| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to | -+--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ -| 573e024d-5235-49ce-8332-be1576d323f8 | available | my-new-volume | 8 | None | true | | -| bd7cf584-45de-44e3-bf7f-f7b50bf235e3 | available | my-bootable-vol | 8 | None | true | | -+--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ - Note that the volume is now available. - - - Now you can delete the volume, as follows: - $ cinder delete my-new-volume - The delete command does not return any - output. - - - List the volumes again, and note that the status of - your volume is deleting: - $ cinder list - +--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ -| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to | -+--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ -| 573e024d-5235-49ce-8332-be1576d323f8 | deleting | my-new-volume | 8 | None | true | | -| bd7cf584-45de-44e3-bf7f-f7b50bf235e3 | available | my-bootable-vol | 8 | None | true | | -+--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ - When the volume is fully deleted, it disappears from - the list of volumes: - $ cinder list - +--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ -| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to | -+--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ -| bd7cf584-45de-44e3-bf7f-f7b50bf235e3 | available | my-bootable-vol | 8 | None | true | | -+--------------------------------------+-----------+-----------------+------+-------------+----------+-------------+ - - -
diff --git a/doc/user-guide/section_cli_heat.xml b/doc/user-guide/section_cli_heat.xml new file mode 100644 index 0000000000..1c7d431b08 --- /dev/null +++ b/doc/user-guide/section_cli_heat.xml @@ -0,0 +1,126 @@ + +
+ + Create and manage stacks +
+ Create a stack from an example template file + + + To create a stack, or template, from an example template file, run the following + command: + $ heat stack-create mystack --template-file=/PATH_TO_HEAT_TEMPLATES/WordPress_Single_Instance.template + --parameters="InstanceType=m1.large;DBUsername=USERNAME;DBPassword=PASSWORD;KeyName=HEAT_KEY;LinuxDistribution=F17" + The --parameters values that + you specify depend on the parameters that are defined + in the template. If a website hosts the template file, you can specify the URL with the + --template-url parameter + instead of the --template-file + parameter. + The command returns the following output: + +--------------------------------------+---------------+--------------------+----------------------+ +| id | stack_name | stack_status | creation_time | ++--------------------------------------+---------------+--------------------+----------------------+ +| 4c712026-dcd5-4664-90b8-0915494c1332 | mystack | CREATE_IN_PROGRESS | 2013-04-03T23:22:08Z | ++--------------------------------------+---------------+--------------------+----------------------+ + + + You can also use the + stack-create command to + validate a template file without creating a stack + from it. + To do so, run the following command: + $ heat stack-create mystack --template-file=/PATH_TO_HEAT_TEMPLATES/WordPress_Single_Instance.template + If validation fails, the response returns an + error message. + + +
+
+ Get information about stacks + To explore the state and history of a particular stack, + you can run a number of commands. + + + To see which stacks are visible to the current + user, run the following command: + $ heat stack-list ++--------------------------------------+---------------+-----------------+----------------------+ +| id | stack_name | stack_status | creation_time | ++--------------------------------------+---------------+-----------------+----------------------+ +| 4c712026-dcd5-4664-90b8-0915494c1332 | mystack | CREATE_COMPLETE | 2013-04-03T23:22:08Z | +| 7edc7480-bda5-4e1c-9d5d-f567d3b6a050 | my-otherstack | CREATE_FAILED | 2013-04-03T23:28:20Z | ++--------------------------------------+---------------+-----------------+----------------------+ + + + To show the details of a stack, run the + following command: + $ heat stack-show mystack + + + A stack consists of a collection of + resources. + To list the resources and their status, run the + following command: + $ heat resource-list mystack ++---------------------+--------------------+-----------------+----------------------+ +| logical_resource_id | resource_type | resource_status | updated_time | ++---------------------+--------------------+-----------------+----------------------+ +| WikiDatabase | AWS::EC2::Instance | CREATE_COMPLETE | 2013-04-03T23:25:56Z | ++---------------------+--------------------+-----------------+----------------------+ + + + To show the details for the specified resource + in a stack, run the following command: + $ heat resource-show mystack WikiDatabase + Some resources have associated metadata which + can change throughout the life-cycle of a + resource: + $ heat resource-metadata mystack WikiDatabase + + + A series of events is generated during the + life-cycle of a stack. + To display life-cycle events, run:: + $ heat event-list mystack ++---------------------+----+------------------------+-----------------+----------------------+ +| logical_resource_id | id | resource_status_reason | resource_status | event_time | ++---------------------+----+------------------------+-----------------+----------------------+ +| WikiDatabase | 1 | state changed | IN_PROGRESS | 2013-04-03T23:22:09Z | +| WikiDatabase | 2 | state changed | CREATE_COMPLETE | 2013-04-03T23:25:56Z | ++---------------------+----+------------------------+-----------------+----------------------+ + + + To show the details for a particular event, run + the following command: + $ heat event-show WikiDatabase 1 + + +
+
+ Update a stack + + + To update an existing stack from a modified + template file, run a command like the following + command: + $ heat stack-update mystack --template-file=/path/to/heat/templates/WordPress_Single_Instance_v2.template + --parameters="InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17" ++--------------------------------------+---------------+-----------------+----------------------+ +| id | stack_name | stack_status | creation_time | ++--------------------------------------+---------------+-----------------+----------------------+ +| 4c712026-dcd5-4664-90b8-0915494c1332 | mystack | UPDATE_COMPLETE | 2013-04-03T23:22:08Z | +| 7edc7480-bda5-4e1c-9d5d-f567d3b6a050 | my-otherstack | CREATE_FAILED | 2013-04-03T23:28:20Z | ++--------------------------------------+---------------+-----------------+----------------------+ + Some resources are updated in-place, while + others are replaced with new resources. + + +
+
diff --git a/doc/user-guide/section_heat_cli.xml b/doc/user-guide/section_heat_cli.xml deleted file mode 100644 index 35c2677ba1..0000000000 --- a/doc/user-guide/section_heat_cli.xml +++ /dev/null @@ -1,108 +0,0 @@ - -
- Create and manage stacks -
Create a stack from an example template file - - - To create a stack, or template, from an example template - file, run following command: - $ heat stack-create mystack --template-file=/path/to/heat/templates/WordPress_Single_Instance.template \ - --parameters="InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17" -The --parameters values that you specify - depend on which parameters are defined in the - template. If the template file is hosted on a website, - you can specify the URL with - --template-url parameter - instead of the --template-file - parameter. - The command returns the following output: - +--------------------------------------+---------------+--------------------+----------------------+ -| id | stack_name | stack_status | creation_time | -+--------------------------------------+---------------+--------------------+----------------------+ -| 4c712026-dcd5-4664-90b8-0915494c1332 | mystack | CREATE_IN_PROGRESS | 2013-04-03T23:22:08Z | -+--------------------------------------+---------------+--------------------+----------------------+ - - - You can also use the stack-create - command to validate a template file without creating a - stack from it. - To do so, run the following command: - $ heat stack-create mystack --template-file=/path/to/heat/templates/WordPress_Single_Instance.template - If validation fails, the response returns an error - message. - - -
-
Get information about stacks -To explore the state and history of a particular stack, you can - run a number of commands. - - - To see which stacks are visible to the current user, - run the following command: - $ heat stack-list+--------------------------------------+---------------+-----------------+----------------------+ -| id | stack_name | stack_status | creation_time | -+--------------------------------------+---------------+-----------------+----------------------+ -| 4c712026-dcd5-4664-90b8-0915494c1332 | mystack | CREATE_COMPLETE | 2013-04-03T23:22:08Z | -| 7edc7480-bda5-4e1c-9d5d-f567d3b6a050 | my-otherstack | CREATE_FAILED | 2013-04-03T23:28:20Z | -+--------------------------------------+---------------+-----------------+----------------------+ - - - - To show the details of a stack, run the following - command: - $ heat stack-show mystack - A stack consists of a collection of resources. To list the - resources and their status, run the following - command: - $ heat resource-list mystack -+---------------------+--------------------+-----------------+----------------------+ -| logical_resource_id | resource_type | resource_status | updated_time | -+---------------------+--------------------+-----------------+----------------------+ -| WikiDatabase | AWS::EC2::Instance | CREATE_COMPLETE | 2013-04-03T23:25:56Z | -+---------------------+--------------------+-----------------+----------------------+ - - - To show the details for the specified resource in a - stack, run the following command: - $ heat resource-show mystack WikiDatabase - Some resources have associated metadata which can - change throughout the life-cycle of a resource: - $ heat resource-metadata mystack WikiDatabase - A series of events is generated during the life-cycle of a - stack. This command displays those events: - $ heat event-list mystack+---------------------+----+------------------------+-----------------+----------------------+ -| logical_resource_id | id | resource_status_reason | resource_status | event_time | -+---------------------+----+------------------------+-----------------+----------------------+ -| WikiDatabase | 1 | state changed | IN_PROGRESS | 2013-04-03T23:22:09Z | -| WikiDatabase | 2 | state changed | CREATE_COMPLETE | 2013-04-03T23:25:56Z | -+---------------------+----+------------------------+-----------------+----------------------+ - To show the details for a particular event, run the following - command: - $ heat event-show WikiDatabase 1 - - -
-
Update stacks - - - To update an existing stack from a modified template - file, run the following command:$ heat stack-update mystack --template-file=/path/to/heat/templates/WordPress_Single_Instance_v2.template - --parameters="InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17"+--------------------------------------+---------------+-----------------+----------------------+ -| id | stack_name | stack_status | creation_time | -+--------------------------------------+---------------+-----------------+----------------------+ -| 4c712026-dcd5-4664-90b8-0915494c1332 | mystack | UPDATE_COMPLETE | 2013-04-03T23:22:08Z | -| 7edc7480-bda5-4e1c-9d5d-f567d3b6a050 | my-otherstack | CREATE_FAILED | 2013-04-03T23:28:20Z | -+--------------------------------------+---------------+-----------------+----------------------+ - Some resources are updated in-place, while others - are replaced with new resources. - - -
-
diff --git a/doc/user-guide/section_swift_cli_howto.xml b/doc/user-guide/section_swift_cli_howto.xml index 24d1466d3e..e33206cceb 100644 --- a/doc/user-guide/section_swift_cli_howto.xml +++ b/doc/user-guide/section_swift_cli_howto.xml @@ -6,33 +6,35 @@ version="5.0" xml:id="managing-openstack-object-storage-with-swift-cli"> Manage object storage - The OpenStack Object Storage service provides the swift - command-line interface (CLI) that enables you to gather - statistics, list items, update metadata, upload, download, and - delete files. This client is based on the native swift client - library, client.py, which seamlessly - re-authenticates if the current token expires during - processing, retries operations multiple times, and provides a - processing concurrency of 10. + The Object Storage service provides the + swift command-line interface (CLI) that + enables you to gather statistics, list items, update metadata, + upload, download, and delete files. This client is based on + the native swift client library, client.py, + which seamlessly re-authenticates if the current token expires + during processing, retries operations multiple times, and + provides a processing concurrency of 10. Users have roles on accounts. For example, the admin role enables full access to all containers and objects in an account. - You can set access control lists (ACLs) are set at the container level + You can set access control lists (ACLs) at the container level and support lists for read and write access, which are set with the X-Container-Read and X-Container-Write header respectively. - You can use the swift client to set the ACLs by using the - post subcommand with the -r parameter for the read access and - -w option for the write access. The following example enables the testuser user - to read objects in the container: + You can use the swift client to set + the ACLs by using the post subcommand with + the -r parameter for the read access + and -w parameter for the write access. + The following example enables the testuser + user to read objects in the container: $ swift post -r 'testuser' You can also use this command with a list of users. - If you use the StaticWeb middleware to enable - OpenStack Object Storage to serve public web content, - be aware of the ACL syntax for - managing allowed referrers. The syntax is .r: - followed by a list of allowed referrers. For example, - the following command gives object access to all referring domains access: + If you use the StaticWeb middleware to enable Object + Storage to serve public web content, the syntax for allowed + referrers is .r: followed by a list of + allowed referrers. + The following command gives object access to all referring + domains: $ swift post -r '.r:*'