simplifications, fixes to make it work

docker/Dockerfile.pushmi_pullyu.development → Dockerfile

@@ -3,12 +3,12 @@
 
 FROM ruby:2.3.4
 
-WORKDIR /app/ 
+RUN mkdir /app
+WORKDIR /app
 
 ADD Gemfile /app/
 ADD pushmi_pullyu.gemspec /app/
-ADD lib/pushmi_pullyu/version.rb /app/lib/pushmi_pullyu/version.rb
 ADD . /app
-RUN bundle install
+RUN cd /app && bundle install
 
 CMD ["bundle", "exec", "pushmi_pullyu", "start", "-C", "/app/docker/files/pushmi_pullyu_config_docker.yml"]

docker/README.md

@@ -11,23 +11,23 @@ This directory contains the apparatus to create a Docker Container for the [Push
 
 ## Requirements
 
-* [Docker](https://docs.docker.com/engine/installation/) - tested with version 17.05 
+* [Docker](https://docs.docker.com/engine/installation/) - tested with version 17.05
 * [Docker Compose](https://docs.docker.com/compose/install/) - tested with version 1.13
 
 
 
 ## In this Docker Container
 
-A minimalistic, as simple as possible but no simpler container. 
+A minimalistic, as simple as possible but no simpler container.
 
 ### Development Environment Docker Container
 
 * base off Ruby Docker image
-* shared code directory between host and container 
+* shared code directory between host and container
 * start pushmi_pullyu at start-up
 
 
-### Production Environment Docker Container 
+### Production Environment Docker Container
 
 * base off Ruby Docker image
 * pull from RubyGems
@@ -48,44 +48,37 @@ Goal: Development environment for Pushmi-Pullyu where the codebase on the host i
 2. Clone the [HydraNorth](https://github.com/ualbertalib/HydraNorth/) GitHub repository
     * purpose: use to mount volume for HydraNorth docker container
 
-3. Copy example `.env-hydranorth_example` to `.env-hydranorth` and update with environment variables
-    * LOCAL_SRC_PATH: location of codebase in step #2.
-    * EZID_PASSWORD: EZID password. 
+3. Update environment variables inside docker-compose-development.yml file.  These environment variables are defined in `pushmi_pullyu_config_docker.yml`.
 
-4. Copy example `.env-pushmi_pullyu` to `.env-pushmi_pullyu` and update with environment variables. These environment variables are defined in `pushmi_pullyu_config_docker.yml`. Defaults will work except for the following:
-    * FEDORA_USER
-    * FEDORA_PASS
-    * **Warning:** without REDIS_URL, rspec test fail as they assume Redis runs on localhost. [Reference](https://github.com/redis/redis-rb).
-
-5. Run Docker Compose 
+4. Run Docker Compose
     * Development:
-      * docker-compose -f docker/docker-compose-development.yml up -d 
+      * docker-compose -f docker/docker-compose-development.yml up -d
         * or without `-d` if one want the interactive mode where ctrl-c will shutdown the containers
 
-6. Enter the `HydraNorth` container and update the `/etc/redis/redis.conf` with `bind 127.0.0.1 hydra-north` and restart `redis` (to bind Redis to an interface reachable via another container on the same network i.e., bind to interface other than localhost).
+5. Enter the `HydraNorth` container and update the `/etc/redis/redis.conf` with `bind 127.0.0.1 hydra-north` and restart `redis` (to bind Redis to an interface reachable via another container on the same network i.e., bind to interface other than localhost).
     * Note: restarting `redis` might require `kill -kill` if `service redis-server restart` fails
     * `docker exec -it docker_hydranorth_1 bash`
     * reference: [GitHub issue](https://github.com/ualbertalib/di_docker_hydranorth/issues/12)
 
-7. Test redis by entering the `pushmi-pullyu` container and inspect the pushmi-pullyu log `/app/log/pushmi_pullyu.log` or try the command `telnet hydranorth 6379`
+6. Test redis by entering the `pushmi-pullyu` container and inspect the pushmi-pullyu log `/app/log/pushmi_pullyu.log` or try the command `telnet hydranorth 6379`
     * `docker exec -it docker_pushmi-pullyu_1 bash`
     * note: networking setup by docker compose allows referencing containers by their service names as defined in the `docker-compose-development.yml` file
 
-8. Within the Pushmi-Pullyu container: to start the daemon
+7. Within the Pushmi-Pullyu container: to start the daemon
     * `bundle exec pushmi_pullyu start -C docker/files/pushmi_pullyu_config_docker.yml`
     * `pushmi_pullyu start -C docker/files/pushmi_pullyu_config_docker.yml`
 
-9. Within the Pushmi-Pullyu container: to run tests:
-   * `rspec` 
+8. Within the Pushmi-Pullyu container: to run tests:
+   * `rspec`
 
 
 #### Notes:
 
 * Within a container, the following DNS entries are available: swift, hydranorth, pushmi-pullyu (e.g., ping swift)
-* From outside the container, access either via: 
-  * Mapped ports to the host as defined in `docker-compose-development.yml` 
+* From outside the container, access either via:
+  * Mapped ports to the host as defined in `docker-compose-development.yml`
     * E.g., `http://localhost:3000`
-  * `container_IP` 
+  * `container_IP`
     * E.g., `http://172.18.0.3:3000` (IP is a sample)
 
 
@@ -104,20 +97,20 @@ Goal: like option #1 but using only two containers: one for HydraNorth and the o
 
 3. Copy example `.env-hydranorth_example` to `.env-hydranorth` and update with environment variables
     * LOCAL_SRC_PATH: location of codebase in step #2.
-    * EZID_PASSWORD: EZID password. 
+    * EZID_PASSWORD: EZID password.
 
 4. Copy example `.env-pushmi_pullyu` to `.env-pushmi_pullyu` and update with environment variables. These environment variables are defined in `pushmi_pullyu_config_docker.yml`. Defaults will work except for the following:
     * FEDORA_USER
     * FEDORA_PASS
 
-5. Run Docker Compose 
+5. Run Docker Compose
     * Development:
-      * docker-compose -f docker/docker-compose-development-hydranorth.yml up -d 
+      * docker-compose -f docker/docker-compose-development-hydranorth.yml up -d
         * or without `-d` if one want the interactive mode where ctrl-c will shutdown the containers
       * `app_pushmi-pullyu` application directory
 
 6. Run tests
-    * `docker exec -it docker_hydranorth_1  sh -c "cd /app_pushmi-pullyu; bundle install; rspec;"` 
+    * `docker exec -it docker_hydranorth_1  sh -c "cd /app_pushmi-pullyu; bundle install; rspec;"`
 
 
 
@@ -130,18 +123,18 @@ First usage:
 1. Clone the [Pushmi-Pullyu](https://github.com/ualbertalib/pushmi_pullyu/) GitHub repository
 
 2. Acquire the Docker image in one of two ways:
-    1. Download the prebuilt images from [ualibraries DockerHub](https://hub.docker.com/r/ualibraries/) 
+    1. Download the prebuilt images from [ualibraries DockerHub](https://hub.docker.com/r/ualibraries/)
         * Development
           * `docker pull ualibraries/pushmi-pullyu:development_x.x`
-        * Production 
+        * Production
           * `docker pull ualibraries/pushmi-pullyu:production_x.x`
-    2. Build from `Dockerfile` definition in [Pushmi-pullyu GitHub repo](https://github.com/ualbertalib/pushmi_pullyu/docker) 
+    2. Build from `Dockerfile` definition in [Pushmi-pullyu GitHub repo](https://github.com/ualbertalib/pushmi_pullyu/docker)
         * Development:
-          * `docker build -t ualibraries/pushmi_pullyu:development_x.x -f Dockerfile.pushmi_pullyu.development .` 
+          * `docker build -t ualibraries/pushmi_pullyu:development_x.x -f Dockerfile.pushmi_pullyu.development .`
         * Production:
-          * `docker build -t ualibraries/pushmi_pullyu:production_x.x -f Dockerfile.pushmi_pullyu.production .` 
+          * `docker build -t ualibraries/pushmi_pullyu:production_x.x -f Dockerfile.pushmi_pullyu.production .`
 
-3. Run the Docker image 
+3. Run the Docker image
     * Development:
       * `docker run -d -v $PUSHMI_PULLYU_DIR:/mnt --name pushmi_pullyu ualibraries/pushmi_pullyu:development`
     * Production:
@@ -162,22 +155,22 @@ After initial `docker run`:
 
 1. Clone the [Pushmi-Pullyu](https://github.com/ualbertalib/pushmi_pullyu/) GitHub repository
 
-2. Grab the prebuilt images from [ualibraries DockerHub](https://hub.docker.com/r/ualibraries/) 
+2. Grab the prebuilt images from [ualibraries DockerHub](https://hub.docker.com/r/ualibraries/)
     * Development
-      * docker-compose -f docker/docker-compose-development.yml pull 
-    * Production 
+      * docker-compose -f docker/docker-compose-development.yml pull
+    * Production
       * docker-compose -f docker/docker-compose-production.yml pull
 
-3. Run the Docker Compose 
+3. Run the Docker Compose
     * Development:
-      * docker-compose -f docker/docker-compose-development.yml up -d 
+      * docker-compose -f docker/docker-compose-development.yml up -d
     * Production:
-      * docker-compose -f docker/docker-compose-production.yml up -d 
+      * docker-compose -f docker/docker-compose-production.yml up -d
 
 
 **[ToDo] possibly wrong**
 From inside the clone of the GitHub pushmi-pullyu/docker directory
-  * `docker-compose up` to start the container (i.e., pushmi-pullyu stack) 
+  * `docker-compose up` to start the container (i.e., pushmi-pullyu stack)
   * **ToDo** does one need to be inside the directory or is this dependent on the .env file? "Compose supports declaring default environment variables in an environment file named .env placed in the folder where the docker-compose command is executed (current working directory)." [reference](https://docs.docker.com/compose/env-file/)
 
 
@@ -198,30 +191,30 @@ Start a docker container and execute `bash` within container allowing user to te
 
 ## Maintenance
 
-### Updating Docker Hub 
+### Updating Docker Hub
 
 **ToDo: need to flesh-out details**
 
 University of Alberta maintains a Docker Hub repository at https://hub.docker.com/r/ualibraries. Two tagged Docker images are registered with Docker Hub:
 
-1. Development 
+1. Development
     * ualibraries/pushmi_pullyu:development_x.x
-2. Production 
+2. Production
     * ualibraries/pushmi_pullyu:production_x.x
 
-#### To update the Docker Hub repository: 
+#### To update the Docker Hub repository:
 
 1. name your local using the `ualibraries` username and the repository name [reference](https://docs.docker.com/docker-hub/repos/#pushing-a-repository-image-to-docker-hub)
     * Development:
-      * `docker build -t ualibraries/pushmi_pullyu:development_x.x -f Dockerfile.pushmi_pullyu.development .` 
+      * `docker build -t ualibraries/pushmi_pullyu:development_x.x -f Dockerfile.pushmi_pullyu.development .`
     * Production:
-      * `docker build -t ualibraries/pushmi_pullyu:production_x.x -f Dockerfile.pushmi_pullyu.production .` 
+      * `docker build -t ualibraries/pushmi_pullyu:production_x.x -f Dockerfile.pushmi_pullyu.production .`
 
 2. push to the Docker Hub registry - `docker push <hub-user>/<repo-name>:<tag>`
     * Development:
-      * `docker push ualibraries/pushmi_pullyu:development_x.x` 
+      * `docker push ualibraries/pushmi_pullyu:development_x.x`
     * Production:
-      * `docker push ualibraries/pushmi_pullyu:production_x.x` 
+      * `docker push ualibraries/pushmi_pullyu:production_x.x`
 
 
 
@@ -230,15 +223,15 @@ University of Alberta maintains a Docker Hub repository at https://hub.docker.co
 To upgrade to a newer release of Pushmi-Pullyu (applicable in the `production` container as the `development` container leverages a local codebase):
 
 * download the updated Docker image:
-  * `docker pull ualibraries\pushmi_pullyu:${production_x.x|development_x.x}` 
+  * `docker pull ualibraries\pushmi_pullyu:${production_x.x|development_x.x}`
 
 * stop currently running image:
-  * `docker stop ${container_id}` 
+  * `docker stop ${container_id}`
 
 * Removed the stopped container:
-  * `docker rm -v ${container_id}` 
+  * `docker rm -v ${container_id}`
 
-* Start the updated Docker image: 
+* Start the updated Docker image:
   * `docker run ...`
 
 

docker/docker-compose-development.yml

@@ -1,34 +1,40 @@
 # Docker Compose for a development version of Pushmi-Pullyu
-# 
+#
 version: '3'
 
 services:
   hydranorth:
     image: "ualibraries/hydra_north:deb"
-    env_file:
-      - .env-hydranorth
-    volumes: 
+    environment:
+      - LOCAL_SRC_PATH=$HOME/dev/HydraNorth
+      - EZID_PASSWORD=changeme
+    volumes:
       # di_docker_hydranorth expects codebase in `app` within the container
-      - ${LOCAL_SRC_PATH:-../../HydraNorth}:/app
+      - ${LOCAL_SRC_PATH}:/app
     ports:
       - "3000:3000"
       - "8983:8983"
 
-  swift: 
+  swift:
     image: "ualibraries/swift_dev"
+    environment:
+      - LOCAL_SWIFT_STORAGE=$HOME/.swift
+    ports:
+      - "8080:8080"
 
   pushmi-pullyu:
-    # assumes GitHup repo clone & run `docker-compose up` from repo root
-    # `..` context changes to `docker` dir, change to root of repo
-    build: 
-      context: ..
-      dockerfile: ./docker/Dockerfile.pushmi_pullyu.development
-    env_file:
-      - .env-pushmi_pullyu
-    volumes: 
-      - ..:/app
+    image: "ualibraries/pushmi_pullyu"
+    environment:
+      - REDIS_HOST=hydranorth
+      - REDIS_URL=redis://hydranorth:6379
+      - SOLR_HOST=hydranorth
+      - FEDORA_HOST=hydranorth
+      - FEDORA_USER=fedoraAdmin
+      - FEDORA_PASS=fedoraAdmin
+      - SWIFT_ENDPOINT=http://swift:8080
     depends_on:
       - swift
+      - hydranorth
     stdin_open: true # help debug: keep STDIN open even if not attached
     tty: true # help debug: Allocate a pseudo-TTY
 

docker/docker-compose-production.yml

@@ -5,16 +5,20 @@ services:
 
   hydranorth:
     image: "ualibraries/hydra_north:deb"
-    env_file:
-      - .env-hydranorth
+    environment:
+      - LOCAL_SRC_PATH=$HOME/dev/HydraNorth
+      - EZID_PASSWORD=changeme
     volumes:
       # di_docker_hydranorth expects codebase in `app` within the container
-      - ${LOCAL_SRC_PATH:-../../HydraNorth}:/app
+      - ${LOCAL_SRC_PATH}:/app
 
   swift:
     image: "ualibraries/swift_dev"
+    environment:
+      - LOCAL_SWIFT_STORAGE=$HOME/.swift
 
   pushmi-pullyu:
     image: "ualibraries/pushmi_pullyu:production"
     depends_on:
       - swift
+      - hydranorth