docs/platform/plugins/dnsdesig.rst

   1 .. raw:: html
   2
   3    <!--
   4    ============LICENSE_START=======================================================
   5    org.onap.ccsdk
   6    ================================================================================
   7    Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
   8    ================================================================================
   9    Licensed under the Apache License, Version 2.0 (the "License");
  10    you may not use this file except in compliance with the License.
  11    You may obtain a copy of the License at
  12
  13         http://www.apache.org/licenses/LICENSE-2.0
  14
  15    Unless required by applicable law or agreed to in writing, software
  16    distributed under the License is distributed on an "AS IS" BASIS,
  17    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18    See the License for the specific language governing permissions and
  19    limitations under the License.
  20    ============LICENSE_END=========================================================
  21    -->
  22
  23 DNS/Designate Plugin
  24 ====================
  25
  26 Cloudify DNS/Designate plugin description # Description The
  27 DNS/Designate plugin extends the concepts of the Cloudify OpenStack
  28 plugin to include using the DNS/Designate service, to set up and tear
  29 down DNS "A" and "CNAME" records, as part of a Cloudify blueprint. #
  30 Plugin Requirements \* Python versions \* 2.7.x
  31
  32 Note: These requirements apply to the VM where Cloudify Manager itself
  33 runs.
  34
  35 Note: Cloudify Manager, itself, requires Python 2.7.x (and CentOS 7).
  36
  37 Types
  38 =====
  39
  40 ccsdk.nodes.dns.arecord
  41 -----------------------
  42
  43 **Derived From:** cloudify.nodes.Root
  44
  45 **Properties:**
  46
  47 -  ``fqdn`` (required string) The FQDN for the set of DNS A records to
  48    be managed. The DNS zone to which this FQDN belongs is assumed to be
  49    the entire FQDN following the first dot. This value must not end with
  50    a dot. The provided openstack credentials must allow updating records
  51    in the DNS zone.
  52 -  ``ttl`` (optional integer default=300) The time to live, in seconds,
  53    of the DNS entries.
  54 -  ``openstack`` (required map) The set of configuration parameters to
  55    use for accessing the OpenStack DNS service: username, password,
  56    tenant\_name, auth\_url, and region.
  57
  58 **Mapped Operations:**
  59
  60 -  ``cloudify.interfaces.lifecycle.create`` Creates or updates the type
  61    "A" recordset for the specified FQDN. \*\* ``Inputs:`` \*\*\*
  62    ``args`` Key-value configuration \*\*\*\* ``ip_addresses`` (required
  63    sequence of string) A non-empty list of IP addresses corresponding to
  64    the FQDN
  65 -  ``cloudify.interfaces.lifecycle.delete`` Deletes the type "A"
  66    recordset, if any, for the specified FQDN.
  67
  68 **Attributes:** This type has no runtime attributes
  69
  70 ccsdk.nodes.dns.cnamerecord
  71 ---------------------------
  72
  73 **Derived From:** cloudify.nodes.Root
  74
  75 **Properties:**
  76
  77 -  ``fqdn`` (required string) The FQDN for the DNS CNAME record to be
  78    managed. The DNS zone to which this FQDN belongs is assumed to be the
  79    entire FQDN following the first dot. This value must not end with a
  80    dot. The provided openstack credentials must allow updating records
  81    in the DNS zone.
  82 -  ``ttl`` (optional integer default=300) The time to live, in seconds,
  83    of the DNS entry.
  84 -  ``openstack`` (required map) The set of configuration parameters to
  85    use for accessing the OpenStack DNS service: username, password,
  86    tenant\_name, auth\_url, and region.
  87
  88 **Mapped Operations:**
  89
  90 -  ``cloudify.interfaces.lifecycle.create`` Creates or updates the type
  91    "CNAME" recordset for the specified FQDN. \*\* ``Inputs:`` \*\*\*
  92    ``args`` Key-value configuration \*\*\*\* ``cname`` (required string)
  93    The FQDN that this CNAME record should point to. This value must not
  94    end with at dot.
  95 -  ``cloudify.interfaces.lifecycle.delete`` Deletes the type "CNAME"
  96    recordset, if any, for the specified FQDN.
  97
  98 **Attributes:** This type has no runtime attributes
  99
 100 Relationships
 101 =============
 102
 103 This plugin does not define or use any relationships