Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unstoppablemango/docker.fsharp
Docker computation expression and client written in F#
https://github.com/unstoppablemango/docker.fsharp
Last synced: 1 day ago
JSON representation
Docker computation expression and client written in F#
- Host: GitHub
- URL: https://github.com/unstoppablemango/docker.fsharp
- Owner: UnstoppableMango
- License: mit
- Created: 2024-05-05T22:53:03.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-19T15:20:25.000Z (about 1 month ago)
- Last Synced: 2024-12-13T02:40:39.563Z (13 days ago)
- Language: F#
- Size: 80.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker.FSharp
[](https://github.com/UnstoppableMango/Docker.FSharp/actions)
[](https://app.codecov.io/gh/UnstoppableMango/Docker.FSharp)
[](https://github.com/UnstoppableMango/Docker.FSharp/releases)
[](https://nuget.org/packages/UnMango.Docker.FSharp)
[](https://nuget.org/packages/UnMango.Docker.FSharp)
This library defines a computation expression that can be used to describe Docker operations.
Not to be confused with [Docker.DotNet.FSharp](https://github.com/UnstoppableMango/Docker.DotNet.FSharp)!
## Install
- [NuGet](https://nuget.org/packages/UnMango.Docker.FSharp): `dotnet add package UnMango.Docker.FSharp`
- [GitHub Packages](https://github.com/UnstoppableMango/Docker.FSharp/pkgs/nuget/UnMango.Docker.FSharp): `dotnet add package UnMango.Docker.FSharp -s github`
- [Authenticating to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry#authenticating-to-github-packages)
- [Installing from GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry#installing-a-package)
## 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.
```fsharp
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](https://github.com/UnstoppableMango/Docker.DotNet.FSharp), is one such consumer that provides `Docker.run` to execute operations using `Docker.DotNet`.
## Development
At a minimum, the [.NET SDK](https://dotnet.microsoft.com) is required.
At the time of writing this project is built with .NET 9.0 which you can find [here](https://dotnet.microsoft.com/download/dotnet/9.0).
The specific version is defined in [global.json](./global.json).
It might be a good idea to install [make](https://www.gnu.org/software/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.
```shell
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](https://nodejs.org) 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.