add more experimental verbiage to invoker agent description (#534)
diff --git a/docs/configurationChoices.md b/docs/configurationChoices.md
index c37ea99..da0d12a 100644
--- a/docs/configurationChoices.md
+++ b/docs/configurationChoices.md
@@ -210,9 +210,13 @@
options: "-Dwhisk.spi.LogStoreProvider=org.apache.openwhisk.core.containerpool.logging.LogDriverLogStoreProvider"
```
-The KubernetesContainerFactory can be deployed with an additional
-invokerAgent that implements container suspend/resume operations on
-behalf of a remote Invoker. To enable this experimental configuration, add
+There is an experimental configuration of the KubernetesContainerFactory
+that deploys an additional invokerAgent DaemonSet that implements container suspend/resume
+operations on behalf of a remote Invoker. The agent does this by attempting to
+connect directly to the Docker engine running on the worker node. If your worker nodes
+do not use Docker as their underlying container engine, the invoker agent will go into
+a `CrashLoopBackOff`. If you want to experiment with this feature,
+you can enable it by adding the stanza:
```yaml
invoker:
containerFactory:
diff --git a/helm/openwhisk/values-metadata.yaml b/helm/openwhisk/values-metadata.yaml
index add3f29..f69e741 100644
--- a/helm/openwhisk/values-metadata.yaml
+++ b/helm/openwhisk/values-metadata.yaml
@@ -1117,7 +1117,7 @@
enabled:
__metadata:
label: "Agent enabled"
- description: "If the invoker agent should be enabled"
+ description: "If the experimental invoker agent should be enabled"
type: "boolean"
required: true
port:
diff --git a/helm/openwhisk/values.yaml b/helm/openwhisk/values.yaml
index ccca325..4bfdbdb 100644
--- a/helm/openwhisk/values.yaml
+++ b/helm/openwhisk/values.yaml
@@ -275,6 +275,7 @@
options: ""
kubernetes:
replicaCount: 1
+ # WARNING: the invoker agent is an experimental feature and is not recommend for general use
agent:
imageName: "openwhisk/kube-invoker-agent"
imageTag: "7314d75"
