Add capabilities to resource type API #8182

rynowak · 2025-01-02T21:59:34Z

Description

This change adds the 'capabilities' concept to the resource type API.

Capabilities enable resource types to indicate the schema and behaviors they support.
Capabilities enable clients like the rad CLI to understand the behaviors of resource types dynamically.

For example, we're adding the SupportsRecipes capability.

All resource types that support recipes should declare this capability. This is how a UDT will opt-in to recipe functionality during provisioning.
The rad CLI functionality for rad recipe register can introspect the resource type to validate recipe support, rather than hardcoding which types have the support and which don't.

Description of the changes:

The manifests previously supported capabilities as part of the API version, we're moving this to the resource type for a simplification.
The manifest entry for capabilities wasn't sent to the server. Now it is.
Updated API, converters, and UCP functionality.

Type of change

This pull request adds or changes features of Radius and has an approved issue (issue link required).

Part of: #6688

Contributor checklist

Please verify that the PR meets the following requirements, where applicable:

An overview of proposed schema changes is included in a linked GitHub issue.
A design document PR is created in the design-notes repository, if new APIs are being introduced.
If applicable, design document has been reviewed and approved by Radius maintainers/approvers.
A PR for the samples repository is created, if existing samples are affected by the changes in this PR.
A PR for the documentation repository is created, if the changes in this PR affect the documentation or any user facing updates are made.
A PR for the recipes repository is created, if existing recipes are affected by the changes in this PR.

rynowak · 2025-01-02T21:59:44Z

/cc @lakshmimsft

rynowak · 2025-01-02T22:01:56Z

deploy/manifest/built-in-providers/applications_core.yaml

@@ -4,34 +4,34 @@ types:
    apiVersions:
      "2025-01-01-preview":
        schema: {}
-        capabilities: []
+    capabilities: []


Note: we decided to move this to the resource type rather than the API version.

There are edge cases in how a consumer should behave for a capability that was added to a resource type, and is missing support from previous API versions. These edge cases are present regardless of where we configure the capability, so we went with the simplest design.

A lot of the changes in this PR are updates to existing configuration files or tests.

rynowak · 2025-01-02T22:02:38Z

deploy/manifest/built-in-providers/applications_core.yaml

  extenders:
    apiVersions:
      "2025-01-01-preview":
        schema: {}
-        capabilities: ["Recipes"]
+    capabilities: ["SupportsRecipes"]


Note: We wanted capabilities to use a Verb+Noun naming style so they are more readable.

rynowak · 2025-01-02T22:03:36Z

pkg/cli/cmd/resourceprovider/create/create.go

