The murano client is the command-line interface (CLI) for the Application catalog API and its extensions. This chapter documents murano version 0.7.1. For help on a specific murano command, enter: $ murano help COMMAND

usage: murano [--version] [-d] [-v] [-k] [--os-cacert <ca-certificate>] [--cert-file CERT_FILE] [--key-file KEY_FILE] [--ca-file OS_CACERT] [--api-timeout API_TIMEOUT] [--os-username OS_USERNAME] [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth] [--murano-url MURANO_URL] [--glance-url GLANCE_URL] [--murano-api-version MURANO_API_VERSION] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint-type OS_ENDPOINT_TYPE] [--include-password] [--murano-repo-url MURANO_REPO_URL] <subcommand> ... app-show List applications, added to specified environment. bundle-import Import a bundle. bundle-save Save a bundle. category-create Create a category. category-delete Delete a category. category-list List all available categories. category-show Display category details. deployment-list List deployments for an environment. env-template-add-app Add application to the environment template. env-template-create Create an environment template. env-template-del-app Delete application from the environment template. env-template-delete Delete an environment template. env-template-list List the environments templates. env-template-show Display environment template details. env-template-update Update an environment template. environment-action-call Call action `ACTION` in environment `ID`. environment-action-get-result Get result of `TASK` in environment `ID`. environment-apps-edit Edit environment's object model. environment-create Create an environment. environment-delete Delete an environment. environment-deploy Start deployment of a murano environment session. environment-list List the environments. environment-rename Rename an environment. environment-session-create Creates a new configuration session for environment ID. environment-show Display environment details. package-create Create an application package. package-delete Delete a package. package-download Download a package to a filename or stdout. package-import Import a package. package-list List available packages. package-save Save a package. package-show Display details for a package. package-update Edit the package in question bash-completion Prints all of the commands and options to stdout. help Display help about this program or one of its subcommands.

--version Show program's version number and exit. -d, --debug Defaults to env[MURANOCLIENT_DEBUG]. -v, --verbose Print more verbose output. -k, --insecure Explicitly allow muranoclient to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution. --os-cacert <ca-certificate> Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT]. --cert-file CERT_FILE Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key. --key-file KEY_FILE Path of client key to use in SSL connection. This option is not necessary if your key is prepended to your cert file. --ca-file OS_CACERT DEPRECATED! Use --os-cacert. --api-timeout API_TIMEOUT Number of seconds to wait for an API response, defaults to system socket timeout. --os-username OS_USERNAME Defaults to env[OS_USERNAME]. --os-password OS_PASSWORD Defaults to env[OS_PASSWORD]. --os-tenant-id OS_TENANT_ID Defaults to env[OS_TENANT_ID]. --os-tenant-name OS_TENANT_NAME Defaults to env[OS_TENANT_NAME]. --os-auth-url OS_AUTH_URL Defaults to env[OS_AUTH_URL]. --os-region-name OS_REGION_NAME Defaults to env[OS_REGION_NAME]. --os-auth-token OS_AUTH_TOKEN Defaults to env[OS_AUTH_TOKEN]. --os-no-client-auth Do not contact keystone for a token. Defaults to env[OS_NO_CLIENT_AUTH]. --murano-url MURANO_URL Defaults to env[MURANO_URL]. --glance-url GLANCE_URL Defaults to env[GLANCE_URL]. --murano-api-version MURANO_API_VERSION Defaults to env[MURANO_API_VERSION] or 1. --os-service-type OS_SERVICE_TYPE Defaults to env[OS_SERVICE_TYPE]. --os-endpoint-type OS_ENDPOINT_TYPE Defaults to env[OS_ENDPOINT_TYPE]. --include-password Send os-username and os-password to murano. --murano-repo-url MURANO_REPO_URL Defaults to env[MURANO_REPO_URL] or http://apps.openstack.org/api/v1/murano_repo/liberty/

usage: murano app-show [-p <PATH>] <ID> List applications, added to specified environment. <ID> Environment ID to show applications from. -p <PATH>, --path <PATH> Level of detalization to show. Leave empty to browse all applications in the environment.

usage: murano bundle-import [--is-public] [--exists-action {a,s,u}] <FILE> [<FILE> ...] Import a bundle. `FILE` can be either a path to a zip file, URL, or name from repo. If `FILE` is a local file, treat names of packages in a bundle as file names, relative to location of the bundle file. Requirements are first searched in the same directory. <FILE> Bundle URL, bundle name, or path to the bundle file. --is-public Make packages available to users from other tenants. --exists-action {a,s,u} Default action when a package already exists.

