resource Package

resource Package

controllers Module

Workflow Logic the Resource service.

class keystone.resource.controllers.DomainConfigV3(*args, **kwargs)[source]

Bases: keystone.common.controller.V3Controller

create_domain_config(context, *args, **kwargs)[source]
delete_domain_config(context, *args, **kwargs)[source]
get_domain_config(context, *args, **kwargs)[source]
member_name = 'config'
update_domain_config(context, *args, **kwargs)[source]
update_domain_config_group(context, domain_id, group, config)[source]
update_domain_config_only(context, domain_id, config)[source]
class keystone.resource.controllers.DomainV3[source]

Bases: keystone.common.controller.V3Controller

collection_name = 'domains'
create_domain(context, *args, **kwargs)[source]
delete_domain(context, *args, **kwargs)[source]
get_domain(context, *args, **kwargs)[source]
list_domains(context, **kwargs)[source]
member_name = 'domain'
update_domain(context, *args, **kwargs)[source]
class keystone.resource.controllers.ProjectV3[source]

Bases: keystone.common.controller.V3Controller

collection_name = 'projects'
create_project(context, *args, **kwargs)[source]
delete_project(context, *args, **kwargs)[source]
get_project(context, *args, **kwargs)[source]
list_projects(context, **kwargs)[source]
member_name = 'project'
update_project(context, *args, **kwargs)[source]
class keystone.resource.controllers.Tenant(*args, **kwargs)[source]

Bases: keystone.common.controller.V2Controller

create_project(context, tenant)[source]
delete_project(context, tenant_id)[source]
get_all_projects(context, **kw)[source]

Gets a list of all tenants for an admin user.

get_project(context, tenant_id)[source]
get_project_by_name(context, tenant_name)[source]
update_project(context, tenant_id, tenant)[source]

core Module

Main entry point into the Resource service.

class keystone.resource.core.DomainConfigDriverV8[source]

Bases: object

Interface description for a Domain Config driver.

create_config_option(domain_id, group, option, value, sensitive=False)[source]

Creates a config option for a domain.

Parameters:
  • domain_id – the domain for this option
  • group – the group name
  • option – the option name
  • value – the value to assign to this option
  • sensitive – whether the option is sensitive
Returns:

dict containing group, option and value

Raises keystone.exception.Conflict:
 

when the option already exists

delete_config_options(domain_id, group=None, option=None, sensitive=False)[source]

Deletes config options for a domain.

Allows deletion of all options for a domain, all options in a group or a specific option. The driver is silent if there are no options to delete.

Parameters:
  • domain_id – the domain for this option
  • group – optional group option name
  • option – optional option name. If group is None, then this parameter is ignored
  • sensitive – whether the option is sensitive
get_config_option(domain_id, group, option, sensitive=False)[source]

Gets the config option for a domain.

Parameters:
  • domain_id – the domain for this option
  • group – the group name
  • option – the option name
  • sensitive – whether the option is sensitive
Returns:

dict containing group, option and value

Raises keystone.exception.DomainConfigNotFound:
 

the option doesn’t exist.

list_config_options(domain_id, group=None, option=False, sensitive=False)[source]

Gets a config options for a domain.

Parameters:
  • domain_id – the domain for this option
  • group – optional group option name
  • option – optional option name. If group is None, then this parameter is ignored
  • sensitive – whether the option is sensitive
Returns:

list of dicts containing group, option and value

obtain_registration(domain_id, type)[source]

Try and register this domain to use the type specified.

Parameters:
  • domain_id – the domain required
  • type – type of registration
Returns:

True if the domain was registered, False otherwise. Failing to register means that someone already has it (which could even be the domain being requested).

read_registration(type)[source]

Get the domain ID of who is registered to use this type.

Parameters:type – type of registration
Returns:domain_id of who is registered.
Raises :keystone.exception.ConfigRegistrationNotFound: nobody is registered.
release_registration(domain_id, type=None)[source]

Release registration if it is held by the domain specified.

If the specified domain is registered for this domain then free it, if it is not then do nothing - no exception is raised.

Parameters:
  • domain_id – the domain in question
  • type – type of registration, if None then all registrations for this domain will be freed
update_config_option(domain_id, group, option, value, sensitive=False)[source]

Updates a config option for a domain.

Parameters:
  • domain_id – the domain for this option
  • group – the group option name
  • option – the option name
  • value – the value to assign to this option
  • sensitive – whether the option is sensitive
Returns:

dict containing updated group, option and value

Raises keystone.exception.DomainConfigNotFound:
 

the option doesn’t exist.

class keystone.resource.core.DomainConfigManager(*args, **kwargs)[source]

Bases: keystone.common.manager.Manager

Default pivot point for the Domain Config backend.

create_config(domain_id, config)[source]

Create config for a domain

Parameters:
  • domain_id – the domain in question
  • config – the dict of config groups/options to assign to the domain

Creates a new config, overwriting any previous config (no Conflict error will be generated).

