openstack/python-designateclient
Code Issues Proposed changes

Merge "Update doc examples to use keystoneauth"

Browse Source
This commit is contained in:
Jenkins
2016-05-11 09:24:51 +00:00
committed by Gerrit Code Review
parent bb9ce0980c 69f4597bf1
commit 11416b4726
7 changed files with 85 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/examples/recordset_create.py
View File

@@ -5,8 +5,8 @@ from designateclient.v2 import client
from designateclient import exceptions from designateclient import exceptions
from designateclient import shell from designateclient import shell
from keystoneclient.auth.identity import generic from keystoneauth1.identity import generic
from keystoneclient import session as keystone_session from keystoneauth1 import session as keystone_session
logging.basicConfig(level='DEBUG') logging.basicConfig(level='DEBUG')
@@ -20,7 +20,9 @@ auth = generic.Password(
auth_url=shell.env('OS_AUTH_URL'), auth_url=shell.env('OS_AUTH_URL'),
username=shell.env('OS_USERNAME'), username=shell.env('OS_USERNAME'),
password=shell.env('OS_PASSWORD'), password=shell.env('OS_PASSWORD'),
tenant_name=shell.env('OS_TENANT_NAME')) project_name=shell.env('OS_PROJECT_NAME'),
project_domain_id='default',
user_domain_id='default')
session = keystone_session.Session(auth=auth) session = keystone_session.Session(auth=auth)

8
doc/examples/recordset_crud.py
View File

@@ -4,8 +4,8 @@ from designateclient.v2 import client
from designateclient import exceptions from designateclient import exceptions
from designateclient import shell from designateclient import shell
from keystoneclient.auth.identity import generic from keystoneauth1.identity import generic
from keystoneclient import session as keystone_session from keystoneauth1 import session as keystone_session
logging.basicConfig(level='DEBUG') logging.basicConfig(level='DEBUG')
@@ -14,7 +14,9 @@ auth = generic.Password(
auth_url=shell.env('OS_AUTH_URL'), auth_url=shell.env('OS_AUTH_URL'),
username=shell.env('OS_USERNAME'), username=shell.env('OS_USERNAME'),
password=shell.env('OS_PASSWORD'), password=shell.env('OS_PASSWORD'),
tenant_name=shell.env('OS_TENANT_NAME')) project_name=shell.env('OS_PROJECT_NAME'),
project_domain_id='default',
user_domain_id='default')
session = keystone_session.Session(auth=auth) session = keystone_session.Session(auth=auth)

8
doc/examples/zone_create_primary.py
View File

@@ -6,8 +6,8 @@ from designateclient import exceptions
from designateclient import shell from designateclient import shell
from designateclient.v2 import client from designateclient.v2 import client
from keystoneclient.auth.identity import generic from keystoneauth1.identity import generic
from keystoneclient import session as keystone_session from keystoneauth1 import session as keystone_session
logging.basicConfig(level='DEBUG') logging.basicConfig(level='DEBUG')
@@ -16,7 +16,9 @@ auth = generic.Password(
auth_url=shell.env('OS_AUTH_URL'), auth_url=shell.env('OS_AUTH_URL'),
username=shell.env('OS_USERNAME'), username=shell.env('OS_USERNAME'),
password=shell.env('OS_PASSWORD'), password=shell.env('OS_PASSWORD'),
tenant_name=shell.env('OS_TENANT_NAME')) project_name=shell.env('OS_PROJECT_NAME'),
project_domain_id='default',
user_domain_id='default')
session = keystone_session.Session(auth=auth) session = keystone_session.Session(auth=auth)

8
doc/examples/zone_create_secondary.py
View File

@@ -1,8 +1,8 @@
import logging import logging
import uuid import uuid
from keystoneclient.auth.identity import generic from keystoneauth1.identity import generic
from keystoneclient import session as keystone_session from keystoneauth1 import session as keystone_session
from designateclient import exceptions from designateclient import exceptions
from designateclient import shell from designateclient import shell
@@ -15,7 +15,9 @@ auth = generic.Password(
auth_url=shell.env('OS_AUTH_URL'), auth_url=shell.env('OS_AUTH_URL'),
username=shell.env('OS_USERNAME'), username=shell.env('OS_USERNAME'),
password=shell.env('OS_PASSWORD'), password=shell.env('OS_PASSWORD'),
tenant_name=shell.env('OS_TENANT_NAME')) project_name=shell.env('OS_PROJECT_NAME'),
project_domain_id='default',
user_domain_id='default')
session = keystone_session.Session(auth=auth) session = keystone_session.Session(auth=auth)

8
doc/examples/zone_list_nameservers.py
View File

@@ -5,8 +5,8 @@ from designateclient.v2 import client
from designateclient import shell from designateclient import shell
from designateclient import utils from designateclient import utils
from keystoneclient.auth.identity import generic from keystoneauth1.identity import generic
from keystoneclient import session as keystone_session from keystoneauth1 import session as keystone_session
logging.basicConfig(level='DEBUG') logging.basicConfig(level='DEBUG')
@@ -15,7 +15,9 @@ auth = generic.Password(
auth_url=shell.env('OS_AUTH_URL'), auth_url=shell.env('OS_AUTH_URL'),
username=shell.env('OS_USERNAME'), username=shell.env('OS_USERNAME'),
password=shell.env('OS_PASSWORD'), password=shell.env('OS_PASSWORD'),
tenant_name=shell.env('OS_TENANT_NAME')) project_name=shell.env('OS_PROJECT_NAME'),
project_domain_id='default',
user_domain_id='default')
session = keystone_session.Session(auth=auth) session = keystone_session.Session(auth=auth)

