Pre-release charm-helpers sync

To begin release testing get each charm up to date with lp:charm-helpers

This also brings the tests up to date with recent changes
to the keystone endpoints registered by the proxy charm.

Change-Id: I96312a20b043857def4a3116c75652f63bc38ac2

charmhelpers/contrib/openstack/utils.py

@@ -145,7 +145,7 @@ SWIFT_CODENAMES = OrderedDict([
     ('mitaka',
         ['2.5.0', '2.6.0', '2.7.0']),
     ('newton',
-        ['2.8.0']),
+        ['2.8.0', '2.9.0']),
 ])
 
 # >= Liberty version->codename mapping
@@ -220,7 +220,6 @@ GIT_DEFAULT_REPOS = {
 }
 
 GIT_DEFAULT_BRANCHES = {
-    'kilo': 'stable/kilo',
     'liberty': 'stable/liberty',
     'mitaka': 'stable/mitaka',
     'master': 'master',
@@ -413,7 +412,8 @@ def os_release(package, base='essex'):
     global os_rel
     if os_rel:
         return os_rel
-    os_rel = (get_os_codename_package(package, fatal=False) or
+    os_rel = (git_os_codename_install_source(config('openstack-origin-git')) or
+              get_os_codename_package(package, fatal=False) or
               get_os_codename_install_source(config('openstack-origin')) or
               base)
     return os_rel
@@ -719,7 +719,24 @@ def git_install_requested():
     return config('openstack-origin-git') is not None
 
 
-requirements_dir = None
+def git_os_codename_install_source(projects_yaml):
+    """
+    Returns OpenStack codename of release being installed from source.
+    """
+    if git_install_requested():
+        projects = _git_yaml_load(projects_yaml)
+
+        if projects in GIT_DEFAULT_BRANCHES.keys():
+            if projects == 'master':
+                return 'newton'
+            return projects
+
+        if 'release' in projects:
+            if projects['release'] == 'master':
+                return 'newton'
+            return projects['release']
+
+    return None
 
 
 def git_default_repos(projects_yaml):
@@ -740,12 +757,6 @@ def git_default_repos(projects_yaml):
             }
             repos = [repo]
 
-            # NOTE(coreycb): This is a temp work-around until the requirements
-            # repo moves from stable/kilo branch to kilo-eol tag. The core
-            # repos have already done this.
-            if default == 'kilo':
-                branch = 'kilo-eol'
-
             # neutron-* and nova-* charms require some additional repos
             if service in ['neutron-api', 'neutron-gateway',
                            'neutron-openvswitch']:
@@ -778,7 +789,7 @@ def git_default_repos(projects_yaml):
             }
             repos.append(repo)
 
-            return yaml.dump(dict(repositories=repos))
+            return yaml.dump(dict(repositories=repos, release=default))
 
     return projects_yaml
 
@@ -793,6 +804,9 @@ def _git_yaml_load(projects_yaml):
     return yaml.load(projects_yaml)
 
 
+requirements_dir = None
+
+
 def git_clone_and_install(projects_yaml, core_project):
     """
     Clone/install all specified OpenStack repositories.
@@ -856,6 +870,10 @@ def git_clone_and_install(projects_yaml, core_project):
             # upper-constraints didn't exist until after icehouse
             if not os.path.isfile(constraints):
                 constraints = None
+            # use constraints unless project yaml sets use_constraints to false
+            if 'use_constraints' in projects.keys():
+                if not projects['use_constraints']:
+                    constraints = None
         else:
             repo_dir = _git_clone_and_install_single(repo, branch, depth,
                                                      parent_dir, http_proxy,
@@ -882,6 +900,8 @@ def _git_validate_projects_yaml(projects, core_project):
     if projects['repositories'][-1]['name'] != core_project:
         error_out('{} git repo must be specified last'.format(core_project))
 
+    _git_ensure_key_exists('release', projects)
+
 
 def _git_ensure_key_exists(key, keys):
     """

charmhelpers/contrib/storage/linux/ceph.py

@@ -21,9 +21,10 @@
 #  James Page <james.page@ubuntu.com>
 #  Adam Gandelman <adamg@ubuntu.com>
 #
-import bisect
+
 import errno
 import hashlib
+import math
 import six
 
 import os
