Skip to content
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.

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

metadata: if value in cluster profile is empty, return error #1335

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

Conversation

AlbeeSo
Copy link
Member

@AlbeeSo AlbeeSo commented Feb 28, 2025

In Private Cloud, cluster profile only has clusterId and resourceGroupId key.
ack-cluster-profile provider should return error to avoid a nil string, and allow the following providers to keep trying retrieve the values.

What type of PR is this?

/kind bug

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?


Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 28, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 28, 2025
@AlbeeSo AlbeeSo changed the title metadata: if vauel in cluster profile is empty, return error metadata: if value in cluster profile is empty, return error Feb 28, 2025
@huww98
Copy link
Contributor

huww98 commented Feb 28, 2025

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 28, 2025
@@ -27,7 +27,9 @@ func NewProfileMetadata(client kubernetes.Interface) (*ProfileMetadata, error) {

func (m *ProfileMetadata) Get(key MetadataKey) (string, error) {
if key, ok := MetadataProfileDataKeys[key]; ok {
return m.profile.Data[key], nil
if m.profile.Data[key] != "" {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's unreasonable to return ErrUnknownMetadataKey for an empty value; please use a new error code instead.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is appropriate. Golang returns empty string if the key does not exist in the map. In this case, ErrUnknownMetadataKey will trigger fallback to another source, which is expected.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just "unknown" for this source as keys are not found in cluster-profile.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants