aa49cb1cfe
* Move from Alpine Linux to Fedora Linux. This changes the base container image away from Alpine Linux to Fedora Linux to address some musl libc issues with some of our gems. It also moved the main file to a Containerfile and symlinks the Dockerfile to it. This makes our container setup less Docker-centric as Linux users most likely will be using Podman as their container runtime. Lastly, it moves the WORKDIR from /usr/src/app to /opt/apps/devto. The Linux FHS states that /opt is the spot for Optional application software packages and /usr/src is for kernel source code. https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard /opt Optional application software packages /usr/src Source code, e.g., the kernel source code with its header files. Also, if SELinux becomes a thing in our future, moving this makes it easier to manage contexts out of /opt rather than /usr/src. * Adjust the Containerfile a bit to add some missing packages, make it more generic and move env vars to the docker-compose. * Move the Dockerfile to a symlink to the Containerfile. We need to be able to support more than just Docker for a container runtime. Moving everything to a Containerfile and symlinking the Dockerfile helps users run runtimes such as Podman. * Add in new entrypoint files and fix the app path in docker-entrypoint.sh * Refactor the docker-compose.yml file so it doesn't build the main application container three times in a row. We can use the same container for web, webpacker, and sidekiq. Also make the volume names very explicit on what their contents and add in SELinux context support with :Z * Fix ELASTICSEARCH_URL. * Remove the absolute path on ip binary and add in iproute to Containerfile. * Symlink the Dockerfile to Containerfile and add in a container-compose.yml file for usage with podman-compose. We are waiting for this issue to get resolved https://github.com/containers/libpod/issues/6153 and for podman-compose to mature a bit more. A user using podman-compose can use podman-compose -f container-compose.yml to launch the DEV container stack with Podman. * Update the .gitignore file to reflect the new container volumes. * Fix the entrypoint script on the Containerfile and clean up a bunch of things. * Rework the Containerfile to prep it to run as a non-root user. We have to wait for this issue to get fixed: https://github.com/containers/libpod/issues/6153 for Linux users and then we can uncomment the USER line so we are running Rails as a non-root user. :toot: * This reworks the compose files so each task that is needed to start the app has a correct wait command with dockerize. It also adds in containers for doing yarn and bundle things for development. Since we mount the code directory inside the container we lose our pre-containerized gems and node_modules. This means users can run: Linux podman-compose -f container-compose.yml up Mac docker-compose up and it should correctly build the app stack with containers! * Clean up old container related things. * Add in some container pre-reqs and my name to the "Core team" section! :toot: * Adjust the seed and sidekiq compose entries so they do not use the web entrypoint and set the REDIS_URL and REDIS_SESSIONS_URL env vars for seed. Add in some echos to the entrypoint.sh. Also set docker-compose to use :delegated on mount points to speed things up. https://docs.docker.com/storage/bind-mounts/#configure-mount-consistency-for-macos * Just call yarn install --dev on the yarn container. * Update documentation to support Docker and Podman as Container Engines and move the page from docker to containers to reflect the fact not all users run their containers via Docker. There are dozens of us... DOZENS! * Set --local on bundle config so it just impacts this Ruby app. * Renamed bin/docker-setup to bin/container-setup to reflect the fact that that we can use Podman as a container engine. I also refactored it so it does some basic pre-flight checks for docker and docker-compose or podman and podman-compose to make sure users have a container engine installed. * Set cache_all_platforms true for bundler. * Bump docker-compose dockerize -timeout to 45min for slower macOS hardware. * Move to the consolidated app_initializer:setup rake task for bootstrapping the app. * Update docs/installation/readme.md
117 lines
4.4 KiB
Markdown
117 lines
4.4 KiB
Markdown
---
|
|
title: Containers
|
|
---
|
|
|
|
# Installing DEV using Containers
|
|
|
|
If you encounter any errors with our Container setup, please kindly
|
|
[report any issues](https://github.com/thepracticaldev/dev.to/issues/new/choose)!
|
|
|
|
## Installing prerequisites
|
|
|
|
_These prerequisites assume you're working on an operating system supported by
|
|
Docker or Podman._
|
|
|
|
### Choosing a Container Engine
|
|
|
|
A container engine is software that runs and manages containers on a computer.
|
|
One of the most widely known Container Engines is Docker, but there are many
|
|
other Container Engines available, such as [Podman](https://podman.io/), [CRI-O](https://cri-o.io/), and [LXD](https://linuxcontainers.org/lxd/introduction/).
|
|
|
|
DEV supports two Container Engines: Docker and Podman.
|
|
|
|
### Docker
|
|
|
|
DEV can be setup with Docker and Docker Compose on macOS or Linux systems.
|
|
|
|
Docker is available for many different operating systems. You may use Docker as your Container Engine on both macOS and Linux workstations. As of right now Docker is the only Container Engine for macOS and we recommend you follow the [Docker Desktop on Mac](https://docs.docker.com/docker-for-mac/install/),
|
|
install instructions to get Docker and Docker Compose installed.
|
|
|
|
Docker also works well on Linux distributions that have not moved to cgroup v2.
|
|
You can install it by following their [Installation per distro](https://docs.docker.com/engine/install/)
|
|
to get Docker and you can install Docker Compose by following these
|
|
[instructions](https://docs.docker.com/compose/install/).
|
|
|
|
### Podman
|
|
|
|
DEV can be setup with Podman and Podman Compose on Linux systems.
|
|
|
|
[Podman](https://podman.io/) is an FOSS project that provides a Container Engine
|
|
that is daemonless which only runs on Linux systems. It can be run as the root
|
|
user or as a non-privileged user. It also provides a Docker-compatible
|
|
command line interface. Podman is available on many different Linux distributions
|
|
and it can be installed by following these [instructions](https://podman.io/getting-started/installation).
|
|
|
|
[Podman Compose](https://github.com/containers/podman-compose) is a an early
|
|
project under development that is implementing docker-compose like experience
|
|
with Podman. You can install it by following these [instructions](https://github.com/containers/podman-compose#installation).
|
|
|
|
## Setting up DEV
|
|
|
|
1. Fork DEV's repository, e.g. <https://github.com/thepracticaldev/dev.to/fork>
|
|
1. Clone your forked repository, eg.
|
|
`git clone https://github.com/<your-username>/dev.to.git`
|
|
1. Set up your environment variables/secrets
|
|
|
|
- Take a look at `Envfile`. This file lists all the `ENV` variables we use
|
|
and provides a fake default for any missing keys.
|
|
- The [backend guide](/backend) will show you how to get free API keys for
|
|
additional services that may be required to run certain parts of the app.
|
|
- For any key that you wish to enter/replace:
|
|
|
|
1. Create `config/application.yml` by copying from the provided template
|
|
(i.e. with bash:
|
|
`cp config/sample_application.yml config/application.yml`). This is a
|
|
personal file that is ignored in git.
|
|
1. Obtain the development variable and apply the key you wish to
|
|
enter/replace. i.e.:
|
|
|
|
```shell
|
|
GITHUB_KEY: "SOME_REAL_SECURE_KEY_HERE"
|
|
GITHUB_SECRET: "ANOTHER_REAL_SECURE_KEY_HERE"
|
|
```
|
|
|
|
- You do not need "real" keys for basic development. Some features require
|
|
certain keys, so you may be able to add them as you go.
|
|
|
|
## Running DEV with Docker via docker-compose
|
|
|
|
1. Run `bin/container-setup`
|
|
2. That's it! Navigate to <http://localhost:3000>
|
|
|
|
The script executes the following steps:
|
|
|
|
1. `docker-compose build`
|
|
2. `docker-compose up`
|
|
|
|
## Running DEV with Podman via podman-compose
|
|
|
|
1. Run `bin/container-setup`
|
|
2. That's it! Navigate to <http://localhost:3000>
|
|
|
|
The script executes the following steps:
|
|
|
|
1. `podman-compose build`
|
|
2. `podman-compose up`
|
|
|
|
## Known Problems & Solutions
|
|
|
|
### Docker on Mac
|
|
|
|
- Should you experience problems with the Elasticsearch container, try to
|
|
increase the memory and/or swap allocation for Docker. On macOS this can be
|
|
done via the GUI:
|
|
|
|
|
|
|
|
- In case `rails server` doesn't start with the following message:
|
|
|
|
```
|
|
Data update scripts need to be run before you can start the application. Please run rails data_updates:run (RuntimeError)
|
|
```
|
|
|
|
run the following command:
|
|
|
|
```shell
|
|
docker-compose run web rails data_updates:run
|
|
```
|