@@ -76,8 +77,16 @@ log to syslog = {use_syslog}
 err to syslog = {use_syslog}
 clog to syslog = {use_syslog}
 """
-# For 50 < osds < 240,000 OSDs (Roughly 1 Exabyte at 6T OSDs)
+
-powers_of_two = [8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608]
+# The number of placement groups per OSD to target for placement group
+# calculations. This number is chosen as 100 due to the ceph PG Calc
+# documentation recommending to choose 100 for clusters which are not
+# expected to increase in the foreseeable future. Since the majority of the
+# calculations are done on deployment, target the case of non-expanding
+# clusters as the default.
+DEFAULT_PGS_PER_OSD_TARGET = 100
+DEFAULT_POOL_WEIGHT = 10.0
+LEGACY_PG_COUNT = 200
 
 
 def validator(value, valid_type, valid_range=None):
@@ -184,42 +193,106 @@ class Pool(object):
             check_call(['ceph', '--id', self.service, 'osd', 'tier', 'remove-overlay', self.name])
             check_call(['ceph', '--id', self.service, 'osd', 'tier', 'remove', self.name, cache_pool])
 
-    def get_pgs(self, pool_size):
+    def get_pgs(self, pool_size, percent_data=DEFAULT_POOL_WEIGHT):
-        """
+        """Return the number of placement groups to use when creating the pool.
-        :param pool_size: int. pool_size is either the number of replicas for replicated pools or the K+M sum for
+
-            erasure coded pools
+        Returns the number of placement groups which should be specified when
+        creating the pool. This is based upon the calculation guidelines
+        provided by the Ceph Placement Group Calculator (located online at
+        http://ceph.com/pgcalc/).
+
+        The number of placement groups are calculated using the following:
+
+            (Target PGs per OSD) * (OSD #) * (%Data)
+            ----------------------------------------
+                         (Pool size)
+
+        Per the upstream guidelines, the OSD # should really be considered
+        based on the number of OSDs which are eligible to be selected by the
+        pool. Since the pool creation doesn't specify any of CRUSH set rules,
+        the default rule will be dependent upon the type of pool being
+        created (replicated or erasure).
+
+        This code makes no attempt to determine the number of OSDs which can be
+        selected for the specific rule, rather it is left to the user to tune
+        in the form of 'expected-osd-count' config option.
+
+        :param pool_size: int. pool_size is either the number of replicas for
+            replicated pools or the K+M sum for erasure coded pools
+        :param percent_data: float. the percentage of data that is expected to
+            be contained in the pool for the specific OSD set. Default value
+            is to assume 10% of the data is for this pool, which is a
+            relatively low % of the data but allows for the pg_num to be
+            increased. NOTE: the default is primarily to handle the scenario
+            where related charms requiring pools has not been upgraded to
+            include an update to indicate their relative usage of the pools.
         :return: int.  The number of pgs to use.
         """
+
+        # Note: This calculation follows the approach that is provided
+        # by the Ceph PG Calculator located at http://ceph.com/pgcalc/.
         validator(value=pool_size, valid_type=int)
+
+        # Ensure that percent data is set to something - even with a default
+        # it can be set to None, which would wreak havoc below.
+        if percent_data is None:
+            percent_data = DEFAULT_POOL_WEIGHT
+
+        # If the expected-osd-count is specified, then use the max between
+        # the expected-osd-count and the actual osd_count
         osd_list = get_osds(self.service)
-        if not osd_list:
+        expected = config('expected-osd-count') or 0
+
+        if osd_list:
+            osd_count = max(expected, len(osd_list))
+
+            # Log a message to provide some insight if the calculations claim
+            # to be off because someone is setting the expected count and
+            # there are more OSDs in reality. Try to make a proper guess
+            # based upon the cluster itself.
+            if expected and osd_count != expected:
+                log("Found more OSDs than provided expected count. "
+                    "Using the actual count instead", INFO)
+        elif expected:
+            # Use the expected-osd-count in older ceph versions to allow for
+            # a more accurate pg calculations
+            osd_count = expected
+        else:
             # NOTE(james-page): Default to 200 for older ceph versions
             # which don't support OSD query from cli
-            return 200
+            return LEGACY_PG_COUNT
 