usage: murano bundle-save [-p <PATH>] [--no-images] <BUNDLE> Save a bundle. This will download a bundle of packages with all dependencies to specified path. If path doesn't exist it will be created. <BUNDLE> Bundle URL, bundle name, or path to the bundle file. -p <PATH>, --path <PATH> Path to the directory to store packages. If not set will use current directory. --no-images If set will skip images downloading.

usage: murano category-create <CATEGORY_NAME> Create a category. <CATEGORY_NAME> Category name.

usage: murano category-delete <ID> [<ID> ...] Delete a category. <ID> ID of a category(ies) to delete.

usage: murano category-list List all available categories.

usage: murano category-show <ID> Display category details. <ID> ID of a category(s) to show.

usage: murano deployment-list <ID> List deployments for an environment. <ID> Environment ID for which to list deployments.

usage: murano env-template-add-app <ENV_TEMPLATE_NAME> <FILE> Add application to the environment template. <ENV_TEMPLATE_NAME> Environment template name. <FILE> Path to the template.

usage: murano env-template-create <ENV_TEMPLATE_NAME> Create an environment template. <ENV_TEMPLATE_NAME> Environment template name.

usage: murano env-template-del-app <ENV_TEMPLATE_ID> <ENV_TEMPLATE_APP_ID> Delete application from the environment template. <ENV_TEMPLATE_ID> Environment template ID. <ENV_TEMPLATE_APP_ID> Application ID.

usage: murano env-template-delete <ID> [<ID> ...] Delete an environment template. <ID> ID of environment(s) template to delete.

usage: murano env-template-list List the environments templates.

usage: murano env-template-show <ID> Display environment template details. <ID> Environment template ID.

usage: murano env-template-update <ID> <ENV_TEMPLATE_NAME> Update an environment template. <ID> Environment template ID. <ENV_TEMPLATE_NAME> Environment template name.

usage: murano environment-action-call --action-id <ACTION> [--arguments [<KEY=VALUE> [<KEY=VALUE> ...]]] id Call action `ACTION` in environment `ID`. Returns id of an asynchronous task, that executes the action. Actions can only be called on a `deployed` environment. To view actions available in a given environment use `environment-show` command. id ID of Environment to call action against. --action-id <ACTION> ID of action to run. --arguments [<KEY=VALUE> [<KEY=VALUE> ...]] Action arguments.

usage: murano environment-action-get-result --task-id <TASK> <ID> Get result of `TASK` in environment `ID`. <ID> ID of Environment where task is being executed. --task-id <TASK> ID of action to run.

usage: murano environment-apps-edit --session-id <SESSION_ID> <ID> [FILE] Edit environment's object model. `FILE` is path to a file, that contains jsonpatch, that describes changes to be made to environment's object-model. [ { "op": "add", "path": "/-", "value": { ... your-app object model here ... } }, { "op": "replace", "path": "/0/?/name", "value": "new_name" }, ] NOTE: Values '===id1===', '===id2===', etc. in the resulting object-model will be substituted with uuids. For more info on jsonpatch see RFC 6902 <ID> ID of Environment to edit. FILE File to read jsonpatch from (defaults to stdin). --session-id <SESSION_ID> Id of a config session.

usage: murano environment-create [--join-net-id <NET_ID>] [--join-subnet-id <SUBNET_ID>] <ENVIRONMENT_NAME> Create an environment. <ENVIRONMENT_NAME> Environment name. --join-net-id <NET_ID> Network id to join. --join-subnet-id <SUBNET_ID> Subnetwork id to join.

usage: murano environment-delete [--abandon] <NAME or ID> [<NAME or ID> ...] Delete an environment. <NAME or ID> Id or name of environment(s) to delete. --abandon If set will abandon environment without deleting any of its resources.

usage: murano environment-deploy --session-id <SESSION> <ID> Start deployment of a murano environment session. <ID> ID of Environment to deploy. --session-id <SESSION> ID of configuration session to deploy.

usage: murano environment-list [--all-tenants] List the environments. --all-tenants Allows to list environments from all tenants (admin only).

