You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openwhisk.apache.org by ra...@apache.org on 2020/04/18 20:27:12 UTC
[openwhisk] branch master updated: Replace compose with quick-start
standalone OpenWhisk. (#4880)
This is an automated email from the ASF dual-hosted git repository.
rabbah pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk.git
The following commit(s) were added to refs/heads/master by this push:
new d9e908c Replace compose with quick-start standalone OpenWhisk. (#4880)
d9e908c is described below
commit d9e908cce62c2d6e9f34e0295c53736be496c195
Author: rodric rabbah <ro...@gmail.com>
AuthorDate: Sat Apr 18 16:27:01 2020 -0400
Replace compose with quick-start standalone OpenWhisk. (#4880)
---
README.md | 83 +++++++++++++++++++++++++++++++++++++++------------------------
1 file changed, 51 insertions(+), 32 deletions(-)
diff --git a/README.md b/README.md
index 5413920..eac5e0b 100644
--- a/README.md
+++ b/README.md
@@ -25,30 +25,59 @@
[](https://codecov.io/gh/apache/openwhisk)
[](https://twitter.com/intent/follow?screen_name=openwhisk)
-OpenWhisk is a cloud-first distributed event-based programming service. It provides a programming model to upload event handlers to a cloud service, and register the handlers to respond to various events. Learn more at [http://openwhisk.apache.org](http://openwhisk.apache.org).
+OpenWhisk is a serverless functions platform for building cloud applications.
+OpenWhisk offers a rich programming model for creating serverless APIs from functions,
+composing functions into serverless workflows, and connecting events to functions using rules and triggers.
+Learn more at [http://openwhisk.apache.org](http://openwhisk.apache.org).
+
+* [Quick Start](#quick-start) (Deploy and Use OpenWhisk on your machine)
+* [Deploy to Kubernetes](#deploy-to-kubernetes) (For development and production)
+* For project contributors and Docker deployments:
+ * [Deploy to Docker for Mac](./tools/macos/README.md)
+ * [Deploy to Docker for Ubuntu](./tools/ubuntu-setup/README.md)
+* [Learn Concepts and Commands](#learn-concepts-and-commands)
+* [OpenWhisk Community and Support](#openwhisk-community-and-support)
+* [Project Repository Structure](#project-repository-structure)
+### Quick Start
-* [Quick Start](#quick-start) (Docker-Compose)
-* [Native development](#native-development) (Mac and Ubuntu)
-* [Kubernetes](#kubernetes-setup)
-* [Learn concepts and commands](#learn-concepts-and-commands)
-* [Issues](#issues)
-* [Slack](#slack)
+The easiest way to start using OpenWhisk is to install the "Standalone" OpenWhisk stack.
+This is a full-featured OpenWhisk stack running as a Java process for convenience.
+Serverless functions run within Docker containers. You will need [Docker](https://docs.docker.com/install),
+[Java](https://java.com/en/download/help/download_options.xml) and [Node.js](https://nodejs.org) available on your machine.
-### Quick Start
-The easiest way to start using OpenWhisk is to get Docker installed on Mac, Windows or Linux. The [Docker website](https://docs.docker.com/install/) has detailed 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.
+To get started:
+```
+git clone https://github.com/apache/openwhisk.git
+cd openwhisk
+./gradlew core:standalone:bootRun
+```
+- When the OpenWhisk stack is up, it will open your browser to a functions [Playground](./docs/images/playground-ui.png),
+typically served from http://localhost:3232. The Playground allows you create and run functions directly from your browser.
+
+- To make use of all OpenWhisk features, you will need the OpenWhisk command line tool called
+`wsk` which you can download from https://s.apache.org/openwhisk-cli-download.
+Please refer to the [CLI configuration](./docs/cli.md) for additional details. Typically you
+configure the CLI for Standalone OpenWhisk as follows:
```
-git clone https://github.com/apache/openwhisk-devtools.git
-cd openwhisk-devtools/docker-compose
-make quick-start
+wsk property set \
+ --apihost 'http://localhost:3233' \
+ --auth '23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP'
```
-For more detailed instructions or if you encounter problems see the [OpenWhisk-dev tools](https://github.com/apache/openwhisk-devtools/blob/master/docker-compose/README.md) project.
+- Standalone OpenWhisk can be configured to deploy additional capabilities when that is desirable.
+Additional resources are available [here](./core/standalone/README.md).
+
+### Deploy to Kubernetes
-### Kubernetes Setup
+OpenWhisk can also be installed on a Kubernetes cluster. You can use
+a managed Kubernetes cluster provisioned from a public cloud provider
+(e.g., AKS, EKS, IKS, GKE), or a cluster you manage yourself.
+Additionally for local development, OpenWhisk is compatible with Minikube,
+and Kubernetes for Mac using the support built into Docker 18.06 (or higher).
-Another path to quickly starting to use OpenWhisk is to install it on a Kubernetes cluster. On a Mac, you can use the Kubernetes support built into Docker 18.06 (or higher). You can also deploy OpenWhisk on Minikube, on a managed Kubernetes cluster provisioned from a public cloud provider, or on a Kubernetes cluster you manage yourself. To get started,
+To get started:
```
git clone https://github.com/apache/openwhisk-deploy-kube.git
@@ -56,15 +85,7 @@ git clone https://github.com/apache/openwhisk-deploy-kube.git
Then follow the instructions in the [OpenWhisk on Kubernetes README.md](https://github.com/apache/openwhisk-deploy-kube/blob/master/README.md).
-### Native development
-
-Docker must be natively installed in order to build and deploy OpenWhisk.
-If you plan to make contributions to OpenWhisk, we recommend either a Mac or Ubuntu environment.
-
-* [Setup Mac for OpenWhisk](tools/macos/README.md)
-* [Setup Ubuntu for OpenWhisk](tools/ubuntu-setup/README.md)
-
-### Learn concepts and commands
+### Learn Concepts and Commands
Browse the [documentation](docs/) to learn more. Here are some topics you may be
interested in:
@@ -79,16 +100,14 @@ interested in:
- [Implementing feeds](docs/feeds.md)
- [Developing a runtime for a new language](docs/actions-actionloop.md)
-### Repository Structure
-
-The OpenWhisk system is built from a [number of components](docs/dev/modules.md). The picture below groups the components by their GitHub repos. Please open issues for a component against the appropriate repo (if in doubt just open against the main openwhisk repo).
+### OpenWhisk Community and Support
-
+Report bugs, ask questions and request features [here on GitHub](../../issues).
-### Issues
+You can also join the OpenWhisk Team on Slack [https://openwhisk-team.slack.com](https://openwhisk-team.slack.com) and chat with developers. To get access to our public Slack team, request an invite [https://openwhisk.apache.org/slack.html](https://openwhisk.apache.org/slack.html).
-Report bugs, ask questions and request features [here on GitHub](../../issues).
+### Project Repository Structure
-### Slack
+The OpenWhisk system is built from a [number of components](docs/dev/modules.md). The picture below groups the components by their GitHub repos. Please open issues for a component against the appropriate repo (if in doubt just open against the main openwhisk repo).
-You can also join the OpenWhisk Team on Slack [https://openwhisk-team.slack.com](https://openwhisk-team.slack.com) and chat with developers. To get access to our public slack team, request an invite [https://openwhisk.apache.org/slack.html](https://openwhisk.apache.org/slack.html).
+