Create a Guide/Template: Using Docker

[gregpawin]

Overview

We need to create a guide for beginner developers to setup their environments using Docker.

Action Items

• [x] Gather examples of how other projects have done it, adding each example as a link in the resources section
  • [ ] Use this template and update the contents as you go on each project (in addition to the template itself, if you find other ways to check for evidence of docker).

• [Name of Repo]
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

  • [ ] Once done, remove the "TG: Gather Examples" label and add the "TG: Draft Template" label
• [ ] Create a draft template, either in markdown format in this issue or a google doc in the Engineering google drive
  • [ ] Once done, remove the "TG: Draft Template" label and add the "TG: Create Guide" label
• [ ] Create a guide on how to use the template
  • [ ] Once done, remove the "TG: Create Guide" label and add the "TG: Review Guide" label
• [ ] Review the guide with product management communities of practice
  • [ ] Once done, remove the "TG: Review Guide" label and add the "TG: Leadership Review" label
• [ ] Present to Hack for LA leadership team for sign off
  • [ ] Once approved, remove the "TG: Leadership Review" label and add the "TG: Place Guide" label
• [ ] Possibly create an issue template on .github
  • [ ] Include link to template under resources if you add it as a template in .github

Resources

Active Projects and repos

Active without Docker documentation

311-report: No file

Active with Docker documentation

• Hack for LA's Website

  • config.docker.yml
  • docker-compose.yml
  • Readme.md (has no docker info)
  • CONTRIBUTING.md, Docker section
  • [INSTALL.md] There is no INSTALL.md file as of Jul 13 2022
  • WIKI The only instructions is this: Add local user accounts to the docker users group on Windows 10

• Food Oasis

  • Dockerfile, most recent
  • Dockerfile-jared, seems like an old test
  • docker-compose.yml
  • Deployment workflows build and deploy docker image to dockerhub on push to main and develop branch, then deploy the image to heroku in separate scripts
  • README.md: has no docker info as of 2022-02-11
  • CONTRIBUTING.md there is no contributing file as of 2022-02-11
  • INSTALL.md there is no install file as of 2022-02-14
  • WIKI: https://github.com/hackforla/food-oasis/wiki/Docker

• VRMS

  • Dockerfile
  • backend
    • Dockerfile.api
    • Dockerfile.dev
    • Dockerfile.prod
  • client
    • Dockerfile.client
    • Dockerfile.dev
    • Dockerfile.prod
  • nginx
    • Dockerfile.nginx
  • Deployment workflows
  • aws-backend-deploy.yml
  • aws-frontend-deploy.yml
  • docker-compose.yml
  • README.md: does not mention docker
  • CONTRIBUTING.md there is no contributing file as of 2022-02-14
  • INSTALL.md there is no install file as of 2022-02-14
  • WIKI

• TDM Calculator

  • Dockerfile
  • [docker-compose.yml] there is no docker-compose file as of 2022-02-14
  • docker.yaml build and push docker image on push to experimental, develop, and main branches
  • [README.md] does not mention docker
  • [CONTRIBUTING.md] points to the wiki
  • [INSTALL.md] there is no INSTALL.md file as of Jul 13 2022
  • WIKI:
  • Local Database has instructions on settin g up a local SQL Server in docker in Window/OSX/Linux, instructions on setting up the databse, and docker tips
  • Deployment has instructions on Azure deployment

• HomeUniteUs

  • [config.docker.yml] there is no config.docker.yml file as of 2022-02-11
  • .dockerignore
  • Dockerfile
  • docker-compose.yml
  • README.md, is empty as of 2022-02-11
  • [CONTRIBUTING.md] there is no contributing file as of 2022-02-11
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• BallotNav

  • [config.docker.yml] has not been checked
  • [docker-compose.yml] has not been checked
  • [docker-compose.yml] has not been checked
  • README.md backend
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• 100 Automations

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • CONTRIBUTING.md
  • WIKI: [URL] has not been checked

• Engage (its own GitHub org)

  • engage-backend

    • [config.docker.yml] has not been checked
    • [.dockerignore] has not been checked
    • [docker-compose.yml] has not been checked
    • [Dockerfile] has not been checked
    • [README.md] has not been checked
    • [CONTRIBUTING.md] has not been checked
    • [INSTALL.md] has not been checked
    • WIKI: [URL] has not been checked

  • council-portal

  • [config.docker.yml] has not been checked

  • [.dockerignore] has not been checked

  • [docker-compose.yml] has not been checked

  • [Dockerfile] has not been checked

  • [README.md] has not been checked

  • [CONTRIBUTING.md] has not been checked

  • [INSTALL.md] has not been checked

  • WIKI: [URL] has not been checked

  • engage-scraper

  • [config.docker.yml] has not been checked

  • [.dockerignore] has not been checked

  • [docker-compose.yml] has not been checked

  • [Dockerfile] has not been checked

  • [README.md] has not been checked

  • [CONTRIBUTING.md] has not been checked

  • [INSTALL.md] has not been checked

  • WIKI: [URL] has not been checked

  • engage-scheduler

  • [config.docker.yml] has not been checked

  • [.dockerignore] has not been checked

  • [docker-compose.yml] has not been checked

  • [Dockerfile] has not been checked

  • [README.md] has not been checked

  • [CONTRIBUTING.md] has not been checked

  • [INSTALL.md] has not been checked

  • WIKI: [URL] has not been checked

  • Engage-docker

  • [config.docker.yml] has not been checked

  • [.dockerignore] has not been checked

  • [docker-compose.yml] has not been checked

  • [Dockerfile] has not been checked

  • README.md has not been checked

  • [CONTRIBUTING.md] has not been checked

  • [INSTALL.md] has not been checked

  • WIKI: [URL] has not been checked

