Skip to content

Add WithDockerCredsFile() RegClient Opt #784

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 20, 2024
Merged

Add WithDockerCredsFile() RegClient Opt #784

merged 1 commit into from
Jul 20, 2024

Conversation

mmonaco
Copy link
Contributor

@mmonaco mmonaco commented Jul 20, 2024 •
edited
Loading

Make it easier to pull creds from a docker config.json outside of the standard location, without needing environmental variables. For example, a mounted K8s Secret of type kubernetes.io/dockerconfigjson.

Describe the change

new feature

This is a small nice-to-have, exposing existing functionality to regclient library users.

How to verify it

Connect to a registry using creds in a non-standard config file.

Changelog text

  • Add a WithDockerCredsFile() regclient.Opt

Please verify and check that the pull request fulfills the following requirements

  • Tests have been added or not applicable
  • N/A - regclient doesn't have much coverage for opts, config.Docker tests reads
  • Documentation has been added, updated, or not applicable
  • will be picked up in godoc
  • Changes have been rebased to main
  • Multiple commits to the same code have been squashed

@mmonaco
Add WithDockerCredsFile() RegClient Opt
a5e9903 
Make it easier to pull creds from a docker config.json outside of the
standard location, without needing environmental variables. For example,
a mounted K8s Secret of type `kubernetes.io/dockerconfigjson`.

Signed-off-by: Matthew Monaco <matt@monaco.cx>
sudo-bmitch
sudo-bmitch approved these changes Jul 20, 2024
View reviewed changes
Copy link
Contributor

@sudo-bmitch sudo-bmitch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@sudo-bmitch sudo-bmitch merged commit d888dff into regclient:main Jul 20, 2024
5 checks passed
@lia39
Copy link

lia39 commented Jul 24, 2024

how do I implement this within a deployment?
until now I mounted the secret to the config.json path manually

@mmonaco
Copy link
Contributor Author

mmonaco commented Jul 24, 2024 •
edited
Loading

how do I implement this within a deployment? until now I mounted the secret to the config.json path manually

This is what I am doing (I almost always wind up wrapping clients with a local one).

type Client struct {
        rc   *regclient.RegClient
        ...
}

// NewClient builds a new Client.
func NewClient(conffile) *Client {
        opt := func() regclient.Opt {
                if conffile != "" {
                        return regclient.WithDockerCredsFile(conffile)
                }
                return regclient.WithDockerCreds()
        }()
        return &Client{
                rc: regclient.New(opt),
                ...
        }
}

and conffile is being set from a flag. So in my Deployment config (I use jsonnet, but yaml, json, etc work too), I add a volume+volumemount mount to /run/.../<mysecretname> and add a container arg for --conf-file=/run/.../<mysecretname>/.dockerconfigjson. When I'm running locally, the --conf-file default is empty, so it uses my local docker config as normal.

@BrewTestBot BrewTestBot mentioned this pull request Aug 3, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sudo-bmitch sudo-bmitch sudo-bmitch approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mmonaco @lia39 @sudo-bmitch