You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@openwhisk.apache.org by GitBox <gi...@apache.org> on 2020/04/14 15:18:16 UTC
[GitHub] [openwhisk] rabbah opened a new pull request #4880: Replace compose
with quick-start.
rabbah opened a new pull request #4880: Replace compose with quick-start.
URL: https://github.com/apache/openwhisk/pull/4880
We've discussed in the past using the standalone controller as the new quick start. This morning I was trying to help someone in the community slack and I had trouble bringing up the compose version of the quick start. Plus it took many minutes to pull all the docker images. By contrast standalone is much lighter weight.
This is an attempt to replace compose with standalone controller in the welcome docs.
cc @chetanmeh @sciabarra I know we can do even better with the docker self container version. If you can point me to those steps, I can include them.
## Description
<!--- Provide a detailed description of your changes. -->
<!--- Include details of what problem you are solving and how your changes are tested. -->
## Related issue and scope
<!--- Please include a link to a related issue if there is one. -->
- [ ] I opened an issue to propose and discuss this change (#????)
## My changes affect the following components
<!--- Select below all system components are affected by your change. -->
<!--- Enter an `x` in all applicable boxes. -->
- [ ] API
- [ ] Controller
- [ ] Message Bus (e.g., Kafka)
- [ ] Loadbalancer
- [ ] Invoker
- [ ] Intrinsic actions (e.g., sequences, conductors)
- [ ] Data stores (e.g., CouchDB)
- [ ] Tests
- [ ] Deployment
- [ ] CLI
- [ ] General tooling
- [ ] Documentation
## Types of changes
<!--- What types of changes does your code introduce? Use `x` in all the boxes that apply: -->
- [ ] Bug fix (generally a non-breaking change which closes an issue).
- [ ] Enhancement or new feature (adds new functionality).
- [ ] Breaking change (a bug fix or enhancement which changes existing behavior).
## Checklist:
<!--- Please review the points below which help you make sure you've covered all aspects of the change you're making. -->
- [ ] I signed an [Apache CLA](https://github.com/apache/openwhisk/blob/master/CONTRIBUTING.md).
- [ ] I reviewed the [style guides](https://github.com/apache/openwhisk/wiki/Contributing:-Git-guidelines#code-readiness) and followed the recommendations (Travis CI will check :).
- [ ] I added tests to cover my changes.
- [ ] My changes require further changes to the documentation.
- [ ] I updated the documentation where necessary.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] rabbah commented on a change in pull request #4880:
Replace compose with quick-start standalone OpenWhisk.
Posted by GitBox <gi...@apache.org>.
rabbah commented on a change in pull request #4880: Replace compose with quick-start standalone OpenWhisk.
URL: https://github.com/apache/openwhisk/pull/4880#discussion_r408978372
##########
File path: README.md
##########
@@ -25,46 +25,68 @@
[](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". This is a full-featured OpenWhisk stack running as a Java
+process for convenience. Serverless functions run within Docker containers.
+- Pre-requesites:
+ - [Docker](https://docs.docker.com/install)
+ - [Java](https://java.com/en/download/help/download_options.xml)
+ - [Node.js](https://nodejs.org)
-### 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.
+```
+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,
+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 the Standalone Controller 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.
+- The Standalone Controller 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 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).
Review comment:
thanks.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] rabbah commented on issue #4880: Replace compose with
quick-start standalone OpenWhisk.
Posted by GitBox <gi...@apache.org>.
rabbah commented on issue #4880: Replace compose with quick-start standalone OpenWhisk.
URL: https://github.com/apache/openwhisk/pull/4880#issuecomment-614076526
Thanks for all the feedback. Will merge when Travis approves.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] rabbah commented on a change in pull request #4880:
Replace compose with quick-start standalone OpenWhisk.
Posted by GitBox <gi...@apache.org>.
rabbah commented on a change in pull request #4880: Replace compose with quick-start standalone OpenWhisk.
URL: https://github.com/apache/openwhisk/pull/4880#discussion_r408883112
##########
File path: README.md
##########
@@ -25,46 +25,68 @@
[](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". This is a full-featured OpenWhisk stack running as a Java
+process for convenience. Serverless functions run within Docker containers.
+- Pre-requesites:
+ - [Docker](https://docs.docker.com/install)
+ - [Java](https://java.com/en/download/help/download_options.xml)
+ - [Node.js](https://nodejs.org)
-### 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.
+```
+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,
+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 the Standalone Controller 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.
+- The Standalone Controller 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 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).
Review comment:
@dgrove-oss can you take another look at this paragraph?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] rabbah commented on a change in pull request #4880:
Replace compose with quick-start.
Posted by GitBox <gi...@apache.org>.
rabbah commented on a change in pull request #4880: Replace compose with quick-start.
URL: https://github.com/apache/openwhisk/pull/4880#discussion_r408811487
##########
File path: README.md
##########
@@ -25,46 +25,62 @@
[](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 Controller". This is a full-featured OpenWhisk stack running as a Java
+process for convenience. Serverless functions run within Docker containers.
+Please refer to [Docker's installation instructions](https://docs.docker.com/install/) to configure your system to use Docker.
-### 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.
+```
+git clone https://github.com/apache/openwhisk.git
Review comment:
I will add Node and Java are also required. Agree on the jar, we need to push toward the release.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] rabbah merged pull request #4880: Replace compose with
quick-start standalone OpenWhisk.
Posted by GitBox <gi...@apache.org>.
rabbah merged pull request #4880: Replace compose with quick-start standalone OpenWhisk.
URL: https://github.com/apache/openwhisk/pull/4880
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] rabbah commented on a change in pull request #4880:
Replace compose with quick-start.
Posted by GitBox <gi...@apache.org>.
rabbah commented on a change in pull request #4880: Replace compose with quick-start.
URL: https://github.com/apache/openwhisk/pull/4880#discussion_r408811031
##########
File path: README.md
##########
@@ -25,46 +25,62 @@
[](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 Controller". This is a full-featured OpenWhisk stack running as a Java
Review comment:
Excellent point!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] chetanmeh commented on a change in pull request #4880:
Replace compose with quick-start.
Posted by GitBox <gi...@apache.org>.
chetanmeh commented on a change in pull request #4880: Replace compose with quick-start.
URL: https://github.com/apache/openwhisk/pull/4880#discussion_r408670482
##########
File path: README.md
##########
@@ -25,46 +25,62 @@
[](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 Controller". This is a full-featured OpenWhisk stack running as a Java
+process for convenience. Serverless functions run within Docker containers.
+Please refer to [Docker's installation instructions](https://docs.docker.com/install/) to configure your system to use Docker.
-### 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.
+```
+git clone https://github.com/apache/openwhisk.git
Review comment:
Currently I think build may fail if node is not installed. Should we highlight that node and java are needed. Also not sure if build works fine on Windows
Best would have been to have users download a prebuilt jar but for that I think we need to wait for the core repo release.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] rabbah commented on a change in pull request #4880:
Replace compose with quick-start standalone OpenWhisk.
Posted by GitBox <gi...@apache.org>.
rabbah commented on a change in pull request #4880: Replace compose with quick-start standalone OpenWhisk.
URL: https://github.com/apache/openwhisk/pull/4880#discussion_r408978942
##########
File path: README.md
##########
@@ -25,46 +25,67 @@
[](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 cluster you manage yourself.
Review comment:
```suggestion
(e.g., AKS, EKS, IKS, GKE), or a cluster you manage yourself.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] chetanmeh commented on a change in pull request #4880:
Replace compose with quick-start.
Posted by GitBox <gi...@apache.org>.
chetanmeh commented on a change in pull request #4880: Replace compose with quick-start.
URL: https://github.com/apache/openwhisk/pull/4880#discussion_r408671929
##########
File path: README.md
##########
@@ -25,46 +25,62 @@
[](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 Controller". This is a full-featured OpenWhisk stack running as a Java
+process for convenience. Serverless functions run within Docker containers.
+Please refer to [Docker's installation instructions](https://docs.docker.com/install/) to configure your system to use Docker.
-### 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.
+```
+git clone https://github.com/apache/openwhisk.git
+cd openwhisk
+./gradlew core:standalone:bootRun
+```
+- When the standalone controller is up, it will open your browser to a functions Playground,
+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 the Standalone Controller 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.
+- The Standalone Controller can be configured to deploy additional capabilities when that is desirable.
+Additional resources are available [here](./core/standalone/README.md).
-### Kubernetes Setup
+### Deploy to Kubernetes
-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,
+Another path to quickly starting to use OpenWhisk is to install it on a Kubernetes cluster.
Review comment:
```
- Another path to quickly starting to use OpenWhisk
+ Another path to quickly start using OpenWhisk
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] codecov-io commented on issue #4880: Replace compose
with quick-start standalone OpenWhisk.
Posted by GitBox <gi...@apache.org>.
codecov-io commented on issue #4880: Replace compose with quick-start standalone OpenWhisk.
URL: https://github.com/apache/openwhisk/pull/4880#issuecomment-614238413
# [Codecov](https://codecov.io/gh/apache/openwhisk/pull/4880?src=pr&el=h1) Report
> Merging [#4880](https://codecov.io/gh/apache/openwhisk/pull/4880?src=pr&el=desc) into [master](https://codecov.io/gh/apache/openwhisk/commit/6928a1d3b1ef83491b567db51b07bf1e429d53a1&el=desc) will **decrease** coverage by `6.32%`.
> The diff coverage is `n/a`.
[](https://codecov.io/gh/apache/openwhisk/pull/4880?src=pr&el=tree)
```diff
@@ Coverage Diff @@
## master #4880 +/- ##
==========================================
- Coverage 83.36% 77.03% -6.33%
==========================================
Files 200 200
Lines 9304 9306 +2
Branches 401 384 -17
==========================================
- Hits 7756 7169 -587
- Misses 1548 2137 +589
```
| [Impacted Files](https://codecov.io/gh/apache/openwhisk/pull/4880?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [...core/database/cosmosdb/RxObservableImplicits.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29tbW9uL3NjYWxhL3NyYy9tYWluL3NjYWxhL29yZy9hcGFjaGUvb3BlbndoaXNrL2NvcmUvZGF0YWJhc2UvY29zbW9zZGIvUnhPYnNlcnZhYmxlSW1wbGljaXRzLnNjYWxh) | `0.00% <0.00%> (-100.00%)` | :arrow_down: |
| [...ore/database/cosmosdb/cache/CacheInvalidator.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29yZS9jb3Ntb3NkYi9jYWNoZS1pbnZhbGlkYXRvci9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL29wZW53aGlzay9jb3JlL2RhdGFiYXNlL2Nvc21vc2RiL2NhY2hlL0NhY2hlSW52YWxpZGF0b3Iuc2NhbGE=) | `0.00% <0.00%> (-100.00%)` | :arrow_down: |
| [...e/database/cosmosdb/cache/ChangeFeedConsumer.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29yZS9jb3Ntb3NkYi9jYWNoZS1pbnZhbGlkYXRvci9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL29wZW53aGlzay9jb3JlL2RhdGFiYXNlL2Nvc21vc2RiL2NhY2hlL0NoYW5nZUZlZWRDb25zdW1lci5zY2FsYQ==) | `0.00% <0.00%> (-100.00%)` | :arrow_down: |
| [...core/database/cosmosdb/CosmosDBArtifactStore.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29tbW9uL3NjYWxhL3NyYy9tYWluL3NjYWxhL29yZy9hcGFjaGUvb3BlbndoaXNrL2NvcmUvZGF0YWJhc2UvY29zbW9zZGIvQ29zbW9zREJBcnRpZmFjdFN0b3JlLnNjYWxh) | `0.00% <0.00%> (-96.23%)` | :arrow_down: |
| [...sk/core/database/cosmosdb/CosmosDBViewMapper.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29tbW9uL3NjYWxhL3NyYy9tYWluL3NjYWxhL29yZy9hcGFjaGUvb3BlbndoaXNrL2NvcmUvZGF0YWJhc2UvY29zbW9zZGIvQ29zbW9zREJWaWV3TWFwcGVyLnNjYWxh) | `0.00% <0.00%> (-93.90%)` | :arrow_down: |
| [...tabase/cosmosdb/cache/CacheInvalidatorConfig.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29yZS9jb3Ntb3NkYi9jYWNoZS1pbnZhbGlkYXRvci9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL29wZW53aGlzay9jb3JlL2RhdGFiYXNlL2Nvc21vc2RiL2NhY2hlL0NhY2hlSW52YWxpZGF0b3JDb25maWcuc2NhbGE=) | `0.00% <0.00%> (-92.31%)` | :arrow_down: |
| [...enwhisk/connector/kafka/KamonMetricsReporter.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29tbW9uL3NjYWxhL3NyYy9tYWluL3NjYWxhL29yZy9hcGFjaGUvb3BlbndoaXNrL2Nvbm5lY3Rvci9rYWZrYS9LYW1vbk1ldHJpY3NSZXBvcnRlci5zY2FsYQ==) | `0.00% <0.00%> (-83.34%)` | :arrow_down: |
| [...e/database/cosmosdb/cache/KafkaEventProducer.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29yZS9jb3Ntb3NkYi9jYWNoZS1pbnZhbGlkYXRvci9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL29wZW53aGlzay9jb3JlL2RhdGFiYXNlL2Nvc21vc2RiL2NhY2hlL0thZmthRXZlbnRQcm9kdWNlci5zY2FsYQ==) | `0.00% <0.00%> (-77.78%)` | :arrow_down: |
| [...whisk/core/database/cosmosdb/CosmosDBSupport.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29tbW9uL3NjYWxhL3NyYy9tYWluL3NjYWxhL29yZy9hcGFjaGUvb3BlbndoaXNrL2NvcmUvZGF0YWJhc2UvY29zbW9zZGIvQ29zbW9zREJTdXBwb3J0LnNjYWxh) | `0.00% <0.00%> (-74.08%)` | :arrow_down: |
| [...abase/cosmosdb/CosmosDBArtifactStoreProvider.scala](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree#diff-Y29tbW9uL3NjYWxhL3NyYy9tYWluL3NjYWxhL29yZy9hcGFjaGUvb3BlbndoaXNrL2NvcmUvZGF0YWJhc2UvY29zbW9zZGIvQ29zbW9zREJBcnRpZmFjdFN0b3JlUHJvdmlkZXIuc2NhbGE=) | `7.69% <0.00%> (-50.00%)` | :arrow_down: |
| ... and [14 more](https://codecov.io/gh/apache/openwhisk/pull/4880/diff?src=pr&el=tree-more) | |
------
[Continue to review full report at Codecov](https://codecov.io/gh/apache/openwhisk/pull/4880?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/apache/openwhisk/pull/4880?src=pr&el=footer). Last update [6928a1d...a7ffd41](https://codecov.io/gh/apache/openwhisk/pull/4880?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] chetanmeh commented on a change in pull request #4880:
Replace compose with quick-start.
Posted by GitBox <gi...@apache.org>.
chetanmeh commented on a change in pull request #4880: Replace compose with quick-start.
URL: https://github.com/apache/openwhisk/pull/4880#discussion_r408669290
##########
File path: README.md
##########
@@ -25,46 +25,62 @@
[](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 Controller". This is a full-featured OpenWhisk stack running as a Java
Review comment:
Should we call it `Standalone Controller` or `Standalone OpenWhisk`? Referring to it as controller may confuse users to assume a limited feature set
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] dgrove-oss commented on a change in pull request #4880:
Replace compose with quick-start standalone OpenWhisk.
Posted by GitBox <gi...@apache.org>.
dgrove-oss commented on a change in pull request #4880: Replace compose with quick-start standalone OpenWhisk.
URL: https://github.com/apache/openwhisk/pull/4880#discussion_r408886335
##########
File path: README.md
##########
@@ -25,46 +25,68 @@
[](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". This is a full-featured OpenWhisk stack running as a Java
+process for convenience. Serverless functions run within Docker containers.
+- Pre-requesites:
+ - [Docker](https://docs.docker.com/install)
+ - [Java](https://java.com/en/download/help/download_options.xml)
+ - [Node.js](https://nodejs.org)
-### 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.
+```
+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,
+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 the Standalone Controller 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.
+- The Standalone Controller 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 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).
Review comment:
Looks good. Agree it makes more sense to lead with a managed cluster; that's the easy path for many users.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] rabbah commented on issue #4880: Replace compose with
quick-start.
Posted by GitBox <gi...@apache.org>.
rabbah commented on issue #4880: Replace compose with quick-start.
URL: https://github.com/apache/openwhisk/pull/4880#issuecomment-614015559
Thanks Dave, Dominic and Chetan. Will incorporate the feedback today.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services