You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openwhisk.apache.org by ho...@apache.org on 2018/07/03 18:45:57 UTC
svn commit: r27903 - in
/dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2:
doc/INSTALL.md openwhisk-0.9.0-incubating-sources.tar.gz
openwhisk-0.9.0-incubating-sources.tar.gz.asc
openwhisk-0.9.0-incubating-sources.tar.gz.sha512
Author: houshengbo
Date: Tue Jul 3 18:45:57 2018
New Revision: 27903
Log:
Staging Apache OpenWhisk release 0.9.0-incubating-rc2.
Modified:
dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/doc/INSTALL.md
dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz
dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.asc
dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.sha512
Modified: dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/doc/INSTALL.md
==============================================================================
--- dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/doc/INSTALL.md (original)
+++ dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/doc/INSTALL.md Tue Jul 3 18:45:57 2018
@@ -19,79 +19,99 @@
# Download OpenWhisk
-The source code of OpenWhisk can be accessed by [this link](https://dist.apache.org/repos/dist/dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc1/).
-You are currently releasing the version 0.9.0, and the artifact of OpenWhisk source code is called "openwhisk-0.9.0-incubating-sources.tar.gz".
+The OpenWhisk source code may be downloaded from https://dist.apache.org/repos/dist/dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2. The current release is version 0.9.0, and the artifact for this OpenWhisk source code release is called `"openwhisk-0.9.0-incubating-sources.tar.gz"`.
+```
+# download from your terminal with wget
+wget https://dist.apache.org/repos/dist/dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz
+```
-# Verify the Apache license header of OpenWhisk
+# Verify the SHA-512 checksums, and signature
-OpenWhisk uses a tool called openwhisk-utilities to check the license header of each source code file. Please check the
-tutorial [here](https://github.com/apache/incubator-openwhisk-utilities) about how to run it on the directory level.
+You need to install `gpg` on your local machine.
+- For Ubuntu user, run the following command:
+ ```
+ sudo apt-get install gnupg
+ ```
-# Verify the SHA-512 checksums, and signature
+- For Mac user, run the following command:
+ ```
+ brew install gpg
+ ```
-You need to install gpg on your local machine.
+Before using `gpg` to verify the OpenWhisk release integrity, you should [verify `gpg`'s own integrity](https://gnupg.org/download/integrity_check.html).
-For Ubuntu user, run the following command:
+The public key used to verify the OpenWhisk checksums can be found [here](https://dist.apache.org/repos/dist/dev/incubator/openwhisk/KEYS). Download the key and import it on your local machine.
```
-$ sudo apt-get install gnupg
+gpg --import <key_file>
```
-For Mac user, run the following command:
-
-```
-$ brew install gpg
-```
+The parameter <key_file> is the file, where the public key is saved.
-The public key used to verify the checksums can be found [here](https://dist.apache.org/repos/dist/dev/incubator/openwhisk/KEYS). After
-download it, you need to import it on your local machine.
+To generate the SHA512 checksum:
```
-$ gpg --import <key_file>
+gpg --print-md SHA512 <artifact>
```
-The parameter <key_file> is the file, where the public key is saved.
+The parameter <artifact> is the file of the artifact `"openwhisk-0.9.0-incubating-sources.tar.gz"`. Compare the content with the [SHA512 file](https://dist.apache.org/repos/dist/dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.sha512).
-To generate the SHA512 checksum:
+Download the [signature](https://dist.apache.org/repos/dist/dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.asc), and verify it with the command:
```
-$ gpg --print-md SHA512 <artifact>
+gpg --verify openwhisk-0.9.0-incubating-sources.tar.gz.asc openwhisk-0.9.0-incubating-sources.tar.gz
```
-The parameter <artifact> is the file of the artifact "openwhisk-0.9.0-incubating-sources.tar.gz". Compare the content with the [SHA512 file](https://dist.apache.org/repos/dist/dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc1/openwhisk-0.9.0-incubating-sources.tar.gz.sha512).
+# Unpack the release
-Download the [signature](https://dist.apache.org/repos/dist/dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc1/openwhisk-0.9.0-incubating-sources.tar.gz.asc), and verify it with the command:
+Once you have verified the artifact checksums, unzip and extract the source code from the file `"openwhisk-0.9.0-incubating-sources.tar.gz"`. This will yield a directory called `"incubator-openwhisk-0.9.0-incubating"` on your local machine.
+
+You can use the following command to untar the package:
```
-$ gpg --verify openwhisk-0.9.0-incubating-sources.tar.gz.asc openwhisk-0.9.0-incubating-sources.tar.gz
+tar -xvzf openwhisk-0.9.0-incubating-sources.tar.gz
```
+# Verify the Apache license header
-# Installation of OpenWhisk 0.9.0
+OpenWhisk uses a tool called [`scanCode`](https://github.com/apache/incubator-openwhisk-utilities/tree/master/scancode) to check the license header of each source file included in the release. Please check the [`scanCode` tutorial](https://github.com/apache/incubator-openwhisk-utilities) for instructions to download and run the tool and scan all code in the release.
-This instruction walks you through the steps to install OpenWhisk 0.9.0. We support both Ubuntu and Mac operating systems.
-Please download the source code package of OpenWhisk "openwhisk-0.9.0-incubating-sources.tar.gz" and unzip it, then you
-get a directory called "incubator-openwhisk-<version>" on your local machine.
+# Building OpenWhisk
+The following instructions walk you through the steps to build OpenWhisk 0.9.0 for the supported operation systems which are Ubuntu and Mac OS.
## Prerequisites
-If you are a Ubuntu user, our suggested version is between 14.04 and 16.04. Open a terminal, go to the directory of "incubator-openwhisk",
-and run the script "all.sh" under tools/ubuntu-setup:
+We recommend you set the environment variable `$OPENWHISK_HOME` on your local machine to the extracted directory `incubator-openwhisk-0.9.0-incubating`.
+It is an _error_ to set `$OPENWHISK_HOME` to an invalid or incorrect path (including an empty string). If you do not wish to use the environment variable, make sure it is not defined in your environment at all. The rest of the instructions assume you have defined this environment variable.
+
+### Ubuntu users
+
+If you are a Ubuntu user, our suggested version is between 14.04 and 16.04. Open a terminal, go to the directory of `"incubator-openwhisk-0.9.0-incubating"`, and run the script `"all.sh"` under `tools/ubuntu-setup`:
```
-$ cd incubator-openwhisk-<version>
-$ ./tools/ubuntu-setup/all.sh
+cd $OPENWHISK_HOME
+./tools/ubuntu-setup/all.sh
```
Then, you need to add the permission for the current Ubuntu user in Docker:
```
-$ sudo usermod -a -G docker $USER
+sudo usermod -a -G docker $USER
```
+Install Gradle 4.8.1 or the latest version with the following commands:
+
+```
+sudo add-apt-repository ppa:cwchien/gradle
+sudo apt-get update
+sudo apt-get install gradle
+```
+
+### Mac users
+
If you are a Mac user, please run the following script:
```
@@ -115,82 +135,94 @@ sudo -H pip install docker==2.2.1 ansibl
Then, activate docker0 network with the following command:
```
-$ sudo ifconfig lo0 alias 172.17.0.1/24
+sudo ifconfig lo0 alias 172.17.0.1/24
+```
+
+Install Gradle 4.8.1 or the latest version with the following commands:
+
+```
+brew install gradle
```
After running the script above, you should have all you need to install OpenWhisk. Normally there should be no error, but it
-some error messages pop-up, please [log an issue](https://github.com/apache/incubator-openwhisk/issues) for OpenWhisk community.
+some error messages pop-up, please [log an issue](https://github.com/apache/incubator-openwhisk/issues) for the OpenWhisk community to assist you.
## Build the source code
+Open the terminal, and go to the directory $OPENWHISK_HOME. Install the Gradle wrapper with the command:
-Stay under the directory of incubator-openwhisk-<version>, and download [gradle-wrapper-4.8.1.jar](https://repo.gradle.org/gradle/libs-releases-local/org/gradle/gradle-wrapper/4.8.1/gradle-wrapper-4.8.1.jar) and place it in the gradle/wrapper
-folder. Rename it into gradle-wrapper.jar, run the following gradlew command to build the source code:
+```
+gradle wrapper
+```
+
+Then, run the following gradlew command to build the source code:
```
-$ ./gradlew distDocker
+./gradlew distDocker
```
-You should be able to have all the docker images necessary to run OpenWhisk, after running this command. If you fail to build
-it, first make sure docker is running correctly by verifying with the command "docker images". If the error message still
-remains clueless, please [log an issue](https://github.com/apache/incubator-openwhisk/issues) for OpenWhisk community.
+Once the build is complete, you will have Docker images necessary to run OpenWhisk. If your build fails,
+first make sure `docker` is running correctly by verifying with the command `docker images`. If you continue
+to encounter build problems, please seek help by opening [an issue](https://github.com/apache/incubator-openwhisk/issues) for the OpenWhisk community to assist you.
## Deploy OpenWhisk
-Stay under the directory of incubator-openwhisk-<version>, and run the following ansible scripts one by one:
+Make sure you are in the `$OPENWHISK_HOME/ansible` directory, and run the following ansible
+scripts one after the other. If any of these commands fail, the rest of the deployment will
+not work correctly and you should [seek help](https://github.com/apache/incubator-openwhisk/issues).
```
-$ cd ansible
-$ ansible-playbook -i environments/local setup.yml
-$ ansible-playbook -i environments/local prereq.yml
-$ ansible-playbook -i environments/local couchdb.yml
-$ ansible-playbook -i environments/local initdb.yml
-$ ansible-playbook -i environments/local wipe.yml
-$ ansible-playbook -i environments/local apigateway.yml
-$ ansible-playbook -i environments/local openwhisk.yml
-$ ansible-playbook -i environments/local postdeploy.yml
+ansible-playbook -i environments/local setup.yml
+ansible-playbook -i environments/local couchdb.yml
+ansible-playbook -i environments/local initdb.yml
+ansible-playbook -i environments/local wipe.yml
+ansible-playbook -i environments/local openwhisk.yml
+ansible-playbook -i environments/local postdeploy.yml
+ansible-playbook -i environments/local apigateway.yml
```
-There are several know issues when you run the above ansible scripts:
-
-One known issue we have can be found at [this link](https://github.com/apache/incubator-openwhisk/issues/3804). You
-can run the script "ansible-playbook -i environments/local routemgmt.yml" to see if it can succeed.
+### Troubleshooting
-Another issue can be found at [this link](https://github.com/apache/incubator-openwhisk/issues/3815). You can find the solution
-in the description of this issue.
+There are several know issues you may encounter:
-Since this release does not ship the code of test cases, any error regarding test cases can be ignored.
+- The API gateway packages may not install correctly on some systems. You can try to recover, and then proceed with the rest of the playbooks by running `ansible-playbook -i environments/local routemgmt.yml`. See [this issue](https://github.com/apache/incubator-openwhisk/issues/3804) for more details. If you are not interested in the API gateway, you can ignore this error (and also skip the last playbook).
-The ansible scripts will be executed without error after you go through the above issues. If you still fail to deploy OpenWhisk, please [log an issue](https://github.com/apache/incubator-openwhisk/issues) for OpenWhisk community.
+- If the playbook fail, sometimes tearing down the (partially) deployed system and retrying is sufficient to recover. To clean your local environment, run the following commands:
+ ```
+ ansible-playbook -i environments/local apigateway.yml -e mode=clean
+ ansible-playbook -i environments/local openwhisk.yml -e mode=clean
+ ansible-playbook -i environments/local couchdb.yml -e mode=clean
+ ```
+ Then, run the ansible playbooks again to see if there are still failures. If you still fail to deploy OpenWhisk,
+please [log an issue](https://github.com/apache/incubator-openwhisk/issues) for the OpenWhisk community to assist you.
+- Since this release does not ship the code for test cases, any error regarding test cases can be ignored.
## Run OpenWhisk
-The easiest way to try out OpenWhisk is to use OpenWhisk CLI. Please find the configuration [here](https://github.com/apache/incubator-openwhisk/blob/master/docs/cli.md).
-For example, you can configure you CLI with the following command, if you have deployed OpenWhisk locally:
+The easiest way to try out OpenWhisk is to use OpenWhisk CLI. Please find the configuration [steps here](https://github.com/apache/incubator-openwhisk/blob/master/docs/cli.md). Briefly, you can configure the CLI with the following command once you have deployed OpenWhisk locally:
```
-$ wsk property set --apihost 172.17.0.1 --auth $(cat ${OPENWHISK_HOME}/ansible/files/auth.guest)
+wsk property set --apihost 172.17.0.1 --auth $(cat ${OPENWHISK_HOME}/ansible/files/auth.guest)
```
-The environment variable $OPENWHISK_HOME points to the directory incubator-openwhisk-<version>. After that, run the following command
-to each an input message:
+Run the following command to invoke a built in "echo" action that returns the received input parameters as its result:
```
-$ bin/wsk -i action invoke /whisk.system/utils/echo -p message hello --result
+bin/wsk -i action invoke /whisk.system/utils/echo --param message hello --result
```
Output:
-```
+```json
{
- "message": "hello"
+ "message": "hello"
}
```
-If you can get the above message, you have successfully deployed OpenWhisk on your local machine.
+If you can get the above message, you have successfully deployed OpenWhisk on your local machine. You can learn more about the basics of working with OpenWhisk actions using this [tutorial](https://github.com/apache/incubator-openwhisk/blob/master/docs/actions.md#the-basics).
-If you want to learn how to use OpenWhisk in a more comprehensive way, please visit the [OpenWhisk website](https://openwhisk.apache.org/) or
-[OpenWhisk repository](https://github.com/apache/incubator-openwhisk/blob/master/README.md) for detailed information.
+For more comprehensive information about OpenWhisk, please visit the [OpenWhisk website](https://openwhisk.apache.org/) or the
+[OpenWhisk repository](https://github.com/apache/incubator-openwhisk/blob/master/README.md) on GitHub.
Modified: dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz
==============================================================================
Binary files - no diff available.
Modified: dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.asc
==============================================================================
--- dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.asc (original)
+++ dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.asc Tue Jul 3 18:45:57 2018
@@ -1,17 +1,17 @@
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1
-iQIcBAABAgAGBQJbOkIMAAoJEHKvDMIsTPMgQwAQAJ4HFSov7vU8v3HSi3yJJ79Y
-mEhj+qh1fJAEzex9IfZjCfTRA2PHs/l2h2rEDyKjEJ0ZzrExSo+TrpFUvDRN6P8q
-W0R2v08eeRui38Mcwdmu2qska2Ur9cVaDSFiKDjhtn4Pb04P4qoOMEMVkwDvuUDF
-+gmy9LWM8O/A+wapdtmCIL7NpsuEua9IijSyIHhP/8+6DyQPkpriDg7C6u6DcvFZ
-dxKdTTe/vZsGdv7rQRMb1/qq4n8RWr1wKSIxFjON6HtqaXaLJLy6ZXDYQnQMP+ey
-Oa6tzqsKirszmPIyBeuitbVlKoMHwINoEAfjbis2huNBXiQFI+dIThoWV7R9UZ4N
-yeV91DF80+PsvPtS0EbqCY0mPnzIg/sToSgo1SGcOAxTfR2tP6ZAOBNGXsio8Oui
-pcnR1l2LiZWUpBLFx/sXh4F7w4payET50ZW0L33pO6tyM7JNdq/Xy2j+RlDM6TWv
-1KxFf6u11g8qXKZtBo0NnnVKYGJ5QB7QJ2fFJWL1d4oyj8AG00d1YE1jegJj76Kk
-x8uW1amY0FJjlj60QAYUuZRV4Hc/GSu14QUhQFzgh404kkHdC2nTL+I3jUyOuxbD
-Byzz2S17IFAI0uhxewV/iQAhaNX3OUVXTUEh7izZ7wdDGLGVExF4EQOc58YQdHl1
-w2Ayr/SFiJ2pRRp43LxY
-=Slha
+iQIcBAABAgAGBQJbO8RjAAoJEHKvDMIsTPMgAysQAJZB2MN5YT0AxNmMu3OxmbkF
+kzpNwZ9h0RKKRPfRHN5t2PoilGMX9EHJtZCIW1gypJBNZfLUNQJg87vTDfmrg/Tp
+QCh0JqZ7E8IuIlEta1gMi1T6TlzymhEf5/SEHXNKgz8n6gUYKislbKPV4eUvINTB
+mVvqZd6lYRbfiQIhrslyU80PTN4vdoyqX1h+Ii1yQ7rinjb1pTGvnysGEqrNwwlA
+WG+7/6Hsi2sFqb6NGm113/+Oo273H63opEvTQ56ddobUwAT2jM5/Z5ZUpJ+Cdgct
+0McTp2/ieg/DlI/7g7DHhl0oMYzBctvEyXiXvfHc1g2+sIv4HCKdvSWj64BUhtTL
+jQQg/HE8JDG6JziesDih/R6r3WByAAh/Ig/mezaBrTikQCrfILTJcDFzrVVkQrtt
+10sh9Vax/mZHir6Owz2kbI4xFGv+UUtBzq1Gdh1CqsX83YZISTmTIihXZmzm17rE
+/SSsT00qQpYZnMMtHEi+9NnGv5dlmIFTN5vPlJPvXSS5WizTuzh7w5YcVGJjXAjW
+jS+2k4sunboeRe7ZTxNkpgMCGCa/6B3yKXrZZmvPAUtNcq2uoVlYW4E9dmiARAJ0
+1DHKxAhz/jUWuklKFKN5bKQKwQefQFzBpsiU7ZkEhUDWPcHNBlrjXUWBZrzU9tel
+ROyV7//+pmG+ZPtlNb7H
+=Bu/+
-----END PGP SIGNATURE-----
Modified: dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.sha512
==============================================================================
--- dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.sha512 (original)
+++ dev/incubator/openwhisk/apache-openwhisk-0.9.0-incubating-rc2/openwhisk-0.9.0-incubating-sources.tar.gz.sha512 Tue Jul 3 18:45:57 2018
@@ -1,3 +1,3 @@
openwhisk-0.9.0-incubating-sources.tar.gz:
-D6DCEB75 E50EDFBC 0EABF31A 6C1A8A86 74DAFE3E F9D05231 D99A7613 1E2F07FA D5F25994
- F42B0F45 7607EF17 914F3550 5657B247 BAFC27C9 29CCE006 A7EA5E07
+CC98B4E3 1E3AA782 0C20360B 76DCAB03 7734FB5F EE49AD6A 0B8C65FA 71BDA114 69940524
+ 05F6F3AF 0D0891C9 9B1D8EA3 DA19F1FA 8815AAF6 840068FD 7CD5CC26