Openwhisk in a standalone runnable jar #4516

chetanmeh · 2019-06-18T13:17:07Z

Enables running a minimal OpenWhisk (with in memory store) as a runnable jar outside of docker

Description

Currently users looking to explore OpenWhisk directly have few options like devtools docker compose, mini kube etc. This PR provides yet another option which enables launching a fully working OpenWhisk server via a runnable jar

java -jar openwhisk-standalone-1.0.0-SNAPSHOT.jar

This launches a fully functional OpenWhisk controller and invoker. You can run wsk commands against it and launch and execute actions etc.

To try it out currently you can download a pre built jar from here

Design

This PR builds up on lean openwhisk support. It configures OpenWhisk to use a MemoryArtifactStore (thus avoiding nead of a separate CouchDB container) and enables executing the standard wsk commands against it

Usage

First build the standalone module

./gradlew :core:standalone:build

In future

wget maven/openwhisk.jar

Launch the server

$ java -jar openwhisk-standalone-1.0.0-SNAPSHOT.jar -h
OpenWhisk standalone launcher
  -c, --config-file  <arg>   application.conf which overwrites the default
                             whisk.conf
  -m, --manifest  <arg>      Manifest json defining the supported runtimes
  -p, --port  <arg>          Server port
  -h, --help                 Show help message
$ java -jar openwhisk-standalone-1.0.0-SNAPSHOT.jar

When to use

This mode may be benefical in cases like

Running simple test against an OpenWhisk server say when testing compositions
Faster development cycle - No need to build and relaunch docker container to test out simple changes in regular development flow on OpenWhisk core codebase
Easier entrypoint for new users to get a feel of OpenWhisk features

Related issue and scope

