Central

Central RPC API

class designate.central.rpcapi.CentralAPI(topic=None)

Bases: object

Client side of the central RPC API.

API version history:

1.0 - Initial version 1.1 - Add new finder methods 1.2 - Add get_tenant and get_tenants 1.3 - Add get_absolute_limits 2.0 - Renamed most get_resources to find_resources 2.1 - Add quota methods 3.0 - RecordSet Changes 3.1 - Add floating ip ptr methods 3.2 - TLD Api changes 3.3 - Add methods for blacklisted domains 4.0 - Create methods now accept designate objects 4.1 - Add methods for server pools 4.2 - Add methods for pool manager integration 4.3 - Added Zone Transfer Methods 5.0 - Remove dead server code 5.1 - Add xfr_zone 5.2 - Add Zone Import methods 5.3 - Add Zone Export method 5.4 - Add asynchronous Zone Export methods 5.5 - Add deleted zone purging task 5.6 - Changed ‘purge_zones’ function args 6.0 - Renamed domains to zones 6.1 - Add ServiceStatus methods 6.2 - Changed ‘find_recordsets’ method args

LOGGING_BLACKLIST = ['update_service_status']

RPC_API_VERSION = '6.2'

count_records(context, criterion=None)

count_recordsets(context, criterion=None)

count_report(context, criterion=None)

count_tenants(context)

count_zones(context, criterion=None)

create_blacklist(context, blacklist)

create_pool(context, pool)

create_record(context, zone_id, recordset_id, record, increment_serial=True)

create_recordset(context, zone_id, recordset)

create_tld(context, tld)

create_tsigkey(context, tsigkey)

create_zone(context, zone)

create_zone_export(context, zone_id)

create_zone_import(context, request_body)

create_zone_transfer_accept(context, zone_transfer_accept)

create_zone_transfer_request(context, zone_transfer_request)

delete_blacklist(context, blacklist_id)

delete_pool(context, pool_id)

delete_record(context, zone_id, recordset_id, record_id, increment_serial=True)

delete_recordset(context, zone_id, recordset_id, increment_serial=True)

delete_tld(context, tld_id)

delete_tsigkey(context, tsigkey_id)

delete_zone(context, zone_id)

delete_zone_export(context, zone_export_id)

delete_zone_import(context, zone_import_id)

delete_zone_transfer_accept(context, zone_transfer_accept_id)

delete_zone_transfer_request(context, zone_transfer_request_id)

export_zone(context, zone_id)

find_blacklist(context, criterion)