• Civic Tech Index (its own GitHub org)

  • CTI-website-frontend

  • [config.docker.yml] has not been checked

  • [.dockerignore] has not been checked

  • [docker-compose.yml] has not been checked

  • [Dockerfile] has not been checked

  • [README.md] has not been checked

  • CONTRIBUTING.md , docker section

  • [INSTALL.md] has not been checked

  • WIKI: [URL] has not been checked

  • CTI-website-backend

  • [config.docker.yml] has not been checked

  • [.dockerignore] has not been checked

  • [docker-compose.yml] has not been checked

  • [Dockerfile] has not been checked

  • README.md

  • [CONTRIBUTING.md] has not been checked

  • [INSTALL.md] has not been checked

  • WIKI: [URL] has not been checked

• Getting-started

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • Using-docker.md
  • WIKI: [URL] has not been checked

• [311 Data](https://github.com/hackforla/311-data

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Access the Data

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Civic Tech Jobs

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• [ ] Data Science Projects

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Design Systems

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Expunge-Assist (formerly known as Record Clearance)

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• GreenEarthOS

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Guides

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Internship project

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Lucky Parking

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Open Community Survey

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

• Youth Justice Nav

  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • [INSTALL.md] has not been checked
  • WIKI: [URL] has not been checked

Inactive Projects

Inactive with Docker files

• Ohana Web Search
  • ohana-api-la
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • INSTALL.md
  • WIKI: [URL] has not been checked
  • ohana-web-search-la
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • INSTALL.md
  • WIKI: [URL] has not been checked
• Spare
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • README.md
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
• Heart
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • README.md
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
  • Notes: could not find installation file
• RailStats LA aka Metro-ontime
  • performance_tracker
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md](https://github.com/metro- ontime/performance_tracker/blob/master/README.md)
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
  • railstats_api
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • README.md
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
• project-light-the-way
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
• citygram
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
• helloGov (its own GitHub org)
  • webapp
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • README.md
  • [CONTRIBUTING.md] has not been checked
  • WIKI: [URL] has not been checked
• Shared Housing
  • [config.docker.yml] has not been checked
  • [.dockerignore] has not been checked
  • [docker-compose.yml] has not been checked
  • [Dockerfile] has not been checked
  • [README.md] has not been checked
  • [CONTRIBUTING.md] has not been checked

  • WIKI: [URL] has not been checked

Draft Template(incomplete):

• Docker Template Guide Draft
• Ops Google Drive folder for Docker Guide

Errors and Fixes

-Error: hfla_site | <internal:/usr/local/lib/ruby/site_ruby/3.1.0/rubygems/core_ext/kernel_require.rb>:85:in `require': cannot load such file -- webrick (LoadError) -Fix: Go to docker-compose.yml and change the image (line 4) to hackforlaops/ghpages:latest. Do NOT commit changes! (error may soon be fixed)

[ExperimentsInHonesty]

@Zak234 I think you might have created this draft template in your own google drive. Please move it to the engineering community of practice shared drive

Current file: https://docs.google.com/document/d/16Mp3rsEmMFKL6K7FXFbyT3Fqgs0hIreUBU3V0mhGrPs/edit# Folder where I want you to put the file: https://drive.google.com/drive/folders/1divwsyL2KXENBXhzqw3uodCjvpibVTop?usp=sharing

[ExperimentsInHonesty]

bumping this back into your inbox @Zak234 I think you might have created this draft template in your own google drive. Please move it to the engineering community of practice shared drive

Current file: https://docs.google.com/document/d/16Mp3rsEmMFKL6K7FXFbyT3Fqgs0hIreUBU3V0mhGrPs/edit# Folder where I want you to put the file: https://drive.google.com/drive/folders/1divwsyL2KXENBXhzqw3uodCjvpibVTop?usp=sharing

[ExperimentsInHonesty]

send him another email, will send a text message if he does not respond.

[ExperimentsInHonesty]

The next steps for this guide:

• [ ] Guides team to clean up the last contributor gathering of examples so that it makes sense to the next person who picks up this guide
• [ ] Make sure each team has been surveyed (they have not). Once this is done the gather step will be complete
• [ ] Then review the existing draft of the guide and go check the other projects to see how they are using docker and write up a document that explains each project's use of it (you can group them by way they are using it).
• [ ] Put the guide template format
• [ ] Finish writing the instructions
• [ ] Find a team to test it with
• [ ] Test it.

You will need lots of mentorship on this project, don't hesitate to ask for it both from the Engineering & Devops Communities of Practice and if you really need it, reach out to bonnie@hackforla.org as a last resort

[ExperimentsInHonesty]

Checking to see if all the current projects are on this issue

• [x] 100 Automations
• [ ] 311 Data
• [ ] Access the Data
• [x] BallotNav
• [ ] Brigade Organizer's Playbook
• [x] Civic Tech Index
• [ ] Civic Tech Jobs
• [ ] Civic Tech Structure
• [ ] Data Science Projects
• [ ] Design Systems
• [x] Engage
• [ ] Expunge-Assist (formerly known as Record Clearance)
• [x] Food Oasis
• [ ] GreenEarthOS
• [ ] Guides
• [x] HomeUniteUs
• [ ] Internship project
• [ ] Lucky Parking
• [ ] Open Community Survey
• [x] TDM Calculator
• [x] VRMS
• [x] Hack for LA's Website
• [ ] Youth Justice Nav

[Neecolaa]

The ops team does not have access to the draft template which is in the engineering google drive.

[nyarly]

I was just looking for something like this. A containerization contract would be hugely valuable from a devops perspective. Is anyone moving this one along?

[ExperimentsInHonesty]

@Zak234 if you are not working on this, please unassign yourself. If you are working on it, please move it to in progress