OTC Extensions
==============
.. image:: https://zuul.otc-service.com/api/tenant/eco/badge?project=opentelekomcloud/python-otcextensions&pipeline=check&branch=master
:target: https://zuul.otc-service.com/t/eco/builds?project=opentelekomcloud%2Fpython-otcextensions
.. image:: https://readthedocs.org/projects/python-otcextensions/badge/?version=latest
:target: http://python-otcextensions.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
The OTC Extensions augment the OpenStack SDK of features and services
provided by the Open Telekom Cloud. If installed as a Python package,
they add several extra commands to the OpenStack Client CLI. Therefore
the project interacts closely with the
* `python-openstacksdk`
* `python-openstackclient`
packages.
Documentation
-------------
`Documentation Overview <https://docs.otc.t-systems.com/python-otcextensions/>`_
Installation
------------
`Installation Page <https://docs.otc.t-systems.com/python-otcextensions/install/index.html>`_
The OTC Extensions are hosted as the package `otcextensions` on PyPI
and can be installed by pip as
.. code-block: console
$ pip install otcextensions
There are several options
to do that including but not limited to pip userland installation, system wide
installation as well as installation from operating system packets or directly
from source. Refer to the installation instructions_ in the projects
documentation.
Configuration
-------------
`Configuration Page <https://docs.otc.t-systems.com/python-otcextensions/install/configuration.html>`_
Acessing the Open Telekom Cloud APIs requires authentication and
authorization. For both there are several options available:
* **Configuration files** (recommended): A file called `clouds.yaml`
holds all necessary configuration parameters. The file can be placed
either in the local directory, below the user home directory in
`.config/openstack` or in the system-wide directory
`/etc/openstack`. You may use a second file `secure.yaml` in the
same directories to extra protect clear-text password
credentials. For more details see the section `configuration`_ in
the official documentation.
Minimal sample ``clouds.yaml`` file:
.. code-block:: yaml
clouds:
otc:
profile: otc
auth:
username: '<USER_NAME>'
password: '<PASSWORD>'
project_name: '<eu-de_project>'
# or project_id: '<123456_PROJECT_ID>'
user_domain_name: 'OTC00000000001000000xxx'
# or user_domain_id: '<123456_DOMAIN_ID>'
auth_url: 'https://iam.eu-de.otc.t-systems.com:443/v3'
interface: 'public'
identity_api_version: 3 # !Important
ak: '<AK_VALUE>' # AK/SK pair for access to OBS
sk: '<SK_VALUE>'
With this configuration you can start using the CLI with ``openstack
--os-cloud otc *command*`` or by ``export OS_CLOUD=otc; openstack
*command*``.
* **Environment variables:** Authentication using username/password is often
used::
export OS_AUTH_URL=<url-to-openstack-identity>
export OS_IDENTITY_API_VERSION=3
export OS_PROJECT_NAME=<project-name>
export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
export OS_USERNAME=<username>
export OS_USER_DOMAIN_NAME=<user-domain-name>
export OS_PASSWORD=<password> # (optional)
export S3_ACCESS_KEY_ID=<access_key>
export S3_SECRET_ACCESS_KEY=<secret_access_key>
* **Command-Line Options:** The corresponding command-line options look
very similar::
--os-auth-url <url>
--os-identity-api-version 3
--os-project-name <project-name>
--os-project-domain-name <project-domain-name>
--os-username <username>
--os-user-domain-name <user-domain-name>
[--os-password <password>]
If a password is not provided above (in plaintext), you will be
interactively prompted to provide one securely.
* **Existing Token:** Authentication may also be performed using an
already-acquired token and a URL pointing directly to the service
API that presumably was acquired from the Service Catalog::
export OS_TOKEN=<token>
export OS_URL=<url-to-openstack-service>
* The corresponding command-line options look very similar::
--os-token <token>
--os-url <url-to-openstack-service>
In addition to that a regular `clouds.yaml` configuration file can be used
More information is available at
https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html
or
https://developer.openstack.org/sdks/python/openstacksdk/users/config
OTC Extensions CLI Usage
------------------------
`OTCE CLI Command Overview <https://docs.otc.t-systems.com/python-otcextensions/cli/index.html>`_
OTC Extensions SDK Guides
-------------------------
`OTCE SDK Guides <https://docs.otc.t-systems.com/python-otcextensions/sdk/guides/index.html>`_
Contributing
------------
* `Contribution Page <https://docs.otc.t-systems.com/python-otcextensions/contributor/index.html>`_
Further Links
-------------
* `Release Notes <https://docs.otc.t-systems.com/releasenotes/otcdocstheme/>`_
* `Issue Tracker <https://github.com/OpenTelekomCloud/python-otcextensions/issues>`_
.. _instructions: https://docs.otc.t-systems.com/python-otcextensions/install/index.html
Raw data
{
"_id": null,
"home_page": "http://python-otcextensions.readthedocs.io/",
"name": "otcextensions",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenStack, openstackclient, openstacksdk, Open Telekom Cloud, otc, T-Systems, Telekom",
"author": "Artem Goncharov",
"author_email": "artem.goncharov@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9c/2f/8e0b5896916d76b58cb8e30531233ae56ea0256ebb2f1306dc9dab7ee1ec/otcextensions-0.32.6.tar.gz",
"platform": null,
"description": "OTC Extensions\n==============\n\n.. image:: https://zuul.otc-service.com/api/tenant/eco/badge?project=opentelekomcloud/python-otcextensions&pipeline=check&branch=master\n :target: https://zuul.otc-service.com/t/eco/builds?project=opentelekomcloud%2Fpython-otcextensions\n\n.. image:: https://readthedocs.org/projects/python-otcextensions/badge/?version=latest\n :target: http://python-otcextensions.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nThe OTC Extensions augment the OpenStack SDK of features and services\nprovided by the Open Telekom Cloud. If installed as a Python package,\nthey add several extra commands to the OpenStack Client CLI. Therefore\nthe project interacts closely with the\n\n* `python-openstacksdk`\n* `python-openstackclient`\n\npackages.\n\nDocumentation\n-------------\n\n`Documentation Overview <https://docs.otc.t-systems.com/python-otcextensions/>`_\n\nInstallation\n------------\n\n`Installation Page <https://docs.otc.t-systems.com/python-otcextensions/install/index.html>`_\n\nThe OTC Extensions are hosted as the package `otcextensions` on PyPI\nand can be installed by pip as\n\n.. code-block: console\n\n $ pip install otcextensions\n\nThere are several options\nto do that including but not limited to pip userland installation, system wide\ninstallation as well as installation from operating system packets or directly\nfrom source. Refer to the installation instructions_ in the projects\ndocumentation.\n\nConfiguration\n-------------\n\n`Configuration Page <https://docs.otc.t-systems.com/python-otcextensions/install/configuration.html>`_\n\nAcessing the Open Telekom Cloud APIs requires authentication and\nauthorization. For both there are several options available:\n\n* **Configuration files** (recommended): A file called `clouds.yaml`\n holds all necessary configuration parameters. The file can be placed\n either in the local directory, below the user home directory in\n `.config/openstack` or in the system-wide directory\n `/etc/openstack`. You may use a second file `secure.yaml` in the\n same directories to extra protect clear-text password\n credentials. For more details see the section `configuration`_ in\n the official documentation.\n\n Minimal sample ``clouds.yaml`` file:\n\n .. code-block:: yaml\n\n clouds:\n otc:\n profile: otc\n auth:\n username: '<USER_NAME>'\n password: '<PASSWORD>'\n project_name: '<eu-de_project>'\n # or project_id: '<123456_PROJECT_ID>'\n user_domain_name: 'OTC00000000001000000xxx'\n # or user_domain_id: '<123456_DOMAIN_ID>'\n auth_url: 'https://iam.eu-de.otc.t-systems.com:443/v3'\n interface: 'public'\n identity_api_version: 3 # !Important\n ak: '<AK_VALUE>' # AK/SK pair for access to OBS\n sk: '<SK_VALUE>'\n\n With this configuration you can start using the CLI with ``openstack\n --os-cloud otc *command*`` or by ``export OS_CLOUD=otc; openstack\n *command*``.\n\n* **Environment variables:** Authentication using username/password is often\n used::\n\n export OS_AUTH_URL=<url-to-openstack-identity>\n export OS_IDENTITY_API_VERSION=3\n export OS_PROJECT_NAME=<project-name>\n export OS_PROJECT_DOMAIN_NAME=<project-domain-name>\n export OS_USERNAME=<username>\n export OS_USER_DOMAIN_NAME=<user-domain-name>\n export OS_PASSWORD=<password> # (optional)\n export S3_ACCESS_KEY_ID=<access_key>\n export S3_SECRET_ACCESS_KEY=<secret_access_key>\n\n* **Command-Line Options:** The corresponding command-line options look\n very similar::\n\n --os-auth-url <url>\n --os-identity-api-version 3\n --os-project-name <project-name>\n --os-project-domain-name <project-domain-name>\n --os-username <username>\n --os-user-domain-name <user-domain-name>\n [--os-password <password>]\n\n If a password is not provided above (in plaintext), you will be\n interactively prompted to provide one securely.\n\n* **Existing Token:** Authentication may also be performed using an\n already-acquired token and a URL pointing directly to the service\n API that presumably was acquired from the Service Catalog::\n\n export OS_TOKEN=<token>\n export OS_URL=<url-to-openstack-service>\n\n* The corresponding command-line options look very similar::\n\n --os-token <token>\n --os-url <url-to-openstack-service>\n\nIn addition to that a regular `clouds.yaml` configuration file can be used\n\nMore information is available at\nhttps://docs.openstack.org/python-openstackclient/latest/cli/authentication.html\nor\nhttps://developer.openstack.org/sdks/python/openstacksdk/users/config\n\nOTC Extensions CLI Usage\n------------------------\n\n`OTCE CLI Command Overview <https://docs.otc.t-systems.com/python-otcextensions/cli/index.html>`_\n\nOTC Extensions SDK Guides\n-------------------------\n\n`OTCE SDK Guides <https://docs.otc.t-systems.com/python-otcextensions/sdk/guides/index.html>`_\n\nContributing\n------------\n\n* `Contribution Page <https://docs.otc.t-systems.com/python-otcextensions/contributor/index.html>`_\n\nFurther Links\n-------------\n\n* `Release Notes <https://docs.otc.t-systems.com/releasenotes/otcdocstheme/>`_\n* `Issue Tracker <https://github.com/OpenTelekomCloud/python-otcextensions/issues>`_\n\n.. _instructions: https://docs.otc.t-systems.com/python-otcextensions/install/index.html\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Open Telekom Cloud specific extensions for the OpenStack Client CLI and OpenStack SDK",
"version": "0.32.6",
"project_urls": {
"Homepage": "http://python-otcextensions.readthedocs.io/"
},
"split_keywords": [
"openstack",
" openstackclient",
" openstacksdk",
" open telekom cloud",
" otc",
" t-systems",
" telekom"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f03cb294da528afef1814e4e0f4fe22ab2bd48115751e369710fc5f1b61b7e49",
"md5": "ca1dfe592e6cb77c07a610bc68665466",
"sha256": "bdf8452beee7030fef65f80e46e7662d4098a1353d79287b90d0b36bb82161cf"
},
"downloads": -1,
"filename": "otcextensions-0.32.6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca1dfe592e6cb77c07a610bc68665466",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 1729712,
"upload_time": "2024-12-02T11:50:04",
"upload_time_iso_8601": "2024-12-02T11:50:04.738927Z",
"url": "https://files.pythonhosted.org/packages/f0/3c/b294da528afef1814e4e0f4fe22ab2bd48115751e369710fc5f1b61b7e49/otcextensions-0.32.6-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c2f8e0b5896916d76b58cb8e30531233ae56ea0256ebb2f1306dc9dab7ee1ec",
"md5": "58b7bc149afd483a55007da39db0c44d",
"sha256": "d8a54338c29396ed4a80b4fb57e88e2bdc40cf6be3515fb8bfb98280736c47d9"
},
"downloads": -1,
"filename": "otcextensions-0.32.6.tar.gz",
"has_sig": false,
"md5_digest": "58b7bc149afd483a55007da39db0c44d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 983894,
"upload_time": "2024-12-02T11:50:07",
"upload_time_iso_8601": "2024-12-02T11:50:07.033127Z",
"url": "https://files.pythonhosted.org/packages/9c/2f/8e0b5896916d76b58cb8e30531233ae56ea0256ebb2f1306dc9dab7ee1ec/otcextensions-0.32.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 11:50:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "otcextensions"
}
JSON