From 6c1df0aaf6b9e237e522161e04e43b1a0bf4d0fb Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 28 Nov 2015 12:37:16 +0100 Subject: [PATCH] [config-ref] Convert some image-service files Convert some image-service sections from DocBook XML to RST. Update image_service_ISO_support to use a generic description and not a distro specific one that might get outdated. Implements: blueprint config-ref-rst Change-Id: Id522f41c74c68a3b380fb14e512b45d25ed61cb9 --- doc/config-ref-rst/source/image-service.rst | 4 + .../image_service_ISO_support.rst | 28 ++++ .../image-service/image_service_api.rst | 19 +++ .../image-service/image_service_backends.rst | 131 ++++++++++++++++++ .../image-service/image_service_rpc.rst | 18 +++ 5 files changed, 200 insertions(+) create mode 100644 doc/config-ref-rst/source/image-service/image_service_ISO_support.rst create mode 100644 doc/config-ref-rst/source/image-service/image_service_api.rst create mode 100644 doc/config-ref-rst/source/image-service/image_service_backends.rst create mode 100644 doc/config-ref-rst/source/image-service/image_service_rpc.rst diff --git a/doc/config-ref-rst/source/image-service.rst b/doc/config-ref-rst/source/image-service.rst index 764a0ec257..ce8a0a744a 100644 --- a/doc/config-ref-rst/source/image-service.rst +++ b/doc/config-ref-rst/source/image-service.rst @@ -4,4 +4,8 @@ Image service .. toctree:: + image-service/image_service_api.rst + image-service/image_service_rpc.rst + image-service/image_service_ISO_support.rst + image-service/image_service_backends.rst tables/conf-changes/glance.rst diff --git a/doc/config-ref-rst/source/image-service/image_service_ISO_support.rst b/doc/config-ref-rst/source/image-service/image_service_ISO_support.rst new file mode 100644 index 0000000000..42211486d9 --- /dev/null +++ b/doc/config-ref-rst/source/image-service/image_service_ISO_support.rst @@ -0,0 +1,28 @@ +====================== +Support for ISO images +====================== + +You can load ISO images into the Image service. You can subsequently +boot an ISO image using Compute. + +To load an ISO image to an Image service data store +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In the Image service, run the following command: + +.. code-block:: console + + $ glance image-create --name "my-image.iso" \ + --copy-from IMAGE_URL \ + --is-public True --container-format bare --disk-format iso + +In this command, ``my-image.iso`` is the name for the ISO image after +it is loaded to the Image service, and ``IMAGE_URL`` is a remote +location with the URL of the source ISO image. + +Optionally, to confirm the upload in Image service (glance), run this +command: + +.. code-block:: console + + $ glance image-list diff --git a/doc/config-ref-rst/source/image-service/image_service_api.rst b/doc/config-ref-rst/source/image-service/image_service_api.rst new file mode 100644 index 0000000000..e097e03db7 --- /dev/null +++ b/doc/config-ref-rst/source/image-service/image_service_api.rst @@ -0,0 +1,19 @@ +================= +Configure the API +================= + +The Image service has two APIs: the user-facing API, and the registry +API, which is for internal requests that require access to the database. + +Both of the APIs currently have two major versions, v1 and v2. It is +possible to run either or both versions, by setting appropriate values +of ``enable_v1_api``, ``enable_v2_api``, ``enable_v1_registry`` and +``enable_v2_registry``. If the v2 API is used, running +``glance-registry`` is optional, as v2 of ``glance-api`` can connect +directly to the database. + +Tables of all the options used to configure the APIs, including enabling +SSL and modifying WSGI settings are found below. + +.. include:: ../tables/glance-api.rst +.. include:: ../tables/glance-ca.rst diff --git a/doc/config-ref-rst/source/image-service/image_service_backends.rst b/doc/config-ref-rst/source/image-service/image_service_backends.rst new file mode 100644 index 0000000000..c239dd2566 --- /dev/null +++ b/doc/config-ref-rst/source/image-service/image_service_backends.rst @@ -0,0 +1,131 @@ +=================== +Configure back ends +=================== + +The Image service supports several back ends for storing virtual machine +images: + +* OpenStack Block Storage (cinder) +* A directory on a local file system +* GridFS +* Ceph RBD +* Amazon S3 +* Sheepdog +* OpenStack Object Storage (swift) +* VMware ESX + +The following tables detail the options available for each. + +.. include:: ../tables/glance-cinder.rst +.. include:: ../tables/glance-filesystem.rst +.. include:: ../tables/glance-gridfs.rst +.. include:: ../tables/glance-rbd.rst +.. include:: ../tables/glance-s3.rst +.. include:: ../tables/glance-sheepdog.rst +.. include:: ../tables/glance-swift.rst + +Configure vCenter data stores for the Image service back end +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To use vCenter data stores for the Image service back end, you must +update the ``glance-api.conf`` file, as follows: + +- Add data store parameters to the ``VMware Datastore Store Options`` + section. + +- Specify vSphere as the back end. + + .. note:: + + You must configure any configured Image service data stores for + the Compute service. + +You can specify vCenter data stores directly by using the data store +name or Storage Policy Based Management (SPBM), which requires vCenter +Server 5.5 or later. For details, see :ref:`glance-backend-vmware-DS`. + +.. note:: + + If you intend to use multiple data stores for the back end, use the + SPBM feature. + +In the ``glance_store`` section, set the ``default_store`` option to +``vsphere``, as shown in this code sample: + +.. code:: ini + + [glance_store] + # Which back end scheme should Glance use by default is not specified + # in a request to add a new image to Glance? Known schemes are determined + # by the known_stores option below. + # Default: 'file' + default_store = vsphere + +The following table describes the parameters in the +``VMware Datastore Store Options`` section: + +.. include:: ../tables/glance-vmware.rst + +The following block of text shows a sample configuration: + +.. code:: ini + + # ============ VMware Datastore Store Options ===================== + # ESX/ESXi or vCenter Server target system. + # The server value can be an IP address or a DNS name + # e.g. 127.0.0.1, 127.0.0.1:443, www.vmware-infra.com + vmware_server_host = 192.168.0.10 + + # Server username (string value) + vmware_server_username = ADMINISTRATOR + + # Server password (string value) + vmware_server_password = password + + # Inventory path to a datacenter (string value) + # Value optional when vmware_server_ip is an ESX/ESXi host: if specified + # should be `ha-datacenter`. + vmware_datacenter_path = DATACENTER + + # Datastore associated with the datacenter (string value) + vmware_datastore_name = datastore1 + + # PBM service WSDL file location URL. e.g. + # file:///opt/SDK/spbm/wsdl/pbmService.wsdl Not setting this + # will disable storage policy based placement of images. + # (string value) + #vmware_pbm_wsdl_location = + + # The PBM policy. If `pbm_wsdl_location` is set, a PBM policy needs + # to be specified. This policy will be used to select the datastore + # in which the images will be stored. + #vmware_pbm_policy = + + # The interval used for polling remote tasks + # invoked on VMware ESX/VC server in seconds (integer value) + vmware_task_poll_interval = 5 + + # Absolute path of the folder containing the images in the datastore + # (string value) + vmware_store_image_dir = /openstack_glance + + # Allow to perform insecure SSL requests to the target system (boolean value) + vmware_api_insecure = False + +.. _glance-backend-vmware-DS: + +Configure vCenter data stores for the back end +---------------------------------------------- + +You can specify a vCenter data store for the back end by setting the +``vmware_datastore_name`` parameter value to the vCenter name of +the data store. This configuration limits the back end to a single +data store. + +If present, comment or delete the ``vmware_pbm_wsdl_location`` and +``vmware_pbm_policy`` parameters. + +Uncomment and define the ``vmware_datastore_name`` parameter with the +name of the vCenter data store. + +Complete the other vCenter configuration parameters as appropriate. diff --git a/doc/config-ref-rst/source/image-service/image_service_rpc.rst b/doc/config-ref-rst/source/image-service/image_service_rpc.rst new file mode 100644 index 0000000000..717653ce56 --- /dev/null +++ b/doc/config-ref-rst/source/image-service/image_service_rpc.rst @@ -0,0 +1,18 @@ +================================== +Configure the RPC messaging system +================================== + +OpenStack projects use an open standard for messaging middleware known +as AMQP. This messaging middleware enables the OpenStack services that +run on multiple servers to talk to each other. The OpenStack common +library project, oslo, supports three implementations of AMQP: RabbitMQ, +Qpid, and ZeroMQ. + +The following tables contain settings to configure the messaging +middleware for the Image service: + +.. include:: ../tables/glance-zeromq.rst +.. include:: ../tables/glance-amqp.rst +.. include:: ../tables/glance-rpc.rst +.. include:: ../tables/glance-rabbitmq.rst +.. include:: ../tables/glance-qpid.rst