From ab9fbb5698b0668f09077219c67aae06e140bc50 Mon Sep 17 00:00:00 2001 From: "Tullis, Michael L" Date: Fri, 20 Nov 2015 10:31:23 -0600 Subject: [PATCH] Minor formatting and non-technical text corrections to these files: - OpenStack Dashboard - OpenStack Block Storage - OpenStack Orchestration - OpenStack Networking - OpenStack Telemetry --- source/openstack_block_storage.rst | 8 +- source/openstack_dashboard.rst | 2 +- source/openstack_networking.rst | 6 +- source/openstack_orchestration.rst | 257 ++++++++++++++--------------- source/openstack_telemetry.rst | 74 ++++----- 5 files changed, 166 insertions(+), 181 deletions(-) diff --git a/source/openstack_block_storage.rst b/source/openstack_block_storage.rst index 533d3214..296b6550 100644 --- a/source/openstack_block_storage.rst +++ b/source/openstack_block_storage.rst @@ -3,10 +3,10 @@ Block Storage ######################## -The OpenStack Block Storage service (cinder) adds persistent storage to +The OpenStack* Block Storage service (cinder) adds persistent storage to a virtual machine. Block Storage provides an infrastructure for managing volumes, and interacts with OpenStack Compute to provide volumes for -instances. The service also enables management of volume snapshots, and +instances. The service also enables management of volume snapshots and volume types. Install and configure controller node @@ -96,9 +96,9 @@ must create a database, service credentials, and API endpoints. | type | volumev2 | +-------------+----------------------------------+ - .. note:: + .. note:: - The Block Storage services requires two service entities. + The Block Storage services requires two service entities. #. Create the Block Storage service API endpoints:: diff --git a/source/openstack_dashboard.rst b/source/openstack_dashboard.rst index 4fb4d816..a77d3c28 100644 --- a/source/openstack_dashboard.rst +++ b/source/openstack_dashboard.rst @@ -3,7 +3,7 @@ Dashboard #################### -The OpenStack Dashboard, also known as Horizon, is a web-based interface +The OpenStack* Dashboard, also known as Horizon, is a web-based interface for cloud administrators and users to manage various OpenStack resources and services. diff --git a/source/openstack_networking.rst b/source/openstack_networking.rst index 58ab2cfb..4d302cea 100644 --- a/source/openstack_networking.rst +++ b/source/openstack_networking.rst @@ -62,7 +62,7 @@ database, service credentials, and an API endpoint. $ openstack role add --project service --user neutron admin - Note: This command provides no output. + Note: This command provides no output. * Create the ``neutron`` service entity:: @@ -365,8 +365,8 @@ The Layer-3 (L3) agent provides routing and NAT services for virtual networks. interface_driver = neutron.agent.linux.interface.BridgeInterfaceDriver external_network_bridge = - Note: The ``external_network_bridge`` option intentionally lacks a value to - enable multiple external networks on a single agent. + Note: The ``external_network_bridge`` option intentionally lacks a value to + enable multiple external networks on a single agent. Configure the DHCP agent ~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/openstack_orchestration.rst b/source/openstack_orchestration.rst index 75c2e90c..b047c2b0 100644 --- a/source/openstack_orchestration.rst +++ b/source/openstack_orchestration.rst @@ -1,16 +1,17 @@ .. _openstack_orchestration: -OpenStack* Orchestration +Orchestration ############################################################ -The Orchestration service provides a template-based orchestration for -describing a cloud application by running OpenStack* API calls to generate +The OpenStack* Orchestration service provides a template-based orchestration for +describing a cloud application by running OpenStack API calls to generate running cloud applications. The software integrates other core components of -OpenStack* into a one-file template system. -The templates allow you to create most OpenStack* resource types, such as +OpenStack into a one-file template system. + +The templates allow you to create most OpenStack resource types, such as instances, floating IPs, volumes, security groups and users. It also provides advanced functionality, such as instance high availability, instance -auto-scaling, and nested stacks. This enables OpenStack* core projects to +auto-scaling, and nested stacks. This enables OpenStack core projects to receive a larger user base. Installing and configuring controller node @@ -71,145 +72,129 @@ database, service credentials, and API endpoints. $ openstack role add --project service --user heat admin - * Create the ``heat`` and ``heat-cfn`` service entities: + * Create the ``heat`` and ``heat-cfn`` service entities:: - * :: + $ openstack service create --name heat \ + --description "Orchestration" orchestration + +-------------+----------------------------------+ + | Field | Value | + +-------------+----------------------------------+ + | description | Orchestration | + | enabled | True | + | id | 727841c6f5df4773baa4e8a5ae7d72eb | + | name | heat | + | type | orchestration | + +-------------+----------------------------------+ - $ openstack service create --name heat \ - --description "Orchestration" orchestration - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | Orchestration | - | enabled | True | - | id | 727841c6f5df4773baa4e8a5ae7d72eb | - | name | heat | - | type | orchestration | - +-------------+----------------------------------+ + $ openstack service create --name heat-cfn \ + --description "Orchestration" cloudformation + +-------------+----------------------------------+ + | Field | Value | + +-------------+----------------------------------+ + | description | Orchestration | + | enabled | True | + | id | c42cede91a4e47c3b10c8aedc8d890c6 | + | name | heat-cfn | + | type | cloudformation | + +-------------+----------------------------------+ - * :: +#. Create the Orchestration service API endpoints:: - $ openstack service create --name heat-cfn \ - --description "Orchestration" cloudformation - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | Orchestration | - | enabled | True | - | id | c42cede91a4e47c3b10c8aedc8d890c6 | - | name | heat-cfn | - | type | cloudformation | - +-------------+----------------------------------+ + $ openstack endpoint create --region RegionOne \ + orchestration public http://controller:8004/v1/%\(tenant_id\)s + +--------------+-----------------------------------------+ + | Field | Value | + +--------------+-----------------------------------------+ + | enabled | True | + | id | 3f4dab34624e4be7b000265f25049609 | + | interface | public | + | region | RegionOne | + | region_id | RegionOne | + | service_id | 727841c6f5df4773baa4e8a5ae7d72eb | + | service_name | heat | + | service_type | orchestration | + | url | http://controller:8004/v1/%(tenant_id)s | + +--------------+-----------------------------------------+ -#. Create the Orchestration service API endpoints: + $ openstack endpoint create --region RegionOne \ + orchestration internal http://controller:8004/v1/%\(tenant_id\)s + +--------------+-----------------------------------------+ + | Field | Value | + +--------------+-----------------------------------------+ + | enabled | True | + | id | 9489f78e958e45cc85570fec7e836d98 | + | interface | internal | + | region | RegionOne | + | region_id | RegionOne | + | service_id | 727841c6f5df4773baa4e8a5ae7d72eb | + | service_name | heat | + | service_type | orchestration | + | url | http://controller:8004/v1/%(tenant_id)s | + +--------------+-----------------------------------------+ - * :: + $ openstack endpoint create --region RegionOne \ + orchestration admin http://controller:8004/v1/%\(tenant_id\)s + +--------------+-----------------------------------------+ + | Field | Value | + +--------------+-----------------------------------------+ + | enabled | True | + | id | 76091559514b40c6b7b38dde790efe99 | + | interface | admin | + | region | RegionOne | + | region_id | RegionOne | + | service_id | 727841c6f5df4773baa4e8a5ae7d72eb | + | service_name | heat | + | service_type | orchestration | + | url | http://controller:8004/v1/%(tenant_id)s | + +--------------+-----------------------------------------+ - $ openstack endpoint create --region RegionOne \ - orchestration public http://controller:8004/v1/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | 3f4dab34624e4be7b000265f25049609 | - | interface | public | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 727841c6f5df4773baa4e8a5ae7d72eb | - | service_name | heat | - | service_type | orchestration | - | url | http://controller:8004/v1/%(tenant_id)s | - +--------------+-----------------------------------------+ + $ openstack endpoint create --region RegionOne \ + cloudformation public http://controller:8000/v1 + +--------------+----------------------------------+ + | Field | Value | + +--------------+----------------------------------+ + | enabled | True | + | id | b3ea082e019c4024842bf0a80555052c | + | interface | public | + | region | RegionOne | + | region_id | RegionOne | + | service_id | c42cede91a4e47c3b10c8aedc8d890c6 | + | service_name | heat-cfn | + | service_type | cloudformation | + | url | http://controller:8000/v1 | + +--------------+----------------------------------+ - * :: + $ openstack endpoint create --region RegionOne \ + cloudformation internal http://controller:8000/v1 + +--------------+----------------------------------+ + | Field | Value | + +--------------+----------------------------------+ + | enabled | True | + | id | 169df4368cdc435b8b115a9cb084044e | + | interface | internal | + | region | RegionOne | + | region_id | RegionOne | + | service_id | c42cede91a4e47c3b10c8aedc8d890c6 | + | service_name | heat-cfn | + | service_type | cloudformation | + | url | http://controller:8000/v1 | + +--------------+----------------------------------+ - $ openstack endpoint create --region RegionOne \ - orchestration internal http://controller:8004/v1/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | 9489f78e958e45cc85570fec7e836d98 | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 727841c6f5df4773baa4e8a5ae7d72eb | - | service_name | heat | - | service_type | orchestration | - | url | http://controller:8004/v1/%(tenant_id)s | - +--------------+-----------------------------------------+ - - * :: - - $ openstack endpoint create --region RegionOne \ - orchestration admin http://controller:8004/v1/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | 76091559514b40c6b7b38dde790efe99 | - | interface | admin | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 727841c6f5df4773baa4e8a5ae7d72eb | - | service_name | heat | - | service_type | orchestration | - | url | http://controller:8004/v1/%(tenant_id)s | - +--------------+-----------------------------------------+ - - * :: - - $ openstack endpoint create --region RegionOne \ - cloudformation public http://controller:8000/v1 - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | b3ea082e019c4024842bf0a80555052c | - | interface | public | - | region | RegionOne | - | region_id | RegionOne | - | service_id | c42cede91a4e47c3b10c8aedc8d890c6 | - | service_name | heat-cfn | - | service_type | cloudformation | - | url | http://controller:8000/v1 | - +--------------+----------------------------------+ - - * :: - - $ openstack endpoint create --region RegionOne \ - cloudformation internal http://controller:8000/v1 - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 169df4368cdc435b8b115a9cb084044e | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | c42cede91a4e47c3b10c8aedc8d890c6 | - | service_name | heat-cfn | - | service_type | cloudformation | - | url | http://controller:8000/v1 | - +--------------+----------------------------------+ - - * :: - - $ openstack endpoint create --region RegionOne \ - cloudformation admin http://controller:8000/v1 - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 3d3edcd61eb343c1bbd629aa041ff88b | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | c42cede91a4e47c3b10c8aedc8d890c6 | - | service_name | heat-cfn | - | service_type | cloudformation | - | url | http://controller:8000/v1 | - +--------------+----------------------------------+ + $ openstack endpoint create --region RegionOne \ + cloudformation admin http://controller:8000/v1 + +--------------+----------------------------------+ + | Field | Value | + +--------------+----------------------------------+ + | enabled | True | + | id | 3d3edcd61eb343c1bbd629aa041ff88b | + | interface | internal | + | region | RegionOne | + | region_id | RegionOne | + | service_id | c42cede91a4e47c3b10c8aedc8d890c6 | + | service_name | heat-cfn | + | service_type | cloudformation | + | url | http://controller:8000/v1 | + +--------------+----------------------------------+ #. Orchestration requires additional information in the Identity service to manage stacks. To add this information, complete these steps: diff --git a/source/openstack_telemetry.rst b/source/openstack_telemetry.rst index 37588037..1ddd62a1 100644 --- a/source/openstack_telemetry.rst +++ b/source/openstack_telemetry.rst @@ -1,22 +1,22 @@ .. _openstack_telemetry: -OpenStack* Telemetry +Telemetry ############################################################ Overview --------- -The Telemetry service performs the following functions: +The OpenStack* Telemetry service performs the following functions: -- Efficiently polls metering data related to OpenStack services; +- Efficiently polls metering data related to OpenStack services - Collects event and metering data by monitoring notifications sent - from services; + from services - Publishes collected data to various targets, including data stores - and message queues; -- Creates alarms when collected data breaks defined rules. + and message queues +- Creates alarms when collected data breaks defined rules -Installing and configure ------------------------- +Installing and configuring +--------------------------- This section describes how to install and configure the Telemetry service, code-named ceilometer, on the controller node. The Telemetry @@ -88,21 +88,21 @@ endpoint. * Add the ``admin`` role to the ``ceilometer`` user:: - $ openstack role add --project service --user ceilometer admin + $ openstack role add --project service --user ceilometer admin * Create the ``ceilometer`` service entity:: - $ openstack service create --name ceilometer \ - --description "Telemetry" metering - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | Telemetry | - | enabled | True | - | id | 3405453b14da441ebb258edfeba96d83 | - | name | ceilometer | - | type | metering | - +-------------+----------------------------------+ + $ openstack service create --name ceilometer \ + --description "Telemetry" metering + +-------------+----------------------------------+ + | Field | Value | + +-------------+----------------------------------+ + | description | Telemetry | + | enabled | True | + | id | 3405453b14da441ebb258edfeba96d83 | + | name | ceilometer | + | type | metering | + +-------------+----------------------------------+ #. Create the Telemetry service API endpoints:: @@ -190,15 +190,15 @@ Install and configure components with the password you chose for the ``openstack`` account in RabbitMQ:: - [DEFAULT] - ... - rpc_backend = rabbit - - [oslo_messaging_rabbit] - ... - rabbit_host = controller - rabbit_userid = openstack - rabbit_password = RABBIT_PASS + [DEFAULT] + ... + rpc_backend = rabbit + + [oslo_messaging_rabbit] + ... + rabbit_host = controller + rabbit_userid = openstack + rabbit_password = RABBIT_PASS * In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, configure Identity service access. Replace *CEILOMETER_PASS* @@ -224,14 +224,14 @@ Install and configure components credentials. Replace *CEILOMETER_PASS* with the password you chose for the ``ceilometer`` user in the Identity service:: - [service_credentials] - ... - os_auth_url = http://controller:5000/v2.0 - os_username = ceilometer - os_tenant_name = service - os_password = CEILOMETER_PASS - os_endpoint_type = internalURL - os_region_name = RegionOne + [service_credentials] + ... + os_auth_url = http://controller:5000/v2.0 + os_username = ceilometer + os_tenant_name = service + os_password = CEILOMETER_PASS + os_endpoint_type = internalURL + os_region_name = RegionOne * Ensure files have proper ownership by running the following command::