-        osd_list_length = len(osd_list)
+        percent_data /= 100.0
-        # Calculate based on Ceph best practices
+        target_pgs_per_osd = config('pgs-per-osd') or DEFAULT_PGS_PER_OSD_TARGET
-        if osd_list_length < 5:
+        num_pg = (target_pgs_per_osd * osd_count * percent_data) // pool_size
-            return 128
+
-        elif 5 < osd_list_length < 10:
+        # The CRUSH algorithm has a slight optimization for placement groups
-            return 512
+        # with powers of 2 so find the nearest power of 2. If the nearest
-        elif 10 < osd_list_length < 50:
+        # power of 2 is more than 25% below the original value, the next
-            return 4096
+        # highest value is used. To do this, find the nearest power of 2 such
+        # that 2^n <= num_pg, check to see if its within the 25% tolerance.
+        exponent = math.floor(math.log(num_pg, 2))
+        nearest = 2 ** exponent
+        if (num_pg - nearest) > (num_pg * 0.25):
+            # Choose the next highest power of 2 since the nearest is more
+            # than 25% below the original value.
+            return int(nearest * 2)
         else:
-            estimate = (osd_list_length * 100) / pool_size
+            return int(nearest)
-            # Return the next nearest power of 2
-            index = bisect.bisect_right(powers_of_two, estimate)
-            return powers_of_two[index]
 
 
 class ReplicatedPool(Pool):
-    def __init__(self, service, name, pg_num=None, replicas=2):
+    def __init__(self, service, name, pg_num=None, replicas=2,
+                 percent_data=10.0):
         super(ReplicatedPool, self).__init__(service=service, name=name)
         self.replicas = replicas
-        if pg_num is None:
+        if pg_num:
-            self.pg_num = self.get_pgs(self.replicas)
+            # Since the number of placement groups were specified, ensure
+            # that there aren't too many created.
+            max_pgs = self.get_pgs(self.replicas, 100.0)
+            self.pg_num = min(pg_num, max_pgs)
         else:
-            self.pg_num = pg_num
+            self.pg_num = self.get_pgs(self.replicas, percent_data)
 
     def create(self):
         if not pool_exists(self.service, self.name):
@@ -238,30 +311,39 @@ class ReplicatedPool(Pool):
 
 # Default jerasure erasure coded pool
 class ErasurePool(Pool):
-    def __init__(self, service, name, erasure_code_profile="default"):
+    def __init__(self, service, name, erasure_code_profile="default",
+                 percent_data=10.0):
         super(ErasurePool, self).__init__(service=service, name=name)
         self.erasure_code_profile = erasure_code_profile
+        self.percent_data = percent_data
 
     def create(self):
         if not pool_exists(self.service, self.name):
-            # Try to find the erasure profile information so we can properly size the pgs
+            # Try to find the erasure profile information in order to properly
-            erasure_profile = get_erasure_profile(service=self.service, name=self.erasure_code_profile)
+            # size the number of placement groups. The size of an erasure
+            # coded placement group is calculated as k+m.
+            erasure_profile = get_erasure_profile(self.service,
+                                                  self.erasure_code_profile)
 
             # Check for errors
             if erasure_profile is None:
-                log(message='Failed to discover erasure_profile named={}'.format(self.erasure_code_profile),
+                msg = ("Failed to discover erasure profile named "
-                    level=ERROR)
+                       "{}".format(self.erasure_code_profile))
-                raise PoolCreationError(message='unable to find erasure profile {}'.format(self.erasure_code_profile))
+                log(msg, level=ERROR)
+                raise PoolCreationError(msg)
             if 'k' not in erasure_profile or 'm' not in erasure_profile:
                 # Error
-                log(message='Unable to find k (data chunks) or m (coding chunks) in {}'.format(erasure_profile),
+                msg = ("Unable to find k (data chunks) or m (coding chunks) "
-                    level=ERROR)
+                       "in erasure profile {}".format(erasure_profile))
-                raise PoolCreationError(
+                log(msg, level=ERROR)
-                    message='unable to find k (data chunks) or m (coding chunks) in {}'.format(erasure_profile))
+                raise PoolCreationError(msg)
 
-            pgs = self.get_pgs(int(erasure_profile['k']) + int(erasure_profile['m']))
+            k = int(erasure_profile['k'])
+            m = int(erasure_profile['m'])
+            pgs = self.get_pgs(k + m, self.percent_data)
             # Create it
