Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: build fedimint-clientd oci images #27

Merged
merged 2 commits into from
Oct 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,30 @@ curl http://localhost:3333/v2/admin/info -H 'Authorization: Bearer some-secure-p

- `/health`: health check endpoint.
- `/metrics`: exports API metrics using opentelemetry with prometheus exporter (num requests, latency, high-level metrics only)

## Fedimint Clientd on Docker

Fedimint Clientd is not officially supported on Docker. However, you can build, publish and deploy your own docker image by following these steps:

- Build an OCI image

```
nix build .#fedimint-clientd-oci && docker load < ./result
```

- confirm the image is built and loaded in your local docker registry

```
docker image ls

# REPOSITORY TAG IMAGE ID CREATED SIZE
# fedimint-clientd f4cb5pgsw4sn7mg93xwyvx09ib4qg3rd ff8cf0f0805b 54 years ago 91.1MB1.1GB
# ...
```

- Tag the image image appropriately then publish to your preferred registry

```
docker tag fedimint-clientd <registry>/fedimint-clientd:v0.4.0
docker push <registry>/fedimint-clientd:v0.4.0
```
9 changes: 9 additions & 0 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
"src"
"multimint"
"fedimint-clientd"
"fedimint-nwc"
"clientd-stateless"
];
};
Expand Down Expand Up @@ -106,6 +107,14 @@
packages = [ "fedimint-clientd" ];
mainProgram = "fedimint-clientd";
};

fedimint-clientd-oci = pkgs.dockerTools.buildLayeredImage {
name = "fedimint-clientd";
contents = [ fedimint-clientd ];
config = {
Cmd = [ "${fedimint-clientd}/bin/fedimint-clientd" ];
};
};
}
);
in
Expand Down
Loading