Skip to main content

FABRIC Python Client Library with CLI

Project description

FABRIC User CLI

Fabric User CLI for experiments

Overview

User CLI supports following kinds commands: - Token : Commands to issue, refresh or revoke tokens - Orchestrator Commands

Command SubCommand Action Input Output
token issue Issue Fabric Tokens projectname Project Name, scope Scope Points user to Credential Manager to generate the tokens
token refresh Refresh Fabric Tokens projectname Project Name, scope Scope, refreshtoken Refresh Token Returns new identity and refresh tokens
token revoke Revoke a Refresh Token refreshtoken Refresh Token Success or Failure status
resources query Query available resources from Orchestrator Graph ML representing the available resources

Requirements

Python 3.7+

Pre-requisites

Ensure that following are installed

  • virtualenv
  • virtualenvwrapper

Installation

Multiple installation options possible. For CF development the recommended method is to install from GitHub MASTER branch:

$ mkvirtualenv cli
$ workon cli
$ pip install git+https://github.com/fabric-testbed/fabric-cli.git

For inclusion in tools, etc, use PyPi

$ mkvirtualenv cli
$ workon cli
$ pip install fabric-cli

Configuration

User CLI expects the user to set FABRIC_ORCHESTRATOR_HOST and FABRIC_CREDMGR_HOST environment variables.

In addition, User is expected to pass either Fabric Identity Token or Fabric Refresh Token to all the orchestrator commands. Alternatively, user is expected to set atleast one of the environment variables FABRIC_ID_TOKEN and FABRIC_REFRESH_TOKEN.

Create config.yml with default content as shown below.

To enable CLI auto-completion, add following line to your ~/.bashrc

eval "$(_FABRIC_CLI_COMPLETE=source_bash fabric-cli)"

Open a new shell to enable completion. Or run the eval command directly in your current shell to enable it temporarily.

Usage

User CLI supports token and resources commands:

$ fabric-cli
Usage: fabric-cli [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --verbose
  --help         Show this message and exit.

Commands:
  resources  Query Resources (set $FABRIC_ORCHESTRATOR_HOST to the Control...
  slice      slice management
  token      issue/get/refresh/revoke FABRIC tokens.

Token Commands

List of the token commands supported can be found below:

$ fabric-cli token
Usage: fabric-cli token [OPTIONS] COMMAND [ARGS]...

  issue/get/refresh/revoke FABRIC tokens. (set $FABRIC_CREDMGR_HOST to the
  Credential Manager Server)

Options:
  --help  Show this message and exit.

Commands:
  issue    issue token with projectname and scope
  refresh  refresh token
  revoke   revoke token

Resources Commands

List of the resource commands supported can be found below:

$ fabric-cli resources
Usage: fabric-cli resources [OPTIONS] COMMAND [ARGS]...

  Query Resources (set $FABRIC_ORCHESTRATOR_HOST to the Control Framework
  Orchestrator)

Options:
  --help  Show this message and exit.

Commands:
  query  issue token with projectname and scope

Project details


Download files

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

Source Distribution

fabric-cli-0.1.tar.gz (37.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fabric_cli-0.1-py3-none-any.whl (56.7 kB view details)

Uploaded Python 3

File details

Details for the file fabric-cli-0.1.tar.gz.

File metadata

  • Download URL: fabric-cli-0.1.tar.gz
  • Upload date:
  • Size: 37.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for fabric-cli-0.1.tar.gz
Algorithm Hash digest
SHA256 470b1929fab2fd3ea505edb4207775c76f116999e8e892bd12f3ca4ab22857d4
MD5 16afd9f7da7b217ae23e8b040dc58aae
BLAKE2b-256 bf8775483edf8ba94ecee61c9819c511bb7d9730aed3aa3da94033915a4ab30c

See more details on using hashes here.

File details

Details for the file fabric_cli-0.1-py3-none-any.whl.

File metadata

  • Download URL: fabric_cli-0.1-py3-none-any.whl
  • Upload date:
  • Size: 56.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for fabric_cli-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d6ed66ec55b84f7ef4617ac91c0351e8d56f3a295bf60769105f0fd2f378e8f8
MD5 4e39a580a5e1254172d6000c8ef86849
BLAKE2b-256 0f68dce4316ebfd00f75dc2d0f242e046998b58950fd5bc433c70ff3d67895f2

See more details on using hashes here.

Supported by

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