Deploying Blueprints

Blueprints are descriptors or patterns which describe how Apache Brooklyn should deploy applications. Blueprints are written in YAML and many of the entities available are defined in the Brooklyn Catalog.

Launching from a Blueprint

We'll start by deploying an application with a simple YAML blueprint containing an Apache Tomcat server.

Copy the blueprint below into a text file, "myapp.yaml", in your workspace (Note, to copy the file you can hover your mouse over the right side of the text box below to get a Javascript "copy" button).

name: Tomcat
- type: org.apache.brooklyn.entity.webapp.tomcat.TomcatServer
  name: tomcatServer
location: <your-location-definition-goes-here>


Before you can create an application with this configuration, you need to modify the YAML to specify a location. Locations in Apache Brooklyn are server resources which Brooklyn can use to deploy applications. These locations may be servers or cloud providers which provide access to servers.

In order to configure the location in which Apache Brooklyn launches an application, replace the location: element with values for your chosen target environment. Here are some examples of the various location types:

Hint: in the top right of this page are buttons to select a location. Choose your location to see the most appropriate instructions here.

Vagrant location

The Vagrant configuration described in Running Apache Brooklyn, on the previous page is the recommended way of running this tutorial. This configuration comes with four blank vagrant configurations called byon1 to byon4.

These can be launched by entering the following command into the terminal in the vagrant configuration directory.

 $ vagrant up byon1 byon2 byon3 byon4

The location in "myapp.yaml" can now be replaced with the following YAML to launch using these vagrant servers.

    user: vagrant
    password: vagrant

A cloud location

Apache Brooklyn uses Apache jclouds to support a range of cloud locations. More information on the range of providers and configurations is available here.

As an example, here is a configuration for Amazon Web Services (AWS). Swap the identity and credential with your AWS account details, then replace the location in your "myapp.yaml" with this.

    credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l

"Bring your own nodes" location

The Bring Your Own Nodes (BYON) configuration allows Apache Brooklyn to make use of already available servers. These can be specified by a list of IP addresses with a user and password as shown below. More information including the full range of configuration options is available here.

Replace the hosts, user and password in the example below with your own server details, then replace the location in your "myapp.yaml" with this.

    user: myuser
    password: mypassword
    # or...
    #privateKeyFile: ~/.ssh/my.pem

Note: For instructions on setting up a variety of locations or storing credentials/locations in a file on disk rather than in the blueprint, see Locations in the Operations section of the User Guide.

Deploying the Application

First, log in to brooklyn with the command line interface (CLI) tool by typing:

$ br login http://localhost:8081/

To secure the Apache Brooklyn instance, you can add a username and password to Brooklyn's properties file, as described in the User Guide here. If this is configured, the login command will require an additional parameter for the userid and will then prompt for a password.

Now you can create the application with the command below:

$ br deploy myapp.yaml 
Id:       hTPAF19s   
Name:     Tomcat   
Status:   In progress

Depending on your choice of location it may take some time for the application to start, the next page describes how you can monitor the progress of the application deployment and verify if it was successful.


Having deployed an application, the next step is monitoring and managing it.

results matching ""

    No results matching ""