PYTHON-MURANOCLIENT(1)

📦 version 2.5.0, in debian bookworm

🌸 NAME 🌸

python-muranoclient — bestie, this is the whole vibe in one line. It's the client for the OpenStack Application Catalog API. There's a Python API (the muranoclient module) and a command-line script (installed as murano). Two ways in, one iconic tool. 💅

✨ MURANO API CLIENT ✨

So you wanna hit the python API directly? Okay, first things first: you gotta get yourself an auth token and figure out which endpoint you're speaking to. Once that's done, you can use the API like this, no cap:

>>> from muranoclient import Client
>>> murano = Client('1', endpoint=MURANO_URL, token=OS_AUTH_TOKEN)
...

🎀 Command-line Tool 🎀

For the CLI you need to hand over your OpenStack username, password, tenant, and auth endpoint. Use the matching config options (:option:--os-username, :option:--os-password, :option:--os-tenant-id, and :option:--os-auth-url) or just set them in environment variables, whichever is more your vibe:

export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v2.0

The command line tool will attempt to reauthenticate using your provided credentials for every request. You can override this behavior by manually supplying an auth token using :option:--os-image-url and :option:--os-auth-token. Orrr you can set these environment variables instead:

export MURANO_URL=http://murano.example.org:8082/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155

Once you've configured your authentication parameters, just run murano help to see a complete listing of available commands. Slay. 💖

🦋 Application Catalog service (murano) command-line client 🦋

The murano client is the command-line interface (CLI) for the Application Catalog service (murano) API and its extensions. It's giving main character energy, honestly.

This chapter documents murano version 0.13.0.

Need help on a specific murano command? Just enter:

$ murano help COMMAND

🌈 murano usage 🌈

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 — the whole roster, bestie, every single one:

  • 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.
  • class-schema — Display class schema
  • deployment-list — List deployments for an environment or multiple environments.
  • env-template-add-app — Add application to the environment template.
  • env-template-clone — Create a new template, cloned from template.
  • env-template-create — Create an environment template.
  • env-template-create-env — Create a new environment from 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-model-edit — Edit an environment's object model.
  • environment-model-show — Display an environment's object model.
  • 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 — Update an existing package.
  • static-action-call — Call static method METHOD of the class CLASS with ARGUMENTS.
  • bash-completion — Prints all of the commands and options to stdout.
  • help — Display help about this program or one of its subcommands.