find_blacklists(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_pool(context, criterion=None)

find_pools(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_record(context, criterion=None)

find_records(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_recordset(context, criterion=None)

find_recordsets(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None, force_index=False)

find_service_status(context, criterion=None)

find_service_statuses(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_tenants(context)

find_tlds(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_tsigkeys(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zone(context, criterion=None)

find_zone_exports(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zone_imports(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zone_transfer_accept(context, zone_transfer_accept)

find_zone_transfer_accepts(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zone_transfer_request(context, zone_transfer_request)

find_zone_transfer_requests(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zones(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

get_absolute_limits(context)

get_blacklist(context, blacklist_id)

get_floatingip(context, region, floatingip_id)

classmethod get_instance()

The rpc.get_client() which is called upon the API object initialization will cause a assertion error if the designate.rpc.TRANSPORT isn’t setup by rpc.init() before.

This fixes that by creating the rpcapi when demanded.

get_pool(context, pool_id)

get_quota(context, tenant_id, resource)

get_quotas(context, tenant_id)

get_record(context, zone_id, recordset_id, record_id)

get_recordset(context, zone_id, recordset_id)

get_tenant(context, tenant_id)

get_tld(context, tld_id)

get_tsigkey(context, tsigkey_id)

get_zone(context, zone_id)

get_zone_export(context, zone_export_id)

get_zone_import(context, zone_import_id)

get_zone_ns_records(context, zone_id)

get_zone_transfer_accept(context, zone_transfer_accept_id)

get_zone_transfer_request(context, zone_transfer_request_id)

list_floatingips(context)

purge_zones(context, criterion, limit=None)

reset_quotas(context, tenant_id)

set_quota(context, tenant_id, resource, hard_limit)

sync_record(context, zone_id, recordset_id, record_id)

sync_zone(context, zone_id)

sync_zones(context)

touch_zone(context, zone_id)

update_blacklist(context, blacklist)

update_floatingip(context, region, floatingip_id, values)

update_pool(context, pool)

update_record(context, record, increment_serial=True)

update_recordset(context, recordset, increment_serial=True)

update_service_status(context, service_status)

update_status(context, zone_id, status, serial)

update_tld(context, tld)

update_tsigkey(context, tsigkey)

update_zone(context, zone, increment_serial=True)

update_zone_export(context, zone_export)

update_zone_import(context, zone_import)

update_zone_transfer_accept(context, zone_transfer_accept)

update_zone_transfer_request(context, zone_transfer_request)

xfr_zone(context, zone_id)

designate.central.rpcapi.reset()

Central Service

class designate.central.service.Service

Bases: designate.service.RPCService

RPC_API_VERSION = '6.2'

count_records(context, criterion=None)

count_recordsets(context, criterion=None)

count_report(context, criterion=None)

count_tenants(context)

count_zones(context, criterion=None)

create_blacklist(context, blacklist)

create_pool(context, pool)

create_record(context, zone_id, recordset_id, record, increment_serial=True)

create_recordset(context, zone_id, recordset, increment_serial=True)

create_tld(context, tld)

create_tsigkey(context, tsigkey)

create_zone(context, zone)

Create zone: perform checks and then call _create_zone()

create_zone_export(context, zone_id)

create_zone_import(context, request_body)

create_zone_transfer_accept(context, zone_transfer_accept)

create_zone_transfer_request(context, zone_transfer_request)

delete_blacklist(context, blacklist_id)

delete_pool(context, pool_id)

delete_record(context, zone_id, recordset_id, record_id, increment_serial=True)

delete_recordset(context, zone_id, recordset_id, increment_serial=True)

delete_tld(context, tld_id)

delete_tsigkey(context, tsigkey_id)

delete_zone(context, zone_id)

Delete or abandon a zone On abandon, delete the zone from the DB immediately. Otherwise, set action to DELETE and status to PENDING and poke Pool Manager’s “delete_zone” to update the resolvers. PM will then poke back to set action to NONE and status to DELETED

delete_zone_export(context, zone_export_id)

delete_zone_import(context, zone_import_id)

delete_zone_transfer_accept(context, zone_transfer_accept_id)

delete_zone_transfer_request(context, zone_transfer_request_id)

export_zone(context, zone_id)

find_blacklist(context, criterion)

find_blacklists(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_pool(context, criterion=None)

find_pools(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_record(context, criterion=None)

find_records(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_recordset(context, criterion=None)

find_recordsets(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None, force_index=False)

find_service_status(context, criterion=None)

find_service_statuses(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

List service statuses.

find_tenants(context)

find_tlds(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_tsigkeys(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zone(context, criterion=None)

find_zone_exports(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zone_imports(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zone_transfer_accept(context, criterion)

find_zone_transfer_accepts(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zone_transfer_request(context, criterion)

find_zone_transfer_requests(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

find_zones(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

List existing zones including the ones flagged for deletion.

get_absolute_limits(context)

get_blacklist(context, blacklist_id)

get_floatingip(context, region, floatingip_id)

Get Floating IP PTR

get_pool(context, pool_id)

get_quota(context, tenant_id, resource)

get_quotas(context, tenant_id)

get_record(context, zone_id, recordset_id, record_id)

get_recordset(context, zone_id, recordset_id)

get_tenant(context, tenant_id)

get_tld(context, tld_id)

get_tsigkey(context, tsigkey_id)

get_zone(context, zone_id)

Get a zone, even if flagged for deletion

get_zone_export(context, zone_export_id)

get_zone_import(context, zone_import_id)

get_zone_ns_records(context, zone_id=None, criterion=None)

get_zone_transfer_accept(context, zone_transfer_accept_id)

get_zone_transfer_request(context, zone_transfer_request_id)

list_floatingips(context)

List Floating IPs PTR

1. We have service_catalog in the context and do a lookup using the

   token pr Neutron in the SC

2. We lookup FIPs using the configured values for this deployment.

mdns_api

ping(context)

purge_zones(context, criterion, limit=None)

Purge deleted zones. :returns: number of purged zones

quota

reset_quotas(context, tenant_id)

scheduler

service_name

set_quota(context, tenant_id, resource, hard_limit)

start()

Start a service.

stop(graceful=True)

Stop a service.

Parameters:graceful – indicates whether to wait for all threads to finish or terminate them instantly

storage

sync_record(context, zone_id, recordset_id, record_id)

sync_zone(context, zone_id)

sync_zones(context)

target = <Target version=6.2>

touch_zone(context, zone_id)

update_blacklist(context, blacklist)

update_floatingip(context, region, floatingip_id, values)

We strictly see if values[‘ptrdname’] is str or None and set / unset the requested FloatingIP’s PTR record based on that.

update_pool(context, pool)

update_record(context, record, increment_serial=True)

update_recordset(context, recordset, increment_serial=True)

update_service_status(context, service_status)

update_status(context, zone_id, status, serial)

Parameters:

• context – Security context information.
• zone_id – The ID of the designate zone.
• status – The status, ‘SUCCESS’ or ‘ERROR’.
• serial – The consensus serial number for the zone.

Returns:

updated zone

update_tld(context, tld)

update_tsigkey(context, tsigkey)

update_zone(context, zone, increment_serial=True)

Update zone. Perform checks and then call _update_zone()

Returns:updated zone

update_zone_export(context, zone_export)

update_zone_import(context, zone_import)

update_zone_transfer_accept(context, zone_transfer_accept)

update_zone_transfer_request(context, zone_transfer_request)

worker_api

xfr_zone(context, zone_id)

zone_api

designate.central.service.notification(notification_type)

designate.central.service.synchronized_zone(zone_arg=1, new_zone=False)

Ensures only a single operation is in progress for each zone

A Decorator which ensures only a single operation can be happening on a single zone at once, within the current designate-central instance