Merge pull request #325 from CodeForPhilly/features/bindable-habitat

Bindable Habitat deploy option

Author: themightychris

docs/SUMMARY.md

@@ -12,6 +12,7 @@
   - [Release Process](./operations/release-process.md)
   - [The `chime-live` Cluster](./operations/chime-live-cluster.md)
   - [Deploy to Heroku](./operations/heroku.md)
+  - [Deploy with Chef Habitat](./operations/habitat.md)
   - [Deploy to Your Own Cluster](./operations/byok8s.md)
   - [Manual Validation](./operations/manual-validation.md)
   - [Limited Cluster Access for Deployment](./operations/limited-kubeconfigs/limited-kubeconfigs.md)

docs/operations/habitat.md

@@ -0,0 +1,41 @@
+# Operations: Deploy with Chef Habitat
+
+CHIME can be quickly deployed to any Linux system with [Chef Habitat](https://habitat.sh):
+
+```bash
+hab svc load codeforphilly/chime
+```
+
+This will download the latest CHIME build from [bldr.habitat.sh](bldr.habitat.sh) and start it as a service, serving the interface on the default port of [`8000`](http://localhost:8000)
+
+## Enable HTTPS access
+
+Providing HTTPS access can be easily done by making use of [Caddy](https://caddyserver.com/) and its built-in automatic HTTPS.
+
+First, start the `jarvus/caddy-proxy` service with your CHIME service instance bound to the `backend` slot:
+
+```bash
+hab svc load jarvus/caddy-proxy --bind backend:chime.default
+```
+
+This will open an HTTP interface on port `80` that proxies to the CHIME service on port `8000`.
+
+To enable the HTTPS interface, configure an email address and at least one publicly-resolvable hostname so that Caddy can use [Let's Encrypt](https://letsencrypt.org/) to automatically obtain a free SSL certificate:
+
+```bash
+mkdir -p /hab/user/caddy-proxy/config
+
+# use the editor of your choice:
+vim /hab/user/caddy-proxy/config/user.toml
+```
+
+```toml
+hostnames = [
+    "mydomain.org"
+]
+
+[tls]
+email = "[email protected]"
+```
+
+After you save `user.toml`, the Habitat supervisor will automatically detect the change and apply it. CHIME should now be available via HTTPS, with the HTTP port automatically redirecting.

habitat/README.md

@@ -1,15 +1,19 @@
-## Habitat Service Package for CHIME
+# Habitat Service Package for CHIME
+
 This package can be used to run CHIME as a fully self-contained application.
 See https://habitat.sh for more details.
 
-### Examples
+## Examples
+
 Quickstart With Docker "Shim" Container:
-```
-docker run -it -p 8000:8000 bixu/hab hab sup run "bixu/chime" --channel="unstable"
+
+```bash
+docker run -it -p 8000:8000 bixu/hab hab sup run "codeforphilly/chime" --channel="unstable"
 ```
 
 Local Prototyping Example:
-```
+
+```bash
 set -e
 curl --silent "https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh" | sudo bash -s
 hab cli setup
@@ -20,7 +24,8 @@ hab sup run $HAB_ORIGIN/chime --channel="unstable"
 ```
 
 Complete `systemd` Bootstrap Example:
-```
+
+```bash
 echo 'HAB_AUTH_TOKEN="<enter your token from https://bldr.habitat.sh/#/profile>"
 HAB_LICENSE="accept"
 HAB_NONINTERACTIVE="true"
@@ -50,5 +55,5 @@ sudo systemctl restart supervisor
 sudo groupadd hab || true
 sudo useradd --system --gid hab hab || true
 
-sudo hab svc load "bixu/chime" --channel="unstable"
-```
+sudo hab svc load "codeforphilly/chime" --channel="unstable"
+```

habitat/config/.streamlit/config.toml

@@ -1,4 +1 @@
-[server]
-enableCORS = false
-headless = true
-port = 8000
+{{toToml cfg.streamlit}}

habitat/default.toml

@@ -0,0 +1,4 @@
+[streamlit.server]
+enableCORS = false
+headless = true
+port = 8000

habitat/plan.sh

@@ -1,7 +1,6 @@
-pkg_origin="bixu"
+pkg_origin="codeforphilly"
 pkg_name="chime"
-pkg_version="0.1.0"
-pkg_maintainer="Blake Irvin <[email protected]>"
+pkg_maintainer="Code for Philly <[email protected]>"
 pkg_license=('MIT')
 pkg_deps=(
   "core/python"
@@ -17,19 +16,52 @@ pkg_bin_dirs=(
 )
 pkg_svc_user="root"
 
-do_prepare() {
-  if ! ls "/etc/sudoers" &> "/dev/null"
-  then
-    echo "root ALL=(ALL)  ALL" >> "/etc/sudoers"
+pkg_exports=(
+  [port]=streamlit.server.port
+)
+
+pkg_version() {
+  if [ -n "${pkg_last_tag}" ]; then
+    if [ ${pkg_last_tag_distance} -eq 0 ]; then
+      echo "${pkg_last_version}"
+    else
+      echo "${pkg_last_version}-git+${pkg_last_tag_distance}.${pkg_commit}"
+    fi
+  else
+    echo "${pkg_last_version}-git.${pkg_commit}"
   fi
+}
+
+do_before() {
+  do_default_before
+
+  # configure git repository
+  export GIT_DIR="${PLAN_CONTEXT}/../.git"
+
+  # load version information from git
+  pkg_commit="$(git rev-parse --short HEAD)"
+  pkg_last_tag="$(git describe --tags --abbrev=0 ${pkg_commit} || true 2>/dev/null)"
+
+  if [ -n "${pkg_last_tag}" ]; then
+    pkg_last_version=${pkg_last_tag#v}
+    pkg_last_tag_distance="$(git rev-list ${pkg_last_tag}..${pkg_commit} --count)"
+  else
+    pkg_last_version="0.0.0"
+  fi
+
+  # initialize pkg_version
+  update_pkg_version
+}
+
+do_prepare() {
   python -m venv "${pkg_prefix}"
   source "${pkg_prefix}/bin/activate"
-  pip install --upgrade --force-reinstall "pip" "wheel"
+  pip install --upgrade --force-reinstall "pip" "wheel" "setuptools"
   return $?
 }
 
 do_build() {
-  pip install -r ${PLAN_CONTEXT}/../requirements.txt
+  pip install ${PLAN_CONTEXT}/../
   return $?
 }