[incubator-openwhisk-deploy-kube] branch master updated: kafka provider readme (based on alarm provider readme). (#276)

[da...@apache.org]

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

daisyguo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-deploy-kube.git


The following commit(s) were added to refs/heads/master by this push:
     new 1d151ce  kafka provider readme (based on alarm provider readme). (#276)
1d151ce is described below

commit 1d151ce3be32e1dc5adf29d68923f7023c365da6
Author: David Grove <dg...@users.noreply.github.com>
AuthorDate: Tue Aug 21 03:14:41 2018 -0400

    kafka provider readme (based on alarm provider readme). (#276)
---
 helm/providers/charts/kafka/README.md | 48 +++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/helm/providers/charts/kafka/README.md b/helm/providers/charts/kafka/README.md
new file mode 100644
index 0000000..67ea3b6
--- /dev/null
+++ b/helm/providers/charts/kafka/README.md
@@ -0,0 +1,48 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+# Use Helm to deploy kafka provider and package
+
+This chart is to deploy the kafka provider and package to OpenWhisk on a Kubernetes using Helm.
+
+## Preconditions
+
+If you intend to use a Kafka instance that is external to Kubernetes as your broker, you can stop reading this section; there are no additional preconditions.
+However, if you want to use the Kakfa instance that is installed as part of the OpenWhisk deployment as your Kafka broker, you need to configure your OpenWhisk deployment so that the action containers use Kubernetes DNS. The easiest way to do this is to use the `KubernetesContainerFactory` as the [Invoker Container Factory](https://github.com/apache/incubator-openwhisk-deploy-kube/blob/master/docs/configurationChoices.md#invoker-container-factory) in the Kubernetes cluster by adding belo [...]
+```
+# Invoker configurations
+invoker:
+  containerFactory:
+    impl: "kubernetes"
+```
+If you want to use the `DockerContainerFactory` you can instead attempt to configure the invoker to use Kubernetes DNS. First you can get the IP address of Kubernetes DNS server by `echo $(kubectl get svc kube-dns -n kube-system -o 'jsonpath={.spec.clusterIP}')` and then add below configuration in the `mycluster.yaml`:
+```
+# Invoker configurations
+invoker:
+  kube_dns: "<IP_Address_Of_Kube_DNS>"
+```
+
+## Install
+
+You may install this chart with command like
+```
+helm install ./helm/providers/charts/kafka --namespace=openwhisk --name owdev-kafka-provider
+```
+
+You can use `helm status owdev-kafka-provider` to check the status. When you see pod is running and job is completed, it should be ready to use.