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

Describe why+how to build new stackstorm image #127

Merged
merged 2 commits into from
May 1, 2018
Merged
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
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,22 +79,31 @@ Second, start the docker environment. execute

This will pull the required images from docker hub, and then start them.

However, if you find need to modify the stackstorm image, you will need to build it. Run:
To stop the docker environment, run:

```
REPO=stable
docker build --build-arg ST2_REPO=${REPO} -t stackstorm/stackstorm:${REPO} images/stackstorm
docker-compose down
```

where REPO is one of 'stable', 'unstable', 'staging-stable', 'staging-unstable'. Otherwise,
the following `docker-compose` command will download the specified image from docker hub.
## Building the stackstorm image

To stop the docker environment, run:
The pre-built `stackstorm/stackstorm` image may not meet your requirements. You may need to install
additional libraries, packages or files into the image. For example, if you want to install the
Ansible pack, you must first install the `libkrb5-dev` package. While the package could be installed
using a script in `/st2-docker/entrypoint.d`, this will increase the startup time of the container
and may result in containers that execute different code than others.

Make any necessary changes to `images/stackstorm/Dockerfile`. For example, append `libkrb5-dev` to
the first `apt-get install` command. Next, run:

```
docker-compose down
REPO=stable
docker build --build-arg ST2_REPO=${REPO} -t stackstorm/stackstorm:${REPO} images/stackstorm
```

where REPO is one of 'stable', 'unstable', 'staging-stable', 'staging-unstable'. Otherwise,
the following `docker-compose` command will download the specified image from docker hub.


### Getting started: Simple Tutorial Tour

Expand Down Expand Up @@ -208,6 +217,7 @@ You can bind mount these scripts as mentioned in the previous section.

NOTE: These scripts are currently not available when running in 1ppc mode.


## To enable chatops

Chatops is installed in the `stackstorm` image, but not started by default.
Expand Down