[Docs] Simplify structure of operations guide

This is a first step towards inclusion of the major upgrades
into the operations guide.

Change-Id: I9bf9fc496a5f1a21270aa70723d1f257e88610f9
This commit is contained in:
Jean-Philippe Evrard 2018-02-17 10:32:11 +00:00
parent f7e22daa5e
commit c4d221e29b
9 changed files with 145 additions and 160 deletions

View File

@ -10,13 +10,15 @@ For information how to deploy your OpenStack-Ansible cloud, refer to the
for step-by-step instructions on how to deploy the OpenStack packages and
dependencies on your cloud using OpenStack-Ansible.
We recommend that users of this guide have successfully deployed an
OpenStack-Ansible cloud and are able to perform basic operations such as
adding images, booting instances, and attaching volumes.
This guide is recommended for users of a successfully deployed
OpenStack-Ansible cloud. This explains from basic operations such as
adding images, booting instances, and attaching volumes, to the
more complex operations like upgrading.
.. toctree::
:maxdepth: 3
:maxdepth: 1
openstack-firstrun.rst
openstack-operations.rst
maintenance-tasks.rst
monitor-environment.rst

View File

@ -0,0 +1,13 @@
==============================
Verify OpenStack-Ansible Cloud
==============================
This chapter is intended to document basic OpenStack operations to
verify your OpenStack-Ansible deployment.
It explains how CLIs can be used as an admin and a user, to
ensure the well-behavior of your cloud.
.. include:: openstack-operations/verify-deploy.rst
.. include:: openstack-operations/network-service.rst
.. include:: openstack-operations/cli-operations.rst

View File

@ -1,15 +1,12 @@
====================
OpenStack operations
====================
===================
Managing your cloud
===================
This chapter is intended to document basic OpenStack operations tasks that
are integral to the operations support in an OpenStack-Ansible deployment.
.. toctree::
:maxdepth: 2
It explains operations such as managing images, instances, or networks.
openstack-operations/verify-deploy.rst
openstack-operations/cli-operations.rst
openstack-operations/managing-images.rst
openstack-operations/managing-instances.rst
openstack-operations/network-service.rst
.. include:: openstack-operations/managing-images.rst
.. include:: openstack-operations/managing-instances.rst

View File

@ -1,49 +1,11 @@
=========================================
Managing the cloud using the command line
=========================================
Use the command line clients
============================
This section describes some of the more common commands to view and
manage the cloud.
This section describes some of the more common commands to
use your OpenStack cloud.
Log in to any utility container to run the following commands:
List images
~~~~~~~~~~~
The :command:`openstack image list` command shows details about currently
available images:
.. code::
$ openstack image list
+------------------+--------------+--------+
| ID | Name | Status |
+------------------+--------------+--------+
| [ID truncated] | ExaeImage | active |
+------------------+--------------+--------+
List compute services
~~~~~~~~~~~~~~~~~~~~~
The :command:`openstack compute service list` command details the currently
running compute services:
.. code::
$ openstack compute service list
+------------------+------------+----------+---------+-------+----------------------------+
| Binary | Host | Zone | Status | State | Updated_at |
+------------------+------------+----------+---------+-------+----------------------------+
| nova-consoleauth | controller | internal | enabled | up | 2017-02-21T20:25:17.000000 |
| nova-scheduler | controller | internal | enabled | up | 2017-02-21T20:25:18.000000 |
| nova-conductor | controller | internal | enabled | up | 2017-02-21T20:25:20.000000 |
| nova-compute | compute | nova | enabled | up | 2017-02-21T20:25:20.000000 |
+------------------+------------+----------+---------+-------+----------------------------+
List flavors
~~~~~~~~~~~~
Log in to any utility container or install the openstack client on
your machine, and run the following commands:
The **openstack flavor list** command lists the *flavors* that are
available. These are different disk sizes that can be assigned to
@ -62,11 +24,7 @@ images:
| 5 | m1.xlarge | 16384 | 160 | 0 | 8 | True |
+-----+-----------+-------+------+-----------+-------+-----------+
List floating IP addresses
~~~~~~~~~~~~~~~~~~~~~~~~~~
he **openstack floating ip list** command lists the currently
The **openstack floating ip list** command lists the currently
available floating IP addresses and the instances they are
associated with:

View File

@ -1,4 +1,3 @@
===============
Managing images
===============

View File

@ -1,4 +1,3 @@
==================
Managing instances
==================

View File

