Welcome to Murano Documentation

Murano is an open source OpenStack project that combines an application catalog with versatile tooling to simplify and accelerate packaging and deployment. It can be used with almost any application and service in OpenStack.

Murano project consists of several source code repositories:

• murano - is the main repository. It contains code for Murano API server, Murano engine and MuranoPL.
• murano-agent - agent which runs on guest VMs and executes deployment plan.
• murano-dashboard - Murano UI implemented as a plugin for OpenStack Dashboard.
• python-muranoclient - Client library and CLI client for Murano.

This documentation guides application developers through the process of composing an application package to get it ready for uploading to Murano.

Besides the deployment rules and requirements, it contains information on how to manage images, categories, and repositories using the murano client that will surely be helpful for cloud administrators.

It also explains to end users how they can use the catalog directly from the dashboard. These include guidance on how to manage applications and environments.

And it provides information on how to contribute to the project.

Note

Deploying Murano and Contibuting guides are under development at the moment. The most recently updated information is published as the BETA version of the Murano documentation.

Introduction to Murano

• Key features
  • Application catalog
  • Application catalog management
  • Application lifecycle management
• Target Users
  • Cloud administrators
  • Cloud end users
• Architecture
• Use cases

Using Murano

• Quickstart
  • Upload an application
  • Deploy an application
  • Delete an application
• Managing environments
  • Create an environment
  • Edit an environment
  • Review an environment
• Managing applications
  • Import an application package
  • Search for an application in the catalog
  • Delete an application package
  • Add an application to environment
  • Deploy an environment
  • Delete an application
• Log into murano-spawned instance

Developing Applications

• Step-by-Step
  • Step 1. Create the structure of the package
  • Step 2. Create the manifest file
  • Step 3. Create the execution plan template
  • Step 4. Create the dynamic UI form definition
  • Step 5: Define MuranoPL class definitions
  • Step 6. Add the application logo (optional)
  • Step 7. Compose a zip archive
• Execution plan template
  • Template sections
  • FormatVersion property
  • Scripts section
• HOT packages
  • Compose a package
• MuranoPL Reference
  • YAML
  • YAQL
  • Common class structure
  • Core library
• Murano actions
• Murano packages
  • Package structure
  • Dynamic UI definition specification
  • Murano package repository
• Examples
• Use-cases
  • Performing application interconnections
  • Using application already installed on the image
  • Interacting with non-OpenStack services
  • Configuring Network Access for VMs
• FAQ

Miscellaneous

Installation

• Murano Installation Guide

Background Concepts for Murano

• Murano workflow
• Murano Policy Enforcement

Tutorials

• Composing application package manual
• Uploading HOT templates to the application catalog
• Building Murano Image
• Murano automated tests description

Client

• Murano client

Guidelines

• Contributing to Murano
  • Contributor License Agreement
  • Project Hosting Details
• Development Guidelines
  • Coding Guidelines
  • Testing Guidelines
  • Documentation Guidelines
• Murano TroubleShooting and Debug Tips
  • Problems during configuration
  • Problems during deployment
• Migrating applications from Murano v0.5 to Stable/Juno
  • Rename ‘Workflow’ to ‘Methods’
  • Change the Instance type in the UI definition ‘Application’ section

API specification

• Murano API v1 specification

Indices and tables

• Index
• Module Index
• Search Page