rabbah closed pull request #3729: Add brief Kubernetes Setup section to main README.md URL: https://github.com/apache/incubator-openwhisk/pull/3729
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/README.md b/README.md index 075a8bdd6c..7e8269af35 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,14 @@ OpenWhisk is a cloud-first distributed event-based programming service. It provi * [Quick Start](#quick-start) (Docker-Compose) * [Native development](#native-development) (Mac and Ubuntu) +* [Kubernetes](#kubernetes-setup) * [Vagrant](#vagrant-setup) * [Learn concepts and commands](#learn-concepts-and-commands) * [Issues](#issues) * [Slack](#slack) ### Quick Start -The easiest way to start using OpenWhisk is to get Docker installed on on Mac, Windows or Linux. The [Docker website](https://docs.docker.com/install/) has details instructions on getting the tools installed. This does not give you a prodcution deployment but gives you enough of the pieces to start writing functions and seeing them run. +The easiest way to start using OpenWhisk is to get Docker installed on on Mac, Windows or Linux. The [Docker website](https://docs.docker.com/install/) has details instructions on getting the tools installed. This does not give you a production deployment but gives you enough of the pieces to start writing functions and seeing them run. ``` git clone https://github.com/apache/incubator-openwhisk-devtools.git @@ -45,6 +46,15 @@ make quick-start For more detailed instructions or if you encounter problems see the [OpenWhisk-dev tools](https://github.com/apache/incubator-openwhisk-devtools/blob/master/docker-compose/README.md) project. +### Kubernetes Setup + +Another path to quickly starting to use OpenWhisk is to install it on a Kubernetes cluster. OpenWhisk can be installed on Minikube, on a managed Kubernetes cluster provisioned from a public cloud provider, or on a Kubernetes cluster you manage yourself. To get started, + +``` +git clone https://github.com/apache/incubator-openwhisk-deploy-kube.git +``` + +Then follow the instructions in the [OpenWhisk on Kubernetes README.md](https://github.com/apache/incubator-openwhisk-deploy-kube/blob/master/README.md). ### Vagrant Setup A [Vagrant](http://vagrantup.com) machine is also available to run OpenWhisk on Mac, Windows PC or GNU/Linux but isn't used by as much of the dev team so sometimes lags behind. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services