💜 murano optional arguments 💜

  • --version — Show program's version number and exit.
  • -d, --debug — Defaults to env[MURANOCLIENT_DEBUG].
  • -v, --verbose — Print more verbose output.
  • --cert-file OS_CERT — DEPRECATED! Use --os-cert.
  • --key-file OS_KEY — DEPRECATED! Use --os-key.
  • --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-tenant-id OS_TENANT_ID — Defaults to env[OS_TENANT_ID].
  • --os-tenant-name OS_TENANT_NAME — Defaults to env[OS_TENANT_NAME].
  • --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].
  • --glare-url GLARE_URL — Defaults to env[GLARE_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/
  • --murano-packages-service {murano,glance,glare} — Specifies if murano-api ("murano") or Glance Artifact Repository ("glare") should be used to store murano packages. Defaults to env[MURANO_PACKAGES_SERVICE] or to "murano"
  • --insecure — Explicitly allow client to perform "insecure" TLS (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].
  • --os-cert <certificate> — Defaults to env[OS_CERT].
  • --os-key <key> — Defaults to env[OS_KEY].
  • --timeout <seconds> — Set request timeout (in seconds).
  • --os-auth-url OS_AUTH_URL — Authentication URL
  • --os-domain-id OS_DOMAIN_ID — Domain ID to scope to
  • --os-domain-name OS_DOMAIN_NAME — Domain name to scope to
  • --os-project-id OS_PROJECT_ID — Project ID to scope to
  • --os-project-name OS_PROJECT_NAME — Project name to scope to
  • --os-project-domain-id OS_PROJECT_DOMAIN_ID — Domain ID containing project
  • --os-project-domain-name OS_PROJECT_DOMAIN_NAME — Domain name containing project
  • --os-trust-id OS_TRUST_ID — Trust ID
  • --os-user-id OS_USER_ID — User ID
  • --os-username OS_USERNAME, --os-user-name OS_USERNAME, --os-user_name OS_USERNAME — Username
  • --os-user-domain-id OS_USER_DOMAIN_ID — User's domain id
  • --os-user-domain-name OS_USER_DOMAIN_NAME — User's domain name
  • --os-password OS_PASSWORD — User's password
Heads up bestie: --insecure is literally the "I trust everyone" button. Read that caution again before you use it. 😭

🍓 murano app-show 🍓

usage: murano app-show [-p <PATH>] <ID>

List applications, added to specified environment.

Positional arguments:

  • <ID> — Environment ID to show applications from.

Optional arguments:

  • -p <PATH>, --path <PATH> — Level of detalization to show. Leave empty to browse all applications in the environment.

🧚 murano bundle-import 🧚

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> — Bundle URL, bundle name, or path to the bundle file.

Optional arguments:

  • --is-public — Make packages available to users from other tenants.
  • --exists-action {a,s,u} — Default action when a package already exists.

⭐ murano bundle-save ⭐

usage: murano bundle-save [-p <PATH>] [--no-images] <BUNDLE>

Save a bundle, bestie. 💾 This bad boy downloads a whole bundle of packages plus every dependency they drag along, and drops them at the path you point at. And if that path doesn't exist yet? No stress — it gets created. ✨

🌸 Positional arguments

  • <BUNDLE> — the bundle URL, the bundle name, or a path to the bundle file. Pick your fighter. 🎀

🌸 Optional arguments

  • -p <PATH>, --path <PATH> — where to stash the packages. Don't set it and it'll just use the current directory, living its best life.
  • --no-images — flip this on and it skips downloading images. That's it, that's the whole job. 🙈

🦋 murano category-create

murano category-create <CATEGORY_NAME>

Make a brand-new category. Iconic behaviour, honestly.

🌸 Positional arguments

  • <CATEGORY_NAME> — the name of the category. Go off. 👑

🦋 murano category-delete

murano category-delete <ID> [<ID> ...]

Yeet a category. 🗑️

🌸 Positional arguments

  • <ID> — the ID of the category(ies) you're deleting. Plural is allowed, you can take out several at once.

🦋 murano category-list

murano category-list

Lists every category that's available. That's the whole vibe. ✨

🦋 murano category-show

murano category-show <ID>

Shows you the deets of a category. 👀

🌸 Positional arguments

  • <ID> — the ID of the category(s) to show.

🧚 murano class-schema

murano class-schema [--package-name PACKAGE_NAME]
                    [--class-version CLASS_VERSION]
                    <CLASS> [<METHOD> [<METHOD> ...]]

Displays the schema of a class. ✨

🌸 Positional arguments

  • <CLASS> — the Class FQN.
  • <METHOD> — the method name. You can stack up multiple of these, no cap.

🌸 Optional arguments

  • --package-name PACKAGE_NAME — the FQN of the package where the class is chillin'.
  • --class-version CLASS_VERSION — the class version, or a version range (i.e. a version spec). Versatile queen.

🧚 murano deployment-list

murano deployment-list [--all-environments] [<ID>]

Lists deployments for one environment, or for many environments. Multitasking icon. 💅

🌸 Positional arguments

  • <ID> — the environment ID you want deployments listed for.

🌸 Optional arguments

  • --all-environments — lists every deployment across every environment in the user's tenant. The whole buffet. 🍓

🧚 murano env-template-add-app

murano env-template-add-app <ENV_TEMPLATE_ID> <FILE>

Adds an application to the environment template. Welcome to the fam, app. 🫶

🌸 Positional arguments

  • <ENV_TEMPLATE_ID> — the environment template ID.
  • <FILE> — the path to the template.

🧚 murano env-template-clone

murano env-template-clone <ID> <ENV_TEMPLATE_NAME>

Creates a new template, cloned from an existing template. Twin energy, fr fr. 👯

🌸 Positional arguments

  • <ID> — the environment template ID you're cloning from.
  • <ENV_TEMPLATE_NAME> — the name of the new environment template.

🧚 murano env-template-create

murano env-template-create [--is-public] <ENV_TEMPLATE_NAME>

Creates an environment template. Building from scratch, main character behaviour. ✨

🌸 Positional arguments

  • <ENV_TEMPLATE_NAME> — the name of the environment template.

🌸 Optional arguments

  • --is-public — makes the template available to users from other tenants. Sharing is caring, bestie. 🌈

🧚 murano env-template-create-env

murano env-template-create-env [--region <REGION_NAME>] <ID> <ENV_NAME>

Creates a fresh new environment from a template. Glow-up achieved. 🦋

🌸 Positional arguments

  • <ID> — the environment template ID.
  • <ENV_NAME> — the name of the new environment.

🌸 Optional arguments

  • --region <REGION_NAME> — the name of the target OpenStack region.

🧚 murano env-template-del-app

murano env-template-del-app <ENV_TEMPLATE_ID> <ENV_TEMPLATE_APP_ID>

Deletes an application from the environment template. Not me removing you from the group chat… 😭

🌸 Positional arguments

  • <ENV_TEMPLATE_ID> — the environment template ID.
  • <ENV_TEMPLATE_APP_ID> — the application ID.

🧚 murano env-template-delete

murano env-template-delete <ID> [<ID> ...]

Deletes an environment template. Bye bye, bestie. 👋

🌸 Positional arguments

  • <ID> — the ID of the environment(s) template to delete. (Yes, the original really does phrase it like that, and I love her for it. 💜)

🧚 murano env-template-list

murano env-template-list

Lists the environment templates. Simple, clean, slay. ✨

🧚 murano env-template-show

murano env-template-show <ID>

Displays the details of an environment template. 🔍

🌸 Positional arguments

  • <ID> — the environment template ID.

🧚 murano env-template-update

murano env-template-update <ID> <ENV_TEMPLATE_NAME>

Updates an environment template. Glow up, but make it a command. 💅

🌸 Positional arguments

  • <ID> — the environment template ID.
  • <ENV_TEMPLATE_NAME> — the environment template name.

🔥 murano environment-action-call

murano environment-action-call --action-id <ACTION>
                               [--arguments [<KEY=VALUE> [<KEY=VALUE> ...]]]
                               id

Calls action ACTION in environment ID. What you get back is the id of an asynchronous task that actually executes the action. ⚡

Heads up: actions can only be called on a deployed environment. Don't come for me if you try it on anything else. 💀

Wanna see which actions exist in a given environment? Run environment-show, bestie.

🌸 Positional arguments

  • id — the ID of the Environment to call the action against.

🌸 Optional arguments

  • --action-id <ACTION> — the ID of the action to run.
  • --arguments [<KEY=VALUE> [<KEY=VALUE> ...]] — the action arguments.

🔥 murano environment-action-get-result

murano environment-action-get-result --task-id <TASK> <ID>

Gets the result of TASK in environment ID. The moment of truth. 👀

🌸 Positional arguments

  • <ID> — the ID of the Environment where the task is being executed.

🌸 Optional arguments

  • --task-id <TASK> — the ID of the action to run.

🔥 murano environment-apps-edit

murano environment-apps-edit --session-id <SESSION_ID> <ID> [FILE]

Edits the environment's object model. 🛠️ FILE is a path to a file that contains jsonpatch, which describes the changes to be made to the environment's object-model:

[ { "op": "add", "path": "/-", "value": { ... your-app object model here ... } }, { "op": "replace", "path": "/0/?/name", "value": "new_name" }, ]

NOTE: values like '===id1===', '===id2===', etc. in the resulting object-model will be substituted with uuids. ✨

For more info on jsonpatch, see RFC 6902. iykyk 📚

🌸 Positional arguments

  • <ID> — the ID of the Environment to edit.
  • FILE — the file to read jsonpatch from (defaults to stdin).

🌸 Optional arguments

  • --session-id <SESSION_ID> — the id of a config session.

🔥 murano environment-create

murano environment-create [--join-net-id <NET_ID>]
                          [--join-subnet-id <SUBNET_ID>]
                          [--region <REGION_NAME>]
                          <ENVIRONMENT_NAME>

Creates an environment. Fresh start, new era. 🌱

🌸 Positional arguments

  • <ENVIRONMENT_NAME> — the environment name.

🌸 Optional arguments

  • --join-net-id <NET_ID> — the network id to join.
  • --join-subnet-id <SUBNET_ID> — the subnetwork id to join.
  • --region <REGION_NAME> — the name of the target OpenStack region.

🔥 murano environment-delete

murano environment-delete [--abandon] <NAME or ID> [<NAME or ID> ...]

Deletes an environment. Sayonara. 💀

🌸 Positional arguments

  • <NAME or ID> — the id or name of the environment(s) to delete.

🌸 Optional arguments

  • --abandon — if you set this, it abandons the environment without deleting any of its resources. Big difference, don't sleep on it. 🚨

🔥 murano environment-deploy

murano environment-deploy --session-id <SESSION> <ID>

Starts deployment of a murano environment session. Go time. 🚀

🌸 Positional arguments

  • <ID> — the ID of the Environment to deploy.

🌸 Optional arguments

  • --session-id <SESSION> — the ID of the configuration session to deploy.

🔥 murano environment-list

murano environment-list [--all-tenants] [--tenant <TENANT_ID>]

Lists the environments. The full roster. 📋

🌸 Optional arguments

  • --all-tenants — lets you list environments from all tenants (admin only, so know your power level 👑).
  • --tenant <TENANT_ID> — lets you list environments for a given tenant (admin only too).

🔥 murano environment-model-edit

murano environment-model-edit --session-id <SESSION_ID> <ID> [<FILE>]

Edits an environment's object model. ✏️

🌸 Positional arguments

  • <ID> — the ID of the Environment to edit.
  • <FILE> — the file to read JSON-patch from (defaults to stdin).

🌸 Optional arguments

  • --session-id <SESSION_ID> — the id of a config session.

🔥 murano environment-model-show

murano environment-model-show [--path <PATH>]
                              [--session-id <SESSION_ID>]
                              <ID>

Displays an environment's object model. Peek behind the curtain. 🎀

🌸 Positional arguments

  • <ID> — the ID of the Environment to show.

🌸 Optional arguments

  • --path <PATH> — the path to the Environment model section. Defaults to '/'.
  • --session-id <SESSION_ID> — the id of a config session.

🔥 murano environment-rename

murano environment-rename <NAME or ID> <ENVIRONMENT_NAME>

Renames an environment. Rebrand era. ✨

🌸 Positional arguments

  • <NAME or ID> — the environment ID or name.
  • <ENVIRONMENT_NAME> — the name the environment will be renamed to.

🔥 murano environment-session-create

murano environment-session-create <ID>

Creates a brand-new configuration session for the environment ID. 🎉

🌸 Positional arguments

  • <ID> — the ID of the Environment to add the session to.

🔥 murano environment-show

murano environment-show [--session-id <SESSION_ID>] [--only-apps]
                        <NAME or ID>

Displays the details of an environment. 🔍

🌸 Positional arguments

  • <NAME or ID> — the environment ID or name.

🌸 Optional arguments

  • --session-id <SESSION_ID> — the id of a config session.
  • --only-apps — only prints the apps of the environment. Super useful for automation, bestie. 🤖

💜 murano package-create

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>]