@ -1,12 +1,5 @@
==================
Networking service
==================
The os_neutron role provides for a lot of flexibility. See the `neutron`_ role
for a full list of all available options.
Adding networks to a newly deployed openstack cloud
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Configure your first networks
=============================
A newly deployed OpenStack-Ansible has no networks by default. If you need to
add networks, you can use the openstack CLI, or you can use the ansible modules
@ -14,36 +7,3 @@ for it.
An example for the latter is in the ``openstack-ansible-ops`` repository,
under the ``openstack-service-setup.yml`` playbook.
Load-Balancer-as-a-Service (LBaaS)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Understand the following characteristics of the OpenStack-Ansible LBaaS
technical preview:
* The preview release is not intended to provide highly scalable or
highly available load balancing services.
* Testing and recommended usage is limited to 10 members in a pool
and no more than 20 pools.
* Virtual load balancers deployed as part of the LBaaS service are
not monitored for availability or performance.
* OpenStack-Ansible enables LBaaS v2 with the default HAProxy-based agent.
* The Octavia agent is not supported.
* Integration with physical load balancer devices is not supported.
* Customers can use API or CLI LBaaS interfaces.
* The Dashboard offers a panel for creating and managing LBaaS load balancers,
listeners, pools, members, and health checks.
* SDN integration is not supported.
Since Mitaka, you can `enable Dashboard (horizon) panels`_ for LBaaS.
Additionally, a deployer can specify a list of servers behind a
listener and reuse that list for another listener. This feature,
called *shared pools*, only applies to customers that have a large
number of listeners (ports) behind a load balancer.
.. _neutron:
https://docs.openstack.org/developer/openstack-ansible-os_neutron
.. _enable Dashboard (horizon) panels:
https://docs.openstack.org/developer/openstack-ansible-os_horizon

View File

