Skip to content

[doc/install]: Add note warning against the :latest tag.#35006

Merged
sebastian-philipp merged 1 commit intoceph:masterfrom
zdover23:wip-doc-45411-contain-latest-tag
May 29, 2020
Merged

[doc/install]: Add note warning against the :latest tag.#35006
sebastian-philipp merged 1 commit intoceph:masterfrom
zdover23:wip-doc-45411-contain-latest-tag

Conversation

@zdover23
Copy link
Contributor

Signed-off-by: Zac Dover zac.dover@gmail.com

This commit adds a warning against using the ": latest" tag in dockerfiles. Doing so can result in an inconsistent environment.

Fixes: https://tracker.ceph.com/issues/45411

Checklist

  • References tracker ticket
  • Updates documentation if necessary
  • Includes tests for new functionality or reproducer for bug

Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard backend
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox

Copy link
Contributor

@mgfritch mgfritch left a comment

Choose a reason for hiding this comment

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

Maybe we should also add an example of an explicit tag?

docker pull ceph/ceph:v15.2.0

@zdover23 zdover23 force-pushed the wip-doc-45411-contain-latest-tag branch from 6b6490d to 07db2e6 Compare May 12, 2020 12:49
Comment on lines 3 to 4
Ceph Container Images
=====================
Copy link
Contributor

Choose a reason for hiding this comment

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

we somehow have to make cephadm users aware of it, as they typically will not look into install/containers.

What about simply moving this file to doc/cephadm?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sebastian-philipp Is it your vote that we move all of the content in containers.rst over to doc/cephadm?

Copy link
Contributor

Choose a reason for hiding this comment

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

wdyt? Either we link it from cephadm, or we move it there.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've been sitting here chewing my lip and thinking about it, and I think I'm just going to add a link on the cephadm page. If after a few days we don't think that that's sufficient, I'll move the matter in this page to the cephadm page. (The cephadm page has bigger problems at the moment, in my opinion, anyway.)

Copy link
Contributor

Choose a reason for hiding this comment

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

2 cents I wasn't pinged for, I agree with @zdover23 - a cross ref should be fine in this instance. A short sentence and "here's where to go". If there's complaints later, that can be rectified.

@sebastian-philipp
Copy link
Contributor

jenkins test make check

@sebastian-philipp
Copy link
Contributor

ping?

@zdover23 zdover23 force-pushed the wip-doc-45411-contain-latest-tag branch from 95f6b2c to b8a3de1 Compare May 27, 2020 11:07
@zdover23 zdover23 requested a review from a team as a code owner May 27, 2020 14:08
@sebastian-philipp
Copy link
Contributor

lgtm. Squashing the commits would be great!

Signed-off-by: Zac Dover <zac.dover@gmail.com>

Incorporating mgfritch's improvements.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

s/docker/podman/ -- as per mgfritch's suggestion

Signed-off-by: Zac Dover <zac.dover@gmail.com>

s/: latest/:latest/

Signed-off-by: Zac Dover <zac.dover@gmail.com>

s/image ids/image IDs/ -- as per Alex Settle's suggestion.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

Add note warning against the :latest tag.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

s/image ids/image IDs/ -- as per Alex Settle's suggestion.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

Linked to container page from cephadm install page.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

Clarified the note directing readers to the container documentation.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
@zdover23 zdover23 force-pushed the wip-doc-45411-contain-latest-tag branch from b4f3ed4 to f0fe087 Compare May 29, 2020 04:57
@zdover23
Copy link
Contributor Author

God willing, this thing is rebased against master and properly squashed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants