aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-10-03 21:47:37 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2017-10-20 11:40:48 +0800
commit56a673265b4703f80a8fe54d2d29d131da34db36 (patch)
tree0d81f4e9badc0e07ec752bdfba295e31dfad7b0a /docs/release/release-notes
parent595b3bedb76988415eae34c693cf2eac99b68b52 (diff)
Add release note for Euphrates
Change-Id: I673671a6d02fea007aebaa02d027cfdb670cf044 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn> (cherry picked from commit 344c40c9d0bc196dafae385b3c6536ce1640ebfd)
Diffstat (limited to 'docs/release/release-notes')
-rw-r--r--docs/release/release-notes/euphrates.rst137
1 files changed, 137 insertions, 0 deletions
diff --git a/docs/release/release-notes/euphrates.rst b/docs/release/release-notes/euphrates.rst
new file mode 100644
index 00000000..48058e64
--- /dev/null
+++ b/docs/release/release-notes/euphrates.rst
@@ -0,0 +1,137 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+*********
+Euphrates
+*********
+
+This document provides the release notes of QTIP for OPNFV Euphrates release
+
+.. contents::
+ :depth: 3
+ :local:
+
+Version history
+===============
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date** | **Ver.** | **Author** | **Comment** |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+| 2017-10-20 | Euphrates 1.0 | Yujun Zhang | |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+
+Summary
+=======
+
+QTIP Euphrates release continues working on **QPI**, a.k.a. QTIP Performance Index, which is calculated from metrics
+collected in performance tests.
+
+Besides compute performance benchmark, QTIP has integrated OPNFV storperf for storage performance benchmarking.
+
+A PoC of web portal is implemented as the starting point of Benchmarking as a Service.
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project** | QTIP |
+| | |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID** | qtip/euphrates.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | stable version |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | 2017-10-20 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | release with OPNFV cycle |
+| | |
++--------------------------------------+--------------------------------------+
+
+Version change
+--------------
+
+Module version changes
+^^^^^^^^^^^^^^^^^^^^^^
+
+The following Python packages are used in this release::
+
+ humanfriendly==4.4.1
+ connexion==1.1.11
+ Jinja2==2.9.6
+ Django==1.11.5
+ asq==1.2.1
+ six==1.11.0
+ ansible==2.4.0.0
+ requests==2.18.4
+ prettytable==0.7.2
+ numpy==1.13.1
+ click==6.7
+ pbr==3.1.1
+ PyYAML==3.12
+
+It is considered as a baseline for future releases.
+
+Reason for version
+------------------
+
+Features additions
+^^^^^^^^^^^^^^^^^^
+
+* Storage QPI (QTIP Performance Index) specification and benchmarking project
+
+Framework evolution
+^^^^^^^^^^^^^^^^^^^
+
+Ansible is used as the backbone of QTIP framework. Not only the main testing procedure is built as Ansible roles, but
+also the inventory discovery is implemented as Ansible module, the calculation and collection actions are Ansible
+plugins. Even the testing project itself is generated using jinja2 template rendering driven by Ansible.
+
+Deliverables
+------------
+
+Software
+^^^^^^^^
+
+- `QTIP Docker image <https://hub.docker.com/r/opnfv/qtip>`_ (tag: euphrates.1.0)
+
+Documentation
+^^^^^^^^^^^^^
+
+- `Installation & Configuration <http://docs.opnfv.org/en/stable-euphrates/qtip/docs/testing/user/configguide>`_
+- `User Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/qtip/docs/testing/user/userguide>`_
+- `Developer Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/qtip/docs/testing/developer/devguide>`_
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+Limitations
+-----------
+
+- Supporting on legacy OPNFV fuel installer is no longer maintained.
+
+Known issues
+------------
+
+Test Result
+===========
+
+QTIP has undergone QA test runs with the following results:
+
++---------------------------------------------------+--------------------------------------+
+| **TEST-SUITES** | **Results:** |
+| | |
++---------------------------------------------------+--------------------------------------+
+| qtip-verify-euphrates | 53/53 passed, 86% lines coverage |
+| | |
++---------------------------------------------------+--------------------------------------+
+| qtip-compute-apex-euphrates | passed |
+| | |
++---------------------------------------------------+--------------------------------------+
+| qtip-storage-apex-euphrates | passed |
+| | |
++---------------------------------------------------+--------------------------------------+
g.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ } 
heat_template_version: ocata

