mdeuser commented on a change in pull request #3435: CLI docs update and markdown linting. URL: https://github.com/apache/incubator-openwhisk/pull/3435#discussion_r174764985
########## File path: ansible/README.md ########## @@ -172,24 +172,42 @@ Use `ansible-playbook -i environments/<environment> openwhisk.yml` to avoid wipi ### Configuring the installation of `wsk` CLI There are two installation modes to install `wsk` CLI: remote and local. -The mode "remote" means to download the `wsk` binaries from available web links. By default, OpenWhisk sets -the installation mode to remote and downloads the binaries from the CLI [release page](https://github.com/apache/incubator-openwhisk-cli/releases), where OpenWhisk publishes the official `wsk` binaries. +The mode "remote" means to download the `wsk` binaries from available web links. +By default, OpenWhisk sets the installation mode to remote and downloads the +binaries from the CLI +[release page](https://github.com/apache/incubator-openwhisk-cli/releases), +where OpenWhisk publishes the official `wsk` binaries. -The mode "local" means to build and install the `wsk` binaries from local CLI project. You can download the source code -of OpenWhisk CLI via [this link](https://github.com/apache/incubator-openwhisk-cli). Let's assume your OpenWhisk CLI home directory is <openwhisk_cli_home>. After you download the source code, use the gradle command to build the binaries: +The mode "local" means to build and install the `wsk` binaries from local CLI +project. You can download the source code of OpenWhisk CLI +[here](https://github.com/apache/incubator-openwhisk-cli). +Let's assume your OpenWhisk CLI home directory is +`$OPENWHISK_HOME/../incubator-openwhisk-cli` and you've already `export`ed +`OPENWHISK_HOME` to be the root directory of this project. After you download +the CLI repository, use the gradle command to build the binaries (you can omit +the `-PnativeBuild` if you want to cross-compile for all supported platforms): ``` -cd <openwhisk_cli_home> -./gradlew buildBinaries +cd "$OPENWHISK_HOME/../incubator-openwhisk-cli" +./gradlew release -PnativeBuild ``` -All the binaries are generated and put under the folder of <openwhisk_cli_home>/bin. Then, use the following ansible command to configure the CLI installation mode: +The binaries are generated and put into a tarball in the folder +`../incubator-openwhisk-cli/release`. Then, use the following ansible command +to (re-)configure the CLI installation: ``` -ansible-playbook -i environments/<environment> openwhisk.yml -e cli_installation_mode=local -e openwhisk_cli_home=<openwhisk_cli_home> +export OPENWHISK_ENVIRONMENT=local # ... or whatever +ansible-playbook -i environments/$OPENWHSIK_ENVIRONMENT edge.yml -e mode=clean Review comment: typo `OPENWHSIK` -> `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: [email protected] With regards, Apache Git Services
