Merge "Update the Akamai DNS Driver matrix information"

doc/source/admin/backends/akamai_v2.rst

@@ -0,0 +1,40 @@
+..
+    Copyright 2013 Hewlett-Packard Development Company, L.P.
+
+    Licensed under the Apache License, Version 2.0 (the "License"); you may
+    not use this file except in compliance with the License. You may obtain
+    a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+    License for the specific language governing permissions and limitations
+    under the License.
+
+.. _akamai_v2_backend_docs:
+
+Akamai v2 Backend
+=================
+
+This page documents using the Akamai v2 backend.
+The backend uses the FastDNS V2 API to create and delete zones remotely.
+
+Designate Configuration
+-----------------------
+
+Example configuration required:
+One section for each pool target
+
+   .. literalinclude:: sample_yaml_snippets/akamai-v2.yaml
+       :language: yaml
+
+
+Then update the pools in designate - see :ref:`designate_manage_pool`
+for further details on the ``designate-manage pool`` command
+
+.. code-block:: console
+
+    $ designate-manage pool update
+

doc/source/admin/backends/sample_yaml_snippets/akamai-v2.yaml

@@ -0,0 +1,40 @@
+- name: default-akamai-v2
+  # The name is immutable. There will be no option to change the name after
+  # creation and the only way will to change it will be to delete it
+  # (and all zones associated with it) and recreate it.
+  description: Akamai v2
+
+  attributes: {}
+
+  # List out the NS records for zones hosted within this pool
+  ns_records:
+    - hostname: ns1-1.example.org.
+      priority: 1
+
+  # List out the nameservers for this pool. These are the actual Akamai servers.
+  # We use these to verify changes have propagated to all nameservers.
+  nameservers:
+    - host: 192.0.2.2
+      port: 53
+
+  # List out the targets for this pool. For Akamai, most often, there will be
+  # one entry for each Akamai server.
+  targets:
+    - type: akamai_v2
+      description: Akamai v2 server
+
+      # List out the designate-mdns servers from which Akamai servers should
+      # request zone transfers (AXFRs) from.
+      masters:
+        - host: 192.0.2.1
+          port: 5354
+
+      options:
+        host: 192.0.2.2
+        port: 53
+        akamai_host: 192.0.2.2
+        akamai_client_token: client_token_string
+        akamai_access_token: access_token_string
+        akamai_client_secret: client_secret_string
+        akamai_contract_id: contract_id
+        akamai_gid: group_id

doc/source/admin/support-matrix.ini

@@ -49,6 +49,7 @@ backend-impl-pdns4=Power DNS 4
 backend-impl-designate=Designate to Designate
 backend-impl-dynect=DynECT
 backend-impl-akamai=Akamai eDNS
+backend-impl-akamai_v2=Akamai DNS v2
 backend-impl-infoblox-xfr=Infoblox (XFR)
 backend-impl-nsd4=NSD4
 backend-impl-agent=Agent
@@ -73,7 +74,11 @@ status=untested
 status=untested
 
 [backends.backend-impl-akamai]
-status=untested
+status=known-broken
+notes=Akamai has turned off the eDNS API - see https://community.akamai.com/customers/s/article/Big-Changes-Coming-to-Fast-DNS-in-2018
+
+[backends.backend-impl-akamai_v2]
+docs=akamai_v2_backend_docs
 
 [backends.backend-impl-agent]
 

releasenotes/notes/akamai-v2-5a3edb35f59a17c2.yaml

@@ -0,0 +1,8 @@
+---
+features:
+  - |
+    Added new backend driver to support the Akamai FastDNS V2 API
+upgrade:
+  - |
+    The Akamai eDNS API endpoint has been removed, users should migrate to
+    the Akamai v2 driver for the FastDNS V2 API.