Add docker options to repo2docker

[petersudmant]

Proposed change

Add a way to add docker options to repo2docker.

Alternative options

There are no alternate options AFIK

Who would use this feature?

The issue I am facing is a building a x86 repo2docker on an m1 mac. I think this can be done by using docker options --platform linux/amd64 however I cannot do this currently

How much effort will adding it take?

I think this shoudl be quite straightforward.

Who can do this work?

[welcome]

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.

You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

[manics]

This should already be possible. You can pass arbitrary key-word arguments via the extra_build_kwargs Traitlets config (note the help message is incorrect, it looks like it was copied and pasted from another parameter):

repo2docker/repo2docker/app.py

Lines 108 to 117 in 4352535

	extra_build_kwargs = Dict(
	{},
	help="""
	extra kwargs to limit CPU quota when building a docker image.
	Dictionary that allows the user to set the desired runtime flag
	to configure the amount of access to CPU resources your container has.
	Reference https://docs.docker.com/config/containers/resource_constraints/#cpu
	""",
	config=True,
	)

These will be passed to the Docker API client which accepts a platform= argument:
https://docker-py.readthedocs.io/en/latest/api.html#module-docker.api.build

[yuvipanda]

Would this mean you've to pass in something like --Repo2Docker.extra_build_kwargs platform=linux/amd64 to the commandline invocation?

[manics]

Something like that.... I'm still searching for a good traitlets tutorial on command line args 😀

[petersudmant]

I can confirm that that does NOT work... I'll keep playing around though.

…

On Mon, Jan 10, 2022 at 12:17 PM Simon Li ***@***.***> wrote: Something like that.... I'm still searching for a good traitlets tutorial on command line args 😀 — Reply to this email directly, view it on GitHub <#1112 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJTP6FULMBTO7UTVFR3GNJTUVM5GNANCNFSM5LT7KQ4Q> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you authored the thread.Message ID: ***@***.***>

-- Peter Sudmant Assistant Professor (he/him/his) Department of Integrative Biology University of California, Berkeley 510-664-4700

[petersudmant]

I feel like this should work:

jupyter-repo2docker --extra_build_kwargs platform=linux/amd64 ./

but it results in jupyter-repo2docker: error: unrecognized arguments: --extra_build_kwargs

Any ideas?

[petersudmant]

@manics should I reopen this as an "issue" as there doesn't seem to be any documentation of how to get this working in repo2docker?

[manics]

@petersudmant Did you try @yuvipanda's suggestion? If that didn't work would you mind posting on https://discourse.jupyter.org/ instead, and make it clear you need some help with using Traitlets on the command line? I don't think re-opening the issue here will help if we don't have the knowledge of Traitlets, whereas someone is more likely to know the answer on Discourse.

[petersudmant]

@manics Makes good sense. I did try @yuvipanda's suggestion w/ no luck. I'll do that right now

[manics]

@petersudmant I've just had another idea, can you try passing a config file --config CONFIG?

[manics]

Just to emphasize my lack of traitlets experience, I suspect the config may not be in place to forward the CLI args.... I thought it was automatically done when using Traitlets but maybe not?

E.g. jupyter-lab --help-all will show all configurable traitlets but repo2docker --help-all doesn't

[petersudmant]

Actually, this worked!

jupyter-repo2docker --config traitlets.config.json ./

where traitlets.config.json looks like this

{
    "Repo2Docker": {
        "extra_build_kwargs":{"platform":"linux/amd64"}
    }
}

[manics]

@petersudmant Great! Sorry for misleading you with my earlier comment.

What are your thoughts on this configuration- is a config file good enough, or do you think it (and all other configurables) should be exposed on the command line?

[yuvipanda]

@manics generally with traitlets I expect them to be loaded from the commandline, we should try to do that

[petersudmant]

I agree w/ @yuvipanda @manics - traitlets docs suggests either option should be possible