houshengbo closed pull request #3598: Update all .md and .sh files to pass scancode for compliance. URL: https://github.com/apache/incubator-openwhisk/pull/3598
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/CONTRIBUTING.md b/CONTRIBUTING.md index c29a74ea82..cb681fbb3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,21 @@ -[](http://www.apache.org/licenses/LICENSE-2.0) <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # --> +[](http://www.apache.org/licenses/LICENSE-2.0) # Contributing to Apache OpenWhisk @@ -36,18 +36,18 @@ Instructions on how to do this can be found here: [http://www.apache.org/licenses/#clas](http://www.apache.org/licenses/#clas) Once submitted, you will receive a confirmation email from the Apache Software Foundation (ASF) and be added to -the following list: http://people.apache.org/unlistedclas.html. +the following list: http://people.apache.org/unlistedclas.html. Project committers will use this list to verify pull requests (PRs) come from contributors that have signed a CLA. -We look forward to your contributions! +We look forward to your contributions! ## Raising issues -Please raise any bug reports or enhancement requests on the respective project repository's GitHub issue tracker. Be sure to search the +Please raise any bug reports or enhancement requests on the respective project repository's GitHub issue tracker. Be sure to search the list to see if your issue has already been raised. -A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong. +A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue. A good enhancement request comes with an explanation of what you are trying to do and how that enhancement would help you. diff --git a/README.md b/README.md index 9200988c8b..eaf36bbe81 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # diff --git a/actionRuntimes/actionProxy/README.md b/actionRuntimes/actionProxy/README.md index 5413382bae..88d0d65b29 100644 --- a/actionRuntimes/actionProxy/README.md +++ b/actionRuntimes/actionProxy/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # diff --git a/common/scala/copyJMXFiles.sh b/common/scala/copyJMXFiles.sh index 8c3175d27d..82b6fbb760 100644 --- a/common/scala/copyJMXFiles.sh +++ b/common/scala/copyJMXFiles.sh @@ -20,4 +20,4 @@ if [[ $( ls /conf/jmxremote.* 2> /dev/null ) ]] then mv /conf/jmxremote.* /root chmod 600 /root/jmxremote.* -fi \ No newline at end of file +fi diff --git a/common/scala/transformEnvironment.sh b/common/scala/transformEnvironment.sh index 005f0bd7d2..bb8ceed3a0 100755 --- a/common/scala/transformEnvironment.sh +++ b/common/scala/transformEnvironment.sh @@ -18,11 +18,11 @@ # # Transforms environment variables starting with `prefix` to kebab-cased JVM system properties -# +# # "_" becomes "." # "camelCased" becomes "camel-cased" # "PascalCased" stays "PascalCased" -> classnames stay untouched -# +# # Examples: # CONFIG_whisk_loadbalancer_invokerBusyThreshold -> -Dwhisk.loadbalancer.invoker-busy-threshold # CONFIG_akka_remote_netty_tcp_bindPort -> -Dakka.remote.netty.tcp.bind-port @@ -70,4 +70,4 @@ do fi done -echo "${props[@]}" \ No newline at end of file +echo "${props[@]}" diff --git a/docs/feeds.md b/docs/feeds.md index 50df1bbe41..029756e341 100644 --- a/docs/feeds.md +++ b/docs/feeds.md @@ -15,6 +15,7 @@ # specific language governing permissions and limitations under the License. # --> + # Implementing feeds OpenWhisk supports an open API, where any user can expose an event producer service as a **feed** in a **package**. This section describes architectural and implementation options for providing your own feed. @@ -44,7 +45,7 @@ an open repo --> # Difference between Feed and Trigger Feeds and triggers are closely related, -but technically distinct concepts. +but technically distinct concepts. - OpenWhisk processes **events** which flow into the system. @@ -71,7 +72,7 @@ then under the covers the system will do something equivalent to: `wsk action invoke mycloudant/changes -p lifecycleEvent CREATE -p triggerName T -p authKey <userAuthKey> -p password <password value from mycloudant binding> -p username <username value from mycloudant binding> -p dbName mytype` -The feed action named *changes* takes these parameters, and is expected to take whatever action is necessary to set up a stream of events from Cloudant, with the appropriate configuration, directed to the trigger *T*. +The feed action named *changes* takes these parameters, and is expected to take whatever action is necessary to set up a stream of events from Cloudant, with the appropriate configuration, directed to the trigger *T*. For the Cloudant *changes* feed, the action happens to talk directly to a *cloudant trigger* service we've implemented with a connection-based architecture. We'll discuss the other architectures below. @@ -119,4 +120,5 @@ The Cloudant *changes* feed is the canonical example -- it stands up a `cloudant The *alarm* feed is implemented with a similar pattern. -The connection-based architecture is the highest performance option, but imposes more overhead on operations compared to the polling and hook architectures. +The connection-based architecture is the highest performance option, but imposes more overhead on operations compared to the polling and hook architectures. + diff --git a/docs/images/README.md b/docs/images/README.md index 121147606d..5e1ca05344 100644 --- a/docs/images/README.md +++ b/docs/images/README.md @@ -15,5 +15,6 @@ # specific language governing permissions and limitations under the License. # --> -This folder contains approved OpenWhisk logo images bearing the Trademark (TM) symbol + +This folder contains approved OpenWhisk logo images bearing the Trademark (TM) symbol that indicates that the OpenWhisk project has filed to register the OpenWhisk logo. diff --git a/docs/mobile_sdk.md b/docs/mobile_sdk.md index 84e71eeb64..94bcdfc65f 100644 --- a/docs/mobile_sdk.md +++ b/docs/mobile_sdk.md @@ -79,7 +79,7 @@ Build the project for the targets that you need and add the resulting frameworks ## Installing the starter app example -You can use the OpenWhisk CLI to download example code that embeds the OpenWhisk SDK framework. +You can use the OpenWhisk CLI to download example code that embeds the OpenWhisk SDK framework. To install the starter app example, enter the following command: ``` diff --git a/docs/parameters.md b/docs/parameters.md index b411a3be34..5d81fd8d44 100644 --- a/docs/parameters.md +++ b/docs/parameters.md @@ -15,6 +15,7 @@ # specific language governing permissions and limitations under the License. # --> + # Working with parameters When working with serverless actions, data is supplied by adding parameters to the actions; these are in the parameter declared as an argument to the main serverless function. All data arrives this way and the values can be set in a few different ways. The first option is to supply parameters when an action or package is created (or updated). This approach is useful for data that stays the same on every execution, equivalent to environment variables on other platforms, or for default values that might be overridden at invocation time. The second option is to supply parameters when the action is invoked - and this approach will override any parameters already set. @@ -113,7 +114,7 @@ Rather than pass all the parameters to an action every time, you can bind certai ``` ```json - { + { "payload": "Hello, Dorothy from Washington, DC" } ``` diff --git a/docs/rest_api.md b/docs/rest_api.md index 370318d46c..8dd00ab39a 100644 --- a/docs/rest_api.md +++ b/docs/rest_api.md @@ -15,6 +15,7 @@ # specific language governing permissions and limitations under the License. # --> + # Using REST APIs with OpenWhisk After your OpenWhisk environment is enabled, you can use OpenWhisk with your web apps or mobile apps with REST API calls. @@ -134,7 +135,7 @@ To perform a blocking invocation on an action, send a HTTP request with a method ```bash curl -u $AUTH https://openwhisk.ng.bluemix.net/api/v1/namespaces/_/actions/hello?blocking=true \ -X POST -H "Content-Type: application/json" \ --d '{"name":"John"}' +-d '{"name":"John"}' ``` You get the following response: ```json @@ -258,7 +259,7 @@ To do the same with the REST API, lets create the trigger first ```bash curl -u $AUTH https://openwhisk.ng.bluemix.net/api/v1/namespaces/_/triggers/periodic?overwrite=true \ -X PUT -H "Content-Type: application/json" \ --d '{"name":"periodic","annotations":[{"key":"feed","value":"/whisk.system/alarms/alarm"}]}' +-d '{"name":"periodic","annotations":[{"key":"feed","value":"/whisk.system/alarms/alarm"}]}' ``` As you can see the annotation `feed` is stored in the trigger. Later we will use this annotation to know which feed action to use when deleting the trigger. @@ -276,7 +277,7 @@ Invoke the feed action to delete the trigger handler from the feed provider ```bash curl -u $AUTH "https://openwhisk.ng.bluemix.net/api/v1/namespaces/whisk.system/actions/alarms/alarm?blocking=true&result=false"; \ -X POST -H "Content-Type: application/json" \ --d "{\"authKey\":\"$AUTH\",\"lifecycleEvent\":\"DELETE\",\"triggerName\":\"/_/periodic\"}" +-d "{\"authKey\":\"$AUTH\",\"lifecycleEvent\":\"DELETE\",\"triggerName\":\"/_/periodic\"}" ``` Now delete the trigger with a HTTP request using `DELETE` method @@ -298,7 +299,7 @@ Rules can be enabled or disabled, and you can change the status of the rule by u ```bash curl -u $AUTH https://openwhisk.ng.bluemix.net/api/v1/namespaces/_/rules/t2a?overwrite=true \ -X POST -H "Content-Type: application/json" \ --d '{"status":"inactive","trigger":null,"action":null}' +-d '{"status":"inactive","trigger":null,"action":null}' ``` ## Packages diff --git a/docs/webactions.md b/docs/webactions.md index cb8f83a62b..c5d95a9a84 100644 --- a/docs/webactions.md +++ b/docs/webactions.md @@ -15,6 +15,7 @@ # specific language governing permissions and limitations under the License. # --> + # Web Actions Web actions are OpenWhisk actions annotated to quickly enable you to build web based applications. This allows you to program backend logic which your web application can access anonymously without requiring an OpenWhisk authentication key. It is up to the action developer to implement their own desired authentication and authorization (i.e. OAuth flow). @@ -72,7 +73,7 @@ function main() { statusCode: 302 } } -``` +``` Or sets a cookie: ```javascript @@ -221,8 +222,8 @@ $ curl https://${APIHOST}/api/v1/web/guest/demo/hello.json -d "name":"Jane" "__ow_headers": { "accept": "*/*", "connection": "close", - "content-length": "10", - "content-type": "application/x-www-form-urlencoded", + "content-length": "10", + "content-type": "application/x-www-form-urlencoded", "host": "172.17.0.1", "user-agent": "curl/7.43.0" }, @@ -241,7 +242,7 @@ $ curl https://${APIHOST}/api/v1/web/guest/demo/hello.json -H 'Content-Type: app "__ow_headers": { "accept": "*/*", "connection": "close", - "content-length": "15", + "content-length": "15", "content-type": "application/json", "host": "172.17.0.1", "user-agent": "curl/7.43.0" @@ -268,7 +269,7 @@ $ curl https://${APIHOST}/api/v1/web/guest/demo/hello.json -H 'Content-Type: tex "__ow_headers": { "accept": "*/*", "connection": "close", - "content-length": "4", + "content-length": "4", "content-type": "text/plain", "host": "172.17.0.1", "user-agent": "curl/7.43.0" @@ -341,7 +342,7 @@ $ curl https://${APIHOST}/api/v1/web/guest/demo/hello.json?name=Jane -X POST -H "content-length": "15", "content-type": "application/json", "host": "172.17.0.1", - "user-agent": "curl/7.43.0" + "user-agent": "curl/7.43.0" }, "__ow_path": "" } diff --git a/gradle/README.md b/gradle/README.md index 5b83fdbdc5..23cce13257 100644 --- a/gradle/README.md +++ b/gradle/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # diff --git a/tests/dat/blackbox/badaction/README.md b/tests/dat/blackbox/badaction/README.md index de343753f3..33ecb04180 100644 --- a/tests/dat/blackbox/badaction/README.md +++ b/tests/dat/blackbox/badaction/README.md @@ -1,3 +1,21 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional +# information regarding copyright ownership. The ASF licenses this file to you +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License +# at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# CONDITIONS OF ANY KIND, either express or implied. See the License for the +# specific language governing permissions and limitations under the License. +# +--> + A docker action that can manipulates `/init` and `/run` in different ways including - not responding - aborting and terminating the container diff --git a/tests/dat/blackbox/badproxy/README.md b/tests/dat/blackbox/badproxy/README.md index b74ef25b79..867a91e878 100644 --- a/tests/dat/blackbox/badproxy/README.md +++ b/tests/dat/blackbox/badproxy/README.md @@ -1 +1,19 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional +# information regarding copyright ownership. The ASF licenses this file to you +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License +# at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# CONDITIONS OF ANY KIND, either express or implied. See the License for the +# specific language governing permissions and limitations under the License. +# +--> + A docker action that does not implement a proper proxy. Runs a shell commands that never terminates. diff --git a/tools/admin/README.md b/tools/admin/README.md index eb6c7ac645..4f1cb459fb 100644 --- a/tools/admin/README.md +++ b/tools/admin/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # @@ -94,7 +94,3 @@ For example `wskadmin db get whisks --view whisks.v2/actions` will list the acti ### Inspecting System Logs For debugging a local deployment, `wskadmin syslog get` will show you the controller and invoker logs available. You can use `--grep` to grep the logs for specific patterns, or `--tid` to isolate logs specific to a specific transaction in the system. It is possible to isolate logs to a specific component (e.g., `controller0`). By default, logs are fetched from all available components. - - - - diff --git a/tools/build/compile_swift.sh b/tools/build/compile_swift.sh index ff8ab1554f..36edf8df6a 100755 --- a/tools/build/compile_swift.sh +++ b/tools/build/compile_swift.sh @@ -82,4 +82,4 @@ echo 'Creating archive $1.zip...' mkdir -p /owexec/$OUTPUT_DIR zip \"/owexec/$OUTPUT_DIR/$1.zip\" .build/release/Action -" \ No newline at end of file +" diff --git a/tools/db/README.md b/tools/db/README.md index b92dc69c8d..bc3a76b117 100644 --- a/tools/db/README.md +++ b/tools/db/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # @@ -39,9 +39,9 @@ Detailed instructions are found in the [ansible readme](../../ansible/README.md) ## Using Cloudant -As an alternative to a self-managed CouchDB, you may want to try [Cloudant](https://cloudant.com) which is a cloud-based database service. -There are two ways to get a Cloudant account and configure OpenWhisk to use it. -You only need to establish an account once, either through IBM Bluemix or with Cloudant directly. +As an alternative to a self-managed CouchDB, you may want to try [Cloudant](https://cloudant.com) which is a cloud-based database service. +There are two ways to get a Cloudant account and configure OpenWhisk to use it. +You only need to establish an account once, either through IBM Bluemix or with Cloudant directly. ### Create a Cloudant account via IBM Bluemix Sign up for an account via [IBM Bluemix](https://bluemix.net). Bluemix offers trial accounts and its signup process is straightforward so it is not described here in detail. Using Bluemix, the most convenient way to create a Cloudant instance is via the `cf` command-line tool. See [here](https://www.ng.bluemix.net/docs/starters/install_cli.html) for instructions on how to download and configure `cf` to work with your Bluemix account. @@ -89,7 +89,7 @@ If you are [using an ephemeral CouchDB container](#using-an-ephemeral-couchdb-co ``` # Work out of your openwhisk directory cd /your/path/to/openwhisk/ansible - + # Initialize data store containing authorization keys ansible-playbook initdb.yml ``` diff --git a/tools/dev/README.md b/tools/dev/README.md index 351a503ffb..1188e9a528 100644 --- a/tools/dev/README.md +++ b/tools/dev/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # @@ -25,14 +25,14 @@ change With current directory set to OpenWhisk home ./gradlew -p tools/dev <taskName> - + With this module being base directory ../../gradlew <taskName> ## couchdbViews -Extracts and dump the design docs js in readable format. It reads all the design docs from +Extracts and dump the design docs js in readable format. It reads all the design docs from _<OPENWHISH_HOME>/ansibles/files_ and dumps them in _build/views_ directory Sample output @@ -62,8 +62,8 @@ Sample output ## IntelliJ Run Config Generator -This script enables creation of [Intellij Launch Configuration][1] in _<openwhisk home>/.idea/runConfigurations_ -with name controller0 and invoker0. For this to work your Intellij project should be [directory based][3]. If your +This script enables creation of [Intellij Launch Configuration][1] in _<openwhisk home>/.idea/runConfigurations_ +with name controller0 and invoker0. For this to work your Intellij project should be [directory based][3]. If your project is file based (uses ipr files) then you can convert it to directory based via _File -> Save as Directory-Based Format_. These run configurations can then be invoked from _Run -> Edit Configurations -> Application_ ### Usage @@ -71,8 +71,8 @@ project is file based (uses ipr files) then you can convert it to directory base First setup OpenWhisk so that Controller and Invoker containers are up and running. Then run the script: ./gradlew -p tools/dev intellij - -It would inspect the running docker containers and then generate the launch configs with name 'controller0' + +It would inspect the running docker containers and then generate the launch configs with name 'controller0' and 'invoker0'. Key points to note: @@ -87,7 +87,7 @@ Now the docker container can be stopped and application can be launched from wit ### Configuration The script allows some local customization of the launch configuration. This can be done by creating a [config][4] file -`intellij-run-config.groovy` in project root directory. Below is an example of _<openwhisk home>/intellij-run-config.groovy_ +`intellij-run-config.groovy` in project root directory. Below is an example of _<openwhisk home>/intellij-run-config.groovy_ file to customize the logging and db port used for CouchDB. ```groovy diff --git a/tools/git/README.md b/tools/git/README.md index d1454b0aef..aa1e9d08fc 100644 --- a/tools/git/README.md +++ b/tools/git/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # diff --git a/tools/git/pre-commit-scalafmt-gradlew.sh b/tools/git/pre-commit-scalafmt-gradlew.sh index 69cb600bbb..8ba0a35e86 100755 --- a/tools/git/pre-commit-scalafmt-gradlew.sh +++ b/tools/git/pre-commit-scalafmt-gradlew.sh @@ -50,4 +50,4 @@ if [ "${STAGED_SCALA_FILES_DETECTED}" -eq 1 ]; then done fi -exit 0 \ No newline at end of file +exit 0 diff --git a/tools/git/pre-commit-scalafmt-native.sh b/tools/git/pre-commit-scalafmt-native.sh index 4b7850f6e4..040cd7c740 100755 --- a/tools/git/pre-commit-scalafmt-native.sh +++ b/tools/git/pre-commit-scalafmt-native.sh @@ -63,4 +63,4 @@ if [ "${STAGED_SCALA_FILES_DETECTED}" -eq 1 ]; then done fi -exit 0 \ No newline at end of file +exit 0 diff --git a/tools/macos/README.md b/tools/macos/README.md index b575d8d469..b1b80b7ce3 100644 --- a/tools/macos/README.md +++ b/tools/macos/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # diff --git a/tools/macos/docker-machine/README.md b/tools/macos/docker-machine/README.md index 7d6c9b870e..84b5c4ac8a 100644 --- a/tools/macos/docker-machine/README.md +++ b/tools/macos/docker-machine/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # @@ -138,7 +138,7 @@ cd ansible ansible-playbook -i environments/docker-machine setup.yml [-e docker_machine_name=whisk] ``` -**Hint:** If you omit the optional `-e docker_machine_name` parameter, it will default to "whisk". +**Hint:** If you omit the optional `-e docker_machine_name` parameter, it will default to "whisk". If your docker-machine VM has a different name you may pass it via the `-e docker_machine_name` parameter. After this there should be a `hosts` file in the `ansible/environments/docker-machine` directory. diff --git a/tools/ubuntu-setup/README.md b/tools/ubuntu-setup/README.md index 4245acec95..71056ce33d 100644 --- a/tools/ubuntu-setup/README.md +++ b/tools/ubuntu-setup/README.md @@ -1,16 +1,16 @@ <!-- # -# Licensed to the Apache Software Foundation (ASF) under one or more contributor -# license agreements. See the NOTICE file distributed with this work for additional +# Licensed to the Apache Software Foundation (ASF) under one or more contributor +# license agreements. See the NOTICE file distributed with this work for additional # information regarding copyright ownership. The ASF licenses this file to you -# under the Apache License, Version 2.0 (the # "License"); you may not use this -# file except in compliance with the License. You may obtain a copy of the License +# under the Apache License, Version 2.0 (the # "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the License # at: # # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software distributed -# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +# Unless required by applicable law or agreed to in writing, software distributed +# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR # CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. # @@ -18,7 +18,7 @@ # Setting up OpenWhisk on Ubuntu server(s) -The following are verified to work on Ubuntu 14.04.3 LTS. You may need `sudo` or root access to install required software depending on your system setup. +The following are verified to work on Ubuntu 14.04.3 LTS. You may need `sudo` or root access to install required software depending on your system setup. The commands below should be executed on the host machine for single VM/server deployments of OpenWhisk. For a distributed deployment spanning multiple VMs, the commands should be executed on a machine with network connectivity to all the VMs in the deployment - this is called the `bootstrapper` and it is ideally an Ubuntu 14.04 VM that is provisioned in an IaaS (infrastructure as a service platform e.g., OpenStack). Your local machine can act as the bootstrapper as well if it can connect to the VMs deployed in your IaaS. @@ -28,7 +28,7 @@ The commands below should be executed on the host machine for single VM/server d # Clone openwhisk git clone https://github.com/apache/incubator-openwhisk.git openwhisk - + # Change current directory to openwhisk cd openwhisk ---------------------------------------------------------------- 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
