openstack/python-designateclient
Code Issues Proposed changes

Highlight V1 API removal

Browse Source 
Update Docs and the execption logged to point users to the
openstack cli + v2 client.

Change-Id: Ib08330d348a6a2f0e976ab0df26e91b2d7bd4e13
This commit is contained in:
Graham Hayes 2018-02-12 14:01:22 +00:00
parent 1a3632cf57
commit 7cd8b69fc2
No known key found for this signature in database
GPG Key ID: 1B263DC59F4AEFD5
2 changed files with 12 additions and 1 deletions
designateclient/cli
base.py
doc/source
index.rst

6
designateclient/cli/base.py

@ -67,7 +67,11 @@ class Command(command.Command):
self.app.log.error('No endpoint was found. You must provide a ' self.app.log.error('No endpoint was found. You must provide a '
'username or user id via --os-username, ' 'username or user id via --os-username, '
'--os-user-id, env[OS_USERNAME] or ' '--os-user-id, env[OS_USERNAME] or '
'env[OS_USER_ID]') 'env[OS_USER_ID]. You may also be using a '
'cloud that does not have the V1 API enabled. '
'If your cloud does not have the V1 DNS API '
'use the openstack CLI to interact with the '
'DNS Service.')
return 1 return 1

7
doc/source/index.rst

@ -17,6 +17,13 @@ found on the :ref:`designate v2 command line tool page <shell-v2>`.
v1: the :program:`designate` command line tool. More information can be found v1: the :program:`designate` command line tool. More information can be found
on the :ref:`designate v1 command line tool page <shell>`. on the :ref:`designate v1 command line tool page <shell>`.
.. warning::
The V1 API was removed in Queens, and cannot be re-enabled.
The :program:`designate` command line tool will no longer function on
installs newer than Queens.
You'll need credentials for an OpenStack cloud that implements the Designate You'll need credentials for an OpenStack cloud that implements the Designate
API in order to use the client. API in order to use the client.