Returns:a dict of group dicts containing the options, with any that are sensitive removed
Raises keystone.exception.InvalidDomainConfig:
 when the config contains options we do not support
delete_config(domain_id, group=None, option=None)[source]

Delete config, or partial config, for the domain.

Parameters:
  • domain_id – the domain in question
  • group – an optional specific group of options
  • option – an optional specific option within the group

If group and option are None, then the entire config for the domain is deleted. If group is not None, then just that group of options will be deleted. If group and option are both specified, then just that option is deleted.

Raises keystone.exception.InvalidDomainConfig:
 when group/option parameters specify an option we do not support or one that does not exist in the original config.
driver_namespace = 'keystone.resource.domain_config'
get_config(domain_id, group=None, option=None)[source]

Get config, or partial config, for a domain

Parameters:
  • domain_id – the domain in question
  • group – an optional specific group of options
  • option – an optional specific option within the group
Returns:

a dict of group dicts containing the whitelisted options, filtered by group and option specified

Raises:

An example response:

{
    'ldap': {
        'url': 'myurl'
        'user_tree_dn': 'OU=myou'},
    'identity': {
        'driver': 'ldap'}

}
get_config_with_sensitive_info(*arg, **kw)[source]

Get config for a domain with sensitive info included.

This method is not exposed via the public API, but is used by the identity manager to initialize a domain with the fully formed config options.

sensitive_options = {'identity': [], 'ldap': ['password']}
update_config(domain_id, config, group=None, option=None)[source]

Update config, or partial config, for a domain

Parameters:
  • domain_id – the domain in question
  • config – the config dict containing and groups/options being updated
  • group – an optional specific group of options, which if specified must appear in config, with no other groups
  • option – an optional specific option within the group, which if specified must appear in config, with no other options

The contents of the supplied config will be merged with the existing config for this domain, updating or creating new options if these did not previously exist. If group or option is specified, then the update will be limited to those specified items and the inclusion of other options in the supplied config will raise an exception, as will the situation when those options do not already exist in the current config.

Returns:a dict of groups containing all whitelisted options
Raises keystone.exception.InvalidDomainConfig:
 when the config and group/option parameters specify an option we do not support or one that does not exist in the original config
whitelisted_options = {'identity': ['driver'], 'ldap': ['url', 'user', 'suffix', 'use_dumb_member', 'dumb_member', 'allow_subtree_delete', 'query_scope', 'page_size', 'alias_dereferencing', 'debug_level', 'chase_referrals', 'user_tree_dn', 'user_filter', 'user_objectclass', 'user_id_attribute', 'user_name_attribute', 'user_mail_attribute', 'user_pass_attribute', 'user_enabled_attribute', 'user_enabled_invert', 'user_enabled_mask', 'user_enabled_default', 'user_attribute_ignore', 'user_default_project_id_attribute', 'user_allow_create', 'user_allow_update', 'user_allow_delete', 'user_enabled_emulation', 'user_enabled_emulation_dn', 'user_enabled_emulation_use_group_config', 'user_additional_attribute_mapping', 'group_tree_dn', 'group_filter', 'group_objectclass', 'group_id_attribute', 'group_name_attribute', 'group_member_attribute', 'group_desc_attribute', 'group_attribute_ignore', 'group_allow_create', 'group_allow_update', 'group_allow_delete', 'group_additional_attribute_mapping', 'tls_cacertfile', 'tls_cacertdir', 'use_tls', 'tls_req_cert', 'use_pool', 'pool_size', 'pool_retry_max', 'pool_retry_delay', 'pool_connection_timeout', 'pool_connection_lifetime', 'use_auth_pool', 'auth_pool_size', 'auth_pool_connection_lifetime']}
class keystone.resource.core.Manager(*args, **kwargs)[source]

Bases: keystone.common.manager.Manager

Default pivot point for the Resource backend.

See keystone.common.manager.Manager for more details on how this dynamically calls the backend.

assert_domain_enabled(domain_id, domain=None)[source]

Assert the Domain is enabled.

Raises AssertionError:
 if domain is disabled.
assert_domain_not_federated(domain_id, domain)[source]

Assert the Domain’s name and id do not match the reserved keyword.

Note that the reserved keyword is defined in the configuration file, by default, it is ‘Federated’, it is also case insensitive. If config’s option is empty the default hardcoded value ‘Federated’ will be used.

Raises AssertionError:
 if domain named match the value in the config.
assert_project_enabled(project_id, project=None)[source]

Assert the project is enabled and its associated domain is enabled.

Raises AssertionError:
 if the project or domain is disabled.
create_domain(domain_id, domain, initiator=None)[source]
create_project(tenant_id, tenant, initiator=None)[source]
delete_domain(domain_id, initiator=None)[source]
delete_project(tenant_id, initiator=None)[source]
driver_namespace = 'keystone.resource'
get_domain(*arg, **kw)[source]
get_domain_by_name(*arg, **kw)[source]
get_project(*arg, **kw)[source]
get_project_by_name(*arg, **kw)[source]
get_project_parents_as_ids(project)[source]

