Built image digest is stored in the build status #3533
Conversation
mmilata
changed the title
|
@openshift/team-documentation @bparees PTAL |
|
@ahardin-rh - ptal. |
| === Output Image Digest | ||
|
|
||
| Built images can be uniquely identified by their | ||
| link:++https://docs.docker.com/registry/spec/api/#/content-digests++[digest], which can |
There was a problem hiding this comment.
Please remove the ++ before and after the URL
There was a problem hiding this comment.
Without ++ asciibinder mis-parses the URL, probably because it contains #. Is there another way to escape it?
There was a problem hiding this comment.
@mmilata Interesting. I've not seen that before. @adellape @vikram-redhat Do you know a workaround, or do you think the ++ can be accepted? Not sure if this will impact how the docs build. Thanks!
There was a problem hiding this comment.
@ahardin-rh I'm not sure of another workaround. I think only the Customer Portal build would potentially have an issue; worth checking with Lee on. @vikram-redhat Can you look into that?
I'd be inclined to merge this but mark for follow-up before it gets downstream.
There was a problem hiding this comment.
@ahardin-rh - interesting. I haven't seen this issue before either. But from memory, if asciibinder is miss-parsing the URL due to the hash, you could just take the 'link' off. Can you try that and see if it fixes it?
There was a problem hiding this comment.
Ignore my previous comment. Discussed with Lee. He has suggested using $$ instead of ++.
| Built images can be uniquely identified by their | ||
| link:++https://docs.docker.com/registry/spec/api/#/content-digests++[digest], which can | ||
| later be used to | ||
| link:++https://docs.docker.com/engine/reference/commandline/pull/#/pull-an-image-by-digest-immutable-identifier++[pull the image] |
There was a problem hiding this comment.
Same here. Please remove the ++ before and after the URL.
| link:++https://docs.docker.com/engine/reference/commandline/pull/#/pull-an-image-by-digest-immutable-identifier++[pull the image] | ||
| regardless of its current tag. | ||
|
|
||
| Docker and Source builds store the digest in |
There was a problem hiding this comment.
There are three other instances of this in the document, I'll change them all.
|
|
||
| Docker and Source builds store the digest in | ||
| `Build.status.output.to.imageDigest` after the image is pushed to registry. | ||
| Because the digest is computed by the registry it might not be always present, |
There was a problem hiding this comment.
Suggested revision:
The digest is computed by the registry. Therefore, it may not always be present (for example, when the registry did not return a digest, or when the builder image did not understand its format).
| understand its format. | ||
|
|
||
| .Built image digest after successful push to registry | ||
| ==== |
There was a problem hiding this comment.
.Built Image Digest After a Successful Push to the Registry
|
@mmilata Just a few comments from me. Once these changes are made and they are squashed into one commit, we'll be ready to go. Thanks! |
|
technical content lgtm. |
|
The ++ syntax is documented here: http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#links though I can't find it in the official asciidoc manual. |
Please merge after openshift/origin#12407 is merged.