Jump to: navigation, search

Difference between revisions of "App-Catalog"

(Adding content)
(Structure of Glance entry)
Line 97: Line 97:
         company: Debian Project
         company: Debian Project
       description: Base Debian 8 Jessie
       description: Base Debian 8 Jessie
       format: QCOW2
       disk_format: qcow2
      container_format: bare
       supported_by: Debian Project
       supported_by: Debian Project
       license: GPL 2.0
       license: GPL 2.0

Revision as of 21:33, 10 June 2015


The OpenStack Community App Catalog will help you make applications available on your OpenStack cloud by providing a community driven catalog containing Glance images, Heat templates and Murano applications.

By providing a public location where OpenStack users can publish and consume artifacts to share and add additional capabilities, all OpenStack clouds become more valuable. For example vendors can publish Glance images for launching new VMs, Heat templates for creating new stacks, or Murano app packages for installing complete applications. When many OpenStack community members are publishing artifacts that users can easily download and install into their clouds this will multiply the value of their OpenStack cloud. Easy access to images, templates and apps will solve the “what now” question some user consider after successfully deploying an OpenStack environment.


Q: What is the Community App Catalog?

The Community App Catalog is a collection of ready-to-use applications, Heat templates and machine images that you can immediately deploy into your OpenStack cloud. With the catalog (now in beta), there’s no need to go and collect parts of the applications and services you wish to deploy, work out their detailed infrastructure settings, or create scripts to handle their dependencies. To deploy a Murano app, for example, simply browse and select the one you need and copy the name into Murano in your OpenStack environment. Then click through a handful of parameters and your application is deployed

Q: What can I find in it?

The catalog features useful applications and components to use on your OpenStack Cloud, pre-configured with the necessary settings to deploy and run them

  • Murano Application packages: complete applications, either commercial or open source, ready to deploy on your cloud (aka ‘Murano Packages’)
  • Heat templates: YAML files used to orchestrate infrastructure services (network, VMs, storage, etc.) for creating a complete stack on your cloud
  • Glance Images: mountable file with a VM and bootable operating system, ready to launch on your cloud
  • Application bundles: combinations of Applications, Heat templates and Glance images pre-configured to deploy together

Q: How much does it cost?

There’s no charge to put anything in or get anything out of the App Catalog. Catalog items include both free and licensed software, and some may require payment or specific license terms. You’ll see that in each particular package.

Q: How do I update something I already put in the catalog?

  1. Clone https://github.com/stackforge/apps-catalog
  2. Make the changes to your entry, be sure to include what’s changed and why
  3. If you’re updating binary content be sure your commit message points to where the updated binary can be found.
  4. Commit the change for review
  5. The changes will be reviewed, merged within a day or so, and published to the catalog

How to use these assets

Glance Images

In Glance Images you will find a library of preconfigured images ready to launch virtual machines on your cloud. To use them:

  1. Browse the list and find the one you want
  2. Copy the URL for the image file
  3. Use the Glance client to add it to your cloud with the --copy-from option, or add the image from Horizon by specifying the URL as the image location.
  4. Use Nova to launch a vm from the new image

Heat Templates

In Heat Templates you will find templates for creating complete stacks in your cloud. To use them:

  1. Browse the list and find the one you want
  2. Download the template yaml file to your local machine
  3. Use the Heat client or Horizon to add the template to your cloud,
  4. Use the Heat client to create a stack

Murano Packages

In Murano Packages you will find complete applications, simple and clustered, ready to deploy into your cloud. To use them:

  1. Verify that you have Murano installed
  2. Browse the list and find the app package you want
  3. Copy the name of the app package
  4. In Horizon navigate to the Application Catalog | Packages page and Click Download Package
  5. Paste the app package name, and click Download
  6. You can now deploy the app into your cloud using Horizon or the Murano client

How to contribute

The OpenStack Community App Catalog is designed to use the same tools for submission and review as other OpenStack projects. As such we follow the OpenStack development workflow. New contributors should follow the getting started steps before proceeding, as a Launchpad ID and signed contributor license are required to add new entries.

