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

Update to DaprResourceProperties #7919

Open
1 task
lakshmimsft opened this issue Sep 12, 2024 · 1 comment
Open
1 task

Update to DaprResourceProperties #7919

lakshmimsft opened this issue Sep 12, 2024 · 1 comment
Labels
triaged This issue has been reviewed and triaged

Comments

@lakshmimsft
Copy link
Contributor

lakshmimsft commented Sep 12, 2024

Overview of feature request

When recently reviewing a PR (#7906), we looked at Dapr Component specification, https://github.com/dapr/dapr/blob/9591e5778c4e03587acabe35744770881a86c35f/charts/dapr/crds/components.yaml#L83-L86,
and see that fields Metadata, Version, Type are mandatory.

In Radius typespec documentation,

@doc("The metadata for Dapr resource which must match the values specified in Dapr component spec")
metadata?: Record<MetadataValue>;
#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property"
@doc("Dapr component type which must matches the format used by Dapr Kubernetes configuration format")
type?: string;
@doc("Dapr component version")
version?: string;

we treat these as optional fields.

Having reviewed all examples in radius and samples repos, they define these fields, and since we know this specification applies to all Dapr components, creating this issue to review if we should update our model in typespec to required fields or are there compelling reasons to let them be as is today.

Advantages to update: Bicep instellisense will let users know they need to fill out these required fields when describing Dapr components and avoid late errors.

Acceptance criteria

  1. Review decision with team.
  2. If decision is to update model,
    a. Update typespec model for DaprResourceProperties, run make generate
    b. Run all unit and functional tests in radius repo
    c. Ensure tests in samples repo run without issues.

Additional context

No response

Would you like to support us?

  • Yes, I would like to support you

AB#13195

@ytimocin ytimocin added the triaged This issue has been reviewed and triaged label Sep 12, 2024
@radius-triage-bot
Copy link

👍 We've reviewed this issue and have agreed to add it to our backlog. Please subscribe to this issue for notifications, we'll provide updates when we pick it up.

We also welcome community contributions! If you would like to pick this item up sooner and submit a pull request, please visit our contribution guidelines and assign this to yourself by commenting "/assign" on this issue.

For more information on our triage process please visit our triage overview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triaged This issue has been reviewed and triaged
Projects
None yet
Development

No branches or pull requests

2 participants