-
Notifications
You must be signed in to change notification settings - Fork 93
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 typespec to support all Terraform Recipe Providers #7199
Update typespec to support all Terraform Recipe Providers #7199
Conversation
27ce24d
to
e8a8bc2
Compare
Radius functional test overview
Click here to see the list of tools in the current test run
Test Status⌛ Building Radius and pushing container images for functional tests... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you look into comments on the original version of this PR vishwahiremat#1?
b55ecf4
to
fbdba5c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update the PR title and description to provide context on the change. It is in general good practice to write the description in a way that anyone can understand what the PR is about, think about someone looking at the commit in the future to understand what this change is, why it was etc.
8dab28e
to
6ff48cd
Compare
...rp/api/v20231001preview/testdata/environmentrecipepropertiesdatamodel-insecure-registry.json
Outdated
Show resolved
Hide resolved
Radius functional test overview
Click here to see the list of tools in the current test run
Test Status⌛ Building Radius and pushing container images for functional tests... |
Saw the updated title - The title should include a brief description of the functionality this PR is adding and the component it is touching. Details of which files/components are updated should be in the description. I have updated the title from When writing the description, I'd suggest think about someone who is fairly new to the repo, can they tell the summary of why and what changes are made by looking at the commit description? |
aa5bfd8
to
3163303
Compare
Radius functional test overview
Click here to see the list of tools in the current test run
Test Status⌛ Building Radius and pushing container images for functional tests... |
} | ||
} | ||
} | ||
}, | ||
"providers": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we have test coverage for empty values for these?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we have empty data model and resource examples.
3163303
to
6ee7274
Compare
Radius functional test overview
Click here to see the list of tools in the current test run
Test Status⌛ Building Radius and pushing container images for functional tests... |
6ee7274
to
7b3eb9e
Compare
Radius functional test overview
Click here to see the list of tools in the current test run
Test Status⌛ Building Radius and pushing container images for functional tests... |
@@ -77,23 +78,29 @@ model EnvironmentProperties { | |||
model RecipeConfigProperties { | |||
@doc("Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment.") | |||
terraform?: TerraformConfigProperties; | |||
|
|||
@doc("Environment variables injected during Terraform Recipe execution for the recipes in the environment.") | |||
envVariables?: EnvironmentVariables; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be env
like the design doc. https://github.com/radius-project/design-notes/pull/39/files#diff-f9f52b8c3872a6c388dff224c472dfdd39bb011c139480ed60e7f4facd68aa10R183
We review API changes in detail because they are hard to change later. Please do a pass on on this and make sure that the API changes match the design doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this drifted from design doc after vishwahiremat#1 (comment) @lakshmimsft thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there is drift from an approved design doc, then it needs to come back to the design meeting. We review details like naming for clarity and consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there is drift from an approved design doc, then it needs to come back to the design meeting. We review details like naming for clarity and consistency.
Completely agree. This was a miss.
} | ||
|
||
@doc("This secret is used within a recipe. Secrets are encrypted, often have fine-grained access control, auditing and are recommended to be used to hold sensitive data.") | ||
model RecipeSecret { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The design doc calls this ProviderSecret
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was me here vishwahiremat#1 (comment). @rynowak if you think ProviderSecret makes more sense and we should add new properties for secrets for anything else that we might introduce in the future, then keeping it as ProviderSecret sounds good to me.
I think should have brought this up for a re-review of api spec design if it absolutely needed to change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lakshmimsft @ytimocin Let's re-review this and env
in the design review today.
@ytimocin When you correct indentation on the multiple files, please file the separate PR. |
Signed-off-by: ytimocin <ytimocin@microsoft.com>
7b3eb9e
to
1188d65
Compare
Radius functional test overview
Click here to see the list of tools in the current test run
Test Status⌛ Building Radius and pushing container images for functional tests... |
PR will be closed but branch SHOULDN'T BE DELETED. |
Description
Design doc: radius-project/design-notes#39
Type of change
Fixes: part of Allow any Terraform provider to be configured and used in a Recipe #6539