HDDS-11938. [Website v2] [Docs] [Quick Start] Try Ozone With Kubernetes

[Eric977]

What changes were proposed in this pull request?

HDDS-11938. [Website v2] [Docs] [Quick Start] Try Ozone With Kubernetes

Please describe your PR in detail:
Migrate doc from https://ozone.apache.org/docs/edge/start/kubernetes.html to https://ozone-site-v2.staged.apache.org/docs/quick-start/installation/kubernetes

What is the link to the Apache Jira?

https://issues.apache.org/jira/browse/HDDS-11938

How was this patch tested?

Previewed locally.

[adoroszlai]

Thanks @Eric977 for working on this.

In the old docs, Kubernetes topic is split to two pages:

• Minikube & Ozone
• Ozone on Kubernetes

I think we should import both to this single page. The PR is now importing only the second item, but the text references the first one ("Minikube deployment"). As a reader, I wouldn't know what that is. Not sure what would be the best heading for current content. (Does "Hosted Cluster" make sense?)

I also think we need to improve the text in follow-up task(s). As a start, it's best to import it as-is. However, we should make some trivial fixes, like changing "the dockerhub" to "Docker Hub". This makes it unnecessary to define "dockerhub" as a word (it is not).

[Eric977]

Thank you for your feedback! I've addressed the missing pages and added them to the migration.

Regarding the heading, I’ve applied the suggested change to 'Hosted Cluster.' Do you think 'Hosted Kubernetes Cluster' might be clearer?

[adoroszlai]

Thanks for the updates.

Do you think 'Hosted Kubernetes Cluster' might be clearer?

Yes, that may be better.

[errose28]

I also think we need to improve the text in follow-up task(s). As a start, it's best to import it as-is.

I would like avoid importing unfinished content into the new website, it will be hard to track and we will just accumulate debt on an already new project. Remember we are going to have 200-300 pages worth of docs. As part of testing for this PR, please try out the steps locally to verify that they are clear and working.

[Eric977]

the command
kubectl apply -f .
result in the following error:
error: error validating "kustomization.yaml": error validating data: [apiVersion not set, kind not set]; if you choose to ignore these errors, turn validation off with --validate=false

To resolve this issue, replace the command with:
kubectl apply -k .

The issue and its solution are discussed in detail in this GitHub issue.

Currently, I am testing the documentation in my local environment (wsl on window) and have encountered some additional issues. It seems that the latest release (1.4.1) has no corresponding Docker image, which results in pod initialization failures.

After switching to version 1.4.0, I encounter the following error and am still investigating:

NAME         READY   STATUS       RESTARTS        AGE
datanode-0   0/1     Error        8 (2m8s ago)    13m
datanode-1   0/1     Pending      0               16m
om-0         1/1     Running      8 (5m44s ago)   17m
s3g-0        1/1     Running      0               17m
scm-0        0/1     Init:Error   8 (2m49s ago)   13m```

[adoroszlai]

It seems that the latest release (1.4.1) has no corresponding Docker image

Thank you for spotting this. Recently we switched to Rocky Linux, and published new images for existing versions with tags like 1.4.0-rocky to avoid disruption for users of existing images. 1.4.1 was the first release to only have -rocky image. But the kubernetes examples were not updated, so they still point to 1.4.1. I think we should publish additional tag 1.4.1 for the 1.4.1-rocky image.

[adoroszlai]

Docker Image apache/ozone:1.4.1 is now available.

[Eric977]

Docker Image apache/ozone:1.4.1 is now available.

Thanks for your help

After switching to version 1.4.0, I encounter the following error and am still investigating:

The issue was due to a misconfiguration in my Kubernetes storage. After fixing it, everything started running correctly.
So I believe the content of the document is valid.

[adoroszlai]

Thanks @Eric977 for testing and updating the doc. @errose28 please take another look.

[errose28]

Thanks for adding this @Eric977

[errose28]

Let's add a quick summary here about the options for deploying Ozone with K8s and the info that will follow. This will also be automatically picked up in the doc card summary seen here

[errose28]

I'm not sure what our approach to license headers on markdown should be.

• The ASF policy seems to imply it is only required if we are shipping these pages with a release, which we are not currently.
• The ASF website itself does not have headers on their page source
• The default skywalking eyes config which is set up for apache projects does not check markdown files and ours does not either.
• Adding the header in this way will cause this issue in docusaurus. If we need it we would probably have to put it as comments in the yaml front matter.

None of the current markdown pages have headers so I'm thinking we keep going in that direction but I can't find conclusive evidence saying they aren't required.

[adoroszlai]

I think license is included in the original docs in apache/ozone since they are part of the official source release. But the website is not "released", so we can remove the license header.

[errose28]

Please use - for unordered lists since it is consistent with the existing pages in the new site. This was supposed to be enforced by markdownlint but I made a mistake in the config. I'll push a fix for the markdownlint config soon.

[errose28]

The formatting suggestions above also apply to this section

[errose28]

At some point here we should run ozone version in a pod as part of the test that things were set up correctly. More thorough testing will be done in the following "Reading and Writing Data" section.

[Eric977]

Hi @errose28

Thanks for the review, and sorry for the mistakes. I have fixed the comments above.