HDDS-11916. Building Ozone Docker Images#126
HDDS-11916. Building Ozone Docker Images#126kerneltime merged 6 commits intoapache:HDDS-9225-website-v2from
Conversation
github-actions
bot
added
the
website-v2
errose28
left a comment
errose28
left a comment
There was a problem hiding this comment.
Thanks for adding this @adoroszlai. Should we add the testkrb5 image to the website footer listing all the Ozone repos as well, or omit it since it is just for testing?
|
|
||
| ## Development | ||
|
|
||
| ### Common Flow |
There was a problem hiding this comment.
I think this should already be covered by the contributing guides for each repo. In that case we can take the building and tagging steps for each image below and move them into the sections for each image above. I think it's easier to follow if all the info for each image is in one section for that image.
There was a problem hiding this comment.
CONTRIBUTING.md in two of the docker repos currently just directs readers to the main Ozone repo's CONTRIBUTING.md. ozone-docker does not even have CONTRIBUTING.md.
Removed the common flow part from this guide for now, and inlined building/tagging instructions to each image's section.
|
|
||
| [ozone-testkrb5](https://github.com/apache/ozone-docker-testkrb5) is used as KDC in tests where Kerberos is enabled. | ||
|
|
||
| Published only to [GitHub](https://github.com/apache/ozone-docker-testkrb5/pkgs/container/ozone-testkrb5). |
There was a problem hiding this comment.
We should explain why this one is not available on docker hub. I think it's because we only use it in our CI?
|
|
||
| ### Base Image | ||
|
|
||
| Development happens on branch `master`, relevant changes are cherry-picked to branch `jdk11`. |
There was a problem hiding this comment.
Not related to this change, but reading this doc made me think it might be good organize the branch, build, and tag procedures for our docker repos so that they are more similar.
There was a problem hiding this comment.
- Tagging is similar for
ozone-runnerandozone-testkrb5, but runner requires JDK-specific version. ozoneuses branching for versions instead of tagging, because we need to maintain it for multiple Ozone releases.- The only real branching difference is:
latestvs.master. - We can unify build procedure, created PR for adding
build.shin the other two repos:
|
|
||
| ## Images | ||
|
|
||
| ### Base Image (without any Ozone) |
There was a problem hiding this comment.
IMO we should use the image names as the headers and explain them in the paragraph, since we usually refer to them by name. Right now the headers are sort of explanations as well, and the actual image name is at the beginning of the paragraph.
There was a problem hiding this comment.
Makes sense, updated.
|
Thanks @errose28, @kerneltime for the review. (I was kind of waiting with this to see if any update is needed after adding lot of the content to individual repos' README/CONTRIBUTING docs (like apache/ozone-docker#43). But we can do that, if needed, as a follow-up.) |
|
The site build out is going to be iterative, we should merge reasonable pages in and revisit at a regular cadence. |
3 participants
What changes were proposed in this pull request?
Document Ozone Docker images from developer point-of-view.
https://issues.apache.org/jira/browse/HDDS-11916
How was this patch tested?
https://github.com/adoroszlai/ozone-site/actions/runs/13574540904