I opened an issue to propose and discuss this change (#????)

My changes affect the following components

Types of changes

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:

I signed an Apache CLA.
I reviewed the style guides 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.

Refactor Controller such that actor system can be passed from outside

This ensures that standalone jar gets created as main artifact

chetanmeh · 2019-06-18T13:25:51Z

This is an initial version to seek feedback on approach. Based on feedback we can decide what all aspects to support with this approach

rabbah · 2019-06-18T13:33:13Z

cool!

bdelacretaz · 2019-06-19T10:06:47Z

Big +1 to this, great work! I do have a use case where we want to simulate OpenWhisk for local development of actions, looks like this would help a lot.

This is required for test run to avoid launched server influenced by whisk.properties generated for the tests

rabbah

LGTM! this is awesome.

rabbah · 2019-06-20T11:33:06Z

common/scala/src/main/scala/org/apache/openwhisk/core/database/memory/MemoryArtifactStore.scala

@@ -285,8 +296,10 @@ class MemoryArtifactStore[DocumentAbstraction <: DocumentSerializer](dbName: Str
  }

  override def shutdown(): Unit = {
-    artifacts.clear()
-    attachmentStore.shutdown()
+    if (!ignoreShutdown) {


worth commenting this - i dont understand why it would be necessary at face value.

rabbah · 2019-06-20T11:34:24Z

Can we add a test for this in Jenkins? Like with lean - stand it up, create/run/delete a single action as a sniff test.

This avoid superfluous log message about false inits

chetanmeh · 2019-06-21T05:07:38Z

There are still some pending issues like getting log collection to work on Mac. For now implementing an approach which uses docker logs command to fetch logs.

With that change the system test pass percentage improved

108 tests completed, 14 failed

chetanmeh · 2019-06-21T05:08:51Z

Can we add a test for this in Jenkins? Like with lean - stand it up, create/run/delete a single action as a sniff test.

Yeah working on that. Its bit tricky to get it working in tests project as it needs some different default global config. For now only 14 out of 108 system tests fail

MemoryArtifactStore would always return same instance for same db name

Also ensure that a system property is only set if no existing value found. This ensures that in special case user can still supercede the value being set via explicitly providing a system property override

rabbah · 2019-06-25T15:03:00Z

core/standalone/README.md

+$ ./gradlew :core:standalone:build
+```
+
+This would create the runnable jar in `core/standalone/build/libs/` directory


maybe gradle ...:run to then start the built jar?

Good point. Now you run the jar directly via $ ./gradlew :core:standalone:bootRun

chetanmeh · 2019-06-25T15:21:24Z

if the runtimes file is missing, you get a stack trace instead of a nice error

Now it would show an error message like below

[openwhisk] Error: Validation failure for 'manifest' option parameters: /path/to/non-existing.json

chetanmeh · 2019-06-25T15:26:04Z

Two suggestions: when startup detects that wsk is not configured properly, it will emit an ERROR which I think should be a WARN instead. I would also emit the wsk property set ... command as part of the same line if possible and color the whole text so it's easier to spot. It's easy to miss with text scrolling by.

Now it marks it as warning

…nerally named `whisk/` no pull would be done

chetanmeh · 2019-06-25T15:30:19Z

i think the docker pull logic is too eager - it doesn't permit the use of local images that aren't on dockerhub

Fixed that now by ensuring that eager pull is only done for openwhisk/xxx images

chetanmeh · 2019-06-25T15:48:23Z

i would also like to add a wskdev target for standalone.

Added wskdev standalone target now which directly launches the standalone jar via gradle

…jar to bin directory

…test runs

…n timeout failure

...nvoker/src/main/scala/org/apache/openwhisk/core/containerpool/docker/DockerCliLogStore.scala

A standalone controller, using the lean load balancer and an in memory store. * Use WhiskerControl port 3233 as default! * Allow disabling read of whisk.properties, required for test run to avoid launched server influenced by whisk.properties generated for the tests. Also ensure that a system property is only set if no existing value found. This ensures that in special case user can still supersede the value being set via explicitly providing a system property override. * Ensure that MemoryStore is only created when needed * Fetch logs via `docker logs` command on Mac * Add a OpenWhisk colored banner * Package the default runtimes.json * Include log timestamps and filter till sentinel * Use host.docker.internal as api host for Mac and Windows * Enable colored logging * Add support for --verbose flag to enable debug logging easily * Color transactionId and source also. Also support disabling color logging if needed * Expose extension point for format log message * Api host name is defined via system property * Add a set of pre flight checks to confirm if OpenWhisk can run properly on this host * Also check if docker is running * New StandaloneDockerContainerFactory which adapts as per OS * Only do pull for images having `openwhisk` prefix. For local image generally named `whisk/` no pull would be done * Add ./gradlew :core:standalone:bootRun command to run jar directly. Use Spring boot default bootRun target to run the jar. Also copy the jar to bin directory. * Make test run against standalone server * Support disabling pull of standard images all together. Required for test runs * Disable pause/resume support for non linux setups * Print the wsk and docker cli version * Update README with details on how to connect to db * Increase time allowed for server to start to 30 secs and log logs upon timeout failure * Enable verifySystemShutdown in Mesos tests

chetanmeh added 10 commits June 18, 2019 13:36

Initial setup for standalone OpenWhisk

fb10ca5

Enable lean providers

74538d9

Add support for setting whisk properties from typesafe config

9f3acbb

Add support for configuring manifest

d58c5f1

Make MemoryArtifactStore work in singleton mode

bcd48ba

Allow bootstrapping default set of users

e543afa

Refactor Controller such that actor system can be passed from outside

Allow configuring server port

19e2c5e

Disable jar target

59e1191

This ensures that standalone jar gets created as main artifact

Make OS specific setting programatic

e4574eb

Enable prometheus metrics by default

0237e54

Fix the description

4716ac9

chetanmeh added 2 commits June 20, 2019 12:10

Use WhiskerControl port 3233 as default!

5d11c5d

Allow disabling read of whisk.properties

13930eb

This is required for test run to avoid launched server influenced by whisk.properties generated for the tests

rabbah added controller enhancement review Review for this PR has been requested and yet needs to be done. labels Jun 20, 2019

rabbah approved these changes Jun 20, 2019

View reviewed changes

chetanmeh added 2 commits June 20, 2019 18:19

Ensure that MemoryStore is only created when needed

03170d0

This avoid superfluous log message about false inits

Fetch logs via docker logs command on Mac

bf6b25f

chetanmeh added 5 commits June 21, 2019 11:00

Revert config support for MemoryArtifactStore for now

f988f45

MemoryArtifactStore would always return same instance for same db name

Rename the main class

eb4eced

Also ensure that a system property is only set if no existing value found. This ensures that in special case user can still supercede the value being set via explicitly providing a system property override

Add a OpenWhisk cool banner

dae96cb

Remove dependency on other uncomiited changes

c7b72b2

Extract the cli based log store as a generic impl for all OS

32fdfde

rabbah reviewed Jun 25, 2019

View reviewed changes

chetanmeh added 2 commits June 25, 2019 20:37

Use warn for misconfigured wsk

f4c07bc

Validate the files passed as argument to check if it exists

5527f0e

Only do pull for images having openwhisk prefix. For local image ge…

26532c4

…nerally named `whisk/` no pull would be done

chetanmeh added 3 commits June 25, 2019 21:09

Add ./gradlew :core:standalone:run command to run jar directly

0d2ca2a

Update the readme

fd292cd

Add standalone target

31c4137

chetanmeh added 11 commits June 26, 2019 10:25

Use Spring boot default bootRun target to run the jar. Also copy the …

31f0881

…jar to bin directory

Make test run against standalone server

b3784c6

Support disabling pull of standard images all together. Required for …

6f09fc0

…test runs

Disable pause/resume support for non linux setups

f3d57a3

Pass on standalone jar path to test

828c90c

Disable launching the server if preexisting server provided

6ae5f58

Print the wsk and docker cli version

f368bfd

Update README with details on how to connect to db

add1fab

Build standalone as part of docker dist so as to be used in test

0fda29a

Increase time allowed for server to start to 30 secs and log logs upo…

a65b528

…n timeout failure

Enable verifySystemShutdown in Mesos tests

5b99c6e

rabbah reviewed Jun 26, 2019

View reviewed changes

...nvoker/src/main/scala/org/apache/openwhisk/core/containerpool/docker/DockerCliLogStore.scala Show resolved Hide resolved

rabbah merged commit 2f0155f into apache:master Jun 26, 2019

chetanmeh mentioned this pull request Jun 28, 2019

Publish OpenWhisk standalone jar to Github release #4525

Open

chetanmeh deleted the openwhisk-standalone branch July 3, 2019 04:35

chetanmeh mentioned this pull request Jul 26, 2019

Api Gateway support in OpenWhisk Standalone mode #4571

Merged

21 tasks

alexkli mentioned this pull request Aug 5, 2019

Various small fixes for running with openwhisk-standalone adobe/wskdebug#5

Closed

chetanmeh mentioned this pull request Aug 28, 2019

CouchDB support in OpenWhisk Standalone mode #4594

Merged

21 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Openwhisk in a standalone runnable jar #4516

Openwhisk in a standalone runnable jar #4516

chetanmeh commented Jun 18, 2019 •

edited

Loading

chetanmeh commented Jun 18, 2019

rabbah commented Jun 18, 2019

bdelacretaz commented Jun 19, 2019

rabbah left a comment

rabbah Jun 20, 2019

rabbah commented Jun 20, 2019 •

edited

Loading

chetanmeh commented Jun 21, 2019

chetanmeh commented Jun 21, 2019

rabbah Jun 25, 2019

chetanmeh Jun 25, 2019 •

edited

Loading

chetanmeh commented Jun 25, 2019

chetanmeh commented Jun 25, 2019

chetanmeh commented Jun 25, 2019

chetanmeh commented Jun 25, 2019

Openwhisk in a standalone runnable jar #4516

Openwhisk in a standalone runnable jar #4516

Conversation

chetanmeh commented Jun 18, 2019 • edited Loading

Description

Design

Usage

When to use

Related issue and scope

My changes affect the following components

Types of changes

Checklist:

chetanmeh commented Jun 18, 2019

rabbah commented Jun 18, 2019

bdelacretaz commented Jun 19, 2019

rabbah left a comment

Choose a reason for hiding this comment

rabbah Jun 20, 2019

Choose a reason for hiding this comment

rabbah commented Jun 20, 2019 • edited Loading

chetanmeh commented Jun 21, 2019

chetanmeh commented Jun 21, 2019

rabbah Jun 25, 2019

Choose a reason for hiding this comment

chetanmeh Jun 25, 2019 • edited Loading

Choose a reason for hiding this comment

chetanmeh commented Jun 25, 2019

chetanmeh commented Jun 25, 2019

chetanmeh commented Jun 25, 2019

chetanmeh commented Jun 25, 2019

chetanmeh commented Jun 18, 2019 •

edited

Loading

rabbah commented Jun 20, 2019 •

edited

Loading

chetanmeh Jun 25, 2019 •

edited

Loading