keystone.common package

Subpackages

• keystone.common.cache package
  • Subpackages
    • keystone.common.cache.backends package
      • Submodules
      • keystone.common.cache.backends.memcache_pool module
      • keystone.common.cache.backends.mongo module
      • keystone.common.cache.backends.noop module
      • Module contents
  • Submodules
  • keystone.common.cache.core module
  • Module contents
• keystone.common.environment package
  • Submodules
  • keystone.common.environment.eventlet_server module
  • Module contents
• keystone.common.kvs package
  • Subpackages
    • keystone.common.kvs.backends package
      • Submodules
      • keystone.common.kvs.backends.inmemdb module
      • keystone.common.kvs.backends.memcached module
      • Module contents
  • Submodules
  • keystone.common.kvs.core module
  • keystone.common.kvs.legacy module
  • Module contents
• keystone.common.ldap package
  • Submodules
  • keystone.common.ldap.core module
  • Module contents
• keystone.common.sql package
  • Subpackages
    • keystone.common.sql.migrate_repo package
      • Subpackages
        • keystone.common.sql.migrate_repo.versions package
          • Submodules
          • keystone.common.sql.migrate_repo.versions.034_havana module
          • keystone.common.sql.migrate_repo.versions.035_add_compound_revoked_token_index module
          • keystone.common.sql.migrate_repo.versions.036_token_drop_valid_index module
          • keystone.common.sql.migrate_repo.versions.037_add_region_table module
          • keystone.common.sql.migrate_repo.versions.038_add_assignment_table module
          • keystone.common.sql.migrate_repo.versions.039_grant_to_assignment module
          • keystone.common.sql.migrate_repo.versions.040_drop_grant_tables module
          • keystone.common.sql.migrate_repo.versions.041_add_remaining_uses_count_to_trusts module
          • keystone.common.sql.migrate_repo.versions.042_endpoint_enabled module
          • keystone.common.sql.migrate_repo.versions.043_fixup_region_description module
          • keystone.common.sql.migrate_repo.versions.044_service_enabled module
          • keystone.common.sql.migrate_repo.versions.045_placeholder module
          • keystone.common.sql.migrate_repo.versions.046_placeholder module
          • keystone.common.sql.migrate_repo.versions.047_placeholder module
          • keystone.common.sql.migrate_repo.versions.048_placeholder module
          • keystone.common.sql.migrate_repo.versions.049_placeholder module
          • keystone.common.sql.migrate_repo.versions.050_fk_consistent_indexes module
          • keystone.common.sql.migrate_repo.versions.051_add_id_mapping module
          • keystone.common.sql.migrate_repo.versions.052_add_auth_url_to_region module
          • keystone.common.sql.migrate_repo.versions.053_endpoint_to_region_association module
          • keystone.common.sql.migrate_repo.versions.054_add_actor_id_index module
          • keystone.common.sql.migrate_repo.versions.055_add_indexes_to_token_table module
          • Module contents
      • Submodules
      • keystone.common.sql.migrate_repo.manage module
      • Module contents
  • Submodules
  • keystone.common.sql.core module
  • keystone.common.sql.migration_helpers module
  • Module contents
• keystone.common.validation package
  • Submodules
  • keystone.common.validation.parameter_types module
  • keystone.common.validation.validators module
  • Module contents

Submodules

keystone.common.authorization module

keystone.common.base64utils module

keystone.common.config module

keystone.common.controller module

keystone.common.dependency module

keystone.common.driver_hints module

class keystone.common.driver_hints.Hints

Bases: object

Encapsulate driver hints for listing entities.

Hints are modifiers that affect the return of entities from a list_<entities> operation. They are typically passed to a driver to give direction as to what filtering, pagination or list limiting actions are being requested.

It is optional for a driver to action some or all of the list hints, but any filters that it does satisfy must be marked as such by calling removing the filter from the list.