@ -1,15 +1,8 @@
===============================
Verifying your cloud deployment
===============================
This is a draft cloud verification page for the proposed
OpenStack-Ansible operations guide.
Verifying your OpenStack-Ansible operation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Check your OpenStack-Ansible cloud
==================================
This chapter goes through the verification steps for a basic operation of
the OpenStack API and dashboard.
the OpenStack API and dashboard, as an administrator.
.. note::
@ -66,47 +59,110 @@ the OpenStack API and dashboard.
.. code::
$ openstack endpoint list
+----------------------------------+-----------+--------------+----------------+---------+-----------+--------------------------------------------------+
| ID | Region | Service Name | Service Type | Enabled | Interface | URL |
+----------------------------------+-----------+--------------+----------------+---------+-----------+--------------------------------------------------+
| 047ba01661334602abdb5cda12c2ef7d | RegionOne | cinderv2 | volumev2 | True | admin | http://172.29.236.100:8776/v2/%(tenant_id)s |
| 0c2e4ed0526e49149b1aeb55a744098e | RegionOne | cinder | volume | True | public | https://10.23.100.127:8776/v1/%(tenant_id)s |
| 0deb2ba5d07e47f0a690429b45213ed6 | RegionOne | aodh | alarming | True | internal | http://172.29.236.100:8042 |
| 0e95096aad824bcbab637add1c418f90 | RegionOne | glance | image | True | public | https://10.23.100.127:9292 |
| 12551bc5ba6b475cae1dd579ddcb4357 | RegionOne | cinderv2 | volumev2 | True | internal | http://172.29.236.100:8776/v2/%(tenant_id)s |
| 1316cd02ca5f4f1790ce7e212a37c2b5 | RegionOne | heat-cfn | cloudformation | True | admin | http://172.29.236.100:8000/v1 |
| 1b54d54397154eca8c030b9294e0ef45 | RegionOne | neutron | network | True | admin | http://172.29.236.100:9696 |
| 1f256cadb4a04cd98a832970d615053c | RegionOne | aodh | alarming | True | public | https://10.23.100.127:8042 |
| 2116a50e1d8c4a3ab0ce1895bbe1fe19 | RegionOne | nova | compute | True | admin | http://172.29.236.100:8774/v2.1/%(tenant_id)s |
| 221c329f609d41d5a86bfa38f6e26b6e | RegionOne | heat-cfn | cloudformation | True | internal | http://172.29.236.100:8000/v1 |
| 2d0468997f584d7a8d48d4b174394e16 | RegionOne | swift | object-store | True | public | https://10.23.100.127:8080/v1/AUTH_%(tenant_id)s |
| 30971d32cc6047f1a68e719e4763a360 | RegionOne | designate | dns | True | admin | http://172.29.236.100:9001 |
| 3243253d50384373b3de8ca7cee03644 | RegionOne | cinderv2 | volumev2 | True | public | https://10.23.100.127:8776/v2/%(tenant_id)s |
| 35ed5b4756bc4e9b84b434d4ef748445 | RegionOne | keystone | identity | True | admin | http://172.29.236.100:35357/v3 |
| 35f2517709154381a85dba6a28f668c6 | RegionOne | ceilometer | metering | True | admin | http://172.29.236.100:8777/ |
| 4879bb2c0fc14de6ba73393a68d4b1dd | RegionOne | nova | compute | True | public | https://10.23.100.127:8774/v2.1/%(tenant_id)s |
| 48ee308e550445a9a4e89e14f3e0f696 | RegionOne | keystone | identity | True | internal | http://172.29.236.100:5000/v3 |
| 4dd6738824af42b499dd0b255bc0b7f8 | RegionOne | nova | compute | True | internal | http://172.29.236.100:8774/v2.1/%(tenant_id)s |
| 547266c8950e406f8c9a5b3e8ea278a3 | RegionOne | gnocchi | metric | True | public | https://10.23.100.127:8041 |
| 58e6317b9b834ba98d7e70ffc22f6be2 | RegionOne | neutron | network | True | internal | http://172.29.236.100:9696 |
| 676237d45bb6415eae4efba01e3f4919 | RegionOne | aodh | alarming | True | admin | http://172.29.236.100:8042 |
| 67b4f58f322b4165b40f41ab372bffec | RegionOne | heat | orchestration | True | admin | http://172.29.236.100:8004/v1/%(tenant_id)s |
| 6bd40e07f13f475db4d795a89b0fcbe7 | RegionOne | glance | image | True | internal | http://172.29.236.100:9292 |
| 760220c89e1c48dfa250f7f5f91035d3 | RegionOne | designate | dns | True | internal | http://172.29.236.100:9001 |
| 7e7dd80831954e6db16d317fb9bd8524 | RegionOne | cinder | volume | True | internal | http://172.29.236.100:8776/v1/%(tenant_id)s |
| 82b7373368c8401a9a1a6347a35e44ab | RegionOne | heat-cfn | cloudformation | True | public | https://10.23.100.127:8000/v1 |
| 90e1bb2aeb7140af83343bd30d05107b | RegionOne | ceilometer | metering | True | public | https://10.23.100.127:8777 |
| 913c22b8664a4108b2e754761132cdb1 | RegionOne | designate | dns | True | public | http://10.23.100.127:9001 |
| 9f593894bd4c4e9293a314dd9b3fe688 | RegionOne | swift | object-store | True | admin | http://172.29.236.100:8080/v1/AUTH_%(tenant_id)s |
| a184a037133845efb501589e5c7cf549 | RegionOne | heat | orchestration | True | internal | http://172.29.236.100:8004/v1/%(tenant_id)s |
| a23c4e39cdae4cd3b5976dd163eb722a | RegionOne | ceilometer | metering | True | internal | http://172.29.236.100:8777 |
| af34e48f4ed74e44984e9c5de1900cbe | RegionOne | cinder | volume | True | admin | http://172.29.236.100:8776/v1/%(tenant_id)s |
| b0d88d7eb5c84cb69ef39405d8121ca9 | RegionOne | swift | object-store | True | internal | http://172.29.236.100:8080/v1/AUTH_%(tenant_id)s |
| b110eea649a244c0bb3276ae05335e0e | RegionOne | neutron | network | True | public | https://10.23.100.127:9696 |
| bed8df5c8ea643ec9bad01b841618e55 | RegionOne | heat | orchestration | True | public | https://10.23.100.127:8004/v1/%(tenant_id)s |
| c1fc69bf16d2481ca280d84b24d524f7 | RegionOne | gnocchi | metric | True | admin | http://172.29.236.100:8041 |
| e65fafe30d134cba9dd0e4a142fa208c | RegionOne | gnocchi | metric | True | internal | http://172.29.236.100:8041 |
| efe1f79e934d43fcbbb5d3a11e99dfd6 | RegionOne | keystone | identity | True | public | https://10.23.100.127:5000/v3 |
| f4d9e799d4de4635a3d3b66da591841b | RegionOne | glance | image | True | admin | http://172.29.236.100:9292 |
+----------------------------------+-----------+--------------+----------------+---------+-----------+--------------------------------------------------+
+----------------+-----------+--------------+----------------+---------+-----------+--------------------------------------------------+
| ID | Region | Service Name | Service Type | Enabled | Interface | URL |
+----------------+-----------+--------------+----------------+---------+-----------+--------------------------------------------------+
| [ID truncated] | RegionOne | cinderv2 | volumev2 | True | admin | http://172.29.236.100:8776/v2/%(tenant_id)s |
| [ID truncated] | RegionOne | cinder | volume | True | public | https://10.23.100.127:8776/v1/%(tenant_id)s |
| [ID truncated] | RegionOne | aodh | alarming | True | internal | http://172.29.236.100:8042 |
| [ID truncated] | RegionOne | glance | image | True | public | https://10.23.100.127:9292 |
| [ID truncated] | RegionOne | cinderv2 | volumev2 | True | internal | http://172.29.236.100:8776/v2/%(tenant_id)s |
| [ID truncated] | RegionOne | heat-cfn | cloudformation | True | admin | http://172.29.236.100:8000/v1 |
| [ID truncated] | RegionOne | neutron | network | True | admin | http://172.29.236.100:9696 |
| [ID truncated] | RegionOne | aodh | alarming | True | public | https://10.23.100.127:8042 |
| [ID truncated] | RegionOne | nova | compute | True | admin | http://172.29.236.100:8774/v2.1/%(tenant_id)s |
| [ID truncated] | RegionOne | heat-cfn | cloudformation | True | internal | http://172.29.236.100:8000/v1 |
| [ID truncated] | RegionOne | swift | object-store | True | public | https://10.23.100.127:8080/v1/AUTH_%(tenant_id)s |
| [ID truncated] | RegionOne | designate | dns | True | admin | http://172.29.236.100:9001 |
| [ID truncated] | RegionOne | cinderv2 | volumev2 | True | public | https://10.23.100.127:8776/v2/%(tenant_id)s |
| [ID truncated] | RegionOne | keystone | identity | True | admin | http://172.29.236.100:35357/v3 |
| [ID truncated] | RegionOne | ceilometer | metering | True | admin | http://172.29.236.100:8777/ |
| [ID truncated] | RegionOne | nova | compute | True | public | https://10.23.100.127:8774/v2.1/%(tenant_id)s |
| [ID truncated] | RegionOne | keystone | identity | True | internal | http://172.29.236.100:5000/v3 |
| [ID truncated] | RegionOne | nova | compute | True | internal | http://172.29.236.100:8774/v2.1/%(tenant_id)s |
| [ID truncated] | RegionOne | gnocchi | metric | True | public | https://10.23.100.127:8041 |
| [ID truncated] | RegionOne | neutron | network | True | internal | http://172.29.236.100:9696 |
| [ID truncated] | RegionOne | aodh | alarming | True | admin | http://172.29.236.100:8042 |
| [ID truncated] | RegionOne | heat | orchestration | True | admin | http://172.29.236.100:8004/v1/%(tenant_id)s |
| [ID truncated] | RegionOne | glance | image | True | internal | http://172.29.236.100:9292 |
| [ID truncated] | RegionOne | designate | dns | True | internal | http://172.29.236.100:9001 |
| [ID truncated] | RegionOne | cinder | volume | True | internal | http://172.29.236.100:8776/v1/%(tenant_id)s |
| [ID truncated] | RegionOne | heat-cfn | cloudformation | True | public | https://10.23.100.127:8000/v1 |
| [ID truncated] | RegionOne | ceilometer | metering | True | public | https://10.23.100.127:8777 |
| [ID truncated] | RegionOne | designate | dns | True | public | http://10.23.100.127:9001 |
| [ID truncated] | RegionOne | swift | object-store | True | admin | http://172.29.236.100:8080/v1/AUTH_%(tenant_id)s |
| [ID truncated] | RegionOne | heat | orchestration | True | internal | http://172.29.236.100:8004/v1/%(tenant_id)s |
| [ID truncated] | RegionOne | ceilometer | metering | True | internal | http://172.29.236.100:8777 |
| [ID truncated] | RegionOne | cinder | volume | True | admin | http://172.29.236.100:8776/v1/%(tenant_id)s |
| [ID truncated] | RegionOne | swift | object-store | True | internal | http://172.29.236.100:8080/v1/AUTH_%(tenant_id)s |
| [ID truncated] | RegionOne | neutron | network | True | public | https://10.23.100.127:9696 |
| [ID truncated] | RegionOne | heat | orchestration | True | public | https://10.23.100.127:8004/v1/%(tenant_id)s |
| [ID truncated] | RegionOne | gnocchi | metric | True | admin | http://172.29.236.100:8041 |
| [ID truncated] | RegionOne | gnocchi | metric | True | internal | http://172.29.236.100:8041 |
| [ID truncated] | RegionOne | keystone | identity | True | public | https://10.23.100.127:5000/v3 |
| [ID truncated] | RegionOne | glance | image | True | admin | http://172.29.236.100:9292 |
+----------------+-----------+--------------+----------------+---------+-----------+--------------------------------------------------+
#. Run an OpenStack command to ensure all the compute services are
working (the output depends on your configuration)
For example:
.. code::
$ openstack compute service list
+----+------------------+----------------------------------------+----------+---------+-------+----------------------------+
| ID | Binary | Host | Zone | Status | State | Updated At |
+----+------------------+----------------------------------------+----------+---------+-------+----------------------------+
| 1 | nova-conductor | aio1-nova-conductor-container-5482ff27 | internal | enabled | up | 2018-02-14T15:34:42.000000 |
| 2 | nova-scheduler | aio1-nova-scheduler-container-0b594e89 | internal | enabled | up | 2018-02-14T15:34:47.000000 |
| 5 | nova-consoleauth | aio1-nova-console-container-835ca240 | internal | enabled | up | 2018-02-14T15:34:47.000000 |
| 6 | nova-compute | ubuntu-xenial | nova | enabled | up | 2018-02-14T15:34:42.000000 |
+----+------------------+----------------------------------------+----------+---------+-------+----------------------------+
#. Run an OpenStack command to ensure the networking services are
working (the output also depends on your configuration)
For example:
.. code::
$ openstack network agent list
+--------------------------------------+----------------------+----------------------------------------+-------------------+-------+-------+---------------------------+
| ID | Agent Type | Host | Availability Zone | Alive | State | Binary |
+--------------------------------------+----------------------+----------------------------------------+-------------------+-------+-------+---------------------------+
| 262b29fe-e60e-44b0-ae3c-065565f8deb7 | Metering agent | aio1-neutron-agents-container-2b0569d5 | None | :-) | UP | neutron-metering-agent |
| 3f305216-46ea-42c4-9f9f-9910f58323ea | Loadbalancerv2 agent | aio1-neutron-agents-container-2b0569d5 | None | :-) | UP | neutron-lbaasv2-agent |
| 41135f7f-9e6c-4122-b6b3-d131bfaae53e | Linux bridge agent | ubuntu-xenial | None | :-) | UP | neutron-linuxbridge-agent |
| 615d12a8-e738-490a-8552-2a03c8544b51 | Metadata agent | aio1-neutron-agents-container-2b0569d5 | None | :-) | UP | neutron-metadata-agent |
| 99b2abd3-a330-4ca7-b524-ed176c10b31c | DHCP agent | aio1-neutron-agents-container-2b0569d5 | nova | :-) | UP | neutron-dhcp-agent |
| e0139a26-fbf7-4cee-a37f-90940dc5851f | Linux bridge agent | aio1-neutron-agents-container-2b0569d5 | None | :-) | UP | neutron-linuxbridge-agent |
| feb20ed4-4346-4ad9-b50c-41efd784f2e9 | L3 agent | aio1-neutron-agents-container-2b0569d5 | nova | :-) | UP | neutron-l3-agent |
+--------------------------------------+----------------------+----------------------------------------+-------------------+-------+-------+---------------------------+
#. Run an OpenStack command to ensure the block storage services are
working (depends on your configuration).
For example:
.. code::
$ openstack volume service list
+------------------+------------------------------------------+------+---------+-------+----------------------------+
| Binary | Host | Zone | Status | State | Updated At |
+------------------+------------------------------------------+------+---------+-------+----------------------------+
| cinder-scheduler | aio1-cinder-scheduler-container-ff4c6c1e | nova | enabled | up | 2018-02-14T15:37:21.000000 |
| cinder-volume | ubuntu-xenial@lvm | nova | enabled | up | 2018-02-14T15:37:25.000000 |
| cinder-backup | ubuntu-xenial | nova | enabled | up | 2018-02-14T15:37:21.000000 |
+------------------+------------------------------------------+------+---------+-------+----------------------------+
#. Run an OpenStack command to ensure the image storage service is
working (depends on your uploaded images).
For example:
.. code::
$ openstack image list
+--------------------------------------+--------+--------+
| ID | Name | Status |
+--------------------------------------+--------+--------+
| 6092d7b3-87c1-4d6c-a822-66c0c6171bd3 | cirros | active |
+--------------------------------------+--------+--------+

File diff suppressed because one or more lines are too long