1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
|
========================================================
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.
This chapter documents :command:`murano` version ``0.13.0``.
For help on a specific :command:`murano` command, enter:
.. code-block:: console
$ murano help COMMAND
.. _murano_command_usage:
murano usage
~~~~~~~~~~~~
.. code-block:: console
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``
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_command_options:
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
.. _murano_app-show:
murano app-show
---------------
.. code-block:: console
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:
murano bundle-import
--------------------
.. code-block:: console
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:
murano bundle-save
------------------
.. code-block:: console
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>``
Bundle URL, bundle name, or path to the bundle file.
**Optional arguments:**
``-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.
.. _murano_category-create:
murano category-create
----------------------
.. code-block:: console
usage: murano category-create <CATEGORY_NAME>
Create a category.
**Positional arguments:**
``<CATEGORY_NAME>``
Category name.
.. _murano_category-delete:
murano category-delete
----------------------
.. code-block:: console
usage: murano category-delete <ID> [<ID> ...]
Delete a category.
**Positional arguments:**
``<ID>``
ID of a category(ies) to delete.
.. _murano_category-list:
murano category-list
--------------------
.. code-block:: console
usage: murano category-list
List all available categories.
.. _murano_category-show:
murano category-show
--------------------
.. code-block:: console
usage: murano category-show <ID>
Display category details.
**Positional arguments:**
``<ID>``
ID of a category(s) to show.
.. _murano_class-schema:
murano class-schema
-------------------
.. code-block:: console
usage: murano class-schema [--package-name PACKAGE_NAME]
[--class-version CLASS_VERSION]
<CLASS> [<METHOD> [<METHOD> ...]]
Display class schema
**Positional arguments:**
``<CLASS>``
Class FQN
``<METHOD>``
Method name
**Optional arguments:**
``--package-name PACKAGE_NAME``
FQN of the package where the class is located
``--class-version CLASS_VERSION``
Class version or version range (version spec)
.. _murano_deployment-list:
murano deployment-list
----------------------
.. code-block:: console
usage: murano deployment-list [--all-environments] [<ID>]
List deployments for an environment or multiple environments.
**Positional arguments:**
``<ID>``
Environment ID for which to list deployments.
**Optional arguments:**
``--all-environments``
Lists all deployments for all environments in user's
tenant.
.. _murano_env-template-add-app:
murano env-template-add-app
---------------------------
.. code-block:: console
usage: murano env-template-add-app <ENV_TEMPLATE_ID> <FILE>
Add application to the environment template.
**Positional arguments:**
``<ENV_TEMPLATE_ID>``
Environment template ID.
``<FILE>``
Path to the template.
.. _murano_env-template-clone:
murano env-template-clone
-------------------------
.. code-block:: console
usage: murano env-template-clone <ID> <ENV_TEMPLATE_NAME>
Create a new template, cloned from template.
**Positional arguments:**
``<ID>``
Environment template ID.
``<ENV_TEMPLATE_NAME>``
New environment template name.
.. _murano_env-template-create:
murano env-template-create
--------------------------
.. code-block:: console
usage: murano env-template-create [--is-public] <ENV_TEMPLATE_NAME>
Create an environment template.
**Positional arguments:**
``<ENV_TEMPLATE_NAME>``
Environment template name.
**Optional arguments:**
``--is-public``
Make the template available for users from other
tenants.
.. _murano_env-template-create-env:
murano env-template-create-env
------------------------------
.. code-block:: console
usage: murano env-template-create-env [--region <REGION_NAME>] <ID> <ENV_NAME>
Create a new environment from template.
**Positional arguments:**
``<ID>``
Environment template ID.
``<ENV_NAME>``
New environment name.
**Optional arguments:**
``--region <REGION_NAME>``
Name of the target OpenStack region.
.. _murano_env-template-del-app:
murano env-template-del-app
---------------------------
.. code-block:: console
usage: murano env-template-del-app <ENV_TEMPLATE_ID> <ENV_TEMPLATE_APP_ID>
Delete application from the environment template.
**Positional arguments:**
``<ENV_TEMPLATE_ID>``
Environment template ID.
``<ENV_TEMPLATE_APP_ID>``
Application ID.
.. _murano_env-template-delete:
murano env-template-delete
--------------------------
.. code-block:: console
usage: murano env-template-delete <ID> [<ID> ...]
Delete an environment template.
**Positional arguments:**
``<ID>``
ID of environment(s) template to delete.
.. _murano_env-template-list:
murano env-template-list
------------------------
.. code-block:: console
usage: murano env-template-list
List the environments templates.
.. _murano_env-template-show:
murano env-template-show
------------------------
.. code-block:: console
usage: murano env-template-show <ID>
Display environment template details.
**Positional arguments:**
``<ID>``
Environment template ID.
.. _murano_env-template-update:
murano env-template-update
--------------------------
.. code-block:: console
usage: murano env-template-update <ID> <ENV_TEMPLATE_NAME>
Update an environment template.
**Positional arguments:**
``<ID>``
Environment template ID.
``<ENV_TEMPLATE_NAME>``
Environment template name.
.. _murano_environment-action-call:
murano environment-action-call
------------------------------
.. code-block:: console
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``
ID of Environment to call action against.
**Optional arguments:**
``--action-id <ACTION>``
ID of action to run.
``--arguments [<KEY=VALUE> [<KEY=VALUE> ...]]``
Action arguments.
.. _murano_environment-action-get-result:
murano environment-action-get-result
------------------------------------
.. code-block:: console
usage: murano environment-action-get-result --task-id <TASK> <ID>
Get result of \`TASK\` in environment \`ID\`.
**Positional arguments:**
``<ID>``
ID of Environment where task is being executed.
**Optional arguments:**
``--task-id <TASK>``
ID of action to run.
.. _murano_environment-apps-edit:
murano environment-apps-edit
----------------------------
.. code-block:: console
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>``
ID of Environment to edit.
``FILE``
File to read jsonpatch from (defaults to stdin).
**Optional arguments:**
``--session-id <SESSION_ID>``
Id of a config session.
.. _murano_environment-create:
murano environment-create
-------------------------
.. code-block:: console
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>``
Environment name.
**Optional arguments:**
``--join-net-id <NET_ID>``
Network id to join.
``--join-subnet-id <SUBNET_ID>``
Subnetwork id to join.
``--region <REGION_NAME>``
Name of the target OpenStack region.
.. _murano_environment-delete:
murano environment-delete
-------------------------
.. code-block:: console
usage: murano environment-delete [--abandon] <NAME or ID> [<NAME or ID> ...]
Delete an environment.
**Positional arguments:**
``<NAME or ID>``
Id or name of environment(s) to delete.
**Optional arguments:**
``--abandon``
If set will abandon environment without deleting any of its
resources.
.. _murano_environment-deploy:
murano environment-deploy
-------------------------
.. code-block:: console
usage: murano environment-deploy --session-id <SESSION> <ID>
Start deployment of a murano environment session.
**Positional arguments:**
``<ID>``
ID of Environment to deploy.
**Optional arguments:**
``--session-id <SESSION>``
ID of configuration session to deploy.
.. _murano_environment-list:
murano environment-list
-----------------------
.. code-block:: console
usage: murano environment-list [--all-tenants] [--tenant <TENANT_ID>]
List the environments.
**Optional arguments:**
``--all-tenants``
Allows to list environments from all tenants (admin
only).
``--tenant <TENANT_ID>``
Allows to list environments for a given tenant (admin
only).
.. _murano_environment-model-edit:
murano environment-model-edit
-----------------------------
.. code-block:: console
usage: murano environment-model-edit --session-id <SESSION_ID> <ID> [<FILE>]
Edit an environment's object model.
**Positional arguments:**
``<ID>``
ID of Environment to edit.
``<FILE>``
File to read JSON-patch from (defaults to stdin).
**Optional arguments:**
``--session-id <SESSION_ID>``
Id of a config session.
.. _murano_environment-model-show:
murano environment-model-show
-----------------------------
.. code-block:: console
usage: murano environment-model-show [--path <PATH>]
[--session-id <SESSION_ID>]
<ID>
Display an environment's object model.
**Positional arguments:**
``<ID>``
ID of Environment to show.
**Optional arguments:**
``--path <PATH>``
Path to Environment model section. Defaults to '/'.
``--session-id <SESSION_ID>``
Id of a config session.
.. _murano_environment-rename:
murano environment-rename
-------------------------
.. code-block:: console
usage: murano environment-rename <NAME or ID> <ENVIRONMENT_NAME>
Rename an environment.
**Positional arguments:**
``<NAME or ID>``
Environment ID or name.
``<ENVIRONMENT_NAME>``
A name to which the environment will be renamed.
.. _murano_environment-session-create:
murano environment-session-create
---------------------------------
.. code-block:: console
usage: murano environment-session-create <ID>
Creates a new configuration session for environment ID.
**Positional arguments:**
``<ID>``
ID of Environment to add session to.
.. _murano_environment-show:
murano environment-show
-----------------------
.. code-block:: console
usage: murano environment-show [--session-id <SESSION_ID>] [--only-apps]
<NAME or ID>
Display environment details.
**Positional arguments:**
``<NAME or ID>``
Environment ID or name.
**Optional arguments:**
``--session-id <SESSION_ID>``
Id of a config session.
``--only-apps``
Only print apps of the environment (useful for
automation).
.. _murano_package-create:
murano package-create
---------------------
.. code-block:: console
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>``
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.
.. _murano_package-delete:
murano package-delete
---------------------
.. code-block:: console
usage: murano package-delete <ID> [<ID> ...]
Delete a package.
**Positional arguments:**
``<ID>``
Package ID to delete.
.. _murano_package-download:
murano package-download
-----------------------
.. code-block:: console
usage: murano package-download <ID> [file]
Download a package to a filename or stdout.
**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:
murano package-import
---------------------
.. code-block:: console
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>``
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:
murano package-list
-------------------
.. code-block:: console
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``
Show limited number of packages
``--marker MARKER``
Show packages starting from package with id excluding
it
``--include-disabled``
``--owned``
``--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:
murano package-save
-------------------
.. code-block:: console
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:
murano package-show
-------------------
.. code-block:: console
usage: murano package-show <ID>
Display details for a package.
**Positional arguments:**
``<ID>``
Package ID to show.
.. _murano_package-update:
murano package-update
---------------------
.. code-block:: console
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>``
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:
murano static-action-call
-------------------------
.. code-block:: console
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
|