Application reference
Resource format
resource app 'Applications.Core/applications@2023-10-01-preview' = {
name: 'myapp'
properties: {
environment: environment
extensions: [
{
kind: 'kubernetesNamespace'
namespace: 'myapp'
}
{
kind: 'kubernetesMetadata'
labels: {
'team.contact.name': 'frontend'
}
}
]
}
}
Top-level
Key | Required | Description | Example |
---|---|---|---|
name | y | The name of your resource. See common values for more information. | frontend |
location | y | The location of your resource. See common values for more information. | global |
properties | y | Properties of the resource. | See below |
Properties
Key | Required | Description | Example |
---|---|---|---|
environment | y | The ID of the environment resource this container belongs to. | env.id |
extensions | n | List of extensions on the container. | See below |
Extensions
Extensions allow you to customize how resources are generated or customized as part of deployment.
kubernetesNamespace
The Kubernetes namespace extension allows you to customize how all of the resources within your application generate Kubernetes resources. See the Kubernetes mapping guide for more information on namespace mapping behavior.
Key | Required | Description | Example |
---|---|---|---|
kind | y | The kind of extension being used. Must be ‘kubernetesNamespace’ | kubernetesNamespace |
namespace | y | The namespace where all application-scoped resources generate Kubernetes objects. | default |
kubernetesMetadata
The Kubernetes Metadata extension enables you set and cascade Kubernetes metadata such as labels and Annotations on all the Kubernetes resources defined with in your Radius Application. For examples, please refer to the extension overview page.
Properties
Key | Required | Description | Example |
---|---|---|---|
kind | y | The kind of extension being used. Must be ‘kubernetesMetadata’ | kubernetesMetadata |
labels | n | The Kubernetes labels to be set on the application and its resources | See below |
annotations | n | The Kubernetes annotations to set on your application and its resources | See below |
labels
Key | Required | Description | Example |
---|---|---|---|
user defined label key | y | The key and value of the label to be set on the application and its resources. | 'team.name': 'frontend' |
annotations
Key | Required | Description | Example |
---|---|---|---|
user defined annotation key | y | The key and value of the annotation to be set on the application and its resources. | 'app.io/port': '8081' |
Feedback
Was this page helpful?
Glad to hear it! Please feel free to star our repo and join our Discord server to stay up to date with the project.
Sorry to hear that. If you would like to also contribute a suggestion visit and tell us how we can improve.