Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mozilla-services/Dockerflow
Cloud Services Dockerflow specification
https://github.com/mozilla-services/Dockerflow
Last synced: 5 days ago
JSON representation
Cloud Services Dockerflow specification
- Host: GitHub
- URL: https://github.com/mozilla-services/Dockerflow
- Owner: mozilla-services
- License: apache-2.0
- Created: 2016-02-03T00:04:27.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-08-20T09:36:08.000Z (3 months ago)
- Last Synced: 2024-08-21T11:43:34.749Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 71.3 KB
- Stars: 195
- Watchers: 33
- Forks: 28
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - mozilla-services/Dockerflow - Cloud Services Dockerflow specification (others)
README
[](https://circleci.com/gh/mozilla-services/Dockerflow)
# Dockerflow
Dockerflow is a specification for automated building, testing and publishing of docker web application images that comply to a common set of behaviours. Compliant images are simpler to deploy, monitor and manage in production.
The specification is this README.md file. This repo contains a reference application that will change with the specification. See the [Contribution document](CONTRIBUTE.md) for details on suggesting changes and providing feedback.
## Automated Creation Pipeline
````
+-(1)--+ +-(2)-------------+ +-(3)-------+ +-(4)--------+
| Code | | CI builds and | | Docker | | Container |
| Push | ------> | tests container | -----> | Hub | -----> | Deployment |
+------+ +-----------------+ +-----------+ +------------+
````
1. A Code push triggers automated image building
2. CI builds and tests the image
3. Tested images are published to Docker Hub.
4. Images are pulled from Docker Hub to be used
## Specification
The specification has requirements that a container must comply with. Recommendations are optional but encouraged if they are suitable for the application.
### Building and Testing
Dockerflow requires an automated build and test tool that meets these requirements:
1. Able to trigger a build from a code change like a pull request or a merge.
1. Able to run tests on the code and the application in the container.
1. Able to manually trigger a previous build and test.
1. Able to publish container to Docker Hub or Google Artifact Registry.
1. Able to provide a build and test log.
1. Secure and keeps secrets from being exposed.
Within Mozilla, we support the use of CircleCI, Taskcluster, or Github Actions.
### Containerized App Requirements
When the application is ran in the container it must:
1. Accept its configuration through environment variables.
1. Listen on environment variable `$PORT` for HTTP requests.
1. Must have a [JSON version object](docs/version_object.md) at `/app/version.json`.
1. Respond to `/__version__` with the contents of `/app/version.json`.
1. Respond to `/__heartbeat__` with a HTTP 200 or 5xx on error. This should check backing services like a database for connectivity and may respond with the status of backing services and application components as a JSON payload.
1. Respond to `/__lbheartbeat__` with an HTTP 200. This is for load balancer checks and should **not** check backing services.
1. Send text logs to `stdout` or `stderr`.
1. Serve its own [static content](docs/serving-static-content.md).
### Dockerfile requirements
1. Sources should be copied to the `/app` directory in the container.
1. Create an `app` group with a GID of `10001`.
1. Create an `app` user with a UID of `10001` and is a member of the `app` group.
1. Have both `ENTRYPOINT` and `CMD` instructions to start the service.
1. Have a `USER app` instruction to set the default user.
### Optional Recommendations
1. Each instance of a container should only run one process. If you need to run two processes, just create another instance of the container & run a different command.
1. Log to `stdout` in the
[mozlog](https://wiki.mozilla.org/Firefox/Services/Logging) json schema.
1. [Containers should be optimized for production use](docs/building-container.md).
1. Listen on port 8000.
### Docker Hub Credentials
Internal processes for managing `DOCKER_USER` and `DOCKER_PASS` per-project are documented in `hiera-sops/misc/dockerhub/`.
## Contributing
* [Contribution Guidelines](CONTRIBUTE.md)