Skip to main content

Open Telekom Cloud specific extensions for the OpenStack Client CLI and OpenStack SDK

Project description

https://zuul.otc-service.com/api/tenant/eco/badge?project=opentelekomcloud/python-otcextensions&pipeline=check&branch=master 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

Installation

Installation Page

The OTC Extensions are hosted as the package otcextensions on PyPI and can be installed by pip as

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

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:

    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

OTC Extensions SDK Guides

OTCE SDK Guides

Contributing

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

otcextensions-0.32.21.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

otcextensions-0.32.21-py2.py3-none-any.whl (1.9 MB view details)

Uploaded Python 2Python 3

File details

Details for the file otcextensions-0.32.21.tar.gz.

File metadata

  • Download URL: otcextensions-0.32.21.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.9

File hashes

Hashes for otcextensions-0.32.21.tar.gz
Algorithm Hash digest
SHA256 d59094dabffde77651e63007daaa35f24c7fc1f37f60d9d4437ee442943bb92c
MD5 7b147e9702a4188fe9d41fca76f4895e
BLAKE2b-256 d1ed99e4b46554d1cea625bf62366c0c80815f16dae2bcefdf664bc625d348da

See more details on using hashes here.

File details

Details for the file otcextensions-0.32.21-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for otcextensions-0.32.21-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 693919de557a69f46cafc0124c969eca8d07a8b629574139fc295b0b9756bda6
MD5 9350fabe2f811ec97a766584bc220f7a
BLAKE2b-256 e78fe9a8fd644174e88252752bd53c41e0a1413a178bce69d0650c6f14162586

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page