orpy
CLI application¶
Authentication¶
In order to interact with the INDIGO PaaS Orchestrator we need to use an OpenID Connect access token from a trusted OpenID Connect provider at the orchestrator.
Please either store your access token in ORCHESTRATOR_TOKEN
or set the
account to use with oidc-agent in the OIDC_ACCOUNT
and the
socket path of the oidc-agent in the OIDC_SOCK
environment variable:
export ORCHESTRATOR_TOKEN=<your access token>
OR
export OIDC_SOCK=<path to the oidc-agent socket>
export OIDC_ACCOUNT=<account to use>
Usually, the OIDC_SOCK
environmental variable is already exported if you
are using oidc-agent.
As an alternative, you can pass the socket path and the account through the
command line with the --oidc-agent-sock
and --oidc-agent-account
parameters.
Usage¶
Command line client for the INDIGO PaaS Orchestrator.
Please, before using this command put your a valid OpenID Connnect access token into the ORCHESTRATOR_TOKEN environment variable, so that we can use this token for authentication.
orpy
[--version]
[-v | -q]
[--log-file LOG_FILE]
[--debug]
[--oidc-agent-sock <oidc-agent-socket>]
[--oidc-agent-account <oidc-agent-account>]
[--url <orchestrator-url>]
-
--version
¶
show program’s version number and exit
-
-v
,
--verbose
¶
Increase verbosity of output. Can be repeated.
-
-q
,
--quiet
¶
Suppress output except warnings and errors.
-
--log-file
<LOG_FILE>
¶ Specify a file to log output. Disabled by default.
-
--debug
¶
Show tracebacks on errors.
-
--oidc-agent-sock
<oidc-agent-socket>
¶ The path for the oidc-agent socket to use to get and renew access tokens from the OpenID Connect provider. This defaults to the OIDC_SOCK environment variable, that should be automatically set up if you are using oidc-agent. In order to use the oidc-agent you must also pass the –oidc-agent-account parameter, or set the OIDC_ACCOUNT environment variable.
-
--oidc-agent-account
<oidc-agent-account>
¶ The oidc-agent account that we will use to get tokens from. In order to use the oidc-agent you must pass thos parameter or set the OIDC_ACCOUNT environment variable.
-
--url
<orchestrator-url>
¶ The base url of the orchestrator rest interface. Alternative the environment variable ORCHESTRATOR_URL can be used.
Authentication:
In order to interact with the INDIGO PaaS Orchestrator we need to use an OpenID Connect access token from a trusted OpenID Connect provider at the orchestrator.
Please either store your access token in ‘ORCHESTRATOR_TOKEN’ or set the account to use with oidc-agent in the ‘OIDC_ACCOUNT’ and the socket path of the oidc-agent in the ‘OIDC_SOCK’ environment variable:
- export ORCHESTRATOR_TOKEN=<your access token>
- OR
export OIDC_SOCK=<path to the oidc-agent socket> export OIDC_ACCOUNT=<account to use>
Usually, the OIDC_SOCK environmental variable is already exported if you are using oidc-agent.
As an alternative, you can pass the socket path and the account through the command line with the –oidc-agent-sock and –oidc-agent-account parameters.
List of commands¶
Query orchestrator information¶
Manage deployments¶
deployment create¶
Create a deployment.
orpy deployment create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--callback-url CALLBACK]
[--max-providers-retry MAX_RETRIES]
[--keep-last-attempt KEEP_LAST]
<template
file>
[<parameter>=<value> [<parameter>=<value> ...]]
-
-f
<FORMATTER>
,
--format
<FORMATTER>
¶ the output format, defaults to table
-
-c
COLUMN
,
--column
COLUMN
¶ specify the column(s) to include, can be repeated to show multiple columns
-
--noindent
¶
whether to disable indenting the JSON
-
--prefix
<PREFIX>
¶ add a prefix to all variable names
-
--max-width
<integer>
¶ Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
-
--fit-width
¶
Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
-
--print-empty
¶
Print empty table if there is no data to show.
-
--callback-url
<CALLBACK>
¶ The callback url.
-
--max-providers-retry
<MAX_RETRIES>
¶ Maximum number of cloud providers to be used in case of failure (Default is to be unbounded).
-
--keep-last-attempt
<KEEP_LAST>
¶ In case of failure, keep the resources allocated in the last try (Default: True, accepts boolean values).
-
template
file
¶ TOSCA template file.
-
parameter>
=<value
¶ Input parameter for the deployment in the form <parameter>=<value>. Can be specified several times.
This command is provided by the orpy plugin.
deployment delete¶
Show details about an existing deployment.
orpy deployment delete <deployment uuid>
-
deployment
uuid
¶ Deployment UUID to delete.
This command is provided by the orpy plugin.
deployment list¶
List existing deployments at orchestrator.
orpy deployment list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
-
-f
<FORMATTER>
,
--format
<FORMATTER>
¶ the output format, defaults to table
-
-c
COLUMN
,
--column
COLUMN
¶ specify the column(s) to include, can be repeated to show multiple columns
-
--quote
<QUOTE_MODE>
¶ when to include quotes, defaults to nonnumeric
-
--noindent
¶
whether to disable indenting the JSON
-
--max-width
<integer>
¶ Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
-
--fit-width
¶
Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
-
--print-empty
¶
Print empty table if there is no data to show.
-
--sort-column
SORT_COLUMN
¶ specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
This command is provided by the orpy plugin.
deployment show¶
Show details about an existing deployment.
orpy deployment show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[-l]
<deployment
uuid>
-
-f
<FORMATTER>
,
--format
<FORMATTER>
¶ the output format, defaults to table
-
-c
COLUMN
,
--column
COLUMN
¶ specify the column(s) to include, can be repeated to show multiple columns
-
--noindent
¶
whether to disable indenting the JSON
-
--prefix
<PREFIX>
¶ add a prefix to all variable names
-
--max-width
<integer>
¶ Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
-
--fit-width
¶
Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
-
--print-empty
¶
Print empty table if there is no data to show.
-
-l
,
--long
¶
Show additional fields in output.
-
deployment
uuid
¶ Deployment UUID to show.
This command is provided by the orpy plugin.
deployment template¶
Get template used for a given deployment.
orpy deployment template
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<deployment
uuid>
-
-f
<FORMATTER>
,
--format
<FORMATTER>
¶ the output format, defaults to table
-
-c
COLUMN
,
--column
COLUMN
¶ specify the column(s) to include, can be repeated to show multiple columns
-
--noindent
¶
whether to disable indenting the JSON
-
--prefix
<PREFIX>
¶ add a prefix to all variable names
-
--max-width
<integer>
¶ Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
-
--fit-width
¶
Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
-
--print-empty
¶
Print empty table if there is no data to show.
-
deployment
uuid
¶ Deployment UUID to get template for.
This command is provided by the orpy plugin.
deployment update¶
Update an existing deployment.
orpy deployment update
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--callback-url CALLBACK]
[--max-providers-retry MAX_RETRIES]
[--keep-last-attempt KEEP_LAST]
<deployment
uuid>
<template
file>
[<parameter>=<value> [<parameter>=<value> ...]]
-
-f
<FORMATTER>
,
--format
<FORMATTER>
¶ the output format, defaults to table
-
-c
COLUMN
,
--column
COLUMN
¶ specify the column(s) to include, can be repeated to show multiple columns
-
--noindent
¶
whether to disable indenting the JSON
-
--prefix
<PREFIX>
¶ add a prefix to all variable names
-
--max-width
<integer>
¶ Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
-
--fit-width
¶
Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
-
--print-empty
¶
Print empty table if there is no data to show.
-
--callback-url
<CALLBACK>
¶ The callback url.
-
--max-providers-retry
<MAX_RETRIES>
¶ Maximum number of cloud providers to be used in case of failure (Default is to be unbounded).
-
--keep-last-attempt
<KEEP_LAST>
¶ In case of failure, keep the resources allocated in the last try (Default: True, accepts boolean values).
-
deployment
uuid
¶ Deployment UUID to update.
-
template
file
¶ TOSCA template file.
-
parameter>
=<value
¶ Input parameter for the deployment in the form <parameter>=<value>. Can be specified several times.
This command is provided by the orpy plugin.
Manage resources¶
resource list¶
List Resources for a given deployment.
orpy resource list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
<deployment
uuid>
-
-f
<FORMATTER>
,
--format
<FORMATTER>
¶ the output format, defaults to table
-
-c
COLUMN
,
--column
COLUMN
¶ specify the column(s) to include, can be repeated to show multiple columns
-
--quote
<QUOTE_MODE>
¶ when to include quotes, defaults to nonnumeric
-
--noindent
¶
whether to disable indenting the JSON
-
--max-width
<integer>
¶ Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
-
--fit-width
¶
Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
-
--print-empty
¶
Print empty table if there is no data to show.
-
--sort-column
SORT_COLUMN
¶ specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
deployment
uuid
¶ Deployment UUID to show.
This command is provided by the orpy plugin.
resource show¶
Show details about a resource for a given deployment.
orpy resource show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<deployment
uuid>
<resource
uuid>
-
-f
<FORMATTER>
,
--format
<FORMATTER>
¶ the output format, defaults to table
-
-c
COLUMN
,
--column
COLUMN
¶ specify the column(s) to include, can be repeated to show multiple columns
-
--noindent
¶
whether to disable indenting the JSON
-
--prefix
<PREFIX>
¶ add a prefix to all variable names
-
--max-width
<integer>
¶ Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
-
--fit-width
¶
Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
-
--print-empty
¶
Print empty table if there is no data to show.
-
deployment
uuid
¶ Deployment UUID for the resource.
-
resource
uuid
¶ Resource UUID to show.
This command is provided by the orpy plugin.