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

tool: allow Spec to map to Status or ObservedState in mapper generator #3355

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

Conversation

jingyih
Copy link
Collaborator

@jingyih jingyih commented Dec 11, 2024

In our codebase, some direct resources split a proto message into Spec and Status (as opposed to Spec and ObservedState). Example:

type AwsPropertiesSpec struct {
// Authentication using Google owned service account to assume into
// customer's AWS IAM Role.
// +required
AccessRole *AwsAccessRoleSpec `json:"accessRole,omitempty"`
}

// +kcc:proto=google.cloud.bigquery.connection.v1.AwsProperties
type AwsPropertiesStatus struct {
AccessRole *AwsAccessRoleStatus `json:"accessRole,omitempty"`
}

We should allow Spec to map to Status or ObservedState in mapper generator.

Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign maqiuyujoyce for approval. For more information see the Kubernetes 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

@jingyih
Copy link
Collaborator Author

jingyih commented Dec 11, 2024

/cc @jasonvigil

@google-oss-prow google-oss-prow bot requested a review from jasonvigil December 11, 2024 05:27
@yuwenma
Copy link
Collaborator

yuwenma commented Dec 11, 2024

I think the BQCC AWSPropertyStatus is manually added.

@jingyih
Copy link
Collaborator Author

jingyih commented Dec 11, 2024

I think the BQCC AWSPropertyStatus is manually added.

Yeah, in @jasonvigil's output field design doc, the proposed naming convention is to append ObservedState.

This PR introduces a small update to ensure the mapper generator is compatible with the legacy naming conventions. A few Go structs in BQCC currently end with the suffix Status, and other resources might have also followed this pattern.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants