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

docs: docker tags #96

Merged
merged 2 commits into from
Sep 3, 2021
Merged

docs: docker tags #96

merged 2 commits into from
Sep 3, 2021

Conversation

casperdcl
Copy link
Contributor

@casperdcl casperdcl commented Aug 30, 2021

@casperdcl casperdcl added the documentation Markdown files label Aug 30, 2021
@casperdcl casperdcl self-assigned this Aug 30, 2021
@shcheklein shcheklein temporarily deployed to cml-dev-docker-tags-q1s02zbque August 30, 2021 15:53 Inactive
@shcheklein shcheklein temporarily deployed to cml-dev-docker-tags-q1s02zbque August 30, 2021 15:57 Inactive
@casperdcl casperdcl marked this pull request as ready for review August 30, 2021 16:00
Copy link
Member

@0x2b3bfa0 0x2b3bfa0 left a comment

Choose a reason for hiding this comment

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

Great! I would even dedicate a separate section to container images, as they're useful on many other scenarios apart from self-hosted runners. Nevertheless, it might make sense to keep them along with the self-hosted runner documentation for now.

@0x2b3bfa0
Copy link
Member

0x2b3bfa0 commented Aug 30, 2021

Any strong preference for "Docker images" instead of "container images"? I personally prefer the latter since they've become more standardized.

@casperdcl
Copy link
Contributor Author

image: sequence of layers. container: a running instance of an image. Technically we provide images, not containers.

`docker://ghcr.io/iterative/cml`) come loaded with Python, CUDA, `git`, `node`
and other essentials for full-stack data science. Different versions of these
essentials are available from different `iterativeai/cml` image tags. The tag
convention is `{CML_VER}-dvc{DVC_VER}-base{BASE_VER}{-gpu}`:
Copy link
Contributor

Choose a reason for hiding this comment

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

When I read this automatically I can think of 0.6.2-dvc2.1.0-base1-gpu
Maybe this can be expressed in another way?

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps {CML_MAJOR} and so on?

@0x2b3bfa0
Copy link
Member

0x2b3bfa0 commented Aug 31, 2021

image: sequence of layers. container: a running instance of an image. Technically we provide images, not containers.

Technically, we provide container images as per the OCI specification: that is, images used to run containers, as opposed to virtual machine images, and plain old graphic... images. 😈

Docker just happens to be the brand of one of the first mass-adopted containerization solutions.

Anyhow, this is just a nitpicking exercise. 😄

@casperdcl
Copy link
Contributor Author

well "container images" is like saying "driving cars." It's superfluous and potentially misleading. Better to just say "cars." Secondly (but minor) - it's probably a good idea to include brand-of-car (Docker) since we don't provide other brands atm.

@0x2b3bfa0
Copy link
Member

0x2b3bfa0 commented Aug 31, 2021

well "container images" is like saying "driving cars"

Where "container" is "cars" and "images" is "driving". You can provide users with instructions intended to drive a motorcycle, but it doesn't enable those users to drive a six axis trailer. (Just a funny fallacious argument)

In a project that is all about containers, using "images" would probably suffice, but I believe that it makes sense to use the more verbose "container images" in a project that also deals with other kinds of images, like cml-publish (graphic) images and (virtual machine) images for internal use.

it's probably a good idea to include brand-of-car (Docker) since we don't provide other brands atm.

Yes, it seems a goot idea, at least for SEO purposes and people who intend to read the documentation... diagonally. Nevertheless, I would prefer to keep things as generic as possible beyond the mandatory mention to the most popular car brand.

Our container images can be — and are being — used with any other OCI-compatible runtimes, like CRI-O, sysbox or runc. Not to mention that we host them on both Docker Hub and the GitHub container registry.

@0x2b3bfa0
Copy link
Member

0x2b3bfa0 commented Aug 31, 2021

Here you're some fun facts about container images and how people calls them in the wild:

We may or may not follow them, but it looks like it's a generalized trend.

@casperdcl casperdcl merged commit 8daefb4 into master Sep 3, 2021
@casperdcl casperdcl deleted the docker-tags branch September 3, 2021 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Markdown files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: mention Docker tags
4 participants