From ec0629c98e15ffc2a4bf96787baa3c8d3e69ead3 Mon Sep 17 00:00:00 2001 From: Martin Oemke Date: Sun, 6 Mar 2016 14:22:40 +0100 Subject: [PATCH] Clean up references to neutron Remove references to neutron project in tackerclient doc and conf files. Change-Id: I66a7479a5c12c49f82af0cbff197d6b9976a87c6 Closes-Bug: #1553715 (cherry picked from commit 80220f372b211cf8bddfa81018cdd19042b9f017) --- HACKING.rst | 2 +- doc/source/conf.py | 2 +- doc/source/index.rst | 48 +++++--------------------------------------- 3 files changed, 7 insertions(+), 45 deletions(-) diff --git a/HACKING.rst b/HACKING.rst index b8b3ff96..5ca7f003 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -1,4 +1,4 @@ -Neutron Style Commandments +Tacker Style Commandments ================================ - Step 1: Read the OpenStack Style Commandments diff --git a/doc/source/conf.py b/doc/source/conf.py index 91d21864..2ed8173d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # -project = 'python-neutronclient' +project = 'python-tackerclient' # -- General configuration --------------------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 612a41ee..2000fcc5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,19 +1,7 @@ -Python bindings to the OpenStack Network API +Python bindings to the OpenStack Tacker API ============================================ -In order to use the python neutron client directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so:: - - >>> import logging - >>> from neutronclient.neutron import client - >>> logging.basicConfig(level=logging.DEBUG) - >>> neutron = client.Client('2.0', endpoint_url=OS_URL, token=OS_TOKEN) - >>> neutron.format = 'json' - >>> network = {'name': 'mynetwork', 'admin_state_up': True} - >>> neutron.create_network({'network':network}) - >>> networks = neutron.list_networks(name='mynetwork') - >>> print networks - >>> network_id = networks['networks'][0]['id'] - >>> neutron.delete_network(network_id) +In order to use the python tacker client directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API. Command-line Tool @@ -27,37 +15,11 @@ In order to use the CLI, you must provide your OpenStack username, password, ten The command line tool will attempt to reauthenticate using your provided credentials for every request. You can override this behavior by manually supplying an auth token using ``--os-url`` and ``--os-auth-token``. You can alternatively set these environment variables:: - export OS_URL=http://neutron.example.org:9696/ + export OS_URL=http://tacker.example.org:8888/ export OS_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 -If neutron server does not require authentication, besides these two arguments or environment variables (We can use any value as token.), we need manually supply ``--os-auth-strategy`` or set the environment variable:: +If tacker server does not require authentication, besides these two arguments or environment variables (We can use any value as token.), we need manually supply ``--os-auth-strategy`` or set the environment variable:: export OS_AUTH_STRATEGY=noauth -Once you've configured your authentication parameters, you can run ``neutron -h`` to see a complete listing of available commands. - -Release Notes -============= - -2.0 ------ -* support Neutron API 2.0 - -2.2.0 ------ -* add security group commands -* add Lbaas commands -* allow options put after positional arguments -* add NVP queue and net gateway commands -* add commands for agent management extensions -* add commands for DHCP and L3 agents scheduling -* support XML request format -* support pagination options - -2.2.2 ------ -* improved support for listing a large number of filtered subnets -* add --endpoint-type and OS_ENDPOINT_TYPE to shell client -* made the publicURL the default endpoint instead of adminURL -* add ability to update security group name (requires 2013.2-Havana or later) -* add flake8 and pbr support for testing and building +Once you've configured your authentication parameters, you can run ``tacker -h`` to see a complete listing of available commands.