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

Update the installation instructions in the README #196

Merged
merged 6 commits into from
Jun 8, 2023

Conversation

afbjorklund
Copy link
Contributor

@afbjorklund afbjorklund commented Jun 2, 2023

  • Move documentation sections to right place
  • Use install instead of cp -a for selinux
  • Prefer using binaries and don't rebuild
  • Add make targets for build and install

Issue:


Don't duplicate all the strange go flags in the README, and don't rebuild the binary again during install.

Syntax had to be modified slightly in the Makefile, since it normally runs with SHELL=/bin/sh (not bash)

Mention that there are packages, although they might not exist for all distributions and all architectures.

Systemd units should normally be installed to the prefix location, only overrides and custom config in /etc

@afbjorklund
Copy link
Contributor Author

@neersighted

@afbjorklund
Copy link
Contributor Author

afbjorklund commented Jun 2, 2023

Note that a lot of external documentation is linking directly towards the section in the README:

https://github.com/mirantis/cri-dockerd#build-and-install

@afbjorklund
Copy link
Contributor Author

afbjorklund commented Jun 2, 2023

It would be nice if this was documented on docker.com, next to the other Docker Engine installation.

And if the cri-dockerd packages were available from the Docker repositories, to install with apt or yum.

Copy link
Contributor

@neersighted neersighted left a comment

Choose a reason for hiding this comment

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

README changes LGTM; Makefile needs a spot of work.

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
@neersighted
Copy link
Contributor

Note that a lot of external documentation is linking directly towards the section in the README:

https://github.com/mirantis/cri-dockerd#build-and-install

Yeah, #154 for sure there; they probably shouldn't be linking here, but at the same time, we might need to be pragmatic in the short term.

It would be nice if this was documented on docker.com, next to the other Docker Engine installation.

And if the cri-dockerd packages were available from the Docker repositories, to install with apt or yum.

This is an interesting idea/somewhat promising. I think it's another discussion entirely, but I am in an excellent position to make it happen (if we decide to) in my current role.

That being said, there are technical obstacles to this right now (that I am currently working to solve for other packages); there are organizational barriers as well, but if we lean this direction, I think I can overcome them.

@afbjorklund
Copy link
Contributor Author

I know, Docker only supports Docker Desktop and does not support Docker Engine. But still, it would be nice...

Docker Engine is an open source project, supported by the Moby project maintainers and community members. Docker doesn’t provide support for Docker Engine. Docker provides support for Docker products, including Docker Desktop, which uses Docker Engine as one of its components.

@neersighted
Copy link
Contributor

That's not really the challenge; Docker Inc. still builds Docker CE after all. The issues are mostly technical.

The organizational issues are more 'why:'

  • Why not ship it with Docker CE?
  • Or, why not ship it standalone?
  • Who is the user for this? Will they actually come to download.docker.com?
  • download.docker.com hosts Moby and Docker Inc. code; is it expected to add a Mirantis project there?
  • Should cri-dockerd get more attention from Moby maintainers/potentially become part of the Moby project?

All easily overcome if we move that direction, but I don't have all the answers yet myself.

@neersighted
Copy link
Contributor

/cc @nwneisen

Copy link
Contributor

@neersighted neersighted left a comment

Choose a reason for hiding this comment

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

LGTM

@afbjorklund
Copy link
Contributor Author

afbjorklund commented Jun 2, 2023

The real question is when the docker CRI plugin will be available, so that users don't need a separate shim anymore...

https://kubernetes.io/blog/2018/05/24/kubernetes-containerd-integration-goes-ga/

Anyway, it is out of topic and out of scope for this README. The "docker" runtime users will have to make do with this:

https://kubernetes.io/docs/setup/production-environment/container-runtimes/#docker

@neersighted
Copy link
Contributor

I'm not sure what "the docker plugin" is -- do you mean building CRI directly in to dockerd?

@afbjorklund

This comment was marked as off-topic.

README.md Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@afbjorklund
Copy link
Contributor Author

there's just an odd demographic coming here.

If there are better instructions in some other place, it would be possible to add a link to it in this repository README.

Copy link
Collaborator

@nwneisen nwneisen left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you for updating these!

The builds will fail due to another issue I'm looking at. Feel free to merge these in since they should have no effect on the builds.

@neersighted
Copy link
Contributor

You'll need to hit the button; neither @afbjorklund or I have the button 😅

@nwneisen nwneisen merged commit fa5af6d into Mirantis:master Jun 8, 2023
nwneisen added a commit that referenced this pull request Jun 8, 2023
nwneisen added a commit to nwneisen/cri-dockerd that referenced this pull request Jun 21, 2023
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.

3 participants