openstack/murano
Code Issues Proposed changes

Retire Murano: remove repo content

Browse Source 
Murano project is retiring
- https://review.opendev.org/c/openstack/governance/+/919358

this commit remove the content of this project repo

Depends-On: https://review.opendev.org/c/openstack/project-config/+/919359/
Change-Id: Ifef553e4438244b3f356312c5c9787c2cb7d18c2
This commit is contained in:
Ghanshyam Mann 2024-05-10 15:52:52 -07:00
parent c898a310af
commit 1ac6e2bcb2
1006 changed files with 8 additions and 89215 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.coveragerc
View File

@ -1,12 +0,0 @@
[run]
branch = True
source = murano
omit =
.tox/*
murano/tests/*
[paths]
source = murano
[report]
ignore_errors = True

61
.gitignore vendored
View File

@ -1,61 +0,0 @@
#swap file
*.swp
#IntelJ Idea
.idea/
#virtualenv
.venv/
#Build results
build/
dist/
*.egg-info/
*.egg
eggs/
.eggs/
develop-eggs/
.tox
AUTHORS
ChangeLog
.testrepository
.coverage
cover
api-ref/build/
!/.stestr.conf
.stestr/
#Python
*.pyc
#Translation build
*.mo
#SQLite Database files
*.sqlite
#Autogenerated Documentation
doc/source/api
doc/source/_static/murano.conf.sample
doc/source/_static/murano.policy.yaml.sample
#Config file for functional tests
murano/tests/functional/engine/config.conf
#Autogenerated sample config file and policy file
etc/murano/murano.conf.sample
etc/murano/murano-cfapi.conf.sample
etc/murano.policy.yaml.sample
#User Config file for Murano
etc/murano/murano.conf
etc/murano/murano-cfapi.conf
etc/murano/logging.conf
# pylint autogenerated support files
tools/lintstack.head.py
tools/pylint_exceptions
# Files created by releasenotes build
releasenotes/build

3
.stestr.conf
View File

@ -1,3 +0,0 @@
[DEFAULT]
test_path=${OS_TEST_PATH:-./murano/tests/unit}
top_dir=./

128
.zuul.yaml
View File

@ -1,128 +0,0 @@
- project:
queue: murano
templates:
- check-requirements
- openstack-cover-jobs
- openstack-python3-jobs
- periodic-stable-jobs
- publish-openstack-docs-pti
- release-notes-jobs-python3
check:
jobs:
- murano-rally-task
- murano-tempest-api
- murano-tempest-cfapi
- murano-grenade
- murano-tempest-api-ipv6-only
gate:
jobs:
- murano-tempest-api
- murano-tempest-api-ipv6-only
- job:
name: murano-rally-task
voting: false
parent: rally-task-murano
irrelevant-files: &murano-irrelevant-files
- ^(test-|)requirements.txt$
- ^setup.cfg$
- ^doc/.*$
- ^.*\.rst$
- ^releasenotes/.*$
- ^murano/tests/.*$
- ^contrib/.*$
- ^tools/.*$
timeout: 7800
vars:
devstack_plugins:
rally-openstack: https://opendev.org/openstack/rally-openstack
rally_task: rally-jobs/task-murano.yaml
required-projects:
- openstack/rally-openstack
- job:
name: murano-tempest-base
parent: devstack-tempest
irrelevant-files: *murano-irrelevant-files
timeout: 7800
required-projects: &base_required_projects
- openstack/heat
- openstack/murano
- openstack/murano-dashboard
- openstack/python-heatclient
- openstack/python-muranoclient
- openstack/tempest
- openstack/murano-tempest-plugin
vars: &base_vars
devstack_plugins:
murano: https://opendev.org/openstack/murano
heat: https://opendev.org/openstack/heat
devstack_services:
tempest: true
s-account: false
s-container: false
s-object: false
s-proxy: false
devstack_localrc:
TEMPEST_PLUGINS: "/opt/stack/murano-tempest-plugin"
KEYSTONE_ADMIN_ENDPOINT: true
tempest_test_regex: application_catalog
tox_envlist: all
- job:
name: murano-tempest-api
parent: murano-tempest-base
- job:
name: murano-tempest-api-ipv6-only
parent: devstack-tempest-ipv6
description: |
Murano devstack tempest tests job for IPv6-only deployment
timeout: 7800
irrelevant-files: *murano-irrelevant-files
required-projects: *base_required_projects
vars: *base_vars
- job:
name: murano-tempest-cfapi
parent: murano-tempest-base
voting: false
vars:
devstack_services:
murano-cfapi: true
tempest_test_regex: service_broker
- job:
name: murano-grenade
parent: grenade
voting: false
irrelevant-files: *murano-irrelevant-files
required-projects:
- opendev.org/openstack/grenade
- opendev.org/openstack/heat
- opendev.org/openstack/murano
- opendev.org/openstack/murano-dashboard
- opendev.org/openstack/python-heatclient
- opendev.org/openstack/python-muranoclient
- opendev.org/openstack/murano-tempest-plugin
- opendev.org/openstack/heat-tempest-plugin
vars:
grenade_localrc:
RUN_HEAT_INTEGRATION_TESTS: False
devstack_plugins:
murano: https://opendev.org/openstack/murano
heat: https://opendev.org/openstack/heat
devstack_services:
tempest: true
s-account: false
s-container: false
s-object: false
s-proxy: false
h-api: true
h-api-cfn: true
h-eng: true
heat: true
tempest_plugins:
- murano-tempest-plugin
tempest_test_regex: ^murano_tempest_tests\.tests\.scenario\.application_catalog\.test_deployment
tox_envlist: all

19
CONTRIBUTING.rst
View File

@ -1,19 +0,0 @@
The source repository for this project can be found at:
https://opendev.org/openstack/murano
Pull requests submitted through GitHub are not monitored.
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Launchpad:
https://bugs.launchpad.net/murano
For more specific information about contributing to this repository, see the
murano contributor guide:
https://docs.openstack.org/murano/latest/contributor/contributing.html

15
HACKING.rst
View File

@ -1,15 +0,0 @@
Style Commandments
==================
Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/
Murano Specific Commandments
----------------------------
- [M318] Change assertEqual(A, None) or assertEqual(None, A) by optimal assert
like assertIsNone(A)
- [M322] Method's default argument shouldn't be mutable.
- [M323] Python 3: do not use dict.iteritems.
- [M324] Python 3: do not use dict.iterkeys.
- [M325] Python 3: do not use dict.itervalues.
- [M326] Python 3: do not use basestring.

176
LICENSE
View File

@ -1,176 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

48
README.rst
View File

@ -1,42 +1,10 @@
========================
Team and repository tags
========================
This project is no longer maintained.
.. image:: https://governance.openstack.org/tc/badges/murano.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
The contents of this repository are still available in the Git
source code management system. To see the contents of this
repository before it reached its end of life, please check out the
previous commit with "git checkout HEAD^1".
.. Change things from this point on
Murano
======
Murano Project introduces an application catalog, which allows application
developers and cloud administrators to publish various cloud-ready
applications in a browsable categorised catalog. Cloud users
-- including inexperienced ones -- can then use the catalog to
compose reliable application environments with the push of a button.
Project Resources
-----------------
* `Murano Official Documentation <https://docs.openstack.org/murano/latest/>`_
* Project status, bugs, and blueprints are tracked on
`Launchpad <https://launchpad.net/murano>`_
* Additional resources are linked from the project
`Wiki <https://wiki.openstack.org/wiki/Murano>`_ page
* `Python client <https://opendev.org/openstack/python-muranoclient>`_
License
-------
Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
Release Notes
-------------
Release Notes may be found here: https://docs.openstack.org/releasenotes/murano
For any further questions, please email
openstack-discuss@lists.openstack.org or join #openstack-dev on
OFTC.

208
api-ref/source/conf.py
View File

@ -1,208 +0,0 @@
# -*- coding: utf-8 -*-
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# murano documentation build configuration file, created by
# sphinx-quickstart on Sat May 1 15:17:47 2010.
#
# This file is execfile()d with the current directory set to
# its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import os
import sys
extensions = [
'os_api_ref',
'openstackdocstheme'
]
html_theme = 'openstackdocs'
html_theme_options = {
"sidebar_mode": "toc",
}
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/murano'
openstackdocs_bug_project = 'murano'
openstackdocs_bug_tag = 'api-ref'
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./'))
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
copyright = u'2016-present, OpenStack Foundation'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# The reST default role (used for this markup: `text`) to use
# for all documents.
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'native'
# -- Options for man page output ----------------------------------------------
# Grouping the document tree for man pages.
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# If false, no module index is generated.
# html_use_modindex = True
# If false, no index is generated.
# html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'muranodoc'
# -- Options for LaTeX output -------------------------------------------------
# The paper size ('letter' or 'a4').
# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'Murano.tex', u'OpenStack Application Catalog API Documentation',
u'OpenStack Foundation', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# Additional stuff for the LaTeX preamble.
# latex_preamble = ''
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_use_modindex = True

8
api-ref/source/index.rst
View File

@ -1,8 +0,0 @@
==================================
OpenStack Application Catalog APIs
==================================
.. toctree::
:maxdepth: 1
v1/index

129
api-ref/source/v1/actions.inc
View File

@ -1,129 +0,0 @@
.. -*- rst -*-
==========================
Actions and Static Actions
==========================
A Murano action is a type of MuranoPL method. The differences between a regular
MuranoPL method are:
* Action is executed on deployed objects.
* Action execution is initiated by API request: you do not have to call the
method manually.
Thus, Murano actions allow performing any operations on objects, like:
* Getting information from the VM, like a config that is generated during the
deployment
* VM rebooting
* Scaling
A list of available actions is formed during the environment deployment.
Following deployment completion, you can call the action asynchronously. Murano
engine generates a task for every action thereby allowing the action status to
be tracked.
Execute action
==============
.. rest_method:: POST /environments/{environment_id}/actions/{action_id}
Execute action on deployed environment.
Request Parameters
-------------------
.. rest_parameters:: parameters.yaml
- environment_id: env_id_url
- action_id: action_id_url
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- task_id: task_id
Response Example
----------------
.. literalinclude:: samples/execute-action-response.json
:language: javascript
Get Action Result
=================
.. rest_method:: GET /environments/{environment_id}/actions/{task_id}
Retrieve action result for action executed on deployed environment.
Request Parameters
-------------------
.. rest_parameters:: parameters.yaml
- environment_id: env_id_url
- task_id: task_id_url
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
Execute static action
=====================
.. rest_method:: POST /actions
Execute static action.
Static methods can be called if they are exposed by specifying Scope: Public
in the MuranoPL object and the result of its execution will be returned.
Request Example
---------------
.. literalinclude:: samples/static-action-request.json
:language: javascript
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
Response Example
----------------
.. literalinclude:: samples/static-action-response.json
:language: javascript

162
api-ref/source/v1/categories.inc
View File

@ -1,162 +0,0 @@
.. -*- rst -*-
==========
Categories
==========
In Murano, applications can belong to a category or multiple categories.
Administrative users can create and delete categories as well as list
available categories and view details for a particular category.
List categories
===============
.. rest_method:: GET /catalog/categories
Retrieve list of all available categories in the Application Catalog.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- categories: all_categories
- id: category_id
- name: category_name
- updated: updated
- created: created
- package_count: package_count
Response Example
----------------
.. literalinclude:: samples/category-list-response.json
:language: javascript
Show category details
=====================
.. rest_method:: GET /catalog/categories/{category_id}
Show details for a category.
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- category_id: category_id_url
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 404
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- id: category_id
- name: category_name
- updated: updated
- created: created
- packages: category_packages
- package_count: package_count
Response Example
----------------
.. literalinclude:: samples/category-show-response.json
:language: javascript
Create Category
===============
.. rest_method:: POST /catalog/categories
Add a new category to the Application Catalog.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- name: category_name
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- id: category_id
- name: category_name
- updated: updated
- created: created
- package_count: package_count
Response Example
----------------
.. literalinclude:: samples/category-create-response.json
:language: javascript
Delete Category
===============
.. rest_method:: DELETE /catalog/categories/{category_id}
Remove an existing category from the Application Catalog.
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- category_id: category_id_url
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404

50
api-ref/source/v1/deployments.inc
View File

@ -1,50 +0,0 @@
.. -*- rst -*-
===========
Deployments
===========
Deployments track environments that have been deployed, either successfully
or otherwise. Each deployment contains the following information:
* A "Class: Environment" object (io.murano.Environment) with a name. Each
"Class: Environment" object defines an environment in terms of the deployment
process and groups all Applications and their related infrastructures together.
* An object (or objects) referring to networks that exist.
* A list of Applications (e.g. io.murano.apps.linux.Telnet). Each Application
contains, or otherwise references, anything it requires. The Telnet example
has a property called ``instance`` whose contract states it must be of type
``io.murano.resources.Instance``. In turn, the Instance has properties it
requires (like a ``name``, a ``flavor``, or a keypair name, ``keyname``).
List deployments
================
.. rest_method:: GET /deployments
List deployments for all environments for the current tenant (project).
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- deployments: deployments
Response Example
----------------
.. literalinclude:: samples/deployments-list-response.json
:language: javascript

403
api-ref/source/v1/environments.inc
View File

@ -1,403 +0,0 @@
.. -*- rst -*-
============
Environments
============
An environment is a set of logically connected applications that are grouped
together for easy management. By default, each environment has a single
network for all its applications, and the deployment of the environment is
defined in a single heat stack. Applications in different environments are
always independent from one another.
An environment is a single unit of deployment. This means that you can not only
deploy an environment that contains a single application but an environment
that contains multiple applications.
List environments
=================
.. rest_method:: GET /environments
Get a list of existing Environments
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- all_tenants: all_tenants
- tenant: tenant
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- environments: environments
- status: env_status
- created: created
- updated: updated
- name: env_name
- description_text: env_description
- tenant_id: tenant_id
- version: env_version
- id: env_id
Response Example
----------------
.. literalinclude:: samples/environments-list-response.json
:language: javascript
Create environment
==================
.. rest_method:: POST /environments
Creates an environment.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- name: env_name_request
Request Example
---------------
.. literalinclude:: samples/environment-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- id: env_id
- name: env_name
- description_text: env_description
- created: created
- updated: updated
- tenant_id: tenant_id
- version: env_version
- services: services
- acquired_by: acquired_by
Response Example
----------------
.. literalinclude:: samples/environment-create-response.json
:language: javascript
Rename environment
==================
.. rest_method:: PUT /environments/{env_id}
Renames an environment.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- env_id: env_id_url
- name: env_name_update
Request Example
---------------
.. literalinclude:: samples/environment-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- id: env_id
- name: env_name
- description_text: env_description
- created: created
- updated: updated
- tenant_id: tenant_id
- version: env_version
- services: services
- acquired_by: acquired_by
Response Example
----------------
.. literalinclude:: samples/environment-update-response.json
:language: javascript
Show environment details
========================
.. rest_method:: GET /environments/{env_id}
Shows details for an environment.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- env_id: env_id_url
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- id: env_id
- name: env_name
- description_text: env_description
- created: created
- updated: updated
- tenant_id: tenant_id
- version: env_version
- services: services
- acquired_by: acquired_by
Response Example
----------------
.. literalinclude:: samples/environment-show-response.json
:language: javascript
Delete environment
==================
.. rest_method:: DELETE /environments/{env_id}
Remove specified Environment.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- env_id: env_id_url
- abandon: abandon
Response Parameters
-------------------
This request does not return anything in the response body.
Get environment model
=====================
.. rest_method:: GET /environments/{env_id}/model/{path}
Get an Environment model.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- env_id: env_id_url
- path: env_model_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- defaultNetworks: env_default_networks
- region: env_region
- regions: regions
- name: env_name
- services: services
- ?: env_model
Response Example
----------------
.. literalinclude:: samples/environments-model-response.json
:language: javascript
Update environment model
========================
.. rest_method:: PATCH /environments/{env_id}/model/
Update an environment model.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- env_id: env_id_url
Request Example
---------------
.. literalinclude:: samples/environment-model-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- defaultNetworks: env_default_networks
- region: env_region
- regions: regions
- name: env_name
- services: services
- ?: env_model
Response Example
----------------
.. literalinclude:: samples/environments-model-response.json
:language: javascript
Get environment last status
===========================
.. rest_method:: GET /environments/{env_id}/lastStatus
Get the last status for the environment for each service in the environment.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- env_id: env_id_url
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- lastStatuses: env_last_status
Response Example
----------------
.. literalinclude:: samples/environment-last-status-response.json
:language: javascript

15
api-ref/source/v1/index.rst
View File

@ -1,15 +0,0 @@
:tocdepth: 2
####################################
OpenStack Application Catalog API v1
####################################
.. rest_expand_all::
.. include:: actions.inc
.. include:: categories.inc
.. include:: deployments.inc
.. include:: environments.inc
.. include:: packages.inc
.. include:: sessions.inc
.. include:: templates.inc

488
api-ref/source/v1/packages.inc
View File

@ -1,488 +0,0 @@
.. -*- rst -*-
========
Packages
========
In Murano, each application, as well as the UI form for application data entry,
is defined by packages.
Package Structure
=================
The structure of the Murano application package is predefined. The application package root folder
should contain the following:
* ``manifest.yaml`` file is the application entry point.
.. note::
The filename is fixed, so do not use any custom names.
* ``Classes`` folder contains MuranoPL class definitions.
* ``Resources`` folder contaisn execution plan templates as well as the
``scripts`` folder with all the files required for an application
deployment located inside it.
* ``UI`` folder contains the dynamic UI YAML definitions.
* ``logo.png`` file (optional) is an image file associated with your
application. The logo appears in the Application Catalog within
Murano Dasboard.
.. note::
There are no special limitations regarding an image filename.
However, if it differs from the default ``logo.png``, specify it
in an application manifest file.
* ``images.lst`` file (optional) contains a list of images required by an
application.
.. note::
A bundle is a collection of packages. In the Community App Catalog, you can
find such bundles as ``container-based-apps``, ``app-servers``, and so on.
The packages in the Application Catalog are sorted by usage.
List Packages
=============
.. rest_method:: GET /v1/catalog/packages
Get a list of packages
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- catalog: catalog
- marker: marker
- limit: limit
- order_by: order_by
- type: pkg_type_query
- category: category
- fqn: fqn
- owned: owned
- id: pkg_id_query
- include_disabled: include_disabled
- search: search
- class_name: class_name
- name: pkg_name_query
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- packages: packages
- updated: updated
- class_definitions: class_definitions
- id: pkg_id
- fully_qualified_name: fully_qualified_name
- is_public: is_public
- name: pkg_name
- type: pkg_type
- supplier: pkg_supplier
- description: description
- author: author
- created: created
- enabled: enabled
- tags: tags
- categories: package_categories
- owner_id: owner_id
Response Example
----------------
.. literalinclude:: samples/packages-list-response.json
:language: javascript
Upload package
==============
.. rest_method:: POST /v1/catalog/packages
Upload a package to the application catalog.
.. note::
Though specifying categories is optional, it is recommended that you
specify at least one. It helps to filter applications in the catalog.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- categories: package_categories
- is_public: is_public
- file: pkg_file
Response Parameters
-------------------