Add features spec for Resource extensibility #58
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Co-authored-by: Will <28876888+willtsai@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
|
Can you update this to follow the directory structure we use for images/assets. See: https://github.com/radius-project/design-notes?tab=readme-ov-file#creating-a-pull-request |
rynowak
reviewed
Jul 30, 2024
rynowak
reviewed
Jul 30, 2024
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
rynowak
reviewed
Jul 30, 2024
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
| We need to enable the open-source community to build and experiment with imperfect things. We need to provide an extensibility model that supports “Bring your own technology”, define and use it with Radius. This will help us to meet the community where they are and enable them to experiment and leverage their work as open-source contributions. | ||
|
|
||
| One of the high value extensibility points in Radius is Recipes. We have received interests to create custom resource types, define Recipes for the custom resource types and use it in the Radius application. Today Radius Extenders helps in creating custom resource types, but they are untyped and have limitations. The goal of providing resource extensibility is to empower developers or infrastructure operators to author and run their applications with custom resource types seamlessly in Radius and use all the other features such as Recipes, connections and app graph with ease and flexibility. | ||
|
|
There was a problem hiding this comment.
Not sure if I shared this with you, but there's plenty of good context here as well: https://tag-app-delivery.cncf.io/whitepapers/platform-eng-maturity-model/
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
resources/resource-extensbility/2024-06-resource-extensibility-feature-spec.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>
4 tasks
Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
zachcasper
reviewed
Oct 1, 2024
|
|
||
| ## Summary | ||
|
|
||
| Radius is a core component of the internal developer platform for enterprises building cloud native applications. Many enterprises use a wide range of technologies together for achieving their cloud-native strategy. For any technology that’s a newcomer and helps solve a problem in the cloud native landscape, users look for an easy and seamless way to integrate their existing tools and technologies and incrementally adopt the new technology to their strategy. For Radius, we have heard requests from our users/community to support technologies that their applications are tightly coupled with E.g.: an internal messaging service or a technology they absolutely love E.g.: PostgreSQL/Kafka. Today, Radius provides [`Applications.Core/extenders`](https://docs.radapp.io/guides/author-apps/custom/overview/) to model any kind of service in an untyped way but they pose limitations for sophisticated enterprises in terms of guardrails and validation that platform engineers want to impose on their developer platform. |
There was a problem hiding this comment.
I would run this through a grammar check in Word. There is a lot little nits that Word would pickup real quick.
rynowak
reviewed
Oct 1, 2024
kachawla
reviewed
Oct 1, 2024
lakshmimsft
reviewed
Oct 1, 2024
| 1. Deb uses the rad CLI to scaffold a template typespec definition | ||
|
|
||
| ```bash | ||
| rad resource-provider init Contoso.Messaaging --template-kind typespec |
zachcasper
reviewed
Oct 1, 2024
| ``` | ||
| A sample yaml file is created in the application folder. | ||
|
|
||
| 1. Amy authors the schema for plaid in typespec format |
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
nicolejms
reviewed
Oct 3, 2024
| | OpenAPI YAML/JSON | More common and standard format across the open-source communities ; K8s CRDs follow the structure of Open API | Managing versions and ensuring backward compatibility is challenging | | ||
| | Typespec | Developer friendly; Maintenance and upgrades are easier; Errors and guidance violations at development time | Microsoft developed language; May not be widely adopted by the cloud-native communities ; Yet another language to adopt | | ||
|
|
||
| First, we will create a custom YAML format that requires basic user inputs to define the schema for the user defined type in Radius for users to start using the feature. Following that, we will implement the Typespec authoring experience to provide users with more guidance and validation when authoring the schema. |
There was a problem hiding this comment.
I think we should change 'will' implement to 'may' implement Typespec authoring. If we don't get customers asking for it I assume we won't do it...
rynowak
reviewed
Oct 3, 2024
| properties: { | ||
| name : 'postgresql' | ||
| sku : 'standard' | ||
| } |
nicolejms
reviewed
Oct 3, 2024
|
|
||
| 1. VSCode Type spec extension warns Amy on the errors and warnings as he types | ||
|
|
||
|  |
rynowak
approved these changes
Oct 3, 2024
nicolejms
reviewed
Oct 3, 2024
|
|
||
| 1. Amy uses auto-completion for the schema and properties | ||
|
|
||
|  |
There was a problem hiding this comment.
I do see the images rendered in markdown view... anything I am missing?
nicolejms
reviewed
Oct 3, 2024
| ```bash | ||
| rad resource-provider init Application.Datastores --template-kind typespec | ||
| ``` | ||
| Radius scaffolds a typespec project for the resource provider `Application.Datastores` with individual typespec files for the resource types. |
There was a problem hiding this comment.
Is this a future feature? Or did I misunderstand the discussion during the design review where we decided we weren't going to build typespec. If it's a future feature, can you make that clear in the text? thanks
There was a problem hiding this comment.
yes this is future feature. Ill add that clarification
Reshrahim
commented
Oct 4, 2024
Reshrahim
commented
Oct 4, 2024
Reshrahim
commented
Oct 4, 2024
Address feeedback Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the feature spec document for User defined types
Roadmap item - radius-project/roadmap#14