Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update compiling instructions and rename potential conflicting wfcli directory #171

Merged
merged 1 commit into from
Jul 18, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ __pycache__/

revive.toml

wfcli
wfcli-linux
wfcli-osx
wfcli-windows

wfcli*
fission-workflows-bundle*
fission-workflows-bundle
fission-workflows-bundle-linux
fission-workflows-bundle-osx
fission-workflows-bundle-windows
2 changes: 1 addition & 1 deletion build/docker.sh
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ docker build --tag="${IMAGE_REPO}/workflow-build-env:${IMAGE_TAG}" ${BUILD_ROOT}
--build-arg BUNDLE_IMAGE=${bundleImage} \
--build-arg BUNDLE_TAG=${IMAGE_TAG}
echo "Building wfcli..."
docker build --tag="${IMAGE_REPO}/wfcli:${IMAGE_TAG}" ${BUILD_ROOT}/wfcli/ \
docker build --tag="${IMAGE_REPO}/wfcli:${IMAGE_TAG}" ${BUILD_ROOT}/wfcli-docker/ \
--no-cache \
--build-arg BUNDLE_IMAGE=${bundleImage} \
--build-arg BUNDLE_TAG=${IMAGE_TAG}
Expand Down
File renamed without changes.
43 changes: 31 additions & 12 deletions compiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,54 @@
just deploying Fission Workflows, use the helm chart which points to prebuilt
images by default.*

## Requirements
## Compilation
There are two ways to compiling the environment: locally or in Docker. Regardless of the approach, ensure that your
environment meets all prerequisite requirements, and checkout the repo from github.

### Local Compilation

#### Requirements
- go >1.8
- docker
- [glide](http://glide.sh/) package manager

## Compilation
Ensure that your environment meets all prerequisite requirements, and checkout the repo from github.

```bash
# Install dependencies
glide install
glide install -v

cd build
bash ./build-linux.sh
# Build the artifacts: wfcli, fission-workflows-bundle
build/build-linux.sh

# Optional: Ensure that you target the right docker registry (assuming minikube)
eval $(minikube docker-env)
# Build the docker images (the NOBUILD parameter indicates that Docker should use the artifacts (wfci,
# fission-workflows-bundle) you just build with build/build-linux.sh)
NOBUILD=y build/docker.sh fission latest
```

# Build the docker images
bash ./docker.sh fission latest
### In-Docker Compilation

THe in-Docker compilation approach builds all artifacts in Docker containers. The advantage of this is that builds
are not affected by the environment differences of your local machine and limits the need to install build tooling on
your machine (except for Docker). This comes at the cost of performance: builds are started completely clean
every time; dependencies, intermediate build steps and artifacts are not cached.

While the local compilation is most convenient for developing and testing Fission Workflows, In-Docker compilation
should be used for building the official/final images.

```bash
# Build the docker images (the absence of the NOBUILD parameter indicates that Docker should first build the artifacts
# in a Docker container)
build/docker.sh
```

## Deployment

To deploy your locally compiled version. **As of writing Fission Workflows, requires fission to be installed
in the fission namespace.**
```bash
helm install --set "tag=latest" --namespace fission charts/fission-workflows
```

### CLI
## Optional: CLI
There is an experimental CLI available, called `wfcli`.
The intent is to integrate it into the Fission CLI, removing the need for the separate CLI.
```bash
Expand Down