[brooklyn-docs] 02/03: explain kubectl slightly better

[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-docs.git

commit 06ba4a7b6b987b5d0bb708fccc2ddea08681a588
Author: Alex Heneveld <al...@cloudsoft.io>
AuthorDate: Fri Jul 22 11:49:21 2022 +0100

    explain kubectl slightly better
---
 guide/blueprints/effectors.md | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

diff --git a/guide/blueprints/effectors.md b/guide/blueprints/effectors.md
index 63ecb79c..cb46c368 100644
--- a/guide/blueprints/effectors.md
+++ b/guide/blueprints/effectors.md
@@ -54,7 +54,12 @@ See [`here`](https://brooklyn.apache.org/v/latest/misc/javadoc/org/apache/brookl
 
 ### ContainerEffector
 
-An `Effector` to invoke a command or (a list of commands) on a container node accessible via `kubectl`. This obviously means access to a Kubernetes cluster must be ensured and `kubectl` must be installed where Apache Brooklyn runs. This effector is defined in the blueprint to be added to the entity using Apache Brooklyn initializers.
+This defines an effector to invoke a command or (a list of commands) on a container node accessible via `kubectl`.
+This that the `kubectl` CLI is available on the host where Apache Brooklyn is running
+and configured to access the desired Kubernetes cluster and the associated images.
+Supported Kubernetes environments to run containers include EKS, GKE, AKS, and (locally) Minikube and Docker Desktop.
+
+This effector is defined in the blueprint to be added to the entity using Apache Brooklyn initializers.
 
 It enables execution of a `command` in a specific container managed by a Kubernetes cluster. _Under the covers_ the commands and other configurations are used to generate a Kubernetes job that will execute in its own namespace. Regardless of the job execution result (success or failure) the namespace is deleted at the end, unless configured otherwise. 
 
@@ -92,10 +97,17 @@ services:
           hello: world-amp
         image: perl
         imagePullPolicy: IfNotPresent
-        commands:
-          - /bin/bash
-          - -c
-          - HELLO=$(ls -la) ; echo $HELLO; date ; echo $hello
+        bashScript: >
+          HELLO=$(ls -la)
+          echo $HELLO
+          date
+          echo $hello
+
+  brooklyn.initializers:
+    - type: org.apache.brooklyn.tasks.kubectl.ContainerEffector
+      brooklyn.config:
+        name: run-spark-job
+        image: my-spark-container
 
 {% endhighlight %}