Added: brooklyn/site/zoneMergeManual.html URL: http://svn.apache.org/viewvc/brooklyn/site/zoneMergeManual.html?rev=1925014&view=auto ============================================================================== --- brooklyn/site/zoneMergeManual.html (added) +++ brooklyn/site/zoneMergeManual.html Fri Apr 11 07:44:54 2025 @@ -0,0 +1,27945 @@ +<!DOCTYPE html> +<html> +<head> +<title>Apache Brooklyn Manual - Apache Brooklyn</title> +<meta http-equiv='Content-Type' content='text/html; charset=utf-8' /> +<link href="./style/deps/bootstrap.min.css" rel="stylesheet"> +<link href="./style/deps/octicons/octicons.css" rel="stylesheet"> +<link href="./style/deps/bootstrap-theme.css" rel="stylesheet"> + +<link href="./style/css/website.css" rel="stylesheet"> +<link rel="stylesheet" href="./style/css/singlePage.css" type="text/css" media="screen" /> +<style>.usermanual-pdf-exclude{ display: none; } .usermanual-pdf-include{ display: inline !important; visibility: visible !important; }</style> +<script> +[] +.forEach +.call(document.querySelectorAll('a[target="_blank"]'), + function(link) { + link.removeAttribute('target'); +}); +</script> +</head> + +<body> + + + +<div id="content_container" class="container"> + <header> + <h1 id="content-top">Apache Brooklyn: User Manual</h1> + </header> + <h1>Contents</h1> + + <nav><ul> + + + + + + + + + + + + + + + + + <a id="website/learnmore/index.md" name="website/learnmore/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-learn-more" id="link-learn-more">Learn More</a> + + + + <ul> + + + + + + + + + + + + + + + + + + + + + <a id="website/learnmore/features/index.md" name="website/learnmore/features/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-features" id="link-features">Features</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Blueprinting + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Policy-based Management + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Operations + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Java + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="website/learnmore/theory.md" name="website/learnmore/theory.md" href="javascript:void(0);"></a> + + <li> + + + The Theory behind Brooklyn + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Why Brooklyn? + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Blueprints + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Benefits + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Standards + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="website/learnmore/catalog/index.html" name="website/learnmore/catalog/index.html" href="javascript:void(0);"></a> + + <li> + + + Catalog + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + + + + + <a id="website/documentation/index.md" name="website/documentation/index.md" href="javascript:void(0);"></a> + + <li> + + + Documentation + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/index.md" name="guide/index.md" href="javascript:void(0);"></a> + + <li> + + + User Guide + + + + <ul> + + + + + + + + + + + + + + + + + + + + + <a id="guide/misc/download.md" name="guide/misc/download.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-downloads" id="link-downloads">Downloads</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/concepts/index.md" name="guide/concepts/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-brooklyn-concepts" id="link-brooklyn-concepts">Brooklyn Concepts</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/concepts/entities.md" name="guide/concepts/entities.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-entities" id="link-entities">Entities</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/concepts/application-parent-membership.md" name="guide/concepts/application-parent-membership.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-application,-parent-and-membership" id="link-application,-parent-and-membership">Application, Parent and Membership</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/concepts/configuration-sensor-effectors.md" name="guide/concepts/configuration-sensor-effectors.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-configuration,-sensors-and-effectors" id="link-configuration,-sensors-and-effectors">Configuration, Sensors and Effectors</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/concepts/lifecycle-managementcontext.md" name="guide/concepts/lifecycle-managementcontext.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-lifecycle-and-managementcontext" id="link-lifecycle-and-managementcontext">Lifecycle and ManagementContext</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/concepts/dependent-configuration.md" name="guide/concepts/dependent-configuration.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-dependent-configuration" id="link-dependent-configuration">Dependent Configuration</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/concepts/location.md" name="guide/concepts/location.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-location" id="link-location">Location</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/concepts/policies.md" name="guide/concepts/policies.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-policies" id="link-policies">Policies</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/concepts/execution.md" name="guide/concepts/execution.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-execution" id="link-execution">Execution</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/concepts/stop-start-restart-behaviour.md" name="guide/concepts/stop-start-restart-behaviour.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-stopstartrestart-behaviour" id="link-stopstartrestart-behaviour">Stop/start/restart behaviour</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/index.md" name="guide/blueprints/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-writing-blueprints" id="link-writing-blueprints">Writing Blueprints</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/creating-yaml.md" name="guide/blueprints/creating-yaml.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-the-basic-structure" id="link-the-basic-structure">The Basic Structure</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/entity-configuration.md" name="guide/blueprints/entity-configuration.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-entity-configuration" id="link-entity-configuration">Entity Configuration</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/setting-locations.md" name="guide/blueprints/setting-locations.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-setting-locations" id="link-setting-locations">Setting Locations</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/configuring-vms.md" name="guide/blueprints/configuring-vms.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-configuring-vms" id="link-configuring-vms">Configuring VMs</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/multiple-services.md" name="guide/blueprints/multiple-services.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-multiple-services-and-dependency-injection" id="link-multiple-services-and-dependency-injection">Multiple Services and Dependency Injection</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/custom-entities.md" name="guide/blueprints/custom-entities.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-custom-entities" id="link-custom-entities">Custom Entities</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/config-files.md" name="guide/blueprints/config-files.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-uploading-script-and-configuration-files" id="link-uploading-script-and-configuration-files">Uploading Script and Configuration Files</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/index.md" name="guide/blueprints/workflow/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-workflow" id="link-workflow">Workflow</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/defining.md" name="guide/blueprints/workflow/defining.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-defining-workflow" id="link-defining-workflow">Defining Workflow</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/common.md" name="guide/blueprints/workflow/common.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-common-step-properties" id="link-common-step-properties">Common Step Properties</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/variables.md" name="guide/blueprints/workflow/variables.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-variables-and-expressions" id="link-variables-and-expressions">Variables and Expressions</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/steps/index.md" name="guide/blueprints/workflow/steps/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-workflow-steps" id="link-workflow-steps">Workflow Steps</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Workflow Control + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + External Actions + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Application Models + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + General Purpose + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Index of Step Types + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/nested-workflow.md" name="guide/blueprints/workflow/nested-workflow.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-nested-and-custom-workflow" id="link-nested-and-custom-workflow">Nested and Custom Workflow</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/settings.md" name="guide/blueprints/workflow/settings.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-workflow-settings" id="link-workflow-settings">Workflow Settings</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/examples/index.md" name="guide/blueprints/workflow/examples/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-workflow-examples" id="link-workflow-examples">Workflow Examples</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/examples/ansible-bash/index.md" name="guide/blueprints/workflow/examples/ansible-bash/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-ansible-and-bash-over-ssh-for-a-web-server" id="link-ansible-and-bash-over-ssh-for-a-web-server">Ansible and BASH over SSH for a Web Server</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/examples/git-latest/index.md" name="guide/blueprints/workflow/examples/git-latest/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-custom-step-to-retrieve-a-git-repository" id="link-custom-step-to-retrieve-a-git-repository">Custom Step to Retrieve a Git Repository</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/examples/oauth/index.md" name="guide/blueprints/workflow/examples/oauth/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-oauth-web-request-workflow" id="link-oauth-web-request-workflow">OAuth web request workflow</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/workflow/examples/aws-cfn-stacks/index.md" name="guide/blueprints/workflow/examples/aws-cfn-stacks/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-aws-cloudformation-stack-discovery" id="link-aws-cloudformation-stack-discovery">AWS CloudFormation Stack Discovery</a> + + + + </li> + + + + </ul> + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/catalog/index.md" name="guide/blueprints/catalog/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-catalog" id="link-catalog">Catalog</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/catalog/schema.md" name="guide/blueprints/catalog/schema.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-catalog-items-yaml-syntax" id="link-catalog-items-yaml-syntax">Catalog Items YAML Syntax</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/catalog/templates.md" name="guide/blueprints/catalog/templates.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-templates-and-quick-launch" id="link-templates-and-quick-launch">Templates and Quick Launch</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/catalog/versioning.md" name="guide/blueprints/catalog/versioning.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-versioning" id="link-versioning">Versioning</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/catalog/management.md" name="guide/blueprints/catalog/management.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-catalog-management" id="link-catalog-management">Catalog Management</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/catalog/bundle.md" name="guide/blueprints/catalog/bundle.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-bundling" id="link-bundling">Bundling</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/catalog/cli.md" name="guide/blueprints/catalog/cli.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-brooklyn-server-command-line-arguments" id="link-brooklyn-server-command-line-arguments">Brooklyn Server Command Line Arguments</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/clusters.md" name="guide/blueprints/clusters.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-clusters,-specs,-and-composition" id="link-clusters,-specs,-and-composition">Clusters, Specs, and Composition</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/enrichers.md" name="guide/blueprints/enrichers.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-enrichers" id="link-enrichers">Enrichers</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/policies/index.md" name="guide/blueprints/policies/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-policies" id="link-policies">Policies</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/policies/available_policies.md" name="guide/blueprints/policies/available_policies.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-off-the-shelf-policies" id="link-off-the-shelf-policies">Off-the-Shelf Policies</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/policies/writing_policies.md" name="guide/blueprints/policies/writing_policies.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-writing-a-policy" id="link-writing-a-policy">Writing a Policy</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/effectors.md" name="guide/blueprints/effectors.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-effectors" id="link-effectors">Effectors</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/clusters-and-policies.md" name="guide/blueprints/clusters-and-policies.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-clusters-and-policies" id="link-clusters-and-policies">Clusters and Policies</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/index.md" name="guide/blueprints/java/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-java-entities" id="link-java-entities">Java Entities</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/archetype.md" name="guide/blueprints/java/archetype.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-creating-from-a-maven-archetype" id="link-creating-from-a-maven-archetype">Creating from a Maven Archetype</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/defining-and-deploying.md" name="guide/blueprints/java/defining-and-deploying.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-defining-and-deploying" id="link-defining-and-deploying">Defining and Deploying</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/bundle-dependencies.md" name="guide/blueprints/java/bundle-dependencies.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-handling-bundle-dependencies" id="link-handling-bundle-dependencies">Handling Bundle Dependencies</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/topology-dependencies.md" name="guide/blueprints/java/topology-dependencies.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-topology,-dependencies,-and-management-policies" id="link-topology,-dependencies,-and-management-policies">Topology, Dependencies, and Management Policies</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/common-usage.md" name="guide/blueprints/java/common-usage.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-common-classes-and-entities" id="link-common-classes-and-entities">Common Classes and Entities</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/feeds.md" name="guide/blueprints/java/feeds.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-feeds" id="link-feeds">Feeds</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/entity.md" name="guide/blueprints/java/entity.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-writing-an-entity" id="link-writing-an-entity">Writing an Entity</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/entities.md" name="guide/blueprints/java/entities.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-custom-entity-development" id="link-custom-entity-development">Custom Entity Development</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/service-state.md" name="guide/blueprints/java/service-state.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-service-state" id="link-service-state">Service State</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/java/entitlements.md" name="guide/blueprints/java/entitlements.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-entitlements" id="link-entitlements">Entitlements</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/winrm/index.md" name="guide/blueprints/winrm/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-windows-blueprints" id="link-windows-blueprints">Windows Blueprints</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/winrm/client.md" name="guide/blueprints/winrm/client.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-winrm4j-client" id="link-winrm4j-client">WinRM4j Client</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/winrm/tips.md" name="guide/blueprints/winrm/tips.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-winrm4j-tips-and-tricks" id="link-winrm4j-tips-and-tricks">WinRM4j Tips and Tricks</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/winrm/limitations.md" name="guide/blueprints/winrm/limitations.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-winrm4j-limitations" id="link-winrm4j-limitations">WinRM4j Limitations</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/winrm/troubleshoot.md" name="guide/blueprints/winrm/troubleshoot.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-winrm4j-troubleshooting" id="link-winrm4j-troubleshooting">WinRM4j Troubleshooting</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/test/index.md" name="guide/blueprints/test/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-testing-yaml-blueprints" id="link-testing-yaml-blueprints">Testing YAML Blueprints</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/test/test-entities.md" name="guide/blueprints/test/test-entities.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-blueprint-test-entities" id="link-blueprint-test-entities">Blueprint Test Entities</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/test/usage-examples.md" name="guide/blueprints/test/usage-examples.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-example-blueprint-tests" id="link-example-blueprint-tests">Example Blueprint Tests</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/ansible/index.md" name="guide/blueprints/ansible/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-ansible-in-yaml-blueprints" id="link-ansible-in-yaml-blueprints">Ansible in YAML Blueprints</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/ansible/about-ansible.md" name="guide/blueprints/ansible/about-ansible.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-about-ansible" id="link-about-ansible">About Ansible</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/ansible/creating-ansible-blueprints.md" name="guide/blueprints/ansible/creating-ansible-blueprints.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-creating-blueprints-with-ansible" id="link-creating-blueprints-with-ansible">Creating Blueprints with Ansible</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/chef/index.md" name="guide/blueprints/chef/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-chef-in-yaml-blueprints" id="link-chef-in-yaml-blueprints">Chef in YAML Blueprints</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/chef/about-chef.md" name="guide/blueprints/chef/about-chef.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-about-chef" id="link-about-chef">About Chef</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/chef/creating-blueprints.md" name="guide/blueprints/chef/creating-blueprints.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-creating-blueprints-from-chef" id="link-creating-blueprints-from-chef">Creating Blueprints from Chef</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/chef/writing-chef.md" name="guide/blueprints/chef/writing-chef.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-writing-chef-for-blueprints" id="link-writing-chef-for-blueprints">Writing Chef for Blueprints</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/chef/advanced-chef-integration.md" name="guide/blueprints/chef/advanced-chef-integration.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-advanced-chef-integration" id="link-advanced-chef-integration">Advanced Chef Integration</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/salt/index.md" name="guide/blueprints/salt/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-salt-in-yaml-blueprints" id="link-salt-in-yaml-blueprints">Salt in YAML Blueprints</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/salt/about-salt.md" name="guide/blueprints/salt/about-salt.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-about-salt" id="link-about-salt">About Salt</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/salt/creating-salt-blueprints.md" name="guide/blueprints/salt/creating-salt-blueprints.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-creating-blueprints-with-salt" id="link-creating-blueprints-with-salt">Creating Blueprints with Salt</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/advanced-example.md" name="guide/blueprints/advanced-example.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-yaml-blueprint-advanced-example" id="link-yaml-blueprint-advanced-example">YAML Blueprint Advanced Example</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/blueprinting-tips.md" name="guide/blueprints/blueprinting-tips.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-blueprinting-tips" id="link-blueprinting-tips">Blueprinting Tips</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/yaml-reference.md" name="guide/blueprints/yaml-reference.md" href="javascript:void(0);"></a> + + <li> + + + YAML Blueprint Reference + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/locations/index.md" name="guide/locations/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-locations" id="link-locations">Locations</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Clouds + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Azure Compute ARM + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Amazon Web Services + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Azure Compute Classic + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Apache CloudStack + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Google Compute Engine + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + VMware vSphere + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + OpenStack + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + IBM Softlayer + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/locations/provisioned-machine-requirements.md" name="guide/locations/provisioned-machine-requirements.md" href="javascript:void(0);"></a> + + <li> + + + Provisioned Machine Requirements + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Named Locations + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + BYON + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + SSH Keys + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Localhost + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Location Customizers + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Customizing Cloud Security Groups + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Specialized Locations + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/index.md" name="guide/ops/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-reference-guide" id="link-reference-guide">Reference Guide</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/ops/production-installation.md" name="guide/ops/production-installation.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-production-installation" id="link-production-installation">Production Installation</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/starting-stopping-monitoring.md" name="guide/ops/starting-stopping-monitoring.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-starting,-stopping-and-monitoring" id="link-starting,-stopping-and-monitoring">Starting, Stopping and Monitoring</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/server-cli-reference.md" name="guide/ops/server-cli-reference.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-server-cli-reference" id="link-server-cli-reference">Server CLI Reference</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/cli/index.md" name="guide/ops/cli/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-client-cli-reference" id="link-client-cli-reference">Client CLI Reference</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/ops/cli/cli-ref-guide.md" name="guide/ops/cli/cli-ref-guide.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-cli-reference-guide" id="link-cli-reference-guide">CLI Reference Guide</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Usage + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + List of Commands + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Scopes + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Abbreviations + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Command Reference + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/cli/cli-usage-guide.md" name="guide/ops/cli/cli-usage-guide.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-cli-usage-guide" id="link-cli-usage-guide">CLI Usage Guide</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Login + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Applications + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Entities + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Sensors + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Effectors + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + Policies <a href="#link-policies"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Activities + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + YAML Blueprint + + + + </li> + + + + </ul> + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/gui/index.md" name="guide/ops/gui/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-gui-guide" id="link-gui-guide">GUI Guide</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/ops/gui/running.md" name="guide/ops/gui/running.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-launching" id="link-launching">Launching</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/gui/blueprints.md" name="guide/ops/gui/blueprints.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-deploying-blueprints" id="link-deploying-blueprints">Deploying Blueprints</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Launching from a Blueprint + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Launching from the Catalog + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/gui/managing.md" name="guide/ops/gui/managing.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-monitoring-and-managing-applications" id="link-monitoring-and-managing-applications">Monitoring and Managing Applications</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/gui/policies.md" name="guide/ops/gui/policies.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-using-policies" id="link-using-policies">Using Policies</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/rest.md" name="guide/ops/rest.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-rest-api" id="link-rest-api">REST API</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/configuration/index.md" name="guide/ops/configuration/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-brooklyn-configuration-and-options" id="link-brooklyn-configuration-and-options">Brooklyn Configuration and Options</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Memory Usage + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Authentication and Security + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Catalog in OSGi + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/configuration/brooklyn_cfg.md" name="guide/ops/configuration/brooklyn_cfg.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-brooklyn.cfg" id="link-brooklyn.cfg">brooklyn.cfg</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Quick Setup + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Camp YAML Expressions + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Java + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Authentication + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Entitlements + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + HTTPS Configuration + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/configuration/https.md" name="guide/ops/configuration/https.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-https-configuration" id="link-https-configuration">HTTPS Configuration</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/configuration/cors.md" name="guide/ops/configuration/cors.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-cors-configuration" id="link-cors-configuration">CORS Configuration</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/persistence/index.md" name="guide/ops/persistence/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-persistence" id="link-persistence">Persistence</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Configuration + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + File-based Persistence + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Object Store Persistence + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Rebinding to State + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Writing Persistable Code + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Persisted State Backup + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/high-availability/index.md" name="guide/ops/high-availability/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-high-availability" id="link-high-availability">High Availability</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/ops/high-availability/high-availability-supplemental.md" name="guide/ops/high-availability/high-availability-supplemental.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-configuring-ha---an-example" id="link-configuring-ha---an-example">Configuring HA - an example</a> + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/externalized-configuration.md" name="guide/ops/externalized-configuration.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-externalized-configuration" id="link-externalized-configuration">Externalized Configuration</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/logging/index.md" name="guide/ops/logging/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-logging" id="link-logging">Logging</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Logbook + + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/requirements.md" name="guide/ops/requirements.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-requirements" id="link-requirements">Requirements</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/paths.md" name="guide/ops/paths.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-system-paths-summary" id="link-system-paths-summary">System Paths Summary</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/upgrades/index.md" name="guide/ops/upgrades/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-upgrades" id="link-upgrades">Upgrades</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/security-guidelines.md" name="guide/ops/security-guidelines.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-security-guidelines" id="link-security-guidelines">Security Guidelines</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/index.md" name="guide/ops/troubleshooting/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-troubleshooting" id="link-troubleshooting">Troubleshooting</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/overview.md" name="guide/ops/troubleshooting/overview.md" href="javascript:void(0);"></a> + + <li> + + + Troubleshooting Overview + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/fails-to-start.md" name="guide/ops/troubleshooting/fails-to-start.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-brooklyn-fails-to-start" id="link-brooklyn-fails-to-start">Brooklyn Fails to Start</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/installation.md" name="guide/ops/troubleshooting/installation.md" href="javascript:void(0);"></a> + + <li> + + + Installation + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/web-console-issues.md" name="guide/ops/troubleshooting/web-console-issues.md" href="javascript:void(0);"></a> + + <li> + + + Web Console Issues + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/deployment.md" name="guide/ops/troubleshooting/deployment.md" href="javascript:void(0);"></a> + + <li> + + + Troubleshooting Deployment + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/connectivity.md" name="guide/ops/troubleshooting/connectivity.md" href="javascript:void(0);"></a> + + <li> + + + Troubleshooting Server Connectivity Issues in the Cloud + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/slow-unresponsive.md" name="guide/ops/troubleshooting/slow-unresponsive.md" href="javascript:void(0);"></a> + + <li> + + + Brooklyn Slow or Unresponsive + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/increase-entropy.md" name="guide/ops/troubleshooting/increase-entropy.md" href="javascript:void(0);"></a> + + <li> + + + Increase Entropy + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/increase-system-resource-limits.md" name="guide/ops/troubleshooting/increase-system-resource-limits.md" href="javascript:void(0);"></a> + + <li> + + + Increase System Resource Limits + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/detailed-support-report.md" name="guide/ops/troubleshooting/detailed-support-report.md" href="javascript:void(0);"></a> + + <li> + + + Detailed Support Report + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/softwareprocess.md" name="guide/ops/troubleshooting/softwareprocess.md" href="javascript:void(0);"></a> + + <li> + + + Troubleshooting SoftwareProcess Entities + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/going-deep-in-java-and-logs.md" name="guide/ops/troubleshooting/going-deep-in-java-and-logs.md" href="javascript:void(0);"></a> + + <li> + + + Troubleshooting: Going Deep in Java and Logs + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/troubleshooting/memory-usage.md" name="guide/ops/troubleshooting/memory-usage.md" href="javascript:void(0);"></a> + + <li> + + + Troubleshooting: Monitoring Memory Usage + + + + </li> + + + + </ul> + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/misc/index.md" name="guide/misc/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-other-resources" id="link-other-resources">Other Resources</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="guide/misc/javadoc/index.md" name="guide/misc/javadoc/index.md" href="javascript:void(0);"></a> + + <li> + + + API Reference + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/misc/download.md" name="guide/misc/download.md" href="javascript:void(0);"></a> + + <li> + + + Downloads + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/misc/release-notes.md" name="guide/misc/release-notes.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-release-notes" id="link-release-notes">Release Notes</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/misc/known-issues.md" name="guide/misc/known-issues.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-known-issues" id="link-known-issues">Known Issues</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/index.md" name="guide/dev/index.md" href="javascript:void(0);"></a> + + <li> + + + Developer Guide + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + Get the Code <a href="/website/developers/code/"><span class="octicon octicon-link-external"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/env/maven-build.md" name="guide/dev/env/maven-build.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-maven-build" id="link-maven-build">Maven Build</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/env/ide/index.md" name="guide/dev/env/ide/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-ide-setup" id="link-ide-setup">IDE Setup</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/code/structure.md" name="guide/dev/code/structure.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-code-structure" id="link-code-structure">Code Structure</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/code/tests.md" name="guide/dev/code/tests.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-tests" id="link-tests">Tests</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/code/licensing.md" name="guide/dev/code/licensing.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-license-considerations" id="link-license-considerations">License Considerations</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/tips/index.md" name="guide/dev/tips/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-miscellaneous-tips-and-tricks" id="link-miscellaneous-tips-and-tricks">Miscellaneous Tips and Tricks</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/tips/logging.md" name="guide/dev/tips/logging.md" href="javascript:void(0);"></a> + + <li> + + Logging <a href="#link-logging"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/tips/debugging-remote-brooklyn.md" name="guide/dev/tips/debugging-remote-brooklyn.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-brooklyn-remote-debugging" id="link-brooklyn-remote-debugging">Brooklyn Remote Debugging</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + GitHub <a href="http://github.com/apache/brooklyn"><span class="octicon octicon-link-external"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + Javadoc <a href="https://brooklyn.apache.org/v/latest/misc/javadoc"><span class="octicon octicon-link-external"></span></a> + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="website/documentation/index.md" name="website/documentation/index.md" href="javascript:void(0);"></a> + + <li> + + Documentation <a href="#link-documentation"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + </ul> + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/blueprints/index.md" name="guide/blueprints/index.md" href="javascript:void(0);"></a> + + <li> + + Writing Blueprints <a href="#link-writing-blueprints"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="guide/locations/index.md" name="guide/locations/index.md" href="javascript:void(0);"></a> + + <li> + + Locations <a href="#link-locations"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="guide/ops/index.md" name="guide/ops/index.md" href="javascript:void(0);"></a> + + <li> + + Reference Guide <a href="#link-reference-guide"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/index.md" name="guide/dev/index.md" href="javascript:void(0);"></a> + + <li> + + Developer Guide <a href="#link-developer-guide"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + + + + + + + + + + + + + + + + + + <a id="website/documentation/other-docs.md" name="website/documentation/other-docs.md" href="javascript:void(0);"></a> + + <li> + + Other Resources <a href="#link-other-resources"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + + + + + <a id="website/developers/index.md" name="website/developers/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-developers" id="link-developers">Developers</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="website/developers/code/index.md" name="website/developers/code/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-get-the-code" id="link-get-the-code">Get the Code</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="website/developers/code/git-more.md" name="website/developers/code/git-more.md" href="javascript:void(0);"></a> + + <li> + + Get the Code <a href="#link-get-the-code"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/how-to-contribute.md" name="website/developers/how-to-contribute.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-how-to-contribute" id="link-how-to-contribute">How to Contribute</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + CLA + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Jira + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + GitHub + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Reviews + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + + Patches + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + Get the Code <a href="#link-get-the-code"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + Handy Places <a href="/developers/links.html"><span class="octicon octicon-link-external"></span></a> + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="guide/dev/index.md" name="guide/dev/index.md" href="javascript:void(0);"></a> + + <li> + + Developer Guide <a href="#link-developer-guide"><span class="octicon octicon-link-external flip"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/index.md" name="website/developers/committers/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-committer-guide" id="link-committer-guide">Committer Guide</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/merging-contributed-code.md" name="website/developers/committers/merging-contributed-code.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-merging-contributed-code" id="link-merging-contributed-code">Merging Contributed Code</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/index.md" name="website/developers/committers/release-process/index.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-release-process" id="link-release-process">Release Process</a> + + + + <ul> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/prerequisites.md" name="website/developers/committers/release-process/prerequisites.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-release-prerequisites" id="link-release-prerequisites">Release Prerequisites</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/environment-variables.md" name="website/developers/committers/release-process/environment-variables.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-environment-variables-for-the-release" id="link-environment-variables-for-the-release">Environment variables for the release</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/release-version.md" name="website/developers/committers/release-process/release-version.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-release-branch-and-set-version" id="link-release-branch-and-set-version">Release branch and set version</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/make-release-artifacts.md" name="website/developers/committers/release-process/make-release-artifacts.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-make-the-release-artifacts" id="link-make-the-release-artifacts">Make the release artifacts</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/verify-release-artifacts.md" name="website/developers/committers/release-process/verify-release-artifacts.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-verify-the-release-artifacts" id="link-verify-the-release-artifacts">Verify the release artifacts</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/publish-temp.md" name="website/developers/committers/release-process/publish-temp.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-publish-to-the-staging-area" id="link-publish-to-the-staging-area">Publish to the staging area</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/vote.md" name="website/developers/committers/release-process/vote.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-vote-on-dev@brooklyn" id="link-vote-on-dev@brooklyn">Vote on dev@brooklyn</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/fix-release.md" name="website/developers/committers/release-process/fix-release.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-fix-on-the-release-branch" id="link-fix-on-the-release-branch">Fix on the release branch</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/publish.md" name="website/developers/committers/release-process/publish.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-publish-to-the-public" id="link-publish-to-the-public">Publish to the public</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/committers/release-process/announce.md" name="website/developers/committers/release-process/announce.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-announce-the-release" id="link-announce-the-release">Announce the release</a> + + + + </li> + + + + </ul> + + + </li> + + + + </ul> + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/code-standards.md" name="website/developers/code-standards.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-code-standards" id="link-code-standards">Code Standards</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="website/developers/links.md" name="website/developers/links.md" href="javascript:void(0);"></a> + + <li> + + + <a href="#contentsLink-handy-places" id="link-handy-places">Handy Places</a> + + + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + GitHub <a href="http://github.com/apache/brooklyn"><span class="octicon octicon-link-external"></span></a> + + </li> + + + + + + + + + + + + + + + + + <a id="" name="" href="javascript:void(0);"></a> + + <li> + + Bug Tracker (JIRA) <a href="https://issues.apache.org/jira/browse/BROOKLYN"><span class="octicon octicon-link-external"></span></a> + + </li> + + + + </ul> + + + </li> + + + + + + + </ul></nav> + + + + + + + + + + + + + + + + + <div id="contentsLink-learn-more" class="section-breaker section p-"> + <span style="width: 100%"><h1>Learn More</h1><a href="#content-top" class="goToTop">^</a></span> + + + + + + + + + + + + + <!-- +TODO have a list of resources here? or start w yaml explained? + +Got a minute? blueprint-tour +Got two minutes? watch the video +Four minutes? read the features list + cf http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2FwhatsNew%2Fplatform_whatsnew.html -- though maybe with smaller screenshots at left and bigger text for summary!) +More time? + ... +--> + +<div class="list-children"><ul> + +<li> <a href="http://brooklyn.apache.org/v/1.1.0/learnmore/blueprint-tour.html">A Quick Tour of a Brooklyn Blueprint</a> </li> + +<li> <a href="http://brooklyn.apache.org/v/1.1.0/learnmore/features/index.html">Features</a> </li> + +<li> <a href="#contentsLink-the-theory-behind-brooklyn">The Theory behind Brooklyn</a> </li> + +<li> <a href="http://brooklyn.apache.org/v/1.1.0/learnmore/catalog/index.html">Catalog</a> </li> + +</ul></div> + + + </div> + + + + + + + + + + + + + + + + + + + + + + + <div id="contentsLink-features" class="section-breaker section p-"> + <span style="width: 100%"><h1>Features</h1><a href="#content-top" class="goToTop">^</a></span> + + + + + + + + + + + + + <div class="feature-list"> + + +<h3 id="internalLink_features_blueprinting">Blueprinting</h3> + +<div class="feature-item"> + <div class="feature-title">Composable blueprints</div> + <div class="feature-body"> + + +A YAML service spec can refer to other blueprints, +either in the catalog or by URL, +and can supply custom configuration. + + +<div class="feature-image"> + <img src="./learnmore/features/blueprint-compose.png" /> +</div> + + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">Portable machines specs -- or location-specific identifiers</div> + <div class="feature-body"> + + +<p> +Define machine specs using portable constraints, +or, when you need to, use specific <code>imageId</code>, hardware profiles, and more +</p> + + + + + +<div class="feature-image"> + <img src="./learnmore/features/blueprint-machine-specs.png" /> +</div> + + + +</div></div> + + +<h3 id="internalLink_features_policy-based-management">Policy-Based Management</h3> + +<div class="feature-item"> + <div class="feature-title">Live metrics</div> + <div class="feature-body"> + + +Collect live metrics for use in policies, +either from metric stores or directly using REST, JMX, SSH, and more. + + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">Management policies</div> + <div class="feature-body"> + +<p> +Choose from built-in policies including auto-scaling, failover, and follow-the-sun, +or create new policies to perform custom runtime management. +</p> + +<p> +Use config keys to customize the policies to suit your systems, right in the YAML blueprint. +</p> + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">Dynamic reconfiguration</div> + <div class="feature-body"> + +Reconfigure policies, suspend them, or add new ones on-the-fly +through the REST API. + + + +</div></div> + + +<h3 id="internalLink_features_operations">Operations</h3> + +<div class="feature-item"> + <div class="feature-title">Brooklyn console</div> + <div class="feature-body"> + + +Brooklyn runs with a GUI console giving easy access to the +management hierarchy, sensors, and activities. + + + + + +<div class="feature-image"> + <img src="./learnmore/features/ops-console.png" /> +</div> + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">High availability</div> + <div class="feature-body"> + + +Run standby nodes which can optionally automatically promote to master +in the event of master failure. Hot standby nodes can provide additional +read-only access to entity information. + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">State persistence</div> + <div class="feature-body"> + + +Blueprint, catalog, topology and sensor information can be +automatically persisted to any file system or object store to +stop Brooklyn and restart resuming where you left off. + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">REST API</div> + <div class="feature-body"> + + +<p> +The console is pure JS-REST, and all the data shown in the GUI +is available through a straightforward REST/JSON API. +</p> + +<p> +In many cases, the REST API is simply the GUI endpoint without the +leading <code>#</code>. For instance the data for +<code>#/v1/applications/</code> is available at <code>/v1/applications/</code>. +And in all cases, Swagger doc is available in the product. +</p> + + + + +<div class="feature-image"> + <img src="./learnmore/features/ops-rest.png" /> +</div> + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">Groovy console</div> + <div class="feature-body"> + + +With the right permissions, Groovy scripts can be sent via +the GUI or via REST, allowing open-heart surgery on your systems. +(Use with care!) + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">Versioning</div> + <div class="feature-body"> + + +Blueprints in the catalog can be versioned on-the-fly. +Running entities are attached to the version against which +they were launched to preserve integrity, until manual +version updates are performed. + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">Deep task information</div> + <div class="feature-body"> + +The console shows task flows in real-time, +including the `stdin` and `stdout` for shell commands, +making it simpler to debug those pesky failures. + + + +</div></div> + + + +<h3 id="internalLink_features_java">Java</h3> + +<div class="feature-item"> + <div class="feature-title">Discoverable configuration</div> + <div class="feature-body"> + + +Config keys, sensors, and effectors can be defined on the classes +such that they are automatically discoverable at runtime. +Type information, parameters, documentation, and default values +are returned through the REST API and shown in the GUI. + + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">Type hierarchy</div> + <div class="feature-body"> + + +Use interfaces and mix-ins to share and inherit behavior in a strongly typed way. + + + + + +<div class="feature-image"> + <img src="./learnmore/features/java-hierarchy.png" /> +</div> + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">Sensor feeds</div> + <div class="feature-body"> + + +Fluent builder-style API's are included for collecting sensor information +from REST endpoints, SSH commands, JMX connectors, and more. + + + + +</div></div> + +<div class="feature-item"> + <div class="feature-title">Task libraries</div> + <div class="feature-body"> + + +Fluent builder-style task libraries are included for building activity +chains which run in parallel or sequentially, +executing SSH, REST, or arbitrary Java commands. +Task status, result, hierarchies, and errors are exposed through the REST API and in the GUI. + + + + +</div></div> + + +</div> + + </div> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <div id="contentsLink-downloads" class="section-breaker section p-"> + <span style="width: 100%"><h1>Downloads</h1><a href="#content-top" class="goToTop">^</a></span> + + + + + + + + + + + + + {% include fields.md %} + +{% if site.brooklyn.is_snapshot %} +**The downloads on this page have not been voted on and should be used at your own risk. +The latest stable release can be accessed on the [main download page](/website/download/).** +{% endif %} + + +## Download Version {{ site.brooklyn-version }} + +<table class="table"> + <tr> + <th style='text-align:left'>Download</th> + <th style='text-align:left'>File/Format</th> + <th>checksums <small><a href="http://brooklyn.apache.org/download/verify.html" title='Instructions on verifying the integrity of your downloads.{% if site.brooklyn.is_snapshot %} May not be available for SNAPSHOT artifacts.{% endif %}'>(?)</a></small></th> + </tr> + <tr> + <td style='text-align:left;vertical-align:top' rowspan='2'>Binary distribution<br />Server & client</td> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-bin.tar.gz' title='Download TGZ archive'>apache-brooklyn-{{ site.brooklyn-version }}-bin.tar.gz</a></td> + <td ><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-bin.tar.gz.asc'>PGP</a>, {% endif %} + <a href='{{ site.hash_brooklyn.download_prefix }}-bin.tar.gz.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-bin.zip' title='Download ZIP archive'>apache-brooklyn-{{ site.brooklyn-version }}-bin.zip</a></td> + <td><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-bin.zip.asc'>PGP</a>, {% endif %} + <a href='{{ site.brooklyn.hash_download_prefix }}-bin.zip.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left;vertical-align:top'>RPM package<br />CentOS7, RHEL7, etc.</td> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-1.noarch.rpm' title='Download RPM package'>apache-brooklyn-{{ site.brooklyn-version }}-1.noarch.rpm</a></td> + <td><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-1.noarch.rpm.asc'>PGP</a>, {% endif %} + <a href='{{ site.brooklyn.hash_download_prefix }}-1.noarch.rpm.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left;vertical-align:top'>DEB package<br />Ubuntu, Debian, etc.</td> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}.deb' title='Download DEB package'>apache-brooklyn-{{ site.brooklyn-version }}.deb</a></td> + <td><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}.deb.asc'>PGP</a>, {% endif %} + <a href='{{ site.brooklyn.hash_download_prefix }}.deb.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left;vertical-align:top' rowspan='6'>Client CLI only</td> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-client-cli-linux.tar.gz' title='Download client CLI linux TGZ archive'>apache-brooklyn-{{ site.brooklyn-version }}-client-cli-linux.tar.gz</a></td> + <td ><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-client-cli-linux.tar.gz.asc'>PGP</a>, {% endif %} + <a href='{{ site.hash_brooklyn.download_prefix }}-client-cli-linux.tar.gz.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-client-cli-linux.zip' title='Download client CLI linux ZIP archive'>apache-brooklyn-{{ site.brooklyn-version }}-client-cli-linux.zip</a></td> + <td><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-client-cli-linux.zip.asc'>PGP</a>, {% endif %} + <a href='{{ site.brooklyn.hash_download_prefix }}-client-cli-linux.zip.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-client-cli-macosx.tar.gz' title='Download client CLI macosx TGZ archive'>apache-brooklyn-{{ site.brooklyn-version }}-client-cli-macosx.tar.gz</a></td> + <td ><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-client-cli-macosx.tar.gz.asc'>PGP</a>, {% endif %} + <a href='{{ site.hash_brooklyn.download_prefix }}-client-cli-macosx.tar.gz.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-client-cli-macosx.zip' title='Download client CLI macosx ZIP archive'>apache-brooklyn-{{ site.brooklyn-version }}-client-cli-macosx.zip</a></td> + <td><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-client-cli-macosx.zip.asc'>PGP</a>, {% endif %} + <a href='{{ site.brooklyn.hash_download_prefix }}-client-cli-macosx.zip.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-client-cli-windows.tar.gz' title='Download client CLI windows TGZ archive'>apache-brooklyn-{{ site.brooklyn-version }}-client-cli-windows.tar.gz</a></td> + <td ><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-client-cli-windows.tar.gz.asc'>PGP</a>, {% endif %} + <a href='{{ site.hash_brooklyn.download_prefix }}-client-cli-windows.tar.gz.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-client-cli-windows.zip' title='Download client CLI windows ZIP archive'>apache-brooklyn-{{ site.brooklyn-version }}-client-cli-windows.zip</a></td> + <td><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-client-cli-windows.zip.asc'>PGP</a>, {% endif %} + <a href='{{ site.brooklyn.hash_download_prefix }}-client-cli-windows.zip.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left;vertical-align:top' rowspan='2'>Source code</td> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-src.tar.gz' title='Download source TGZ archive'>apache-brooklyn-{{ site.brooklyn-version }}-src.tar.gz</a></td> + <td ><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-src.tar.gz.asc'>PGP</a>, {% endif %} + <a href='{{ site.hash_brooklyn.download_prefix }}-src.tar.gz.sha1'>SHA1</a></small></td> + </tr> + <tr> + <td style='text-align:left'><a href='{{ site.brooklyn.download_prefix }}-src.zip' title='Download source ZIP archive'>apache-brooklyn-{{ site.brooklyn-version }}-src.zip</a></td> + <td><small> + {% if site.brooklyn.is_release %}<a href='{{ site.brooklyn.hash_download_prefix }}-src.zip.asc'>PGP</a>, {% endif %} + <a href='{{ site.brooklyn.hash_download_prefix }}-src.zip.sha1'>SHA1</a></small></td> + </tr> +</table> + + +## Release Notes + +Release notes can be found [here](/guide/misc/release-notes.md). + +{% comment %} +TODO +<a name="examples"></a> + +## Examples + +Examples can be found in the main Brooklyn codebase, in the `/examples` directory. + +A good example to start with is the [Elastic Web Cluster](/guide/use/examples/webcluster.md). + +{% endcomment %} + +<a name="maven"></a> + +## Maven + +If you use Maven, you can add Brooklyn with the following in your pom: + +<!-- the comment is included due to a jekyll/highlight bug which + removes indentation on the first line in a highlight block; + we want the actual XML indented so you can cut and paste into a pom.xml sensibly --> +{% highlight xml %} +<!-- include all Brooklyn items in our project --> + <dependencies> + <dependency> + <groupId>org.apache.brooklyn</groupId> + <artifactId>brooklyn-all</artifactId> + <version>{{ site.brooklyn-version }}</version> + </dependency> + </dependencies> +{% endhighlight %} + +`brooklyn-all` brings in all dependencies, including jclouds. +If you prefer a smaller repo you might want just ``brooklyn-core``, ``brooklyn-policies``, +and some of ``brooklyn-software-webapp``, ``brooklyn-software-database``, ``brooklyn-software-messaging``, or others +(browse the full list [here]({{ this_anything_url_search }})). + +If you wish to use the Apache snapshot repo, you can add this to you `pom.xml`: + +{% highlight xml %} +<!-- include repos for snapshot items and other dependencies --> + <repositories> + <repository> + <id>apache-nexus-snapshots</id> + <name>Apache Nexus Snapshots</name> + <url>https://repository.apache.org/content/repositories/snapshots</url> + <releases> <enabled>false</enabled> </releases> + <snapshots> <enabled>true</enabled> </snapshots> + </repository> + </repositories> +{% endhighlight %} + +{% if SNAPSHOT %} +**Please note**: to add a snapshot version of Brooklyn as a dependency to your project, +you must either have Brooklyn built locally or one of these snapshot repositories in your POM. +{% endif %} + + +<a name="source"></a> + +## Source Code + +Source code is hosted at [github.com/apache/brooklyn](http://github.com/apache/brooklyn), +with this version in branch [{{ site.brooklyn.git_branch }}]({{ site.brooklyn.url.git }}). +These locations have a `README.md` in the root which explains how to get the code including +submodules. + +Useful information on working with the source is [here](/guide/dev). + + </div> + + + + + + + + + + + + + + + + + + + + <div id="contentsLink-brooklyn-concepts" class="section-breaker section p-"> + <span style="width: 100%"><h1>Brooklyn Concepts</h1><a href="#content-top" class="goToTop">^</a></span> + + + + + + + + + + + + + This introduces brooklyn and describes how it simplifies the deployment and management of big applications. It is +intended for people who are using brooklyn-supported application components (such as web/app servers, data stores) +to be able to use brooklyn to easily start their application in multiple locations with off-the-shelf management +policies. + +{% include list-children.html %} + + </div> + + + + + + + + + + + + + + + + + + + <div id="contentsLink-entities" class="section-breaker section p-"> + <span style="width: 100%"><h1>Entities</h1><a href="#content-top" class="goToTop">^</a></span> + + + + + + + + + + + + + The central concept in a Brooklyn deployment is that of an ***entity***. +An entity represents a resource under management, either *base* entities (individual machines or software processes) +or logical collections of these entities. + +Fundamental to the processing model is the capability of entities to be the *parent* of other entities (the mechanism by which collections are formed),
[... 20598 lines stripped ...]