Creates an application package. ✨

🌸 Optional arguments

  • -t <HEAT_TEMPLATE>, --template <HEAT_TEMPLATE> — the path to the Heat template to import as an Application Definition.
  • -c <CLASSES_DIRECTORY>, --classes-dir <CLASSES_DIRECTORY> — the path to the directory containing application classes.
  • -r <RESOURCES_DIRECTORY>, --resources-dir <RESOURCES_DIRECTORY> — the path to the directory containing application resources.
  • -n <DISPLAY_NAME>, --name <DISPLAY_NAME> — the display name of the Application in the Catalog.
  • -f <full-name>, --full-name <full-name> — the fully-qualified name of the Application in the Catalog.
  • -a <AUTHOR>, --author <AUTHOR> — the name of the publisher.
  • --tags [<TAG1 TAG2> [<TAG1 TAG2> ...]] — a list of keywords connected to the application.
  • -d <DESCRIPTION>, --description <DESCRIPTION> — a detailed description for the Application in the 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. 🎀

murano package-delete 🗑️

usage: murano package-delete <ID> [<ID> ...]

Okay so this one deletes a package. Poof, gone, no cap. 💅

Positional arguments:

  • <ID> — package ID to delete. 🆔

murano package-download 📥

usage: murano package-download <ID> [file]

