Dofigen

Dofigen is a Dockerfile generator using a simplified description in YAML or JSON format. It defines default values and behaviors that makes the creation of Dockerfiles simplier.

A french DevOps said about it:

C'est une bouffée Dofigen dans ce monde de con...teneurs.

Report Bug · Request Feature

Getting Started

Prerequisites

Install Dofigen using one of the next possibilities.

Cargo install

First install Cargo, the Rust package manager: https://doc.rust-lang.org/cargo/getting-started/installation.html

Then use the next command to install dofigen:

cargo install dofigen

Download the binary

You can download the Dofigen binary from the release page and add it to your path environment variable.

Use it with Docker

You can run Dofigen directly from it Docker image with the next command:

docker run --rm -it -v $(pwd):/app lenra/dofigen

How to use it

Use the help options to understand how to use it:

$ dofigen --help
dofigen 0.0.0
Dofigen is a Dockerfile generator using a simplyfied description in YAML or JSON format

USAGE:
    dofigen [OPTIONS] [INPUT_FILE]

ARGS:
    <INPUT_FILE>    The input file Dofigen file. Default reads stdin

OPTIONS:
    -d, --dockerfile <DOCKERFILE>    The output Dockerfile file [default: Dockerfile]
    -f, --format <FORMAT>            The input format [default: yaml] [possible values: json, yaml]
    -h, --help                       Print help information
    -i, --ignorefile <IGNOREFILE>    The output .dockerignore file [default: .dockerignore]
    -o, --output                     Writes the Dockerfile to the stdout
    -V, --version                    Print version information

Image descriptor

The image descriptor structure has been created to be simplier than the Dockerfile's one.

Here is an example to generate the Dofigen Dockerfile:

---
builders:
- name: builder
  image: ekidd/rust-musl-builder
  adds:
  - "."
  script:
  # Build with musl to work with scratch
  - cargo build --release --target=x86_64-unknown-linux-musl
  # copy the generated binary outside of the target directory. If not the other stages won't be able to find it since it's in a cache volume
  - mv target/x86_64-unknown-linux-musl/release/dofigen ../
  caches:
  # Cargo cache
  - /home/rust/.cargo
  # build cache
  - /home/rust/src/target
image: scratch
workdir: /app
artifacts:
- builder: builder
  source: "/home/rust/dofigen"
  destination: "/bin/"
entrypoint: 
- /bin/dofigen
cmd:
- --help
ignores:
- "**"
- "!/dofigen"
- "!/dofigen_lib"
- "!/Cargo.*"

Image

The image is the main element. It defines the runtime stage of the Dockerfile:

Field	Type	Description
`image`	String?	The `FROM` Docker image
`user`	String?	The runtime user (default `1000`)
`workdir`	String?	The runtime work directory
`envs`	Map<String, String>?	The runtime environment variables
`artifacts`	Artifact[]?	Defines artifacts to copy from builders
`adds`	String[]?	Paths of elements to add at build time to the workdir
`root`	Root?	Actions made using the `root` user
`script`	String[]?	Script commands to execute
`caches`	String[]?	Paths in the image stage to cache during the `script` execution
`builders`	Builder[]?	Build stages executed before the runtime stage and not in the final Docker image. Mostly to generate artifacts
`ports`	int[]?	The list of exposed ports of the Docker image
`healthcheck`	Healthcheck?	The Docker image healthcheck definition.
`entrypoint`	String[]?	The Docker image `ENTRYPOINT` parts
`cmd`	String[]?	The Docker image `CMD` parts
`ignores`	String[]?	Paths to generate the `.dockerignore` file

Builder

The builders are stages executed before the runtime stage and not in the final Docker image. Mostly to generate artifacts :

Field	Type	Description
`name`	String?	The builder name. If not defined, a name is defined with the given pattern: `builder-<position in the builders list starting at 0>`
`image`	String?	The `FROM` Docker image of the builder
`user`	String?	The builder user
`workdir`	String?	The builder work directory
`envs`	Map<String, String>?	The builder environment variables
`artifacts`	Artifact[]?	Defines artifacts to copy from previous builders
`adds`	String[]?	Paths of elements to add at build time to the workdir
`root`	Root?	Actions made using the `root` user
`script`	String[]?	Script commands to execute
`caches`	String[]?	Paths in the image stage to cache during the `script` execution

Artifact

Artifacts are element copied from a previous build to the current stage :

Field	Type	Description
`builder`	String	The builder name from which the artifact will be copied
`source`	String	The source of the artifact in the given builder
`destination`	String	The destination path in the current stage

Root

Actions made using the root user :

Field	Type	Description
`script`	String[]?	Script commands to execute
`caches`	String[]?	Paths in the image stage to cache during the `script` execution

Healthcheck

The Docker image's healthcheck definition. It defines when the container is not healthy :

Field	Type	Description
`cmd`	String	The command executed to check the container health
`interval`	String?	The command execution interval (default `30s`)
`timeout`	String?	The command execution timeout (default `30s`)
`start`	String?	The duration before starting the commmand execution at container start (default `0s`)
`retries`	int?	The number of retries before defining the container as unhealthy (default `3`)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please open an issue with the tag "enhancement" or "bug". Don't forget to give the project a star! Thanks again!

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Lenra - @lenra_dev - contact@lenra.io

Project Link: https://github.com/lenra-io/dofigen

dofigen 1.0.0