-            cmd = ['ceph', '--id', self.service, 'osd', 'pool', 'create', self.name, str(pgs), str(pgs),
+            cmd = ['ceph', '--id', self.service, 'osd', 'pool', 'create',
+                   self.name, str(pgs), str(pgs),
                    'erasure', self.erasure_code_profile]
             try:
                 check_call(cmd)
@@ -955,16 +1037,22 @@ class CephBrokerRq(object):
             self.request_id = str(uuid.uuid1())
         self.ops = []
 
-    def add_op_create_pool(self, name, replica_count=3, pg_num=None):
+    def add_op_create_pool(self, name, replica_count=3, pg_num=None,
+                           weight=None):
         """Adds an operation to create a pool.
 
         @param pg_num setting:  optional setting. If not provided, this value
         will be calculated by the broker based on how many OSDs are in the
         cluster at the time of creation. Note that, if provided, this value
         will be capped at the current available maximum.
+        @param weight: the percentage of data the pool makes up
         """
+        if pg_num and weight:
+            raise ValueError('pg_num and weight are mutually exclusive')
+
         self.ops.append({'op': 'create-pool', 'name': name,
-                         'replicas': replica_count, 'pg_num': pg_num})
+                         'replicas': replica_count, 'pg_num': pg_num,
+                         'weight': weight})
 
     def set_ops(self, ops):
         """Set request ops to provided value.
@@ -982,7 +1070,7 @@ class CephBrokerRq(object):
     def _ops_equal(self, other):
         if len(self.ops) == len(other.ops):
             for req_no in range(0, len(self.ops)):
-                for key in ['replicas', 'name', 'op', 'pg_num']:
+                for key in ['replicas', 'name', 'op', 'pg_num', 'weight']:
                     if self.ops[req_no].get(key) != other.ops[req_no].get(key):
                         return False
         else:

charmhelpers/core/templating.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import os
+import sys
 
 from charmhelpers.core import host
 from charmhelpers.core import hookenv
@@ -38,8 +39,9 @@ def render(source, target, context, owner='root', group='root',
     The rendered template will be written to the file as well as being returned
     as a string.
 
-    Note: Using this requires python-jinja2; if it is not installed, calling
+    Note: Using this requires python-jinja2 or python3-jinja2; if it is not
-    this will attempt to use charmhelpers.fetch.apt_install to install it.
+    installed, calling this will attempt to use charmhelpers.fetch.apt_install
+    to install it.
     """
     try:
         from jinja2 import FileSystemLoader, Environment, exceptions
@@ -51,7 +53,10 @@ def render(source, target, context, owner='root', group='root',
                         'charmhelpers.fetch to install it',
                         level=hookenv.ERROR)
             raise
-        apt_install('python-jinja2', fatal=True)
+        if sys.version_info.major == 2:
+            apt_install('python-jinja2', fatal=True)
+        else:
+            apt_install('python3-jinja2', fatal=True)
         from jinja2 import FileSystemLoader, Environment, exceptions
 
     if template_loader:

charmhelpers/fetch/__init__.py

@@ -178,14 +178,14 @@ def filter_installed_packages(packages):
     return _pkgs
 
 
-def apt_cache(in_memory=True):
+def apt_cache(in_memory=True, progress=None):
     """Build and return an apt cache"""
     from apt import apt_pkg
     apt_pkg.init()
     if in_memory:
         apt_pkg.config.set("Dir::Cache::pkgcache", "")
         apt_pkg.config.set("Dir::Cache::srcpkgcache", "")
-    return apt_pkg.Cache()
+    return apt_pkg.Cache(progress)
 
 
 def apt_install(packages, options=None, fatal=False):

tests/basic_deployment.py

@@ -197,7 +197,7 @@ class SwiftStorageBasicDeployment(OpenStackAmuletDeployment):
                  'tenantId': u.not_null,
                  'id': u.not_null,
                  'email': u'juju@localhost'}
-        user4 = {'name': 'swift',
+        user4 = {'name': 's3_swift',
                  'enabled': True,
                  'tenantId': u.not_null,
                  'id': u.not_null,
@@ -219,7 +219,7 @@ class SwiftStorageBasicDeployment(OpenStackAmuletDeployment):
                        'id': u.not_null}
 
         expected = {'image': [endpoint_id], 'object-store': [endpoint_id],
-                    'identity': [endpoint_id]}
+                    'identity': [endpoint_id], 's3': [endpoint_id]}
         actual = self.keystone_demo.service_catalog.get_endpoints()
 
         ret = u.validate_svc_catalog_endpoint_data(expected, actual)