@@ -140,6 +140,7 @@ func (r *Runner) Run(ctx context.Context) error {
 		r.Output.LogInfo("Creating resource type %s/%s", r.ResourceProvider.Name, resourceTypeName)
 		_, err := client.CreateOrUpdateResourceType(ctx, "local", r.ResourceProvider.Name, resourceTypeName, &v20231001preview.ResourceTypeResource{
 			Properties: &v20231001preview.ResourceTypeProperties{
+				Capabilities:      to.SliceOfPtrs(resourceType.Capabilities...),


Prior to this change, it was possible to include capabilities in a manifest, but they were unused.

rynowak · 2025-01-02T22:04:32Z

pkg/ucp/api/v20231001preview/resourcetype_conversion.go

+		return nil
+	}
+
+	return v1.NewClientErrInvalidRequest(fmt.Sprintf("capability %q is not recognized. Supported capabilities: %s", *input, datamodel.CapabilitySupportsRecipes))


This validation will be expanded over time, and potentially made more flexible. For right now we're just validating that one capability we support.

rynowak · 2025-01-02T22:05:25Z

pkg/ucp/datamodel/capabilities.go

+
+const (
+	// CapabilitySupportsRecipes is a capability that indicates the resource type supports recipes.
+	CapabilitySupportsRecipes = "SupportsRecipes"


The next pull-request for UDT will read this capability and run the recipe engine if needed.

codecov · 2025-01-02T22:11:27Z

Codecov Report

Attention: Patch coverage is 85.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 60.15%. Comparing base (46dc40d) to head (3ea3c72).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...cp/api/v20231001preview/resourcetype_conversion.go	82.35%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8182      +/-   ##
==========================================
- Coverage   60.15%   60.15%   -0.01%     
==========================================
  Files         587      587              
  Lines       38923    38943      +20     
==========================================
+ Hits        23415    23426      +11     
- Misses      13781    13787       +6     
- Partials     1727     1730       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

radius-functional-tests · 2025-01-02T22:17:03Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	rynowak/radius
Commit ref	`ab9d11e`
Unique ID	funcc1b36deabb
Image tag	pr-funcc1b36deabb

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr:
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-funcc1b36deabb
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-funcc1b36deabb
dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-funcc1b36deabb
controller test image location: ghcr.io/radius-project/dev/controller:pr-funcc1b36deabb
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-funcc1b36deabb
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

nithyatsu · 2025-01-02T22:43:15Z

pkg/cli/manifest/manifest.go

@@ -40,7 +43,4 @@ type ResourceTypeAPIVersion struct {
 	// TODO: this allows anything right now, and will be ignored. We'll improve this in
 	// a future pull-request.


lakshmimsft · 2025-01-02T23:55:16Z

pkg/ucp/api/v20231001preview/resourcetype_conversion.go

 		DefaultAPIVersion: dm.Properties.DefaultAPIVersion,
 	}

 	return nil
 }
+
+func validateCapability(input *string) error {


we need a unit test for new function.

lakshmimsft · 2025-01-03T07:07:27Z

due to rebase, this file will need update: /pkg/ucp/integrationtests/resourceproviders/testdata/manifests/resourceprovider-valid1.yaml and
pkg/cli/manifest/testdata/registerdirectory/*.yaml

This change adds the 'capabilities' concept to the resource type API. - Capabilities enable resource types to indicate the schema and behaviors they support. - Capabilities enable clients like the `rad` CLI to understand the behaviors of resource types dynamically. For example, we're adding the `SupportsRecipes` capability. - All resource types that support recipes should declare this capability. This is how a UDT will opt-in to recipe functionality during provisioning. - The `rad` CLI functionality for `rad recipe register` can introspect the resource type to validate recipe support, rather than hardcoding which types have the support and which don't. ---- Description of the changes: - The manifests previously supported capabilities as part of the API version, we're moving this to the resource type for a simplification. - The manifest entry for capabilities wasn't sent to the server. Now it is. - Updated API, converters, and UCP functionality. Signed-off-by: Ryan Nowak <nowakra@gmail.com>

rynowak · 2025-01-03T23:30:36Z

@lakshmimsft - updated, can you re-review?

radius-functional-tests · 2025-01-03T23:31:43Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	rynowak/radius
Commit ref	`3ea3c72`
Unique ID	funcbaf6cd1280
Image tag	pr-funcbaf6cd1280

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr:
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-funcbaf6cd1280
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-funcbaf6cd1280
dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-funcbaf6cd1280
controller test image location: ghcr.io/radius-project/dev/controller:pr-funcbaf6cd1280
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-funcbaf6cd1280
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

rynowak requested review from a team as code owners January 2, 2025 21:59

rynowak temporarily deployed to publish-bicep January 2, 2025 21:59 — with GitHub Actions Inactive

rynowak commented Jan 2, 2025

View reviewed changes

ytimocin previously approved these changes Jan 2, 2025

View reviewed changes

rynowak temporarily deployed to functional-tests January 2, 2025 22:16 — with GitHub Actions Inactive

nithyatsu reviewed Jan 2, 2025

View reviewed changes

lakshmimsft reviewed Jan 2, 2025

View reviewed changes

rynowak dismissed ytimocin’s stale review via 7c4dc60 January 3, 2025 01:18

rynowak force-pushed the capabilities branch from ab9d11e to 7c4dc60 Compare January 3, 2025 01:18

rynowak temporarily deployed to publish-bicep January 3, 2025 01:18 — with GitHub Actions Inactive

rynowak force-pushed the capabilities branch from 7c4dc60 to 3ea3c72 Compare January 3, 2025 23:30

rynowak temporarily deployed to publish-bicep January 3, 2025 23:30 — with GitHub Actions Inactive

rynowak temporarily deployed to functional-tests January 3, 2025 23:30 — with GitHub Actions Inactive

rynowak merged commit 75d093a into radius-project:main Jan 4, 2025
29 checks passed

rynowak deleted the capabilities branch January 4, 2025 07:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add capabilities to resource type API #8182

Add capabilities to resource type API #8182

rynowak commented Jan 2, 2025

rynowak commented Jan 2, 2025

rynowak Jan 2, 2025

rynowak Jan 2, 2025

rynowak Jan 2, 2025

rynowak Jan 2, 2025

rynowak Jan 2, 2025

rynowak Jan 2, 2025

codecov bot commented Jan 2, 2025 •

edited

Loading

radius-functional-tests bot commented Jan 2, 2025 •

edited

Loading

nithyatsu Jan 2, 2025

lakshmimsft Jan 2, 2025

lakshmimsft commented Jan 3, 2025 •

edited

Loading

rynowak commented Jan 3, 2025

radius-functional-tests bot commented Jan 3, 2025 •

edited

Loading

		@@ -40,7 +43,4 @@ type ResourceTypeAPIVersion struct {
		// TODO: this allows anything right now, and will be ignored. We'll improve this in
		// a future pull-request.

Add capabilities to resource type API #8182

Add capabilities to resource type API #8182

Conversation

rynowak commented Jan 2, 2025

Description

Type of change

Contributor checklist

rynowak commented Jan 2, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jan 2, 2025 • edited Loading

Codecov Report

radius-functional-tests bot commented Jan 2, 2025 • edited Loading

Radius functional test overview

Test Status

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lakshmimsft commented Jan 3, 2025 • edited Loading

rynowak commented Jan 3, 2025

radius-functional-tests bot commented Jan 3, 2025 • edited Loading

Radius functional test overview

Test Status

codecov bot commented Jan 2, 2025 •

edited

Loading

radius-functional-tests bot commented Jan 2, 2025 •

edited

Loading

lakshmimsft commented Jan 3, 2025 •

edited

Loading

radius-functional-tests bot commented Jan 3, 2025 •

edited

Loading