Gets the IDs from the parents from a given project.

The project IDs are returned as a structured dictionary traversing up the hierarchy to the top level project. For example, considering the following project hierarchy:

  A
  |
+-B-+
|   |
C   D

If we query for project C parents, the expected return is the following dictionary:

'parents': {
    B['id']: {
        A['id']: None
    }
}
get_projects_in_subtree_as_ids(project_id)[source]

Gets the IDs from the projects in the subtree from a given project.

The project IDs are returned as a structured dictionary representing their hierarchy. For example, considering the following project hierarchy:

  A
  |
+-B-+
|   |
C   D

If we query for project A subtree, the expected return is the following dictionary:

'subtree': {
    B['id']: {
        C['id']: None,
        D['id']: None
    }
}
list_domains(*args, **kwargs)[source]
list_project_parents(project_id, user_id=None)[source]
list_projects(*args, **kwargs)[source]
list_projects_in_domain(domain_id)[source]
list_projects_in_subtree(project_id, user_id=None)[source]
update_domain(domain_id, domain, initiator=None)[source]
update_project(tenant_id, tenant, initiator=None)[source]
class keystone.resource.core.ResourceDriverV8[source]

Bases: object

create_domain(domain_id, domain)[source]

Creates a new domain.

Raises keystone.exception.Conflict:
 if the domain_id or domain name already exists
create_project(project_id, project)[source]

Creates a new project.

Raises keystone.exception.Conflict:
 if project_id or project name already exists
delete_domain(domain_id)[source]

Deletes an existing domain.

Raises keystone.exception.DomainNotFound:
 if domain_id does not exist
delete_project(project_id)[source]

Deletes an existing project.

Raises keystone.exception.ProjectNotFound:
 if project_id does not exist
get_domain(domain_id)[source]

Get a domain by ID.

Returns:domain_ref
Raises keystone.exception.DomainNotFound:
 if domain_id does not exist
get_domain_by_name(domain_name)[source]

Get a domain by name.

Returns:domain_ref
Raises keystone.exception.DomainNotFound:
 if domain_name does not exist
get_project(project_id)[source]

Get a project by ID.

Returns:project_ref
Raises keystone.exception.ProjectNotFound:
 if project_id does not exist
get_project_by_name(tenant_name, domain_id)[source]

Get a tenant by name.

Returns:tenant_ref
Raises keystone.exception.ProjectNotFound:
 if a project with the tenant_name does not exist within the domain
is_leaf_project(project_id)[source]

Checks if a project is a leaf in the hierarchy.

Parameters:project_id – the driver will check if this project is a leaf in the hierarchy.
Raises keystone.exception.ProjectNotFound:
 if project_id does not exist
list_domains(hints)[source]

List domains in the system.

Parameters:hints – filter hints which the driver should implement if at all possible.
Returns:a list of domain_refs or an empty list.
list_domains_from_ids(domain_ids)[source]

List domains for the provided list of ids.

Parameters:domain_ids – list of ids
Returns:a list of domain_refs.

This method is used internally by the assignment manager to bulk read a set of domains given their ids.

list_project_ids_from_domain_ids(domain_ids)[source]

List project ids for the provided list of domain ids.

Parameters:domain_ids – list of domain ids
Returns:a list of project ids owned by the specified domain ids.

This method is used internally by the assignment manager to bulk read a set of project ids given a list of domain ids.

list_project_parents(project_id)[source]

List all parents from a project by its ID.

Parameters:project_id – the driver will list the parents of this project.
Returns:a list of project_refs or an empty list.
Raises keystone.exception.ProjectNotFound:
 if project_id does not exist
list_projects(hints)[source]

List projects in the system.

Parameters:hints – filter hints which the driver should implement if at all possible.
Returns:a list of project_refs or an empty list.
list_projects_from_ids(project_ids)[source]

List projects for the provided list of ids.

Parameters:project_ids – list of ids
Returns:a list of project_refs.

This method is used internally by the assignment manager to bulk read a set of projects given their ids.

list_projects_in_domain(domain_id)[source]

List projects in the domain.

Parameters:domain_id – the driver MUST only return projects within this domain.
Returns:a list of project_refs or an empty list.
list_projects_in_subtree(project_id)[source]

List all projects in the subtree below the hierarchy of the given project.

Parameters:project_id – the driver will get the subtree under this project.
Returns:a list of project_refs or an empty list
Raises keystone.exception.ProjectNotFound:
 if project_id does not exist
update_domain(domain_id, domain)[source]

Updates an existing domain.

Raises:
update_project(project_id, project)[source]

Updates an existing project.

Raises:
keystone.resource.core.calc_default_domain()[source]

routers Module

WSGI Routers for the Resource service.

class keystone.resource.routers.Admin(mapper=None)[source]

Bases: keystone.common.wsgi.ComposableRouter

add_routes(mapper)[source]
class keystone.resource.routers.Routers[source]

Bases: keystone.common.wsgi.RoutersBase

append_v3_routers(mapper, routers)[source]

schema Module

Table Of Contents

This Page