feat: docker images for iroh #2404

Arqu · 2024-06-24T20:56:16Z

Description

Enable binding of the RPC endpoint to arbitrary addresses
Add Dockerfile for iroh

Breaking Changes

changed iroh::node::Node::my_rpc_port is now my_rpc_addr and returns Option<SocketAddr>
iroh::node::Builder::rpc_endpoint takes Option<SocketAddr> instead of Option`
added iroh::node::Builder::enable_rpc_with_addr allowing to specify on which address + port to bind to

Notes & open questions

Change checklist

Self-review.
Documentation updates if relevant.
Tests if relevant.
All breaking changes documented.

Arqu

Also to make this easy to connect to other services on the local host, best bet is to run in network mode host.

Dockerfile

dignifiedquire · 2024-06-27T12:48:41Z

@Arqu once we merge this, can we automate it, to publish this to dockerhub on release?

dignifiedquire · 2024-06-27T12:50:13Z

Dockerfile

+RUN cargo build --bin iroh --release --all-features
+
+### Final Image
+FROM ubuntu:latest as iroh


can we switch this to alpine?

or sth else that is smaller

dignifiedquire · 2024-07-01T10:03:02Z

@Arqu we should have one minimal test in CI running the docker image and calling iroh node status or sth, to make sure the basic interactions always work

Arqu · 2024-07-02T11:31:17Z

@Arqu we should have one minimal test in CI running the docker image and calling iroh node status or sth, to make sure the basic interactions always work

We got a node stats test now too.

Also should we title it as breaking? Document the rpc changes?

rklaehn · 2024-07-04T10:20:53Z

iroh-cli/src/commands.rs

+
+    /// Address to serve RPC on.
+    ///
+    /// This overrides the address found in the IPFS_PATH.


What IPFS_PATH?

great question..

rklaehn · 2024-07-04T10:23:37Z

iroh/src/node/builder.rs

@@ -316,8 +320,10 @@ where
    }

    /// Configure the default iroh rpc endpoint.
-    pub async fn enable_rpc(self) -> Result<Builder<D>> {
-        let (ep, actual_rpc_port) = make_rpc_endpoint(&self.secret_key, DEFAULT_RPC_PORT)?;
+    pub async fn enable_rpc(self, rpc_addr: Option<SocketAddr>) -> Result<Builder<D>> {


Can we keep the default builder API simple? I would guess that 99% of all users will want to enable rpc with the default value here.

So either .enable_rpc() or .enable_custom_rpc(AddrOpt) or maybe enable_rpc_with_opts(RpcOpts) in case we expect more options in the future?

rklaehn · 2024-07-04T10:24:30Z

iroh/src/node/builder.rs

    let rpc_quinn_endpoint = match rpc_quinn_endpoint {
        Ok(ep) => ep,
        Err(err) => {
            if err.kind() == std::io::ErrorKind::AddrInUse {
                tracing::warn!(
                    "RPC port {} already in use, switching to random port",
-                    rpc_port
+                    rpc_addr.port(),


We should probably log the entire addr.

dignifiedquire · 2024-07-08T11:02:25Z

build_docker.sh

@@ -0,0 +1,2 @@
+docker buildx build -f docker/Dockerfile --target iroh --platform linux/arm64/v8 --tag n0computer/iroh:latest .
+# docker buildx build -f docker/Dockerfile --target iroh --platform linux/amd64 --tag n0computer/iroh:latest .


what about this?

We should drop this, stuff is already there in the readme.

dignifiedquire · 2024-07-08T11:03:14Z

docker/README.md

+## Building
+
+- All commands are run from the root folder
+- If you're on macOS run `docker buildx build -f docker/Dockerfile --target iroh --platform linux/arm64/v8 --tag n0computer/iroh:latest .`


what does buildx mean?

Buildx is an official extension by docker for the build system for images. Gives you the ability to specify platforms and some other nifty stuff.

Arqu self-assigned this Jun 24, 2024

Arqu commented Jun 24, 2024

View reviewed changes

Dockerfile Outdated Show resolved Hide resolved

Dockerfile Outdated Show resolved Hide resolved

dignifiedquire reviewed Jun 27, 2024

View reviewed changes

Arqu force-pushed the arqu/docker branch from 4b01a61 to a6ff3e3 Compare June 28, 2024 10:53

dignifiedquire force-pushed the arqu/docker branch from a6ff3e3 to 4b01a61 Compare June 28, 2024 10:57

Arqu force-pushed the arqu/docker branch from 4b01a61 to 62bde2f Compare June 28, 2024 11:09

dignifiedquire added this to the v0.20.0 milestone Jun 28, 2024

Arqu mentioned this pull request Jun 28, 2024

dockerize derper and publish to dockerhub #1555

Closed

Arqu changed the title ~~WIP: feat: docker image for iroh~~ feat: docker images for iroh Jun 28, 2024

Arqu marked this pull request as ready for review June 28, 2024 13:18

Arqu requested a review from flub June 28, 2024 13:18

Arqu and others added 10 commits July 2, 2024 11:33

feat: docker image for iroh

8ae503e

better docker

0e2fe7e

expand rpc addr capabilities

f1153a4

cleanup

2c10da1

cleanup again

0091fe9

fix build script

c363b6d

pooooorts

f7334c0

chef + docker fixes + better docs

6f09c7b

cleanup code

bf8fd3a

docker test

8cb807b

Arqu force-pushed the arqu/docker branch from ccccedd to 8cb807b Compare July 2, 2024 09:46

Arqu added 3 commits July 2, 2024 11:54

T_T

89e5ddb

join steps

c5853c0

make sure you start a node

99bd2a1

Arqu requested a review from dignifiedquire July 2, 2024 11:30

dignifiedquire requested a review from rklaehn July 2, 2024 13:24

dignifiedquire self-assigned this Jul 3, 2024

rklaehn reviewed Jul 4, 2024

View reviewed changes

dignifiedquire added 3 commits July 4, 2024 20:04

Merge remote-tracking branch 'origin/main' into arqu/docker

016f8c8

apply CR

78eca4a

Merge remote-tracking branch 'origin/main' into arqu/docker

abec35f

dignifiedquire reviewed Jul 8, 2024

View reviewed changes

dignifiedquire approved these changes Jul 8, 2024

View reviewed changes

dignifiedquire and others added 2 commits July 8, 2024 13:04

Merge branch 'main' into arqu/docker

68f5d63

remove stale scripts

b398403

Arqu enabled auto-merge July 8, 2024 11:06

Arqu added this pull request to the merge queue Jul 8, 2024

Merged via the queue into main with commit debc4fb Jul 8, 2024
25 of 26 checks passed

dignifiedquire deleted the arqu/docker branch July 8, 2024 11:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: docker images for iroh #2404

feat: docker images for iroh #2404

Arqu commented Jun 24, 2024 •

edited by dignifiedquire

Loading

Arqu left a comment

dignifiedquire commented Jun 27, 2024

dignifiedquire Jun 27, 2024

dignifiedquire Jun 27, 2024

dignifiedquire commented Jul 1, 2024

Arqu commented Jul 2, 2024 •

edited

Loading

rklaehn Jul 4, 2024

dignifiedquire Jul 4, 2024

dignifiedquire Jul 8, 2024

rklaehn Jul 4, 2024

dignifiedquire Jul 8, 2024

rklaehn Jul 4, 2024

dignifiedquire Jul 8, 2024

dignifiedquire Jul 8, 2024

Arqu Jul 8, 2024

dignifiedquire Jul 8, 2024

Arqu Jul 8, 2024

		@@ -0,0 +1,2 @@
		docker buildx build -f docker/Dockerfile --target iroh --platform linux/arm64/v8 --tag n0computer/iroh:latest .
		# docker buildx build -f docker/Dockerfile --target iroh --platform linux/amd64 --tag n0computer/iroh:latest .

feat: docker images for iroh #2404

feat: docker images for iroh #2404

Conversation

Arqu commented Jun 24, 2024 • edited by dignifiedquire Loading

Description

Breaking Changes

Notes & open questions

Change checklist

Arqu left a comment

Choose a reason for hiding this comment

dignifiedquire commented Jun 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dignifiedquire commented Jul 1, 2024

Arqu commented Jul 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Arqu commented Jun 24, 2024 •

edited by dignifiedquire

Loading

Arqu commented Jul 2, 2024 •

edited

Loading