usage: murano environment-rename <NAME or ID> <ENVIRONMENT_NAME> Rename an environment. <NAME or ID> Environment ID or name. <ENVIRONMENT_NAME> A name to which the environment will be renamed.

usage: murano environment-session-create <ID> Creates a new configuration session for environment ID. <ID> ID of Environment to add session to.

usage: murano environment-show [--session-id <SESSION_ID>] [--only-apps] <NAME or ID> Display environment details. <NAME or ID> Environment ID or name. --session-id <SESSION_ID> Id of a config session. --only-apps Only print apps of the environment (useful for automation).

usage: murano package-create [-t <HEAT_TEMPLATE>] [-c <CLASSES_DIRECTORY>] [-r <RESOURCES_DIRECTORY>] [-n <DISPLAY_NAME>] [-f <full-name>] [-a <AUTHOR>] [--tags [<TAG1 TAG2> [<TAG1 TAG2> ...]]] [-d <DESCRIPTION>] [-o <PACKAGE_NAME>] [-u <UI_DEFINITION>] [--type TYPE] [-l <LOGO>] Create an application package. -t <HEAT_TEMPLATE>, --template <HEAT_TEMPLATE> Path to the Heat template to import as an Application Definition. -c <CLASSES_DIRECTORY>, --classes-dir <CLASSES_DIRECTORY> Path to the directory containing application classes. -r <RESOURCES_DIRECTORY>, --resources-dir <RESOURCES_DIRECTORY> Path to the directory containing application resources. -n <DISPLAY_NAME>, --name <DISPLAY_NAME> Display name of the Application in Catalog. -f <full-name>, --full-name <full-name> Fully-qualified name of the Application in Catalog. -a <AUTHOR>, --author <AUTHOR> Name of the publisher. --tags [<TAG1 TAG2> [<TAG1 TAG2> ...]] A list of keywords connected to the application. -d <DESCRIPTION>, --description <DESCRIPTION> Detailed description for the Application in Catalog. -o <PACKAGE_NAME>, --output <PACKAGE_NAME> The name of the output file archive to save locally. -u <UI_DEFINITION>, --ui <UI_DEFINITION> Dynamic UI form definition. --type TYPE Package type. Possible values: Application or Library. -l <LOGO>, --logo <LOGO> Path to the package logo.

usage: murano package-delete <ID> [<ID> ...] Delete a package. <ID> Package ID to delete.

usage: murano package-download <ID> [file] Download a package to a filename or stdout. <ID> Package ID to download. file Filename to save package to. If it is not specified and there is no stdout redirection the package won't be saved.

usage: murano package-import [-c [<CATEGORY> [<CATEGORY> ...]]] [--is-public] [--version VERSION] [--exists-action {a,s,u}] <FILE> [<FILE> ...] Import a package. `FILE` can be either a path to a zip file, url or a FQPN. You can use `--` to separate `FILE`s from other arguments. Categories have to be separated with a space and have to be already present in murano. <FILE> URL of the murano zip package, FQPN, or path to zip package. -c [<CATEGORY> [<CATEGORY> ...]], --categories [<CATEGORY> [<CATEGORY> ...]] Category list to attach. --is-public Make the package available for users from other tenants. --version VERSION Version of the package to use from repository (ignored when importing with multiple packages). --exists-action {a,s,u} Default action when a package already exists.

usage: murano package-list [--include-disabled] List available packages. --include-disabled

usage: murano package-save [-p <PATH>] [--version VERSION] [--no-images] <PACKAGE> [<PACKAGE> ...] Save a package. This will download package(s) with all dependencies to specified path. If path doesn't exist it will be created. <PACKAGE> Package URL or name. -p <PATH>, --path <PATH> Path to the directory to store package. If not set will use current directory. --version VERSION Version of the package to use from repository (ignored when saving with multiple packages). --no-images If set will skip images downloading.

usage: murano package-show <ID> Display details for a package. <ID> Package ID to show.

usage: murano package-update [--is-public {true|false}] [--enabled {true|false}] [--name NAME] [--description DESCRIPTION] [--tags [<TAG> [<TAG> ...]]] <ID> Edit the package in question <ID> Package ID to update. --is-public {true|false} Make package available to users from other tenants. --enabled {true|false} Make package active and available for deployments. --name NAME New name for the package. --description DESCRIPTION New package description. --tags [<TAG> [<TAG> ...]] A list of keywords connected to the application.