duynguyen closed pull request #71: [WIP] Remove download master from quick-start
URL: https://github.com/apache/incubator-openwhisk-devtools/pull/71
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/docker-compose/Makefile b/docker-compose/Makefile
index b59263a..d742767 100644
--- a/docker-compose/Makefile
+++ b/docker-compose/Makefile
@@ -29,7 +29,7 @@ endif
# 2. then it starts all components using docker-compose
# 3. it runs a sample hello-world function
# To stop and cleanup the environment use: make destroy
-quick-start: download download-cli run quick-start-pause hello-world
quick-start-info
+quick-start: download-cli run quick-start-pause hello-world quick-start-info
.PHONY: download
download:
@@ -53,7 +53,7 @@ quick-start-info:
echo "$$(tput setaf 2)To invoke the function again use: $$(tput setaf
4)make hello-world$$(tput sgr0)"
echo "$$(tput setaf 2)To stop openwhisk use: $$(tput setaf 4)make
destroy$$(tput sgr0)"
-docker:
+docker: download
echo "building the docker images ... "
cd $(PROJECT_HOME) && \
./gradlew distdocker -x :core:swift3Action:distDocker -x
:core:swiftAction:distDocker
@@ -70,7 +70,7 @@ download-cli:
curl -o $(PROJECT_HOME)/bin/wsk.tgz -L
https://github.com/apache/incubator-openwhisk-cli/releases/download/latest/OpenWhisk_CLI-latest-linux-amd64.tgz
; \
cd $(PROJECT_HOME)/bin ; \
tar -xf wsk.tgz ; \
- fi;
+ fi;
.PHONY: run
diff --git a/docker-compose/README.md b/docker-compose/README.md
index 42f68c2..9c36374 100644
--- a/docker-compose/README.md
+++ b/docker-compose/README.md
@@ -31,7 +31,7 @@ These ports must be available:
make quick-start
```
-This command downloads the `master` branch from the
[OpenWhisk](https://github.com/openwhisk/openwhisk) repo, it builds OpenWhisk,
the docker containers, it starts the system and it executes a simple
`hello-world` function.
+This command downloads the CLI tool, starts the system with prebuilt OpenWhisk
images on Docker Hub and executes a simple `hello-world` function.
At the end of the execution it prints the output of the function:
```javascript
{
@@ -39,10 +39,6 @@ At the end of the execution it prints the output of the
function:
}
```
-If `PROJECT_HOME` variable is set ( i.e. `PROJECT_HOME=/path/to/openwhisk make
quick-start`)
-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`.
-
## Updating OpenWhisk Invoker or Controller
To update the OpenWhisk Invoker or Controller without restarting everything,
run:
@@ -79,6 +75,9 @@ make docker
This command builds the docker containers for local testing and development.
+* If `PROJECT_HOME` variable is not set (default to `./openwhisk-master`), the
command first downloads the main openwhisk repo to `openwhisk-master` for the
build.
+* If `PROJECT_HOME` variable is set (i.e. `PROJECT_HOME=/path/to/openwhisk
make docker`), 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`.
+
> NOTE: The build may skip some components such as Swift actions in order to
> finish the build faster.
# Start
@@ -147,6 +146,6 @@ These 2 variable allow you to execute a JS action using the
container `registry.
## Local Docker containers for controllers and invokers
-By default this setup uses published images for controller and invokers from
`openwhisk` namespace i.e.
+By default this setup uses published images for controller and invokers from
`openwhisk` namespace i.e.
`openwhisk/controller` and `openwhisk/invoker`. To make use of locally build
images you can use `DOCKER_OW_IMAGE_PREFIX`
-variable i.e. `DOCKER_OW_IMAGE_PREFIX=whisk make quick-start`
\ No newline at end of file
+variable i.e. `DOCKER_OW_IMAGE_PREFIX=whisk make quick-start`
----------------------------------------------------------------
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
