usability and docs improvements

including inferring download url

Author: ahgittin

README.md

@@ -6,53 +6,47 @@ AMP-Basho
 
 The **AMP-Basho** software will automatically deploy and manage 
 Basho Riak and Riak Enterprise clusters in a wide range of environments.
-This uses [Apache Brooklyn](http://brooklyn.io)'s easy-to-use YAML blueprinting approach,
+
+This uses [Apache Brooklyn](http://brooklyn.apache.org)'s easy-to-use YAML blueprinting approach,
 combined with [Cloudsoft](http://cloudsoftcorp.com)'s enterprise-supported 
 Application Management Platform (AMP).
 
-For instance, deploy a Riak EE cluster with a configured elastic appserver 
-by posting the following YAML to Brooklyn:
+For instance, deploy a 5-node Riak EE cluster to CentOS by supplying the following blueprint:
 
 ```yaml
-name: Riak with Web Cluster
+name: Riak Cluster
 
 services:
 - type: io.cloudsoft.basho.RiakEnterpriseCluster
-  id: riak-cluster
   initialSize: 5
-  brooklyn.config:
-    download.url.rhelcentos: http://YOUR_DOWNLOAD_URL.FOR_EXAMPLE.s3.amazonaws.com/private.downloads.basho.com/riak_ee/YOUR_CODE/2.0/2.0.5/rhel/6/riak-ee-2.0.5-1.el6.x86_64.rpm
-
-- type: brooklyn.entity.webapp.ControlledDynamicWebAppCluster
-  initialSize: 3
-  brooklyn.config:
-    wars.root: https://s3-eu-west-1.amazonaws.com/brooklyn-clocker/brooklyn-example-hello-world-sql-webapp.war
-    java.sysprops: 
-      brooklyn.example.riak.nodes: $brooklyn:component("riak-cluster").attributeWhenReady("riak.cluster.nodeList")
+  download.url: <your-riak-ee-centos-download-url-here>
 
 location:
   jclouds:aws-ec2:
     identity: YOUR_CLOUD_IDENTIFIER
     credential: YOUR_CLOUD_CREDENTIAL
+    osFamily: centos
+    stopIptables: true
 ```
 
-More options, and info on configuring locations, is included in the [runtime docs](src/main/docs/README.md). 
+More blueprints are available in the [runtime docs](src/main/docs/README.md),
+including examples for **Riak EE with a demo app** and **multi-cluster replication**. 
 
 
 Interested? What Next?
 ---
 
-* Download the latest [release](https://github.com/cloudsoft/amp-basho/releases) tarball and get started
+* Download the latest [release](https://github.com/cloudsoft/amp-basho/releases) tarball and **get started**
 
-* Browse runtime docs [online](src/main/docs/README.md) (these are also included in the release download)
+* Browse runtime docs [online](src/main/docs/README.md): these are also included in the README in the release download
 
-* Read [the source code docs](docs/building-from-source.md) including how to build this project
+* Read [the source code docs](docs/) including how to build this project
 
 
 License
 ---
 
 AMP-Basho is built on [Cloudsoft AMP](http://www.cloudsoftcorp.com) and [Apache Brooklyn](http://brooklyn.io)
-and is copyright &copy; 2015 by Cloudsoft Corporation and Basho.
+and is copyright &copy; 2016 by Cloudsoft Corporation and Basho.
 
 This software is released under the terms of [the Cloudsoft EULA](LICENSE.txt).

docs/building-from-source.md

@@ -7,15 +7,16 @@ AMP-Basho: Build Instructions
 
 These instructions cover how to build the project.
 
-For instructions on running -- deploying Riak EE blueprints -- see [the distro's README](../src/main/docs/README.md).
+For instructions on running -- deploying Riak EE blueprints -- 
+see [the distro's README](../src/main/docs/README.md).
 
 
 Building this Project
 ---
 
 To build this project, with Java 7 and Maven 3 installed, simply run:
 
-    mvn clean install assembly:single
+    mvn clean install
 
 This will build and install a `...-dist.tar.gz` in `target/` which can be redistributed, 
 expanded, and run anywhere where Java is installed to run AMP-Basho.
@@ -27,11 +28,14 @@ Release Build
 ---
 
 For a release build, we want to include Cloudsoft AMP instead of Apache Brooklyn
-and ensure the latest version of the docs are built.  To do this
-you will require jekyll setup (as described [here](https://github.com/apache/incubator-brooklyn/blob/master/docs/README.md)) and a local maven install of Cloudsoft AMP:
+and ensure the latest version of the docs are built.  
+To do this you will require 
+jekyll setup (as described [here](https://github.com/apache/brooklyn-docs/blob/master/README.md)) and 
+Cloudsoft AMP available in your maven environment. 
+Then:
 
     pushd src/main/docs ; rm -rf _site ; jekyll build ; popd
-    mvn clean install assembly:single -Pamp
+    mvn clean install -Pamp
 
 
 Other Ways of Running
@@ -57,6 +61,6 @@ License
 ---
 
 AMP-Basho is built on [Cloudsoft AMP](http://www.cloudsoftcorp.com) and [Apache Brooklyn](http://brooklyn.io)
-and is copyright © 2015 by Cloudsoft Corporation and Basho.
+and is copyright © 2016 by Cloudsoft Corporation and Basho.
 
 This software is released under the terms of [the Cloudsoft EULA](../LICENSE.txt).

docs/roadmap.md

@@ -0,0 +1,9 @@
+
+Immediate:
+* Document DOWNLOAD_URL and specifying the OS
+* Fix cluster join
+* Trim landing README
+
+Longer term:
+* Ensure concurrent resizes don't clobber each other
+* Collect (and render?) migration status

pom.xml

@@ -21,10 +21,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <bundle.version>2.3.7</bundle.version>
-        <jar.version>2.4</jar.version>
-        <compiler.version>3.1</compiler.version>
-        <amp.version>2.0.0-SNAPSHOT</amp.version>
+        <amp.version>3.0.0</amp.version>
     </properties>
 
   <repositories>
@@ -66,7 +63,6 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>${compiler.version}</version>
                 <configuration>
                     <source>1.7</source>
                     <target>1.7</target>
@@ -93,7 +89,6 @@
             <plugin>
                 <groupId>org.apache.felix</groupId>
                 <artifactId>maven-bundle-plugin</artifactId>
-                <version>${bundle.version}</version>
                 <extensions>true</extensions>
                 <executions>
                     <execution>
@@ -116,7 +111,6 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
-                <version>${jar.version}</version>
                 <configuration>
                     <archive>
                         <manifest>
@@ -133,7 +127,8 @@
 
   <profiles>
     <profile>
-      <!-- amp profile builds with Cloudsoft AMP instead of Apache Brooklyn -->
+      <!-- amp profile builds with Cloudsoft AMP instead of Apache Brooklyn.
+           requires assumes AMP is available in repo configured locally. -->
       <id>amp</id>
       <dependencies>
         <dependency>
@@ -202,7 +197,6 @@
         <dependency>
             <groupId>org.apache.brooklyn</groupId>
             <artifactId>brooklyn-all</artifactId>
-            <version>${brooklyn.version}</version>
         </dependency>
       </dependencies>
     </profile>

src/main/java/io/cloudsoft/basho/RiakEnterpriseCluster.java

@@ -2,19 +2,21 @@
 
 import java.util.Set;
 
-import com.google.common.reflect.TypeToken;
-
-import org.apache.brooklyn.core.annotation.Effector;
-import org.apache.brooklyn.core.annotation.EffectorParam;
-import org.apache.brooklyn.entity.nosql.riak.RiakCluster;
-import org.apache.brooklyn.entity.nosql.riak.RiakNode;
+import org.apache.brooklyn.api.entity.EntitySpec;
 import org.apache.brooklyn.api.entity.ImplementedBy;
 import org.apache.brooklyn.api.sensor.AttributeSensor;
+import org.apache.brooklyn.config.ConfigKey;
+import org.apache.brooklyn.core.annotation.Effector;
+import org.apache.brooklyn.core.annotation.EffectorParam;
+import org.apache.brooklyn.core.config.ConfigKeys;
 import org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey;
 import org.apache.brooklyn.core.sensor.BasicAttributeSensorAndConfigKey;
 import org.apache.brooklyn.core.sensor.Sensors;
+import org.apache.brooklyn.entity.nosql.riak.RiakCluster;
 import org.apache.brooklyn.util.core.flags.SetFromFlag;
 
+import com.google.common.reflect.TypeToken;
+
 @ImplementedBy(RiakEnterpriseClusterImpl.class)
 public interface RiakEnterpriseCluster extends RiakCluster {
 
@@ -29,21 +31,26 @@ public interface RiakEnterpriseCluster extends RiakCluster {
     AttributeSensor<Set<RiakEnterpriseCluster>> REPLICATION_SINKS = Sensors.newSensor(new TypeToken<Set<RiakEnterpriseCluster>>(){},
         "riak.cluster.replication.sinks", "Set of RiakEnterpriseClusters currently acting as replication sinks to this cluster");
 
+    ConfigKey<EntitySpec<?>> MEMBER_SPEC = ConfigKeys.newConfigKeyWithDefault(RiakCluster.MEMBER_SPEC, EntitySpec.create(RiakEnterpriseNode.class));
+    
     void updateReplication(Set<RiakEnterpriseCluster> upClusters);
 
     @Effector(description="Manually initiates a fullsync operation with connected sites.")
     void triggerFullSync(@EffectorParam(name = "clusterSink", description = "cluster to make sync with") String clusterName);
 
     @SetFromFlag("downloadUrlRhelCentos")
-    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_RHEL_CENTOS = RiakNode.DOWNLOAD_URL_RHEL_CENTOS;
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_RHEL_CENTOS = RiakEnterpriseNode.DOWNLOAD_URL_RHEL_CENTOS;
 
     @SetFromFlag("downloadUrlUbuntu")
-    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_UBUNTU = RiakNode.DOWNLOAD_URL_UBUNTU;
-
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_UBUNTU = RiakEnterpriseNode.DOWNLOAD_URL_UBUNTU;
+    
     @SetFromFlag("downloadUrlDebian")
-    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_DEBIAN = RiakNode.DOWNLOAD_URL_DEBIAN;
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_DEBIAN = RiakEnterpriseNode.DOWNLOAD_URL_DEBIAN; 
 
     @SetFromFlag("downloadUrlMac")
-    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_MAC = RiakNode.DOWNLOAD_URL_MAC;
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_MAC = RiakEnterpriseNode.DOWNLOAD_URL_MAC; 
+
+    @SetFromFlag("downloadUrl")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL = RiakEnterpriseNode.DOWNLOAD_URL; 
 
 }

src/main/java/io/cloudsoft/basho/RiakEnterpriseClusterImpl.java

@@ -3,15 +3,14 @@
 import java.util.Collection;
 import java.util.Set;
 
-import com.google.common.base.Optional;
-import com.google.common.collect.Iterables;
-import com.google.common.collect.Sets;
-
 import org.apache.brooklyn.api.entity.Entity;
+import org.apache.brooklyn.api.location.Location;
 import org.apache.brooklyn.core.entity.EntityPredicates;
 import org.apache.brooklyn.entity.nosql.riak.RiakClusterImpl;
-import org.apache.brooklyn.api.entity.EntitySpec;
-import org.apache.brooklyn.api.location.Location;
+
+import com.google.common.base.Optional;
+import com.google.common.collect.Iterables;
+import com.google.common.collect.Sets;
 
 public class RiakEnterpriseClusterImpl extends RiakClusterImpl implements RiakEnterpriseCluster {
 
@@ -44,7 +43,7 @@ public void updateReplication(Set<RiakEnterpriseCluster> upClusters) {
             }
         }
 
-        setAttribute(REPLICATION_SINKS, sinks);
+        sensors().set(REPLICATION_SINKS, sinks);
     }
 
     @Override
@@ -57,10 +56,6 @@ public void triggerFullSync(String clusterName) {
         anyNode.get().triggerFullSync(clusterName);
     }
 
-    protected EntitySpec<?> getMemberSpec() {
-        return getConfig(MEMBER_SPEC, EntitySpec.create(RiakEnterpriseNode.class));
-    }
-
     private void initializeReplication() {
         String name = getConfig(CLUSTER_NAME);
         if(name != null) {
@@ -71,8 +66,8 @@ private void initializeReplication() {
             }
 
             anyNode.get().initializeReplication(name);
-            setAttribute(CLUSTER_NAME, name);
-            setAttribute(REPLICATION_INITIALIZED, true);
+            sensors().set(CLUSTER_NAME, name);
+            sensors().set(REPLICATION_INITIALIZED, true);
         }
     }
 

src/main/java/io/cloudsoft/basho/RiakEnterpriseFabric.java

@@ -2,14 +2,36 @@
 
 import org.apache.brooklyn.config.ConfigKey;
 import org.apache.brooklyn.core.config.ConfigKeys;
+import org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey;
 import org.apache.brooklyn.entity.group.DynamicFabric;
+import org.apache.brooklyn.util.core.flags.SetFromFlag;
 import org.apache.brooklyn.api.entity.ImplementedBy;
 import org.apache.brooklyn.api.location.Location;
+
 import com.google.common.base.Function;
 import com.google.common.reflect.TypeToken;
 
 @ImplementedBy(RiakEnterpriseFabricImpl.class)
 public interface RiakEnterpriseFabric extends DynamicFabric {
+    
+    @SuppressWarnings("serial")
     ConfigKey<? extends Function<Location,String>> CLUSTER_NAMER = ConfigKeys.newConfigKey(new TypeToken<Function<Location, String>>() {},
         "riak.fabric.cluster.namer", "Function used to provide the riak.replication.clusterName for a given location");
+    
+    
+    @SetFromFlag("downloadUrlRhelCentos")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_RHEL_CENTOS = RiakEnterpriseNode.DOWNLOAD_URL_RHEL_CENTOS;
+
+    @SetFromFlag("downloadUrlUbuntu")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_UBUNTU = RiakEnterpriseNode.DOWNLOAD_URL_UBUNTU;
+    
+    @SetFromFlag("downloadUrlDebian")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_DEBIAN = RiakEnterpriseNode.DOWNLOAD_URL_DEBIAN; 
+
+    @SetFromFlag("downloadUrlMac")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_MAC = RiakEnterpriseNode.DOWNLOAD_URL_MAC; 
+
+    @SetFromFlag("downloadUrl")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL = RiakEnterpriseNode.DOWNLOAD_URL; 
+
 }

src/main/java/io/cloudsoft/basho/RiakEnterpriseFabricImpl.java

@@ -89,6 +89,7 @@ protected EntitySpec<?> getMemberSpec() {
         }
     }
 
+    @SuppressWarnings({"unchecked","rawtypes"})
     @Override
     protected Entity createCluster(Location location, Map flags) {
         Function<Location, String> clusterNamer = getConfig(CLUSTER_NAMER);
@@ -118,7 +119,7 @@ protected void connectEnrichers() {
         subscribeToMembers(this, SERVICE_UP, new SensorEventListener<Boolean>() {
             @Override
             public void onEvent(SensorEvent<Boolean> event) {
-                setAttribute(SERVICE_UP, calculateServiceUp());
+                sensors().set(SERVICE_UP, calculateServiceUp());
             }
         });
     }

src/main/java/io/cloudsoft/basho/RiakEnterpriseNode.java

@@ -1,10 +1,15 @@
 package io.cloudsoft.basho;
 
+import org.apache.brooklyn.api.entity.ImplementedBy;
 import org.apache.brooklyn.config.ConfigKey;
 import org.apache.brooklyn.core.config.ConfigKeys;
-import org.apache.brooklyn.entity.nosql.riak.RiakNode;
-import org.apache.brooklyn.api.entity.ImplementedBy;
+import org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey;
+import org.apache.brooklyn.core.sensor.BasicAttributeSensorAndConfigKey;
 import org.apache.brooklyn.core.sensor.PortAttributeSensorAndConfigKey;
+import org.apache.brooklyn.entity.nosql.riak.RiakNode;
+import org.apache.brooklyn.util.core.flags.SetFromFlag;
+
+import com.google.common.annotations.Beta;
 
 @ImplementedBy(RiakEnterpriseNodeImpl.class)
 public interface RiakEnterpriseNode extends RiakNode {
@@ -15,11 +20,38 @@ public interface RiakEnterpriseNode extends RiakNode {
     PortAttributeSensorAndConfigKey CLUSTER_MANAGER_PORT = new PortAttributeSensorAndConfigKey("riak.replication.cluster.manager.port",
             "Cluster Manager Port", "9080+");
 
+    @SetFromFlag("downloadUrlRhelCentos")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_RHEL_CENTOS = 
+        Helper.newSensorConfigKey(RiakNode.DOWNLOAD_URL_RHEL_CENTOS, "");
+
+    @SetFromFlag("downloadUrlUbuntu")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_UBUNTU = 
+        Helper.newSensorConfigKey(RiakNode.DOWNLOAD_URL_UBUNTU, "");
+    
+    @SetFromFlag("downloadUrlDebian")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_DEBIAN = 
+        Helper.newSensorConfigKey(RiakNode.DOWNLOAD_URL_DEBIAN, "");
+
+    @SetFromFlag("downloadUrlMac")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL_MAC = 
+        Helper.newSensorConfigKey(RiakNode.DOWNLOAD_URL_MAC, "");
+
+    @SetFromFlag("downloadUrl")
+    AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL = 
+        Helper.newSensorConfigKey(RiakNode.DOWNLOAD_URL, "");
+    
     void initializeReplication(String name);
 
     void triggerFullSync(String clusterName);
 
     void addReplicationSink(RiakEnterpriseCluster upCluster);
 
     Integer getRiakClusterManagerPort();
+    
+    static class Helper {
+        @Beta
+        public static <T> AttributeSensorAndConfigKey<T, T> newSensorConfigKey(AttributeSensorAndConfigKey<T, T> orig, T newDefaultValue) {
+            return new BasicAttributeSensorAndConfigKey<T>(orig, newDefaultValue);
+        }
+    }
 }