8
doc/examples/zone_list_paging.py
View File

@@ -1,8 +1,8 @@
from __future__ import print_function from __future__ import print_function
import logging import logging
from keystoneclient.auth.identity import generic from keystoneauth1.identity import generic
from keystoneclient import session as keystone_session from keystoneauth1 import session as keystone_session
from designateclient import shell from designateclient import shell
from designateclient.v2 import client from designateclient.v2 import client
@@ -13,7 +13,9 @@ auth = generic.Password(
auth_url=shell.env('OS_AUTH_URL'), auth_url=shell.env('OS_AUTH_URL'),
username=shell.env('OS_USERNAME'), username=shell.env('OS_USERNAME'),
password=shell.env('OS_PASSWORD'), password=shell.env('OS_PASSWORD'),
tenant_name=shell.env('OS_TENANT_NAME')) project_name=shell.env('OS_PROJECT_NAME'),
project_domain_id='default',
user_domain_id='default')
session = keystone_session.Session(auth=auth, timeout=10) session = keystone_session.Session(auth=auth, timeout=10)

79
doc/source/bindings.rst
View File

@@ -3,7 +3,7 @@ Python Bindings - v1 and v2
=========================== ===========================
The python-designateclient package comes with python bindings for both versions The python-designateclient package comes with python bindings for both versions
of the Designate API: v1 and v2. These can be used to interact with the Designate of the Designate API: v1 and v2. These can be used to interact with the Designate
API from any python program. API from any python program.
Introduction - Bindings v2 Introduction - Bindings v2
@@ -17,14 +17,17 @@ To view examples of usage please checkout the *doc/examples* folder, basic usage
from designateclient.v2 import client from designateclient.v2 import client
from designateclient import shell from designateclient import shell
from keystoneclient.auth.identity import generic from keystoneauth1.identity import generic
from keystoneclient import session as keystone_session from keystoneauth1 import session as keystone_session
auth = generic.Password( auth = generic.Password(
auth_url=shell.env('OS_AUTH_URL'), auth_url=shell.env('OS_AUTH_URL'),
username=shell.env('OS_USERNAME'), username=shell.env('OS_USERNAME'),
password=shell.env('OS_PASSWORD'), password=shell.env('OS_PASSWORD'),
tenant_name=shell.env('OS_TENANT_NAME')) project_name=shell.env('OS_PROJECT_NAME'),
project_domain_id='default',
user_domain_id='default')
session = keystone_session.Session(auth=auth) session = keystone_session.Session(auth=auth)
@@ -46,13 +49,15 @@ the bindings.
from __future__ import print_function from __future__ import print_function
from designateclient.v1 import Client from designateclient.v1 import Client
# Create an instance of the client, providing the necessary credentials # Create an instance of the client, providing the necessary credentials
client = Client( client = Client(
auth_url="https://example.com:5000/v2.0/", auth_url="https://example.com:5000/v3/",
username="openstack", username="openstack",
password="yadayada", password="yadayada",
tenant_id="123456789" project_name="myproject",
) project_domain_id='default',
user_domain_id='default')
# Fetch a list of the domains this user/tenant has access to # Fetch a list of the domains this user/tenant has access to
domains = client.domains.list() domains = client.domains.list()
@@ -78,7 +83,10 @@ Designate supports either Keystone authentication, or no authentication at all.
Keystone Authentication Keystone Authentication
----------------------- -----------------------
Below is a sample of standard authentication with keystone: Below is a sample of standard authentication with keystone using keystoneauth
Sessions. For more information on keystoneauth API, see `Using Sessions`_.
.. _Using Sessions: http://docs.openstack.org/developer/keystoneauth/using-sessions.html
.. code-block:: python .. code-block:: python
@@ -86,13 +94,24 @@ Below is a sample of standard authentication with keystone:
from designateclient.v1 import Client from designateclient.v1 import Client
# Create an instance of the client, providing the necessary credentials from keystoneauth1.identity import generic
client = Client( from keystoneauth1 import session as keystone_session
auth_url="https://example.com:5000/v2.0/",
username="openstack",
password="yadayada", # Create an authentication plugin providing the necessary credentials
tenant_id="123456789" auth = generic.Password(
) auth_url="https://example.com:5000/v3/",
username="openstack",
password="yadayada",
project_name="myproject",
project_domain_id='default',
user_domain_id='default'
)
session = keystone_session.Session(auth=auth)
# Create an instance of the client, providing a keystoneauth Session
client = Client(session=session)
Below is a sample of standard authentication with keystone, but also explicitly Below is a sample of standard authentication with keystone, but also explicitly
providing the endpoint to use: providing the endpoint to use:
@@ -106,14 +125,26 @@ providing the endpoint to use:
from designateclient.v1 import Client from designateclient.v1 import Client
# Create an instance of the client, providing the necessary credentials from keystoneauth1.identity import generic
from keystoneauth1 import session as keystone_session
# Create an authentication plugin providing the necessary credentials
auth = generic.Password(
auth_url="https://example.com:5000/v3/",
username="openstack",
password="yadayada",
project_name="myproject",
project_domain_id='default',
user_domain_id='default')
session = keystone_session.Session(auth=auth)
# Create an instance of the client, providing a keystoneauth Session
client = Client( client = Client(
auth_url="https://example.com:5000/v2.0/", session=session,
username="openstack", endpoint="https://127.0.0.1:9001/v1/")
password="yadayada",
tenant_id="123456789",
endpoint="https://127.0.0.1:9001/v1/"
)
No Authentication No Authentication
----------------- -----------------