keystone.catalog package

Subpackages

• keystone.catalog.backends package
  • Submodules
  • keystone.catalog.backends.base module
  • keystone.catalog.backends.sql module
  • keystone.catalog.backends.templated module
  • Module contents

Submodules

keystone.catalog.controllers module

class keystone.catalog.controllers.Endpoint(*args, **kwargs)

Bases: keystone.common.controller.V2Controller

create_endpoint(*args, **kwargs)

Create three v3 endpoint refs based on a legacy ref.

delete_endpoint(*args, **kwargs)

Delete up to three v3 endpoint refs based on a legacy ref ID.

get_endpoints(*args, **kwargs)

Merge matching v3 endpoint refs into legacy refs.

class keystone.catalog.controllers.EndpointFilterV3Controller

Bases: keystone.common.controller.V3Controller

add_endpoint_to_project(request, *args, **kwargs)

Establish an association between an endpoint and a project.

check_endpoint_in_project(request, *args, **kwargs)

Verify endpoint is currently associated with given project.

list_endpoints_for_project(request, *args, **kwargs)

List all endpoints currently associated with a given project.

list_projects_for_endpoint(request, *args, **kwargs)

Return a list of projects associated with the endpoint.

remove_endpoint_from_project(request, *args, **kwargs)

Remove the endpoint from the association with given project.

class keystone.catalog.controllers.EndpointGroupV3Controller

Bases: keystone.common.controller.V3Controller

VALID_FILTER_KEYS = [‘service_id’, ‘region_id’, ‘interface’]

classmethod base_url(context, path=None)

Construct a path and pass it to V3Controller.base_url method.

collection_name = ‘endpoint_groups’

create_endpoint_group(request, *args, **kwargs)

Create an Endpoint Group with the associated filters.

delete_endpoint_group(request, *args, **kwargs)

Delete endpoint_group.

get_endpoint_group(request, *args, **kwargs)

Retrieve the endpoint group associated with the id if exists.

list_endpoint_groups(request, *args, **kwargs)

List all endpoint groups.

list_endpoint_groups_for_project(request, *args, **kwargs)

List all endpoint groups associated with a given project.

list_endpoints_associated_with_endpoint_group(request, *args, **kwargs)

List all the endpoints filtered by a specific endpoint group.

list_projects_associated_with_endpoint_group(request, *args, **kwargs)

List all projects associated with endpoint group.

member_name = ‘endpoint_group’

update_endpoint_group(request, *args, **kwargs)

Update fixed values and/or extend the filters.

class keystone.catalog.controllers.EndpointV3

Bases: keystone.common.controller.V3Controller

collection_name = ‘endpoints’

create_endpoint(request, *args, **kwargs)

delete_endpoint(request, *args, **kwargs)

classmethod filter_endpoint(ref)

get_endpoint(request, *args, **kwargs)

list_endpoints(request, **kwargs)

member_name = ‘endpoint’

update_endpoint(request, *args, **kwargs)

classmethod wrap_member(context, ref)

class keystone.catalog.controllers.ProjectEndpointGroupV3Controller

Bases: keystone.common.controller.V3Controller

add_endpoint_group_to_project(request, *args, **kwargs)

Create an association between an endpoint group and project.

collection_name = ‘project_endpoint_groups’

get_endpoint_group_in_project(request, *args, **kwargs)

Retrieve the endpoint group associated with the id if exists.

member_name = ‘project_endpoint_group’

remove_endpoint_group_from_project(request, *args, **kwargs)

Remove the endpoint group from associated project.

class keystone.catalog.controllers.RegionV3(*args, **kwargs)

Bases: keystone.common.controller.V3Controller

collection_name = ‘regions’

create_region(request, *args, **kwargs)

create_region_with_id(request, region_id, region)

Create a region with a user-specified ID.

This method is unprotected because it depends on self.create_region to enforce policy.

delete_region(request, *args, **kwargs)

get_region(request, *args, **kwargs)

list_regions(request, **kwargs)

member_name = ‘region’

update_region(request, *args, **kwargs)

class keystone.catalog.controllers.Service(*args, **kwargs)

Bases: keystone.common.controller.V2Controller

create_service(*args, **kwargs)

delete_service(*args, **kwargs)

get_service(*args, **kwargs)

get_services(*args, **kwargs)

class keystone.catalog.controllers.ServiceV3

