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

go/buildx redirect #14092

Merged
merged 2 commits into from
Jan 13, 2022
Merged

go/buildx redirect #14092

merged 2 commits into from
Jan 13, 2022

Conversation

crazy-max
Copy link
Member

This URL will used in docker/cli#3314 to direct users to instructions on installing buildx. Maybe go/buildx-install would be better?

The last commit updates the install instructions for buildx (will also be changed upstream on buildx repo). Atm the instructions for Manual download redirect to the GitHub releases page but in the future we might change that to use our download.docker.com front. See docker/docker-ce-packaging#618.

cc @chris-crone @tonistiigi @thaJeztah @errordeveloper

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@netlify
Copy link

netlify bot commented Jan 11, 2022

✔️ Deploy Preview for docsdocker ready!

🔨 Explore the source changes: 1f11889

🔍 Inspect the deploy log: https://app.netlify.com/sites/docsdocker/deploys/61df51537db03600070e2dfb

😎 Browse the preview: https://deploy-preview-14092--docsdocker.netlify.app

Comment on lines 31 to 32
Rename the relevant binary for your OS to `docker-buildx` and copy it to
`$HOME/.docker/cli-plugins`.
Copy link
Member

Choose a reason for hiding this comment

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

I guess if users use sudo to run docker, they should pick one of the instructions below, correct?

We also may need to add some information about which path to pick in general, as they're processed in a specific order, which means that users could inadvertently "mask" the version that comes with their install with an older version (and never update)

Copy link
Member Author

@crazy-max crazy-max Jan 12, 2022

Choose a reason for hiding this comment

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

I guess if users use sudo to run docker, they should pick one of the instructions below, correct?

Correct. We might stipulate that this is for an advanced usage and like you said warn users about it. Maybe add a warning bloc, wdyt?

Might require to make it executable with `chmod +x`:

```shell
$ chmod +x ~/.docker/cli-plugins/docker-buildx
Copy link
Member

Choose a reason for hiding this comment

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

Do we need manual instructions for Windows (and macOS) as well?

We should probably link this content from; https://docs.docker.com/engine/install/binaries/ as well

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes indeed. Maybe another page specific to plugins so we could use the same for others like compose, etc..

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated let me know what you think.

[`docker/buildx-bin`](https://hub.docker.com/r/docker/buildx-bin) image:

```dockerfile
FROM docker
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx
COPY --from=docker/buildx-bin:latest /buildx /usr/libexec/docker/cli-plugins/docker-buildx
RUN docker buildx version
Copy link
Member

Choose a reason for hiding this comment

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

Should this (and other instructions) include a docker buildx install step, and a way to verify that docker buildx install correctly replaced docker build to be backed by buildx?

Copy link
Member Author

@crazy-max crazy-max Jan 12, 2022

Choose a reason for hiding this comment

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

We already have a dedicated section below that talks about it Set buildx as the default builder. We might update it when docker/cli#3314 is merged/released though.

@thaJeztah
Copy link
Member

Maybe go/buildx-install would be better?

The goal is to have a short, memorable, easy-to-type URL (mostly because copy/paste from the command-line may not always work, so users should have an easy way to manually type the URL), so shorter is better, but I'm fine either way.

@crazy-max
Copy link
Member Author

Maybe go/buildx-install would be better?

The goal is to have a short, memorable, easy-to-type URL (mostly because copy/paste from the command-line may not always work, so users should have an easy way to manually type the URL), so shorter is better, but I'm fine either way.

Sure SGTM

@crazy-max crazy-max force-pushed the go-buildx branch 4 times, most recently from cf305f7 to a36162a Compare January 12, 2022 10:23
@crazy-max crazy-max requested a review from thaJeztah January 12, 2022 10:26
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Copy link
Member

@thaJeztah thaJeztah 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!

@thaJeztah thaJeztah merged commit 1dacf0b into docker:master Jan 13, 2022
@crazy-max crazy-max deleted the go-buildx branch January 13, 2022 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants