Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
huangmingxia wants to merge 1 commit into
base: master
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/using-hive.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1254,9 +1254,13 @@ spec:
```

Note for `metadataJSONSecretRef`:
1. If the referenced Secret is available -- e.g. if the cluster was previously managed by hive -- simply copy it in.
1. If you have the original metadata.json file -- e.g. if the cluster was provisioned directly via openshift-install -- create the Secret from it: `oc create secret generic my-gcp-cluster-metadata-json -n mynamespace --from-file=metadata.json=/tmp/metadata.json`
1. Otherwise, you may need to compose the file by hand. See the samples below.
- The `metadataJSONSecretRef` file is optional for cluster adoption. If you do not specify `metadataJSONSecretRef` in the ClusterDeployment, Hive will automatically generate the metadata.json content from the ClusterDeployment fields and create a secret named `{cluster-name}-metadata-json` (see [retrofitMetadataJSON](https://github.com/openshift/hive/blob/master/pkg/controller/clusterdeployment/clusterdeployment_controller.go#L1110)). The ClusterDeployment will be automatically updated with the `metadataJSONSecretRef` after the secret is created. You only need to manually provide a metadata.json secret if you have specific metadata that cannot be derived from the ClusterDeployment fields.
- If you need to manually provide the metadata.json secret, use one of the following approaches:
1. If the referenced Secret is available -- e.g. if the cluster was previously managed by hive -- simply copy it in.
2. If you have the original metadata.json file -- e.g. if the cluster was provisioned directly via openshift-install -- create the Secret from it: `oc create secret generic my-gcp-cluster-metadata-json -n mynamespace --from-file=metadata.json=/tmp/metadata.json`.
3. Otherwise, you may need to compose the file by hand. See the [metadata.json samples](#metadatajson-samples) below.

#### metadata.json Samples

If the cluster you are looking to adopt is on AWS and leverages Privatelink, you'll also need to include that setting under `spec.platform.aws` to ensure the VPC Endpoint Service for the cluster is tracked in the ClusterDeployment.

Expand Down