Welcome to Murano Documentation (BETA)

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.

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 of course, it provides information on how to contribute to the project.

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

This guide provides murano end users with information on how they can use the Application Catalog directly from the Dashboard and through the command-line interface (CLI). The screenshots provided in this guide are of the Liberty release.

• 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
• Using CLI
  • Manage environments
  • Manage packages
  • Manage categories
• Deploying environments using CLI
  • Create an environment
  • Create a configuration session
  • Add applications to an environment
  • Verify your object model
  • Deploy your environment

Deploying Murano

• Prepare A Lab For Murano
  • System prerequisites
  • Test Your Lab Host Performance
  • Baseline Data
  • Host Optimizations
• Installation
  • Network configuration
  • Policy configuration
• Managing packages
  • Managing packages on engine side
• Managing images
  • Build an image
  • Manage images
• Managing categories
• Murano repository
  • Use an existing repository
  • Set up a custom repository
• Murano agent
  • Murano-agent on a new VM
  • Interaction with murano-engine
  • Execution plans and execution plan templates
• Policy enforcement
  • Setting up policy enforcement
  • Creating policy enforcement rules
  • Murano policy enforcement internals
  • Using policy for the base modification of an environment
• Murano service broker for Cloud Foundry
  • Service broker overview
  • Configure service broker
  • How to use service broker
  • Known issues
  • Useful links
• Troubleshooting
  • Log location
  • Problems during configuration
  • Problems during deployment

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
  • MuranoPL Core Library
• Murano actions
• Murano packages
  • Package structure
  • Dynamic UI definition specification
  • Version history
  • Murano package repository
• Migrating applications between releases
  • Migrate applications from Murano v0.5 to Stable/Juno
  • Migrate applications to Stable/Kilo
  • Migrate applications to Stable/Liberty
• Application unit tests
• Examples
• Use-cases
  • Performing application interconnections
  • Using application already installed on the image
  • Interacting with non-OpenStack services
  • Configuring Network Access for VMs
• FAQ

Contributing

• How to contribute
• Development guidelines
  • Conventions
  • High-level overview of Murano components
  • Coding guidelines
  • Debug tips
• Murano plug-ins
  • MuranoPL extension plug-ins
  • MuranoPL package type plug-ins
• Testing
  • Testing guidelines
  • Continuous Integration service
  • UI testing
  • Tempest tests
  • Automated testing machinery
• Documentation guidelines

Appendix

• Glossary
• High-level definitions of Murano concepts
• Tutorials
  • Integration with Docker
  • Integration with Kubernetes
  • HA and autoscaling
• REST API specification
• Murano command-line client
  • Subcommands
  • Murano optional arguments
  • Application catalog API v1 commands
  • murano package-delete
  • murano package-import
  • murano package-show