description: >
  OpenStack Cinder API service configured with Puppet

parameters:
  CinderEnableDBPurge:
    default: true
    description: |
      Whether to create cron job for purging soft deleted rows in Cinder database.
    type: boolean
  CinderPassword:
    description: The password for the cinder service account, used by cinder-api.
    type: string
    hidden: true
  ServiceNetMap:
    default: {}
    description: Mapping of service_name -> network name. Typically set
                 via parameter_defaults in the resource registry.  This
                 mapping overrides those in ServiceNetMapDefaults.
    type: json
  DefaultPasswords:
    default: {}
    type: json
  EndpointMap:
    default: {}
    description: Mapping of service endpoint -> protocol. Typically set
                 via parameter_defaults in the resource registry.
    type: json
  KeystoneRegion:
    type: string
    default: 'regionOne'
    description: Keystone region for endpoint
  MonitoringSubscriptionCinderApi:
    default: 'overcloud-cinder-api'
    type: string
  CinderApiLoggingSource:
    type: json
    default:
      tag: openstack.cinder.api
      path: /var/log/cinder/cinder-api.log
  CinderWorkers:
    type: string
    description: Set the number of workers for cinder::wsgi::apache
    default: '%{::os_workers}'
  EnableInternalTLS:
    type: boolean
    default: false
  CinderApiPolicies:
    description: |
      A hash of policies to configure for Cinder API.
      e.g. { cinder-context_is_admin: { key: context_is_admin, value: 'role:admin' } }
    default: {}
    type: json

conditions:
  cinder_workers_zero: {equals : [{get_param: CinderWorkers}, 0]}

resources:

  ApacheServiceBase:
    type: ./apache.yaml
    properties:
      ServiceNetMap: {get_param: ServiceNetMap}
      DefaultPasswords: {get_param: DefaultPasswords}
      EndpointMap: {get_param: EndpointMap}
      EnableInternalTLS: {get_param: EnableInternalTLS}

  CinderBase:
    type: ./cinder-base.yaml
    properties:
      ServiceNetMap: {get_param: ServiceNetMap}
      DefaultPasswords: {get_param: DefaultPasswords}
      EndpointMap: {get_param: EndpointMap}