The Community App Catalog Launchpad page can be found at https://launchpad.net/app-catalog.

Creating content

We actively encourage new submissions - if you're interested in creating content for the catalog, you can find getting started guides at the following links:

Adding content

If you've already got something to share, follow these steps to add an entry to the catalog:

  1. Clone https://github.com/stackforge/apps-catalog
  2. Edit the YAML file pertaining to the type of entry you are adding (see below for structure examples). The YAML files are validated against the YAML schema files which are located in the same folder as the YAML files. The Stackforge gate checks the file for compliance with the schema, so be sure additions match the appropriate schema.
    • Glance entries are found in openstack_catalog/web/static/glance_images.yaml
    • Heat entries are found in openstack_catalog/web/static/heat_templates.yaml
    • Murano entries are found in openstack_catalog/web/static/murano_apps.yaml
  3. Make sure the tests pass - run "tox -epy27"
  4. Make sure your edit looks good - change directory to openstack_catalog/web and run "python -m SimpleHTTPServer", then visit http://localhost:8000
  5. When submitting the entry for review, the commit message must include the catalog entry name, URL to retrieve the asset, and an md5 sum if it is a binary.
    • For example if you wanted to add a Murano package called "MyLAMPStack.zip", the commit message must show where to retrieve that asset along with the SHA or md5 hash:
      • url: http://<your-hostname>/MyLAMPStack.zip
      • hash: 7237de38ebf827e234ca643b725779e4f38f0ef0
    • [OPTIONAL] If the image is meant to be stored on the OpenStack CDN, the glance image URLs and hashes must be similarly included in the commit message, as in the following example NOTE: the image check gate test is non-voting for glance entries, so if it fails you may safely ignore it):
      • Image-URL: http://<your-hostname>/images/ubuntu-14.04-m-agent.qcow2
      • Image-hash: cbd9ded8587b98d144d9cf0faea991a9

Structure of Glance entry

Glance entries are validated against the file openstack_catalog/web/static/glance_images.schema.yaml found in the apps-catalog repository and for example is formatted like this:

     name: Debian 8 (Jessie)
       name: Sally User
       href: http://debian.org
       company: Debian Project
     description: Base Debian 8 Jessie
     disk_format: qcow2
     container_format: bare
     supported_by: Debian Project
     license: GPL 2.0
       url: http://storage.apps.openstack.org/images/debian8.qcow2
       hash: dd69232d1a745a7b237bd8d5e9e8485a

'attributes' section can contain any elements. There is no predefined structure for 'attributes' and the only requirements for them is to be YAML valid entries. So in the example above it will be pretty safe to change 'url' to 'Image URL' and UI will still render this properly as a link. Pease, feel free to add documentation links if there is a any documentation for the image.

Structure of Heat entry

Heat entries are validated against the file openstack_catalog/web/static/heat_templates.schema.yaml found in the apps-catalog repository and for example is formatted like this:

     name: Minecraft
         name: Joe User
         href: mailto:juser@example.com
         company: Community
     description: Minecraft HOT template to create a single node instance
         - Icehouse
         - Juno
         - Kilo
     format: HOT
     supported_by: Community
     license: Apache 2.0

Structure of Murano entry

Murano entries are validated against the file openstack_catalog/web/static/murano_apps.schema.yaml found in the apps-catalog repository and for example is formatted like this:

     name: Docker HTTPd
     package_name: io.murano.apps.docker.DockerHTTPd
         name: Stan Lagun
         href: "https://github.com/istalker2"
         company: Mirantis
     description: >
         The Apache HTTP Server, colloquially called Apache, is a Web server
         application notable for playing a key role in the initial growth of
         the World Wide Web.
         - Kilo
     format: package
     supported_by: Mirantis
     license: Apache 2.0
         "Source URL": "https://github.com/stackforge/murano-apps"
         Documentation: "https://github.com/stackforge/murano-apps/blob/master/Docker/Kubernetes/readme.md"