Merge pull request #103 from DMTF/Docker-File

Added Dockerfile to allow the emulator to run as a Docker container

Author: mraineri

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3-slim
+
+# For healthcheck
+RUN apt-get update && apt-get install curl -y
+
+# Install python requirements
+COPY requirements.txt /tmp/
+RUN pip install --upgrade pip && \
+    pip install --no-cache-dir -r /tmp/requirements.txt
+
+# Copy server files
+COPY . /usr/src/app/.
+
+# Env settings
+EXPOSE 5000
+HEALTHCHECK CMD curl --fail http://127.0.0.1:5000/redfish/v1/ || exit 1
+WORKDIR /usr/src/app
+ENTRYPOINT ["python", "emulator.py"]

README.md

@@ -29,9 +29,30 @@ The 'pip' command can be used to install the environment.
 The 'pip freeze' command can be used to display the installed packages and their revision.
 
 ### Cloud
+
 The required python packages for a Cloud Foundry environment are listed in the file **./requirements.txt**.  The file lists the Python package, without the revision.
 The packages will be installed automatically during invocation.
 
+### Docker
+
+Use one of these actions to pull or build the container:
+
+* Pull the container from Docker Hub:
+
+    ```bash
+    docker pull dmtf/redfish-interface-emulator:latest
+    ```
+* Build a container from local source:
+
+    ```bash
+    docker build -t dmtf/redfish-interface-emulator:latest.
+    ```
+* Build a container from GitHub:
+
+    ```bash
+    docker build -t dmtf/redfish-interface-emulator:latest https://github.com/DMTF/Redfish-Interface-Emulator.git
+    ```
+
 ## Invocation
 
 ### Standalone
@@ -50,6 +71,14 @@ The **foundry-app-name** determines the URL for the Redfish service.
 
 The cloud foundry makes use of the following files: requirements.txt, runtime.txt, and Profile. So they should exists in the same directory as emulator.py.
 
+### Docker
+
+This command runs the container with the built-in mockup:
+
+```bash
+docker run --rm dmtf/redfish-interface-emulator:latest
+```
+
 ## Configuring the Emulator
 The behavior of the emulator can be control via command line flags or property values in emulator-config.json.
 
@@ -272,7 +301,10 @@ To use, point a brower to the URI **http://localhost:5000/browse.html**
 
 ## Release Process
 
-1. Update `CHANGELOG.md` with the list of changes since the last release
-2. Update the `__version__` variable in `api_emulator/version.py` to reflect the new tool version
-3. Push changes to Github
-4. Create a new release in Github
+Run the `release.sh` script to publish a new version.
+
+```bash
+sh release.sh <NewVersion>
+```
+
+Enter the release notes when prompted; an empty line signifies no more notes to add.

release.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# Collect change log info
+CHANGES="## [$1] - $(date +'%Y-%m-%d')"$'\n'
+echo "Enter changes:"
+while : ; do
+    read CHANGE
+    if [ "$CHANGE" = "" ]; then
+        break
+    fi
+
+    CHANGES="$CHANGES- $CHANGE"$'\n'
+done
+
+# Rebase
+git checkout master
+git fetch && git rebase origin
+
+# Update the version number in api_emulator/version.py
+sed -i -E 's/__version__ = .+/__version__ = '\'$1\''/' api_emulator/version.py
+
+# Update the change log file
+ex CHANGELOG.md <<eof
+3 insert
+$CHANGES
+.
+xit
+eof
+
+# Commit and push changes
+git add CHANGELOG.md api_emulator/version.py
+git commit -m "$1 versioning"
+git push origin master
+
+# Make new release in GitHub
+CHANGES="Changes since last release:"$'\n\n'"$CHANGES"
+gh release create $1 -n "$CHANGES"
+