Downloads a package to a filename or straight to stdout, bestie. 🌊

Positional arguments:

  • <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. ⚠️

murano package-import 📦

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, periodt. FILE can be a path to a zip file, a url, or a FQPN. You can use -- to separate FILEs from other arguments. Categories have to be separated with a space and have to be already present in murano — no making up new ones on the fly, bestie. 🚫

Positional arguments:

  • <FILE> — URL of the murano zip package, FQPN, path to zip package or path to directory with package. 🔗

Optional arguments:

  • -c [<CATEGORY> [<CATEGORY> ...]], --categories [<CATEGORY> [<CATEGORY> ...]] — category list to attach. 🏷️
  • --is-public — make the package available for users from other tenants. 🌍
  • --package-version PACKAGE_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: (s)kip, (u)pdate, (a)bort. 🤔
  • --dep-exists-action {a,s,u} — default action when a dependency package already exists: (s)kip, (u)pdate, (a)bort. 🤔

murano package-list 📋

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>]

Lists available packages. Vibe check on what's in the catalog. 🛍️

Optional arguments:

  • --limit LIMIT — show limited number of packages. 🔢
  • --marker MARKER — show packages starting from package with id excluding it. 📍
  • --include-disabled — (no description in the original, bestie — it's giving mystery) 🕵️♀️
  • --owned — (no description in the original either, iconic enigma) 🔮
  • --search <SEARCH_KEYS> — show packages, that match search keys fuzzily. 🔍
  • --name <PACKAGE_NAME> — show packages, whose name match parameter exactly. 🏷️
  • --fqn <PACKAGE_FULLY_QUALIFIED_NAME> — show packages, whose fully qualified name match parameter exactly. 🧬
  • --type <PACKAGE_TYPE> — show packages, whose type match parameter exactly. 🧩
  • --category <PACKAGE_CATEGORY> — show packages, whose categories include parameter. 🗂️
  • --class_name <PACKAGE_CLASS_NAME> — show packages, whose class name match parameter exactly. 🏛️
  • --tag <PACKAGE_TAG> — show packages, whose tags include parameter. 🏷️

murano package-save 💾

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> — package URL or name. 🔗

Optional arguments:

  • -p <PATH>, --path <PATH> — path to the directory to store package. If not set will use current directory. 📁
  • --package-version PACKAGE_VERSION — version of the package to use from repository (ignored when saving with multiple packages). 📌
  • --no-images — if set will skip images downloading. 🖼️

murano package-show 🔍

usage: murano package-show <ID>

Display details for a package. It's giving full dossier. 🕵️♀️

Positional arguments:

  • <ID> — package ID to show. 🆔

murano package-update 🔄

usage: murano package-update [--is-public {true|false}] [--enabled {true|false}] [--name NAME] [--description DESCRIPTION] [--tags [<TAG> [<TAG> ...]]] <ID>

Update an existing package. Glow-up time. 💅

Positional arguments:

  • <ID> — package ID to update. 🆔

Optional arguments:

  • --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. 🏷️

murano static-action-call 🪄

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> — FQN of the class with static method. 🧬
  • <METHOD> — static method to run. ⚡

Optional arguments:

  • --arguments [<KEY=VALUE> [<KEY=VALUE> ...]] — method arguments. No arguments by default. 🧾
  • --package-name <PACKAGE> — optional FQN of the package to look for the class in. 📦
  • --class-version CLASS_VERSION — optional version of the class, otherwise version =0 is used. 📌

FOR CONTRIBUTORS 💖

  • If you are a new contributor to python-muranoclient please refer: So You Want to Contribute... ✨

So You Want to Contribute... 🫶

For general information on contributing to OpenStack, please check out the contributor guide to get started. It covers all the basics that are common to all OpenStack projects: the accounts you need, the basics of interacting with our Gerrit review system, how we communicate as a community, etc. Below will cover the more project specific information you need to get started with python-muranoclient. 🌈

Communication 📣

Contacting the Core Team 👑

Please refer the python-muranoclient Core Team contacts. 💌

New Feature Planning 🚀

python-muranoclient features are tracked on Launchpad. 🛰️

Task Tracking 📌

We track our tasks in Launchpad. If you're looking for some smaller, easier work item to pick up and get started on, search for the 'low-hanging-fruit' tag. 🍓

Reporting a Bug 🐛

You found an issue and want to make sure we are aware of it? You can do so on Launchpad. 🪲

Getting Your Patch Merged 🧚

All changes proposed to the python-muranoclient project require one or two +2 votes from python-muranoclient core reviewers before one of the core reviewers can approve patch by giving Workflow +1 vote. ✅

Project Team Lead Duties 👑

All common PTL duties are enumerated in the PTL guide. 📖

AUTHOR 👻

unknown

OpenStack Foundation

This page is from python-muranoclient, dated Sep 23, 2022, and it's the PYTHON-MURANOCLIENT(1) manual. Periodt. 💅✨

📦 where this page comes from