[brooklyn-server] 13/20: Add docs

[he...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

heneveld pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/brooklyn-server.git

commit ab425d991a7b3c346b20b34b778442db67d7081f
Author: Duncan Grant <du...@cloudsoft.io>
AuthorDate: Tue Jul 7 22:09:33 2020 +0100

    Add docs
---
 .../apache/brooklyn/container/entity/helm/HelmEntity.java   | 13 +++++++++++++
 .../brooklyn/container/entity/helm/HelmEntityImpl.java      |  1 +
 .../brooklyn/container/entity/helm/HelmEntityLiveTest.java  |  4 ++++
 3 files changed, 18 insertions(+)

diff --git a/locations/container/src/main/java/org/apache/brooklyn/container/entity/helm/HelmEntity.java b/locations/container/src/main/java/org/apache/brooklyn/container/entity/helm/HelmEntity.java
index 3144826..bed1d9c 100644
--- a/locations/container/src/main/java/org/apache/brooklyn/container/entity/helm/HelmEntity.java
+++ b/locations/container/src/main/java/org/apache/brooklyn/container/entity/helm/HelmEntity.java
@@ -35,6 +35,19 @@ import org.w3c.dom.Attr;
 
 import java.util.List;
 
+/**
+ * Deploy using a KubernetesLocation
+ * e.g.
+ * location: kubernetes-location
+ * services:
+ * - type: org.apache.brooklyn.container.entity.helm.HelmEntity
+ *   brooklyn.config:
+ *     repo.name: bitnami
+ *     repo.url: https://charts.bitnami.com/bitnami
+ *     helm.template: bitnami/nginx
+ *     helm.deployment.name: nginx
+ */
+
 @ImplementedBy(HelmEntityImpl.class)
 public interface HelmEntity extends Entity, Startable {
 
diff --git a/locations/container/src/main/java/org/apache/brooklyn/container/entity/helm/HelmEntityImpl.java b/locations/container/src/main/java/org/apache/brooklyn/container/entity/helm/HelmEntityImpl.java
index 01e6a9e..7b692fe 100644
--- a/locations/container/src/main/java/org/apache/brooklyn/container/entity/helm/HelmEntityImpl.java
+++ b/locations/container/src/main/java/org/apache/brooklyn/container/entity/helm/HelmEntityImpl.java
@@ -53,6 +53,7 @@ import java.util.List;
 import java.util.concurrent.Callable;
 import java.util.stream.Collectors;
 
+
 public class HelmEntityImpl extends AbstractEntity implements HelmEntity {
 
     private static final Logger LOG = LoggerFactory.getLogger(HelmEntityImpl.class);
diff --git a/locations/container/src/test/java/org/apache/brooklyn/container/entity/helm/HelmEntityLiveTest.java b/locations/container/src/test/java/org/apache/brooklyn/container/entity/helm/HelmEntityLiveTest.java
index 4b02d04..d6d53fd 100644
--- a/locations/container/src/test/java/org/apache/brooklyn/container/entity/helm/HelmEntityLiveTest.java
+++ b/locations/container/src/test/java/org/apache/brooklyn/container/entity/helm/HelmEntityLiveTest.java
@@ -42,6 +42,10 @@ import static org.apache.brooklyn.core.entity.EntityAsserts.assertPredicateEvent
 
 public class HelmEntityLiveTest extends BrooklynAppLiveTestSupport {
 
+    /**
+     * To make these tests work you need to clone https://github.com/helm/charts.git
+     * Then configure PROMETHEUS_TEMPLATE_LOCATION to point to the prometheus chart
+     */
     public static final String PROMETHEUS_TEMPLATE_LOCATION = "~/workspace/charts/stable/prometheus";
 
     @AfterMethod(alwaysRun = true, timeOut = Asserts.THIRTY_SECONDS_TIMEOUT_MS)