UnMango.Docker.FSharp 0.0.4-alpha.0.21

Docker.FSharp

This library defines a computation expression that can be used to describe Docker operations.

Not to be confused with Docker.DotNet.FSharp!

Install

• NuGet: dotnet add package UnMango.Docker.FSharp
• GitHub Packages: dotnet add package UnMango.Docker.FSharp -s github
  • Authenticating to GitHub Packages
  • Installing from GitHub Packages

Usage

The majority of the library is still a work in progress.

Currently, a very basic series of image and container operations can be defined using the docker builder.

let dockerActions = docker {
    Image.create {
        fromImage "ubuntu"
        tag "latest"
    }
    Container.create "my-container" {
        entrypoint "bash"
    }
}

It's worth noting that no interaction with the docker API is actually performed. The intent is to provide the ability to describe operations that a client can consume to perform operations.

The sister library, Docker.DotNet.FSharp, is one such consumer that provides Docker.run to execute operations using Docker.DotNet.

Development

At a minimum, the .NET SDK is required. At the time of writing this project is built with .NET 9.0 which you can find here. The specific version is defined in global.json.

It might be a good idea to install make but it is not required.

If you do however, you can just clone the repo and run make.

This will:

• Restore dependencies
• Restore tools (like fantomas)
• Build the solution
• Run the linter
• Run tests

There are a number of make targets for common tasks such as build, test, lint, format and pack.

You can also use the dotnet CLI like normal.

dotnet build
dotnet test

A solution file is provided for IDE's that support it, such as Rider, Visual Studio, and Ionide.

If you prefer a devcontainer, there is a barebones definition in .devcontainer/devcontainer.json. It's not fully configured yet, so you may need to install some tools manually.

You can run make devcontainer to build the container with the devcontainers-cli. This command requires Node.js and npx (shipped with node).

Q/A

Why make?

It makes me feel smarter than I actually am.

Why use the preview SDK?

I like living on the edge.

The name seems like it was chosen deliberately to be confusing.

That's not a question, get off my back man.