Bases: keystone.common.controller.V3Controller

collection_name = ‘services’

create_service(request, *args, **kwargs)

delete_service(request, *args, **kwargs)

get_service(request, *args, **kwargs)

list_services(request, **kwargs)

member_name = ‘service’

update_service(request, *args, **kwargs)

keystone.catalog.core module

Main entry point into the Catalog service.

class keystone.catalog.core.Manager(*args, **kwargs)

Bases: keystone.common.manager.Manager

Default pivot point for the Catalog backend.

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

add_endpoint_group_to_project(*args, **kwargs)

add_endpoint_to_project(*args, **kwargs)

create_endpoint(*args, **kwargs)

create_region(*args, **kwargs)

create_service(*args, **kwargs)

delete_association_by_endpoint(*args, **kwargs)

delete_association_by_project(*args, **kwargs)

delete_endpoint(*args, **kwargs)

delete_endpoint_group_association_by_project(*args, **kwargs)

delete_region(*args, **kwargs)

delete_service(*args, **kwargs)

driver_namespace = ‘keystone.catalog’

get_catalog(*args, **kwargs)

get_endpoint(*args, **kwargs)

get_endpoint_groups_for_project(*args, **kwargs)

get_endpoints_filtered_by_endpoint_group(*args, **kwargs)

get_region(*args, **kwargs)

get_service(*args, **kwargs)

get_v3_catalog(*args, **kwargs)

list_endpoints(*args, **kwargs)

list_endpoints_for_project(*args, **kwargs)

List all endpoints associated with a project.

Parameters:project_id (string) – project identifier to check Returns:a list of endpoint ids or an empty list.

list_regions(*args, **kwargs)

list_services(*args, **kwargs)

remove_endpoint_from_project(*args, **kwargs)

remove_endpoint_group_from_project(*args, **kwargs)

update_endpoint(*args, **kwargs)

update_region(*args, **kwargs)

update_service(*args, **kwargs)

keystone.catalog.routers module

class keystone.catalog.routers.Routers

Bases: keystone.common.wsgi.RoutersBase

API for the keystone catalog.

The API Endpoint Filter looks like:

PUT /OS-EP-FILTER/projects/{project_id}/endpoints/{endpoint_id}
GET /OS-EP-FILTER/projects/{project_id}/endpoints/{endpoint_id}
HEAD /OS-EP-FILTER/projects/{project_id}/endpoints/{endpoint_id}
DELETE /OS-EP-FILTER/projects/{project_id}/endpoints/{endpoint_id}
GET /OS-EP-FILTER/endpoints/{endpoint_id}/projects
GET /OS-EP-FILTER/projects/{project_id}/endpoints
GET /OS-EP-FILTER/projects/{project_id}/endpoint_groups

GET /OS-EP-FILTER/endpoint_groups
POST /OS-EP-FILTER/endpoint_groups
GET /OS-EP-FILTER/endpoint_groups/{endpoint_group_id}
HEAD /OS-EP-FILTER/endpoint_groups/{endpoint_group_id}
PATCH /OS-EP-FILTER/endpoint_groups/{endpoint_group_id}
DELETE /OS-EP-FILTER/endpoint_groups/{endpoint_group_id}

GET /OS-EP-FILTER/endpoint_groups/{endpoint_group_id}/projects
GET /OS-EP-FILTER/endpoint_groups/{endpoint_group_id}/endpoints

PUT /OS-EP-FILTER/endpoint_groups/{endpoint_group}/projects/
    {project_id}
GET /OS-EP-FILTER/endpoint_groups/{endpoint_group}/projects/
    {project_id}
HEAD /OS-EP-FILTER/endpoint_groups/{endpoint_group}/projects/
    {project_id}
DELETE /OS-EP-FILTER/endpoint_groups/{endpoint_group}/projects/
    {project_id}

PATH_ENDPOINT_GROUPS = ‘/endpoint_groups/{endpoint_group_id}’

PATH_ENDPOINT_GROUP_PROJECTS = ‘/endpoint_groups/{endpoint_group_id}/projects/{project_id}’

PATH_PREFIX = ‘/OS-EP-FILTER’

PATH_PROJECT_ENDPOINT = ‘/projects/{project_id}/endpoints/{endpoint_id}’

append_v3_routers(mapper, routers)

keystone.catalog.schema module

Module contents