A Hint object contains filters, which is a list of dicts that can be accessed publicly. Also it contains a dict called limit, which will indicate the amount of data we want to limit our listing to.

Each filter term consists of:

• name: the name of the attribute being matched

• value: the value against which it is being matched

• comparator: the operation, which can be one of equals,

  startswith or endswith

• case_sensitive: whether any comparison should take account of

  case

• type: will always be ‘filter’

add_filter(name, value, comparator='equals', case_sensitive=False)

Adds a filter to the filters list, which is publicly accessible.

get_exact_filter_by_name(name)

Return a filter key and value if exact filter exists for name.

set_limit(limit, truncated=False)

Set a limit to indicate the list should be truncated.

keystone.common.extension module

keystone.common.extension.register_admin_extension(url_prefix, extension_data)

Register extension with collection of admin extensions.

Extensions register the information here that will show up in the /extensions page as a way to indicate that the extension is active.

url_prefix: unique key for the extension that will appear in the

urls generated by the extension.

extension_data is a dictionary. The expected fields are:

‘name’: short, human readable name of the extension ‘namespace’: xml namespace ‘alias’: identifier for the extension ‘updated’: date the extension was last updated ‘description’: text description of the extension ‘links’: hyperlinks to documents describing the extension

keystone.common.extension.register_public_extension(url_prefix, extension_data)

Same as register_admin_extension but for public extensions.

keystone.common.json_home module

keystone.common.manager module

keystone.common.models module

Base model for keystone internal services

Unless marked otherwise, all fields are strings.

class keystone.common.models.Domain

Bases: keystone.common.models.Model

Domain object.

Required keys:

id name

Optional keys:

description enabled (bool, default True)

optional_keys = ('description', 'enabled')

required_keys = ('id', 'name')

class keystone.common.models.Endpoint

Bases: keystone.common.models.Model

Endpoint object

Required keys:

id region service_id

Optional keys:

internalurl publicurl adminurl

optional_keys = ('internalurl', 'publicurl', 'adminurl')

required_keys = ('id', 'region', 'service_id')

class keystone.common.models.Group

Bases: keystone.common.models.Model

Group object.

Required keys:

id name domain_id

Optional keys:

description

optional_keys = ('description',)

required_keys = ('id', 'name', 'domain_id')

class keystone.common.models.Model

Bases: dict

Base model class.

known_keys

class keystone.common.models.Project

Bases: keystone.common.models.Model

Project object.

Required keys:

id name domain_id

Optional Keys:

description enabled (bool, default True)

optional_keys = ('description', 'enabled')

required_keys = ('id', 'name', 'domain_id')

class keystone.common.models.Role

Bases: keystone.common.models.Model

Role object.

Required keys:

id name

optional_keys = ()

required_keys = ('id', 'name')

class keystone.common.models.Service

Bases: keystone.common.models.Model

Service object.

Required keys:

id type name

Optional keys:

optional_keys = ()

required_keys = ('id', 'type', 'name')

class keystone.common.models.Token

Bases: keystone.common.models.Model

Token object.

Required keys:

id expires (datetime)

Optional keys:

user tenant metadata trust_id

optional_keys = ('extra',)

required_keys = ('id', 'expires')

class keystone.common.models.Trust

Bases: keystone.common.models.Model

Trust object.

Required keys:

id trustor_user_id trustee_user_id project_id

optional_keys = ('expires_at',)

required_keys = ('id', 'trustor_user_id', 'trustee_user_id', 'project_id')

class keystone.common.models.User

Bases: keystone.common.models.Model

User object.

Required keys:

id name domain_id

Optional keys:

password description email enabled (bool, default True) default_project_id

optional_keys = ('password', 'description', 'email', 'enabled', 'default_project_id')

required_keys = ('id', 'name', 'domain_id')

keystone.common.openssl module

keystone.common.pemutils module

keystone.common.router module

keystone.common.serializer module

keystone.common.utils module

keystone.common.wsgi module

Module contents