The murano client is the command-line interface (CLI) for the Application Catalog service (murano) API and its extensions.
This chapter documents murano version 0.13.0
.
For help on a specific murano command, enter:
$ murano help COMMAND
usage: murano [--version] [-d] [-v] [--cert-file OS_CERT] [--key-file OS_KEY]
[--ca-file OS_CACERT] [--api-timeout API_TIMEOUT]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[--os-region-name OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth]
[--murano-url MURANO_URL] [--glance-url GLANCE_URL]
[--glare-url GLARE_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]
[--murano-packages-service {murano,glance,glare}] [--insecure]
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
[--os-key <key>] [--timeout <seconds>]
[--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
[--os-domain-name OS_DOMAIN_NAME]
[--os-project-id OS_PROJECT_ID]
[--os-project-name OS_PROJECT_NAME]
[--os-project-domain-id OS_PROJECT_DOMAIN_ID]
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
[--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID]
[--os-username OS_USERNAME]
[--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-password OS_PASSWORD]
<subcommand> ...
Subcommands:
app-show
bundle-import
bundle-save
category-create
category-delete
category-list
category-show
class-schema
deployment-list
env-template-add-app
env-template-clone
env-template-create
env-template-create-env
env-template-del-app
env-template-delete
env-template-list
env-template-show
env-template-update
environment-action-call
environment-action-get-result
environment-apps-edit
environment-create
environment-delete
environment-deploy
environment-list
environment-model-edit
environment-model-show
environment-rename
environment-session-create
environment-show
package-create
package-delete
package-download
package-import
package-list
package-save
package-show
package-update
static-action-call
bash-completion
help
--version
-d, --debug
env[MURANOCLIENT_DEBUG]
.-v, --verbose
--cert-file OS_CERT
--key-file OS_KEY
--ca-file OS_CACERT
--api-timeout API_TIMEOUT
--os-tenant-id OS_TENANT_ID
env[OS_TENANT_ID]
.--os-tenant-name OS_TENANT_NAME
env[OS_TENANT_NAME]
.--os-region-name OS_REGION_NAME
env[OS_REGION_NAME]
.--os-auth-token OS_AUTH_TOKEN
env[OS_AUTH_TOKEN]
.--os-no-client-auth
env[OS_NO_CLIENT_AUTH]
.--murano-url MURANO_URL
env[MURANO_URL]
.--glance-url GLANCE_URL
env[GLANCE_URL]
.--glare-url GLARE_URL
env[GLARE_URL]
.--murano-api-version MURANO_API_VERSION
env[MURANO_API_VERSION]
or 1.--os-service-type OS_SERVICE_TYPE
env[OS_SERVICE_TYPE]
.--os-endpoint-type OS_ENDPOINT_TYPE
env[OS_ENDPOINT_TYPE]
.--include-password
--murano-repo-url MURANO_REPO_URL
env[MURANO_REPO_URL]
or
http://apps.openstack.org/api/v1/murano_repo/liberty/--murano-packages-service {murano,glance,glare}
env[MURANO_PACKAGES_SERVICE]
or
to “murano”--insecure
--os-cacert <ca-certificate>
env[OS_CACERT]
.--os-cert <certificate>
env[OS_CERT]
.--os-key <key>
env[OS_KEY]
.--timeout <seconds>
--os-auth-url OS_AUTH_URL
--os-domain-id OS_DOMAIN_ID
--os-domain-name OS_DOMAIN_NAME
--os-project-id OS_PROJECT_ID
--os-project-name OS_PROJECT_NAME
--os-project-domain-id OS_PROJECT_DOMAIN_ID
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
--os-trust-id OS_TRUST_ID
--os-user-id OS_USER_ID
--os-username OS_USERNAME, --os-user-name OS_USERNAME, --os-user_name OS_USERNAME
--os-user-domain-id OS_USER_DOMAIN_ID
--os-user-domain-name OS_USER_DOMAIN_NAME
--os-password OS_PASSWORD
usage: murano app-show [-p <PATH>] <ID>
List applications, added to specified environment.
Positional arguments:
<ID>
Optional arguments:
-p <PATH>, --path <PATH>
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.
Positional arguments:
<FILE>
Optional arguments:
--is-public
--exists-action {a,s,u}
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.
Positional arguments:
<BUNDLE>
Optional arguments:
-p <PATH>, --path <PATH>
--no-images
usage: murano category-create <CATEGORY_NAME>
Create a category.
Positional arguments:
<CATEGORY_NAME>
usage: murano category-delete <ID> [<ID> ...]
Delete a category.
Positional arguments:
<ID>
usage: murano category-show <ID>
Display category details.
Positional arguments:
<ID>
usage: murano class-schema [--package-name PACKAGE_NAME]
[--class-version CLASS_VERSION]
<CLASS> [<METHOD> [<METHOD> ...]]
Display class schema
Positional arguments:
<CLASS>
<METHOD>
Optional arguments:
--package-name PACKAGE_NAME
--class-version CLASS_VERSION
usage: murano deployment-list [--all-environments] [<ID>]
List deployments for an environment or multiple environments.
Positional arguments:
<ID>
Optional arguments:
--all-environments
usage: murano env-template-add-app <ENV_TEMPLATE_ID> <FILE>
Add application to the environment template.
Positional arguments:
<ENV_TEMPLATE_ID>
<FILE>
usage: murano env-template-clone <ID> <ENV_TEMPLATE_NAME>
Create a new template, cloned from template.
Positional arguments:
<ID>
<ENV_TEMPLATE_NAME>
usage: murano env-template-create [--is-public] <ENV_TEMPLATE_NAME>
Create an environment template.
Positional arguments:
<ENV_TEMPLATE_NAME>
Optional arguments:
--is-public
usage: murano env-template-create-env [--region <REGION_NAME>] <ID> <ENV_NAME>
Create a new environment from template.
Positional arguments:
<ID>
<ENV_NAME>
Optional arguments:
--region <REGION_NAME>
usage: murano env-template-del-app <ENV_TEMPLATE_ID> <ENV_TEMPLATE_APP_ID>
Delete application from the environment template.
Positional arguments:
<ENV_TEMPLATE_ID>
<ENV_TEMPLATE_APP_ID>
usage: murano env-template-delete <ID> [<ID> ...]
Delete an environment template.
Positional arguments:
<ID>
usage: murano env-template-show <ID>
Display environment template details.
Positional arguments:
<ID>
usage: murano env-template-update <ID> <ENV_TEMPLATE_NAME>
Update an environment template.
Positional arguments:
<ID>
<ENV_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.
Positional arguments:
id
Optional arguments:
--action-id <ACTION>
--arguments [<KEY=VALUE> [<KEY=VALUE> ...]]
usage: murano environment-action-get-result --task-id <TASK> <ID>
Get result of `TASK` in environment `ID`.
Positional arguments:
<ID>
Optional arguments:
--task-id <TASK>
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
Positional arguments:
<ID>
FILE
Optional arguments:
--session-id <SESSION_ID>
usage: murano environment-create [--join-net-id <NET_ID>]
[--join-subnet-id <SUBNET_ID>]
[--region <REGION_NAME>]
<ENVIRONMENT_NAME>
Create an environment.
Positional arguments:
<ENVIRONMENT_NAME>
Optional arguments:
--join-net-id <NET_ID>
--join-subnet-id <SUBNET_ID>
--region <REGION_NAME>
usage: murano environment-delete [--abandon] <NAME or ID> [<NAME or ID> ...]
Delete an environment.
Positional arguments:
<NAME or ID>
Optional arguments:
--abandon
usage: murano environment-deploy --session-id <SESSION> <ID>
Start deployment of a murano environment session.
Positional arguments:
<ID>
Optional arguments:
--session-id <SESSION>
usage: murano environment-list [--all-tenants] [--tenant <TENANT_ID>]
List the environments.
Optional arguments:
--all-tenants
--tenant <TENANT_ID>
usage: murano environment-model-edit --session-id <SESSION_ID> <ID> [<FILE>]
Edit an environment’s object model.
Positional arguments:
<ID>
<FILE>
Optional arguments:
--session-id <SESSION_ID>
usage: murano environment-model-show [--path <PATH>]
[--session-id <SESSION_ID>]
<ID>
Display an environment’s object model.
Positional arguments:
<ID>
Optional arguments:
--path <PATH>
--session-id <SESSION_ID>
usage: murano environment-rename <NAME or ID> <ENVIRONMENT_NAME>
Rename an environment.
Positional arguments:
<NAME or ID>
<ENVIRONMENT_NAME>
usage: murano environment-session-create <ID>
Creates a new configuration session for environment ID.
Positional arguments:
<ID>
usage: murano environment-show [--session-id <SESSION_ID>] [--only-apps]
<NAME or ID>
Display environment details.
Positional arguments:
<NAME or ID>
Optional arguments:
--session-id <SESSION_ID>
--only-apps
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.
Optional arguments:
-t <HEAT_TEMPLATE>, --template <HEAT_TEMPLATE>
-c <CLASSES_DIRECTORY>, --classes-dir <CLASSES_DIRECTORY>
-r <RESOURCES_DIRECTORY>, --resources-dir <RESOURCES_DIRECTORY>
-n <DISPLAY_NAME>, --name <DISPLAY_NAME>
-f <full-name>, --full-name <full-name>
-a <AUTHOR>, --author <AUTHOR>
--tags [<TAG1 TAG2> [<TAG1 TAG2> ...]]
-d <DESCRIPTION>, --description <DESCRIPTION>
-o <PACKAGE_NAME>, --output <PACKAGE_NAME>
-u <UI_DEFINITION>, --ui <UI_DEFINITION>
--type TYPE
-l <LOGO>, --logo <LOGO>
usage: murano package-delete <ID> [<ID> ...]
Delete a package.
Positional arguments:
<ID>
usage: murano package-download <ID> [file]
Download a package to a filename or stdout.
Positional arguments:
<ID>
file
usage: murano package-import [-c [<CATEGORY> [<CATEGORY> ...]]] [--is-public]
[--package-version PACKAGE_VERSION]
[--exists-action {a,s,u}]
[--dep-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.
Positional arguments:
<FILE>
Optional arguments:
-c [<CATEGORY> [<CATEGORY> ...]], --categories [<CATEGORY> [<CATEGORY> ...]]
--is-public
--package-version PACKAGE_VERSION
--exists-action {a,s,u}
--dep-exists-action {a,s,u}
usage: murano package-list [--limit LIMIT] [--marker MARKER]
[--include-disabled] [--owned]
[--search <SEARCH_KEYS>] [--name <PACKAGE_NAME>]
[--fqn <PACKAGE_FULLY_QUALIFIED_NAME>]
[--type <PACKAGE_TYPE>]
[--category <PACKAGE_CATEGORY>]
[--class_name <PACKAGE_CLASS_NAME>]
[--tag <PACKAGE_TAG>]
List available packages.
Optional arguments:
--limit LIMIT
--marker MARKER
--include-disabled
--owned
--search <SEARCH_KEYS>
--name <PACKAGE_NAME>
--fqn <PACKAGE_FULLY_QUALIFIED_NAME>
--type <PACKAGE_TYPE>
--category <PACKAGE_CATEGORY>
--class_name <PACKAGE_CLASS_NAME>
--tag <PACKAGE_TAG>
usage: murano package-save [-p <PATH>] [--package-version PACKAGE_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.
Positional arguments:
<PACKAGE>
Optional arguments:
-p <PATH>, --path <PATH>
--package-version PACKAGE_VERSION
--no-images
usage: murano package-show <ID>
Display details for a package.
Positional arguments:
<ID>
usage: murano package-update [--is-public {true|false}]
[--enabled {true|false}] [--name NAME]
[--description DESCRIPTION]
[--tags [<TAG> [<TAG> ...]]]
<ID>
Update an existing package.
Positional arguments:
<ID>
Optional arguments:
--is-public {true|false}
--enabled {true|false}
--name NAME
--description DESCRIPTION
--tags [<TAG> [<TAG> ...]]
usage: murano static-action-call [--arguments [<KEY=VALUE> [<KEY=VALUE> ...]]]
[--package-name <PACKAGE>]
[--class-version CLASS_VERSION]
<CLASS> <METHOD>
Call static method `METHOD` of the class `CLASS` with `ARGUMENTS`. Returns the result of the method execution. `PACKAGE` and `CLASS_VERSION` can be specified optionally to find class in a particular package and to look for the specific version of a class respectively.
Positional arguments:
<CLASS>
<METHOD>
Optional arguments:
--arguments [<KEY=VALUE> [<KEY=VALUE> ...]]
--package-name <PACKAGE>
--class-version CLASS_VERSION
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.