HIVE-2302: docs: Clarify metadataJSONSecretRef optional behavior for cluster adoption

[huangmingxia]

Add documentation for automatic metadata.json generation via retrofit code

[openshift-ci-robot]

@huangmingxia: This pull request references HIVE-2302 which is a valid jira issue.

Details

In response to this:

Add documentation for automatic metadata.json generation via retrofit code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: huangmingxia
Once this PR has been reviewed and has the lgtm label, please assign dlom for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[openshift-ci]

@huangmingxia: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[huangmingxia]

/unhold

[huangmingxia]

@2uasimojo Could you please help review this when you have time? Thanks!

[2uasimojo]

I think this adds good information, BUT it implies a preference for using CD fields, whereas we want to encourage using an existing Secret or file, if those are available. LMK if you want help wordsmithing an alternative.

cc @jianping-shu

[jianping-shu]

Here is the previous discussion thread
If wanted to let the retrofit code kick in firstly, need instruct the user to double check if metadata.json secret is available after the cluster adoption. If not, then provision it manually.
@2uasimojo Pls. help judge which is the best approach :)

[2uasimojo]

Thanks @jianping-shu.

@huangmingxia please see the comment Jianping linked for an explanation of my reasoning.