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 13ddc30 Add discussion of actions resolving Kubernetes services via
DNS (#366)
13ddc30 is described below
commit 13ddc302634bdb41f706cd645295171ec447bab8
Author: David Grove <dgrove-...@users.noreply.github.com>
AuthorDate: Mon Nov 19 23:38:26 2018 -0500
Add discussion of actions resolving Kubernetes services via DNS (#366)
Fixes #315.
---
README.md | 32 +++++++++++++++++++++++++-------
1 file changed, 25 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 529e3d4..328ef15 100644
--- a/README.md
+++ b/README.md
@@ -23,10 +23,18 @@
[](https://travis-ci.org/apache/incubator-openwhisk-deploy-kube)
[](http://slack.openwhisk.org/)
-This repository can be used to deploy OpenWhisk to Kubernetes.
-It contains Helm charts, documentation, and other supporting artifacts
-that can be used to deploy OpenWhisk to both single-node and
-multi-node Kubernetes clusters.
+Apache OpenWhisk is an open source, distributed Serverless platform
+that executes functions (fx) in response to events at any scale. The
+OpenWhisk platform supports a programming model in which developers
+write functional logic (called Actions), in any supported programming
+language, that can be dynamically scheduled and run in response to
+associated events (via Triggers) from external sources (Feeds) or from
+HTTP requests.
+
+This repository supports deploying OpenWhisk to Kubernetes.
+It contains a Helm chart that can be used to deploy the core
+OpenWhisk platform and optionally some of its Event Providers
+to both single-node and multi-node Kubernetes clusters.
# Table of Contents
@@ -42,9 +50,9 @@ multi-node Kubernetes clusters.
platform that automates the deployment, scaling, and management of
containerized applications. [Helm](https://helm.sh/) is a package
manager for Kubernetes that simplifies the management of Kubernetes
-applications. You do not need to be an expert on either Kubernetes or
+applications. You do not need to have detailed knowledge of either Kubernetes
or
Helm to use this project, but you may find it useful to review their
-overview documentation at the links above to become familiar with
+basic documentation at the links above to become familiar with
their key concepts and terminology.
## Kubernetes
@@ -101,7 +109,7 @@ We would welcome contributions of documentation for Azure
(AKS) and any other pu
[Helm](https://github.com/kubernetes/helm) is a tool to simplify the
deployment and management of applications on Kubernetes clusters. Helm
consists of the `helm` command line tool that you install on your
-development machine and the `tiller` runtime that you install on your
+development machine and the `tiller` runtime that is deployed on your
Kubernetes cluster.
For detailed instructions on installing Helm, see these
[instructions](docs/helm.md).
@@ -135,6 +143,16 @@ deploy.
4. [Configure the `wsk` CLI](#configure-the-wsk-cli). You need to
tell the `wsk` CLI how to connect to your OpenWhisk deployment.
+Although you are deploying OpenWhisk to Kubernetes, by default the
+executing actions will not be aware they are running on a Kubernetes
+cluster. In particular, they will not be configured to do DNS resolution
+of Kubernetes services. However, if you want executing actions to
+easily access services in a Kubernetes-native way, you can configure
+your OpenWhisk deployment to enable that by either using the
+[KubernetesContainerFactory](docs/configurationChoices.md#invoker-container-factory)
+or setting the value of `invoker.DNS` when you create the `mycluster.yaml`
+to customize your deployment.
+
## Initial setup
Indicate the Kubernetes worker nodes that should be used to execute
