You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by m4...@apache.org on 2017/06/26 13:32:23 UTC

[1/2] brooklyn-docs git commit: Update location structure

Repository: brooklyn-docs
Updated Branches:
  refs/heads/master aedfae2a1 -> e3f121943


Update location structure


Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/5e91cdc2
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/5e91cdc2
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/5e91cdc2

Branch: refs/heads/master
Commit: 5e91cdc2461913a08d1d95d5116dbabc5d6e3357
Parents: 0ca3f6e
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Fri Jun 23 15:05:06 2017 +0100
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Fri Jun 23 15:05:06 2017 +0100

----------------------------------------------------------------------
 .../_location-customizer-security-groups.md     |  55 ++++++
 guide/locations/_location-customizers.md        | 178 +++++++++++++++++++
 guide/locations/_special-locations.md           |   2 +-
 guide/locations/index.md                        |   1 -
 .../_location-customizer-security-groups.md     |  56 ------
 .../jclouds-location-customizers/index.md       |   6 -
 guide/locations/location-customizers.md         | 175 ------------------
 .../machine-location-customizers/index.md       |   9 -
 8 files changed, 234 insertions(+), 248 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5e91cdc2/guide/locations/_location-customizer-security-groups.md
----------------------------------------------------------------------
diff --git a/guide/locations/_location-customizer-security-groups.md b/guide/locations/_location-customizer-security-groups.md
new file mode 100644
index 0000000..d7a986b
--- /dev/null
+++ b/guide/locations/_location-customizer-security-groups.md
@@ -0,0 +1,55 @@
+---
+section: Customizing Cloud Security Groups
+section_position: 12
+section_type: inline
+---
+
+## Customizing Cloud Security Groups
+
+Before using SharedLocationSecurityGroupCustomizer, please first refer to [Port Inferencing](../../blueprints/custom-entities.html#port-inferencing).
+
+A security group is a named collection of network access rules that are use to limit the types of traffic that have access to instances.<br>
+Security group is the standard way to set firewall restrictions on the AWS-EC2 environment.
+[docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html)
+
+When deploying to AWS EC2 target, by default Apache Brooklyn creates security group attached to the VM.
+It is easy to add additional rules to the initial security group using `org.apache.brooklyn SharedLocationSecurityGroupCustomizer`.
+
+YAML Example:
+
+    name: ports @ AWS
+    location: jclouds:aws-ec2:us-west-2:
+    services:
+    - type: org.apache.brooklyn.entity.software.base.EmptySoftwareProcess
+      brooklyn.config:
+        provisioning.properties:
+          customizers:
+          - $brooklyn:object:
+              type: org.apache.brooklyn.location.jclouds.networking.SharedLocationSecurityGroupCustomizer
+              object.fields: {tcpPortRanges: ["900-910", "915", "22"], udpPortRanges: ["100","200-300"], cidr: "82.40.153.101/24"}
+
+
+Make sure that you have rule which makes port 22 accessible from Apache Brooklyn.
+
+### Opening ports during runtime.
+
+Apache Brooklyn exposes the SharedLocationSecurityGroupCustomizer functionality after entity is deployed <br>
+just by supplying `effector.add.openInboundPorts: true` "brooklyn.config".
+Example configuration in effector
+
+    location: jclouds:aws-ec2:us-west-2
+    services:
+    - type: org.apache.brooklyn.entity.software.base.EmptySoftwareProcess
+      brooklyn.config:
+        effector.add.openInboundPorts: true
+
+### Known limitations
+
+Not all cloud providers support Security Group abstraction.
+`SharedLocationSecurityGroupCustomizer` is known to work well with Amazon EC2.<br>
+Other clouds which support Security Groups:
+
+- Openstack
+- Azure - jclouds-labs azurecompute implementation uses endpoints rules when creating a VM instance.
+  jclouds:azurecompute based location do not have security groups so SharedLocationSecurityGroupCustomizer is used it will fail to find a security group.
+

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5e91cdc2/guide/locations/_location-customizers.md
----------------------------------------------------------------------
diff --git a/guide/locations/_location-customizers.md b/guide/locations/_location-customizers.md
new file mode 100644
index 0000000..145c158
--- /dev/null
+++ b/guide/locations/_location-customizers.md
@@ -0,0 +1,178 @@
+---
+section: Location Customizers
+section_type: inline
+section_position: 11
+---
+
+### Location Customizers
+
+Apache Brooklyn supports a number of ways to configure and customize locations. These include
+the `JcloudsLocationCustomizer`, which is for advanced customization of VM provisioning through jclouds.
+There is also a `MachineLocationCustomizer`, which allows customization of machines being obtained 
+from any kind of location (including [Bring Your Own Nodes](index.html#byon)).
+
+
+#### Usage Guidelines
+
+Clearly there is an overlap for where things can be done. This section describes the recommended  
+separation of responsibilities.
+
+These are guidelines only - users are obviously free to make alternative usage decisions based on 
+their particular use-cases.
+
+#### Responsibilities of Entity versus Location
+
+From an entity's perspective, it calls `location.obtain(options)` and gets back a usable 
+`MachineLocation` that has a standard base operating system that gives remote access
+(e.g. for Linux it expects credentials for a user with `sudo` rights, and ssh access).
+
+However, there are special cases - for example the `location.obtain(options)` could return
+a Docker container with the software pre-installed, and no remote access (see the 
+[Clocker project](http://clocker.io) for more information on use of Docker with Brooklyn).
+
+The entity is then responsible for configuring that machine according to the needs of the software 
+to be installed.
+
+For example, the entity may install software packages, upload/update configuration files, launch
+processes, etc.
+
+The entity may also configure `iptables`. This is also possible through the `JcloudsLocation` 
+configuration. However, it is preferable to do this in the entity because it is part of 
+configuring the machine in the way required for the given software component.
+
+The entity may also perform custom OS setup, such as installing security patches. However, whether 
+this is appropriate depends on the nature of the security patch: if the security patch is specific 
+to the entity type, then it should be done within the entity; but if it is to harden the base OS 
+to make it comply with an organisation's standards (e.g. to overcome shortcomings of the base 
+image, or to install security patches) then a `MachineLocationCustomizer` is more appropriate.
+
+#### Location Configuration Options
+
+This refers to standard location configuration: explicit config keys, and explicit jclouds template 
+configuration that can be passed through.
+
+This kind of configuration is simplest to use. It is the favoured mechanism when it comes to VM 
+provisioning, and should be used wherever possible.
+
+Note that a jclouds `TemplateBuilder` and cloud-specific `TemplateOptions` are the generic mechanisms 
+within jclouds for specifying the details of the compute resource to be provisioned.
+
+#### Jclouds Location Customizer 
+A `JcloudsLocationCustomizer` has customization hooks to execute code at the various points of building 
+up the jclouds template and provisioning the machine. Where jclouds is being used and where the required 
+use of jclouds goes beyond simple configuration, this is an appropriate solution.
+
+For example, there is a `org.apache.brooklyn.location.jclouds.networking.JcloudsLocationSecurityGroupCustomizer`
+which gives more advanced support for setting up security groups (e.g. in AWS-EC2).
+
+#### Machine Customizer
+
+The `MachineLocationCustomizer` allows customization of machines being obtained from any kind of location.
+For example, this includes for jclouds and for Bring Your Own Nodes (BYON).
+
+It provides customization hooks for when the machine has been provisioned (before it is returned by the location)
+and when the machine is about to be released by the location.
+
+An example use would be to register (and de-register) the machine in a CMDB.
+
+
+### Jclouds Location Customizers
+
+*Warning: additional methods (i.e. customization hooks) may be added to the `JcloudsLocationCustomizer` 
+interface in future releases. Users are therefore strongly encouraged to sub-class 
+`BasicJcloudsLocationCustomizer`, rather than implementing JcloudsLocationCustomizer directly.*
+
+The `JcloudsLocationCustomizer` provides customization hooks at various points of the Brooklyn's
+use of jclouds. These can be used to adjust the configuration, to do additional setup, to do
+custom logging, etc.
+
+* Customize the `org.jclouds.compute.domain.TemplateBuilder`, before it is used to build the template.
+  This is used to influence the choice of VM image, hardware profile, etc. This hook is not normally
+  required as the location configuration options can be used in instead.
+
+* Customize the `org.jclouds.compute.domain.Template`, to be used when creating the machine. This  
+  hook is most often used for performing custom actions - for example to create or modify a security 
+  group or volume, and to update the template's options to use that.
+
+* Customize the `org.jclouds.compute.options.TemplateOptions` to be used when creating the machine.
+  The `TemplateOptions` could be cast to a cloud-specific sub-type (if this does not have to work
+  across different clouds). Where the use-case is to just set simple configuration on the 
+  `TemplateOptions`, consider instead using the config key `templateOptions`, which takes a map
+  of type String to Object - the strings should match the method names in the `TemplateOptions`.
+
+* Customize the `org.apache.brooklyn.location.jclouds.JcloudsMachineLocation` that has been 
+  created. For Linux-based VMs, if the config `waitForSshable` was not false, then this machine
+  is guaranteed to be ssh'able. Similarly for WinRM access to Windows machines, if 
+  `waitForWinRmAvailable` was not false.
+
+* Pre-release of the machine. If the actions required are specific to jclouds (e.g. using jclouds 
+  to make calls to the cloud provider) then this should be used; otherwise one should use the more
+  generic `MachineLocationCustomizer`.
+
+* Post-release of the machine (i.e. after asking jclouds to destroying the machine).
+
+To register a `JcloudsLocationCustomizer` in YAML, the config key `customizers` can be used to 
+provide a list of instances. Each instance can be defined using `$brooklyn:object` to indicate 
+the type and its configuration. For example:
+
+    location:
+      jclouds:aws-ec2:us-east-1:
+        customizers:
+        - $brooklyn:object:
+            type: com.acme.brooklyn.MyJcloudsLocationCustomizer
+
+To register `JcloudsLocationCustomizer` instances programmatically, set the config key
+`JcloudsLocationConfig.JCLOUDS_LOCATION_CUSTOMIZERS` on the location, or pass this 
+config option when calling `location.obtain(options)`.
+
+
+The `SharedLocationSecurityGroupCustomizer` configures a shared security group on Jclouds locations.
+It only works on AWS and Azure ARM.
+
+To register a `SharedLocationSecurityGroupCustomizer` in YAML, you can use the config key `customizers`
+and configure it with `$brooklyn:object` and `object.fields`. For example:
+
+    location:
+      jclouds:aws-ec2:us-east-1:
+        customizers:
+        - $brooklyn:object:
+            type: org.apache.brooklyn.location.jclouds.networking.SharedLocationSecurityGroupCustomizer
+            object.fields: {locationName: "myloc", tcpPortRanges: ["22", "8080", "9443"], udpPortRanges: ["2001", "4013"], cidr: "82.40.153.101/24"}
+
+where `cidr` can be optionally set to restrict the range that the ports that are to be opened can be accessed from.
+
+
+
+#### Machine Location Customizers
+
+*Warning: additional methods (i.e. customization hooks) may be added to the `MachineLocationCustomizer` 
+interface in future releases. Users are therefore strongly encouraged to sub-class 
+`BasicMachineLocationCustomizer`, rather than implementing `MachineLocationCustomizer` directly.*
+
+The `MachineLocationCustomizer` provides customization hooks for when a machine is obtained/released 
+from a `MachineProvisioningLocation`. The following hooks are supported: 
+
+* After the machine has been provisioned/allocated, but before it has been returned.
+
+* When the machine is about to be released, but prior to actually destroying/unallocating the
+  machine.
+
+To register a `MachineLocationCustomizer` in YAML, the config key `machineCustomizers` can be used  
+to provide a list of instances. Each instance can be defined using `$brooklyn:object` to indicate 
+the type and its configuration. For example:
+
+    location:
+      jclouds:aws-ec2:us-east-1:
+        machineCustomizers:
+        - $brooklyn:object:
+            type: com.acme.brooklyn.MyMachineLocationCustomizer
+
+To register `MachineLocationCustomizer` instances programmatically, set the config key
+`CloudLocationConfig.MACHINE_LOCATION_CUSTOMIZERS` on the location, or pass this 
+config option when calling `location.obtain(options)`.
+
+#### Hostname Customizer
+
+[org.apache.brooklyn.entity.machine.SetHostnameCustomizer](https://github.com/apache/brooklyn-server/blob/master/software/base/src/main/java/org/apache/brooklyn/entity/machine/SetHostnameCustomizer.java)
+Sets the hostname on an ssh'able machine. Currently only CentOS and RHEL are supported.
+The customizer can be configured with a hard-coded hostname, or with a freemarker template whose value (after substitutions) will be used for the hostname.

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5e91cdc2/guide/locations/_special-locations.md
----------------------------------------------------------------------
diff --git a/guide/locations/_special-locations.md b/guide/locations/_special-locations.md
index 32f628b..a06b0ae 100644
--- a/guide/locations/_special-locations.md
+++ b/guide/locations/_special-locations.md
@@ -1,6 +1,6 @@
 ---
 section: Specialized Locations
-section_position: 11
+section_position: 13
 section_type: inline
 ---
 

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5e91cdc2/guide/locations/index.md
----------------------------------------------------------------------
diff --git a/guide/locations/index.md b/guide/locations/index.md
index b2d4d98..9092ada 100644
--- a/guide/locations/index.md
+++ b/guide/locations/index.md
@@ -2,7 +2,6 @@
 title: Locations
 layout: website-normal
 children:
-- { path: location-customizers.md, section_position: 8 }
 - { path: provisioned-machine-requirements.md, section_position: 8 }
 check_directory_for_children: true
 ---

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5e91cdc2/guide/locations/jclouds-location-customizers/_location-customizer-security-groups.md
----------------------------------------------------------------------
diff --git a/guide/locations/jclouds-location-customizers/_location-customizer-security-groups.md b/guide/locations/jclouds-location-customizers/_location-customizer-security-groups.md
deleted file mode 100644
index b472a13..0000000
--- a/guide/locations/jclouds-location-customizers/_location-customizer-security-groups.md
+++ /dev/null
@@ -1,56 +0,0 @@
----
-section: Customizing Cloud Security Group
-section_position: 1
-section_type: inline
----
-
-
-## Customizing Cloud Security Group
-
-Before using SharedLocationSecurityGroupCustomizer, please first refer to [Port Inferencing](../../blueprints/custom-entities.html#port-inferencing).
-
-A security group is a named collection of network access rules that are use to limit the types of traffic that have access to instances.<br>
-Security group is the standard way to set firewall restrictions on the AWS-EC2 environment.
-[docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html)
-
-When deploying to AWS EC2 target, by default Apache Brooklyn creates security group attached to the VM.
-It is easy to add additional rules to the initial security group using `org.apache.brooklyn SharedLocationSecurityGroupCustomizer`.
-
-YAML Example:
-
-    name: ports @ AWS
-    location: jclouds:aws-ec2:us-west-2:
-    services:
-    - type: org.apache.brooklyn.entity.software.base.EmptySoftwareProcess
-      brooklyn.config:
-        provisioning.properties:
-          customizers:
-          - $brooklyn:object:
-              type: org.apache.brooklyn.location.jclouds.networking.SharedLocationSecurityGroupCustomizer
-              object.fields: {tcpPortRanges: ["900-910", "915", "22"], udpPortRanges: ["100","200-300"], cidr: "82.40.153.101/24"}
-
-
-Make sure that you have rule which makes port 22 accessible from Apache Brooklyn.
-
-### Opening ports during runtime.
-
-Apache Brooklyn exposes the SharedLocationSecurityGroupCustomizer functionality after entity is deployed <br>
-just by supplying `effector.add.openInboundPorts: true` "brooklyn.config".
-Example configuration in effector
-
-    location: jclouds:aws-ec2:us-west-2
-    services:
-    - type: org.apache.brooklyn.entity.software.base.EmptySoftwareProcess
-      brooklyn.config:
-        effector.add.openInboundPorts: true
-
-### Known limitations
-
-Not all cloud providers support Security Group abstraction.
-`SharedLocationSecurityGroupCustomizer` is known to work well with Amazon EC2.<br>
-Other clouds which support Security Groups:
-
-- Openstack
-- Azure - jclouds-labs azurecompute implementation uses endpoints rules when creating a VM instance.
-  jclouds:azurecompute based location do not have security groups so SharedLocationSecurityGroupCustomizer is used it will fail to find a security group.
-

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5e91cdc2/guide/locations/jclouds-location-customizers/index.md
----------------------------------------------------------------------
diff --git a/guide/locations/jclouds-location-customizers/index.md b/guide/locations/jclouds-location-customizers/index.md
deleted file mode 100644
index b54c235..0000000
--- a/guide/locations/jclouds-location-customizers/index.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Jclouds Location Customizers
-layout: website-normal
-check_directory_for_children: true
----
-{% child_content %}
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5e91cdc2/guide/locations/location-customizers.md
----------------------------------------------------------------------
diff --git a/guide/locations/location-customizers.md b/guide/locations/location-customizers.md
deleted file mode 100644
index ddcb599..0000000
--- a/guide/locations/location-customizers.md
+++ /dev/null
@@ -1,175 +0,0 @@
----
-title: Location Customizers
-layout: website-normal
-children:
-- machine-location-customizers/
-- jclouds-location-customizers/
----
-
-Apache Brooklyn supports a number of ways to configure and customize locations. These include
-the `JcloudsLocationCustomizer`, which is for advanced customization of VM provisioning through jclouds.
-There is also a `MachineLocationCustomizer`, which allows customization of machines being obtained 
-from any kind of location (including [Bring Your Own Nodes](index.html#byon)).
-
-
-## Usage Guidelines
-
-Clearly there is an overlap for where things can be done. This section describes the recommended  
-separation of responsibilities.
-
-These are guidelines only - users are obviously free to make alternative usage decisions based on 
-their particular use-cases.
-
-### Responsibilities of Entity versus Location
-
-From an entity's perspective, it calls `location.obtain(options)` and gets back a usable 
-`MachineLocation` that has a standard base operating system that gives remote access
-(e.g. for Linux it expects credentials for a user with `sudo` rights, and ssh access).
-
-However, there are special cases - for example the `location.obtain(options)` could return
-a Docker container with the software pre-installed, and no remote access (see the 
-[Clocker project](http://clocker.io) for more information on use of Docker with Brooklyn).
-
-The entity is then responsible for configuring that machine according to the needs of the software 
-to be installed.
-
-For example, the entity may install software packages, upload/update configuration files, launch
-processes, etc.
-
-The entity may also configure `iptables`. This is also possible through the `JcloudsLocation` 
-configuration. However, it is preferable to do this in the entity because it is part of 
-configuring the machine in the way required for the given software component.
-
-The entity may also perform custom OS setup, such as installing security patches. However, whether 
-this is appropriate depends on the nature of the security patch: if the security patch is specific 
-to the entity type, then it should be done within the entity; but if it is to harden the base OS 
-to make it comply with an organisation's standards (e.g. to overcome shortcomings of the base 
-image, or to install security patches) then a `MachineLocationCustomizer` is more appropriate.
-
-### Location Configuration Options
-
-This refers to standard location configuration: explicit config keys, and explicit jclouds template 
-configuration that can be passed through.
-
-This kind of configuration is simplest to use. It is the favoured mechanism when it comes to VM 
-provisioning, and should be used wherever possible.
-
-Note that a jclouds `TemplateBuilder` and cloud-specific `TemplateOptions` are the generic mechanisms 
-within jclouds for specifying the details of the compute resource to be provisioned.
-
-### Jclouds Location Customizer 
-A `JcloudsLocationCustomizer` has customization hooks to execute code at the various points of building 
-up the jclouds template and provisioning the machine. Where jclouds is being used and where the required 
-use of jclouds goes beyond simple configuration, this is an appropriate solution.
-
-For example, there is a `org.apache.brooklyn.location.jclouds.networking.JcloudsLocationSecurityGroupCustomizer`
-which gives more advanced support for setting up security groups (e.g. in AWS-EC2).
-
-### Machine Customizer
-
-The `MachineLocationCustomizer` allows customization of machines being obtained from any kind of location.
-For example, this includes for jclouds and for Bring Your Own Nodes (BYON).
-
-It provides customization hooks for when the machine has been provisioned (before it is returned by the location)
-and when the machine is about to be released by the location.
-
-An example use would be to register (and de-register) the machine in a CMDB.
-
-
-## Jclouds Location Customizers
-
-*Warning: additional methods (i.e. customization hooks) may be added to the `JcloudsLocationCustomizer` 
-interface in future releases. Users are therefore strongly encouraged to sub-class 
-`BasicJcloudsLocationCustomizer`, rather than implementing JcloudsLocationCustomizer directly.*
-
-The `JcloudsLocationCustomizer` provides customization hooks at various points of the Brooklyn's
-use of jclouds. These can be used to adjust the configuration, to do additional setup, to do
-custom logging, etc.
-
-* Customize the `org.jclouds.compute.domain.TemplateBuilder`, before it is used to build the template.
-  This is used to influence the choice of VM image, hardware profile, etc. This hook is not normally
-  required as the location configuration options can be used in instead.
-
-* Customize the `org.jclouds.compute.domain.Template`, to be used when creating the machine. This  
-  hook is most often used for performing custom actions - for example to create or modify a security 
-  group or volume, and to update the template's options to use that.
-
-* Customize the `org.jclouds.compute.options.TemplateOptions` to be used when creating the machine.
-  The `TemplateOptions` could be cast to a cloud-specific sub-type (if this does not have to work
-  across different clouds). Where the use-case is to just set simple configuration on the 
-  `TemplateOptions`, consider instead using the config key `templateOptions`, which takes a map
-  of type String to Object - the strings should match the method names in the `TemplateOptions`.
-
-* Customize the `org.apache.brooklyn.location.jclouds.JcloudsMachineLocation` that has been 
-  created. For Linux-based VMs, if the config `waitForSshable` was not false, then this machine
-  is guaranteed to be ssh'able. Similarly for WinRM access to Windows machines, if 
-  `waitForWinRmAvailable` was not false.
-
-* Pre-release of the machine. If the actions required are specific to jclouds (e.g. using jclouds 
-  to make calls to the cloud provider) then this should be used; otherwise one should use the more
-  generic `MachineLocationCustomizer`.
-
-* Post-release of the machine (i.e. after asking jclouds to destroying the machine).
-
-To register a `JcloudsLocationCustomizer` in YAML, the config key `customizers` can be used to 
-provide a list of instances. Each instance can be defined using `$brooklyn:object` to indicate 
-the type and its configuration. For example:
-
-    location:
-      jclouds:aws-ec2:us-east-1:
-        customizers:
-        - $brooklyn:object:
-            type: com.acme.brooklyn.MyJcloudsLocationCustomizer
-
-To register `JcloudsLocationCustomizer` instances programmatically, set the config key
-`JcloudsLocationConfig.JCLOUDS_LOCATION_CUSTOMIZERS` on the location, or pass this 
-config option when calling `location.obtain(options)`.
-
-
-The `SharedLocationSecurityGroupCustomizer` configures a shared security group on Jclouds locations.
-It only works on AWS and Azure ARM.
-
-To register a `SharedLocationSecurityGroupCustomizer` in YAML, you can use the config key `customizers`
-and configure it with `$brooklyn:object` and `object.fields`. For example:
-
-    location:
-      jclouds:aws-ec2:us-east-1:
-        customizers:
-        - $brooklyn:object:
-            type: org.apache.brooklyn.location.jclouds.networking.SharedLocationSecurityGroupCustomizer
-            object.fields: {locationName: "myloc", tcpPortRanges: ["22", "8080", "9443"], udpPortRanges: ["2001", "4013"], cidr: "82.40.153.101/24"}
-
-where `cidr` can be optionally set to restrict the range that the ports that are to be opened can be accessed from.
-
-
-
-## Machine Location Customizers
-
-*Warning: additional methods (i.e. customization hooks) may be added to the `MachineLocationCustomizer` 
-interface in future releases. Users are therefore strongly encouraged to sub-class 
-`BasicMachineLocationCustomizer`, rather than implementing `MachineLocationCustomizer` directly.*
-
-The `MachineLocationCustomizer` provides customization hooks for when a machine is obtained/released 
-from a `MachineProvisioningLocation`. The following hooks are supported: 
-
-* After the machine has been provisioned/allocated, but before it has been returned.
-
-* When the machine is about to be released, but prior to actually destroying/unallocating the
-  machine.
-
-To register a `MachineLocationCustomizer` in YAML, the config key `machineCustomizers` can be used  
-to provide a list of instances. Each instance can be defined using `$brooklyn:object` to indicate 
-the type and its configuration. For example:
-
-    location:
-      jclouds:aws-ec2:us-east-1:
-        machineCustomizers:
-        - $brooklyn:object:
-            type: com.acme.brooklyn.MyMachineLocationCustomizer
-
-To register `MachineLocationCustomizer` instances programmatically, set the config key
-`CloudLocationConfig.MACHINE_LOCATION_CUSTOMIZERS` on the location, or pass this 
-config option when calling `location.obtain(options)`.
-
-## Implementations available in Apache Brooklyn
-{% include list-children.html %}
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5e91cdc2/guide/locations/machine-location-customizers/index.md
----------------------------------------------------------------------
diff --git a/guide/locations/machine-location-customizers/index.md b/guide/locations/machine-location-customizers/index.md
deleted file mode 100644
index 56e9e03..0000000
--- a/guide/locations/machine-location-customizers/index.md
+++ /dev/null
@@ -1,9 +0,0 @@
----
-title: Machine Location Customizers
-layout: website-normal
-check_directory_for_children: true
----
-
-* [org.apache.brooklyn.entity.machine.SetHostnameCustomizer](https://github.com/apache/brooklyn-server/blob/master/software/base/src/main/java/org/apache/brooklyn/entity/machine/SetHostnameCustomizer.java)
-Sets the hostname on an ssh'able machine. Currently only CentOS and RHEL are supported.
-The customizer can be configured with a hard-coded hostname, or with a freemarker template whose value (after substitutions) will be used for the hostname.


[2/2] brooklyn-docs git commit: This closes #201

Posted by m4...@apache.org.
This closes #201


Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/e3f12194
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/e3f12194
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/e3f12194

Branch: refs/heads/master
Commit: e3f121943bd57669cd657ecb67c578fe6a100842
Parents: aedfae2 5e91cdc
Author: Mark McKenna <m4...@gmail.com>
Authored: Mon Jun 26 14:31:03 2017 +0100
Committer: Mark McKenna <m4...@gmail.com>
Committed: Mon Jun 26 14:31:03 2017 +0100

----------------------------------------------------------------------
 .../_location-customizer-security-groups.md     |  55 ++++++
 guide/locations/_location-customizers.md        | 178 +++++++++++++++++++
 guide/locations/_special-locations.md           |   2 +-
 guide/locations/index.md                        |   1 -
 .../_location-customizer-security-groups.md     |  56 ------
 .../jclouds-location-customizers/index.md       |   6 -
 guide/locations/location-customizers.md         | 175 ------------------
 .../machine-location-customizers/index.md       |   9 -
 8 files changed, 234 insertions(+), 248 deletions(-)
----------------------------------------------------------------------