[incubator-openwhisk-devtools] branch master updated: Improving docker-compose instructions for newbies (#54)

[dr...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dragos pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-devtools.git


The following commit(s) were added to refs/heads/master by this push:
     new 8a24e2c  Improving docker-compose instructions for newbies (#54)
8a24e2c is described below

commit 8a24e2c23932717c149343a0c83c4ef5ebb17a9d
Author: Alexander Klimetschek <al...@klimetschek.de>
AuthorDate: Thu Sep 21 21:13:50 2017 -0700

    Improving docker-compose instructions for newbies (#54)
    
    * add troubleshooting to docker-compose readme, note about Docker for Mac requirement
    * sorting ports list by number and 80/443 first as they are commonly used already
    * removing Consul ports from readme as it was removed in #50
---
 docker-compose/README.md | 30 +++++++++++++++++++++++-------
 1 file changed, 23 insertions(+), 7 deletions(-)

diff --git a/docker-compose/README.md b/docker-compose/README.md
index 332c787..f3208c3 100644
--- a/docker-compose/README.md
+++ b/docker-compose/README.md
@@ -8,18 +8,22 @@ An easy way to try OpenWhisk locally is to use Docker Compose.
 
 The following are required to build and deploy OpenWhisk with Docker Compose:
 
-- [Docker 1.12+](https://www.docker.com/products/docker)
-- [Docker Compose 1.6+](https://docs.docker.com/compose/install/)
+- Mac OSX:
+    - [Docker for Mac](https://www.docker.com/docker-mac) - only this currently works on Mac OSX
+      + Install via homebrew: `brew cask install docker`
+- Other Systems:
+    - [Docker 1.12+](https://www.docker.com/products/docker)
+    - [Docker Compose 1.6+](https://docs.docker.com/compose/install/)
 - [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
 
-Available Ports:
+These ports must be available:
 
-- `5984` for CouchDB
+- `80` and `443` for the API Gateway
 - `2181` for Zookeeper
-- `9092` for Kafka
-- `8888` for OpenWhisk's Controller
+- `5984` for CouchDB
 - `8085` for OpenWhisk's Invoker
-- `80` and `443` for the API Gateway
+- `8888` for OpenWhisk's Controller
+- `9092` for Kafka
 
 # Quick Start
 
@@ -39,6 +43,18 @@ If `PROJECT_HOME` variable is set ( i.e. `PROJECT_HOME=/path/to/openwhisk make q
 then the command skips downloading the `master` branch and uses instead the source code found in the `PROJECT_HOME` folder.
 This is useful for working with a local clone, making changes to the code, and run it with `docker-compose`.
 
+## Troubleshooting
+
+* ```error: Authenticated user does not have namespace 'guest'; set command failed: Get https://localhost:443/api/v1/namespaces: dial tcp [::1]:443: getsockopt: connection refused```
+
+  Make sure nothing runs on the above listed ports. Port 80 might be commonly in use by a local httpd for example. On a Mac, use `sudo lsof -i -P` to find out what process runs on a port. You can turn off Internet Sharing under System Settings > Sharing, or try `sudo /usr/sbin/apachectl stop` to stop httpd.
+  
+* ```error: Unable to invoke action 'hello': There was an internal server error. (code 5)```
+
+  Look at the logs in `~/tmp/openwhisk` especially `~/tmp/openwhisk/controller/logs/controller-local_logs.log` that might give more information. This can be an indication that the docker environment doesn't work properly (and on Mac you might need to switch to use [Docker for Mac](https://www.docker.com/docker-mac).
+  
+* Check the [issue tracker](https://github.com/apache/incubator-openwhisk-devtools/issues) for more.
+
 # Build
 
 ```bash

-- 
To stop receiving notification emails like this one, please contact
['"commits@openwhisk.apache.org" <co...@openwhisk.apache.org>'].