brooklyn-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ahgittin <...@git.apache.org>
Subject [GitHub] incubator-brooklyn pull request: Docs: separate ops/launching page...
Date Mon, 19 Jan 2015 23:21:40 GMT
Github user ahgittin commented on a diff in the pull request:

    https://github.com/apache/incubator-brooklyn/pull/456#discussion_r23193634
  
    --- Diff: docs/guide/ops/catalog/index.md ---
    @@ -0,0 +1,163 @@
    +---
    +title: Catalog
    +layout: website-normal
    +---
    +
    +Brooklyn has a 'catalog', which is a collection of versioned blueprints. 
    +These can be deployed directly or referenced by other blueprints. 
    +Blueprints in the catalog can be deployed via the Brooklyn REST API, or from 
    +the web-console's 'Catalog' section of the 'Create Application' dialog box.
    +
    +
    +<!--
    +TODO: Clean up confusion in terminology between Catalog item and Blueprint (and Java
blueprint?)?
    +-->
    +
    +### Catalog items
    +
    +An item to be added to the catalog is defined in YAML. This looks like any other 
    +YAML blueprint, but also has a `brooklyn.catalog` section giving appropriate metadata.
    +
    +An example is shown below.
    +
    +{% highlight yaml %}
    +brooklyn.catalog:
    +  id: org.example.MySQL
    +  version: 1.0
    +  iconUrl: classpath://mysql.png
    +  description: MySql is an open source relational database management system (RDBMS)
    +  libraries:
    +    - url: http://example.com/path/to/my-dependency-1.2.3.jar
    +    - url: http://example.com/path/to/my-other-dependency-4.5.6.jar
    +
    +services:
    +- type: brooklyn.entity.database.mysql.MySqlNode
    +{% endhighlight %}
    +
    +To explain the `brooklyn.catalog` section:
    +
    +- The `id: MySQL` section specifies a unique ID used by Brooklyn to identify the catalog
item. 
    +  Other blueprints can reference the catalog item using this id.
    +- The `version: 1.0` section provides a unique version for the *blueprint*. NOTE: This
is *not* the version of the software
    +being installed (in this case MySQL).
    +- The `iconUrl: classpath://...` is an optional, but recommended, section that allows
you to provide the URL of a graphic to be 
    +displayed in the 'Add Application' dialog alongside the blueprint name. If using a URL
of the form `classpath://...`, then
    +the image should be on Brooklyn's classpath (e.g. in the `conf` folder of the Brooklyn
distro).
    --- End diff --
    
    that would mean loading all osgi bundles simply to be able to render the catalog
    
    have added text to this effect


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message