outputs:
  role_data:
    description: Role data for the Cinder API role.
    value:
      service_name: cinder_api
      monitoring_subscription: {get_param: MonitoringSubscriptionCinderApi}
      logging_source: {get_param: CinderApiLoggingSource}
      logging_groups:
        - cinder
      config_settings:
        map_merge:
          - get_attr: [CinderBase, role_data, config_settings]
          - get_attr: [ApacheServiceBase, role_data, config_settings]
          - cinder::keystone::authtoken::auth_uri: {get_param: [EndpointMap, KeystoneInternal, uri_no_suffix]}
            cinder::keystone::authtoken::auth_url: {get_param: [EndpointMap, KeystoneInternal, uri_no_suffix]}
            cinder::keystone::authtoken::password: {get_param: CinderPassword}
            cinder::keystone::authtoken::project_name: 'service'
            cinder::keystone::authtoken::user_domain_name: 'Default'
            cinder::keystone::authtoken::project_domain_name: 'Default'
            cinder::policy::policies: {get_param: CinderApiPolicies}
            cinder::api::enable_proxy_headers_parsing: true

            cinder::api::nova_catalog_info: 'compute:nova:internalURL'
            cinder::api::nova_catalog_admin_info: 'compute:nova:adminURL'
            # TODO(emilien) move it to puppet-cinder
            cinder::config:
              DEFAULT/swift_catalog_info:
                value: 'object-store:swift:internalURL'
            tripleo::profile::base::cinder::cinder_enable_db_purge: {get_param: CinderEnableDBPurge}
            tripleo.cinder_api.firewall_rules:
              '119 cinder':
                dport:
                  - 8776
                  - 13776
            cinder::api::bind_host:
              str_replace:
                template:
                  "%{hiera('fqdn_$NETWORK')}"
                params:
                  $NETWORK: {get_param: [ServiceNetMap, CinderApiNetwork]}
            cinder::wsgi::apache::ssl: {get_param: EnableInternalTLS}
            cinder::api::service_name: 'httpd'
            # NOTE: bind IP is found in Heat replacing the network name with the local node IP
            # for the given network; replacement examples (eg. for internal_api):
            # internal_api -> IP
            # internal_api_uri -> [IP]
            # internal_api_subnet - > IP/CIDR
            cinder::wsgi::apache::bind_host: {get_param: [ServiceNetMap, CinderApiNetwork]}
            cinder::wsgi::apache::servername:
              str_replace:
                template:
                  "%{hiera('fqdn_$NETWORK')}"
                params:
                  $NETWORK: {get_param: [ServiceNetMap, CinderApiNetwork]}
          -
            if:
            - cinder_workers_zero
            - {}
            - cinder::wsgi::apache::workers: {get_param: CinderWorkers}
      step_config: |
        include ::tripleo::profile::base::cinder::api
      service_config_settings:
        keystone:
          cinder::keystone::auth::tenant: 'service'
          cinder::keystone::auth::public_url: {get_param: [EndpointMap, CinderPublic, uri]}
          cinder::keystone::auth::internal_url: {get_param: [EndpointMap, CinderInternal, uri]}
          cinder::keystone::auth::admin_url: {get_param: [EndpointMap, CinderAdmin, uri]}
          cinder::keystone::auth::public_url_v2: {get_param: [EndpointMap, CinderV2Public, uri]}
          cinder::keystone::auth::internal_url_v2: {get_param: [EndpointMap, CinderV2Internal, uri]}
          cinder::keystone::auth::admin_url_v2: {get_param: [EndpointMap, CinderV2Admin, uri]}
          cinder::keystone::auth::public_url_v3: {get_param: [EndpointMap, CinderV3Public, uri]}
          cinder::keystone::auth::internal_url_v3: {get_param: [EndpointMap, CinderV3Internal, uri]}
          cinder::keystone::auth::admin_url_v3: {get_param: [EndpointMap, CinderV3Admin, uri]}
          cinder::keystone::auth::password: {get_param: CinderPassword}
          cinder::keystone::auth::region: {get_param: KeystoneRegion}
        mysql:
          cinder::db::mysql::password: {get_param: CinderPassword}
          cinder::db::mysql::user: cinder
          cinder::db::mysql::host: {get_param: [EndpointMap, MysqlInternal, host_nobrackets]}
          cinder::db::mysql::dbname: cinder
          cinder::db::mysql::allowed_hosts:
            - '%'
            - "%{hiera('mysql_bind_host')}"
      metadata_settings:
        get_attr: [ApacheServiceBase, role_data, metadata_settings]
      upgrade_tasks:
        - name: Check if cinder_api is deployed
          command: systemctl is-enabled openstack-cinder-api
          tags: common
          ignore_errors: True
          register: cinder_api_enabled
        - name: "PreUpgrade step0,validation: Check service openstack-cinder-api is running"
          shell: /usr/bin/systemctl show 'openstack-cinder-api' --property ActiveState | grep '\bactive\b'
          when: cinder_api_enabled.rc == 0
          tags: step0,validation
        - name: check for cinder running under apache (post upgrade)
          tags: step1
          shell: "httpd -t -D DUMP_VHOSTS | grep -q cinder"
          register: cinder_apache
          ignore_errors: true
        - name: Stop cinder_api service (running under httpd)
          tags: step1
          service: name=httpd state=stopped
          when: cinder_apache.rc == 0
        - name: Stop and disable cinder_api service (pre-upgrade not under httpd)
          tags: step1
          when: cinder_api_enabled.rc == 0
          service: name=openstack-cinder-api state=stopped enabled=no