brooklyn-dev mailing list archives

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

    https://github.com/apache/incubator-brooklyn/pull/456#discussion_r23161609
  
    --- 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. 
    --- End diff --
    
    s/section/line ? (and below too)


---
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