diff --git a/docs/content/reference/api/_index.md b/docs/content/reference/api/_index.md index dca1163fc..f1e396299 100644 --- a/docs/content/reference/api/_index.md +++ b/docs/content/reference/api/_index.md @@ -4,6 +4,4 @@ title: "Radius API reference" linkTitle: "Radius API" description: "Detailed reference documentation on the Radius API" weight: 400 ---- - -## API resource policies +--- \ No newline at end of file diff --git a/docs/content/reference/api/applications.dapr/_index.md b/docs/content/reference/api/applications.dapr/_index.md index dcfa31daa..71ec52145 100644 --- a/docs/content/reference/api/applications.dapr/_index.md +++ b/docs/content/reference/api/applications.dapr/_index.md @@ -3,6 +3,4 @@ type: docs title: "Applications.Dapr API reference" linkTitle: "Applications.Dapr" description: "Detailed reference documentation on the Applications.Dapr API" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Dapr/preview/2023-10-01-preview/openapi.json" >}} +--- \ No newline at end of file diff --git a/docs/content/reference/api/applications.datastores/_index.md b/docs/content/reference/api/applications.datastores/_index.md index 997dfb13e..3d85d35be 100644 --- a/docs/content/reference/api/applications.datastores/_index.md +++ b/docs/content/reference/api/applications.datastores/_index.md @@ -5,4 +5,3 @@ linkTitle: "Applications.Datastores" description: "Detailed reference documentation on the Applications.Datastores API" --- -{{< redoc "swagger/specification/applications/resource-manager/Applications.Datastores/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/applications.messaging/_index.md b/docs/content/reference/api/applications.messaging/_index.md index 9eae15c61..2a8955814 100644 --- a/docs/content/reference/api/applications.messaging/_index.md +++ b/docs/content/reference/api/applications.messaging/_index.md @@ -4,5 +4,3 @@ title: "Applications.Messaging API reference" linkTitle: "Applications.Messaging" description: "Detailed reference documentation on the Applications.Messaging API" --- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Messaging/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/resource-policies/_index.md b/docs/content/reference/api/resource-policies/index.md similarity index 100% rename from docs/content/reference/api/resource-policies/_index.md rename to docs/content/reference/api/resource-policies/index.md diff --git a/docs/content/reference/cli/_index.md b/docs/content/reference/cli/_index.md index 1e3b7e7de..342cc9be7 100644 --- a/docs/content/reference/cli/_index.md +++ b/docs/content/reference/cli/_index.md @@ -4,6 +4,4 @@ title: "Radius CLI reference" linkTitle: "rad CLI" description: "Detailed reference documentation on the Radius CLI" weight: 100 ---- - -## Available commands +--- \ No newline at end of file diff --git a/docs/content/reference/resource-schema/_index.md b/docs/content/reference/resource-schema/_index.md index c4c19f48e..1ae5f2338 100644 --- a/docs/content/reference/resource-schema/_index.md +++ b/docs/content/reference/resource-schema/_index.md @@ -5,59 +5,3 @@ linkTitle: "Resource schemas" description: "Schema docs for the resources that can comprise a Radius Application" weight: 300 --- - -## Common values - -The following properties and values are available across all Radius resources: - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. | `mycontainer` -| location | y | The location of your resource. See [below](#location) for more information. The rad CLI defaults the value to 'global' for Radius resources. Direct API calls require `location` to be set to `'global'`. | `global` -| environment | y | The environment used by your resources for deployment. | `environment` | - -### Name - -The name of the resource defines how to address the resource within the context of the application. - -#### Naming constraints - -Radius resource names follow the DNS-1035 naming convention. This, plus other control-plane requirements, result in resource names that must: - -- Contain at most 63 user-entered characters -- Contain only alphanumeric characters or '-' -- Start with an alphabetic character -- End with an alphanumeric character - -#### Rendered names - -The combination of the resource name and application name results in the rendered resource name in a self-hosted Kubernetes environment. The resource group name and resource name also result in the full Universal Control Plane (UCP) identifier of the resource. - -For example, take the following values: - -- **Resource name:** `mycontainer` -- **Application name:** `myapp` -- **Resource group name:** `myrg` - -The resulting names are: - -- **Rendered Kubernetes pod name:** `myapp-mycontainer` -- **Universal Control Plane (UCP) ID:** `/planes/local/resourcegroups/myrg/providers/Applications.Core/containers/mycontainer` - -### Location - -The location property defines where to deploy a resource within the targeted platform. - -For self-hosted environments, the location property is defaulted to `global` by the rad CLI to indicate the resource is scoped to the entire underlying cluster. Direct API calls require `location` to be set to `'global'`. This is a point-in-time implementation that will be revisited in a future revision of self-hosted Kubernetes environments. - -### Environment parameter - -The `environment` string parameter is automatically injected into your Bicep template using the environment ID value specified in your default [workspace]({{< ref workspaces >}}). This value can also be overridden with the rad CLI: `rad deploy --params environment="/planes/radius/..."`. - -To access the auto-injected value, specify an `environment` string parameter in your Bicep file: - -```bicep -param environment string -``` - -## Resource categories diff --git a/docs/content/reference/resource-schema/cache/_index.md b/docs/content/reference/resource-schema/cache/_index.md index 75bb893b3..245b6c236 100644 --- a/docs/content/reference/resource-schema/cache/_index.md +++ b/docs/content/reference/resource-schema/cache/_index.md @@ -3,5 +3,5 @@ type: docs title: "Cache links" linkTitle: "Cache" description: "Learn what cache links are available in your application" -weight: 300 +weight: 400 --- diff --git a/docs/content/reference/resource-schema/core-schema/_index.md b/docs/content/reference/resource-schema/core-schema/_index.md index cdc09708c..e13d22b42 100644 --- a/docs/content/reference/resource-schema/core-schema/_index.md +++ b/docs/content/reference/resource-schema/core-schema/_index.md @@ -3,7 +3,5 @@ type: docs title: "Core resource schemas" linkTitle: "Core" description: "Reference the schemas of the core Radius resources" -weight: 100 ---- - -## Core resources +weight: 200 +--- \ No newline at end of file diff --git a/docs/content/reference/resource-schema/core-schema/application-schema/_index.md b/docs/content/reference/resource-schema/core-schema/application-schema/index.md similarity index 100% rename from docs/content/reference/resource-schema/core-schema/application-schema/_index.md rename to docs/content/reference/resource-schema/core-schema/application-schema/index.md diff --git a/docs/content/reference/resource-schema/core-schema/container-schema/_index.md b/docs/content/reference/resource-schema/core-schema/container-schema/index.md similarity index 100% rename from docs/content/reference/resource-schema/core-schema/container-schema/_index.md rename to docs/content/reference/resource-schema/core-schema/container-schema/index.md diff --git a/docs/content/reference/resource-schema/core-schema/extender/_index.md b/docs/content/reference/resource-schema/core-schema/extender/index.md similarity index 100% rename from docs/content/reference/resource-schema/core-schema/extender/_index.md rename to docs/content/reference/resource-schema/core-schema/extender/index.md diff --git a/docs/content/reference/resource-schema/core-schema/secretstore/_index.md b/docs/content/reference/resource-schema/core-schema/secretstore/index.md similarity index 100% rename from docs/content/reference/resource-schema/core-schema/secretstore/_index.md rename to docs/content/reference/resource-schema/core-schema/secretstore/index.md diff --git a/docs/content/reference/resource-schema/core-schema/volumes/_index.md b/docs/content/reference/resource-schema/core-schema/volumes/_index.md index 90c4f26d8..fec6ee37f 100644 --- a/docs/content/reference/resource-schema/core-schema/volumes/_index.md +++ b/docs/content/reference/resource-schema/core-schema/volumes/_index.md @@ -3,10 +3,4 @@ type: docs title: "Radius Volumes" linkTitle: "Volumes" description: "Learn about Radius volumes" ---- - -A Radius volume allows you to model an outside resource as a volume that can be mounted to one or more containers. It has a lifecycle that is separate from the container lifecycle, ensuring that data is persisted across container restarts and mounts. - -Refer to the [container docs]({{< ref container-schema >}}) to learn how to mount a volume to a container. - -## Supported resources +--- \ No newline at end of file diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/_index.md b/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/index.md similarity index 100% rename from docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/_index.md rename to docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/index.md diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/_index.md b/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/index.md similarity index 100% rename from docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/_index.md rename to docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/index.md diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/_index.md b/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/index.md similarity index 100% rename from docs/content/reference/resource-schema/dapr-schema/dapr-statestore/_index.md rename to docs/content/reference/resource-schema/dapr-schema/dapr-statestore/index.md diff --git a/docs/content/reference/resource-schema/databases/_index.md b/docs/content/reference/resource-schema/databases/_index.md index b78dfcb05..cb6a0cd1d 100644 --- a/docs/content/reference/resource-schema/databases/_index.md +++ b/docs/content/reference/resource-schema/databases/_index.md @@ -3,5 +3,5 @@ type: docs title: "Database links" linkTitle: "Databases" description: "Learn what database resources are available in your application" -weight: 200 +weight: 300 --- diff --git a/docs/content/reference/resource-schema/messaging/_index.md b/docs/content/reference/resource-schema/messaging/_index.md index 7a75d04bf..e94651a91 100644 --- a/docs/content/reference/resource-schema/messaging/_index.md +++ b/docs/content/reference/resource-schema/messaging/_index.md @@ -3,5 +3,5 @@ type: docs title: "Messaging" linkTitle: "Messaging" description: "Learn what messaging resources are available in your application" -weight: 400 +weight: 500 --- diff --git a/docs/content/reference/resource-schema/overview/index.md b/docs/content/reference/resource-schema/overview/index.md new file mode 100644 index 000000000..258e02139 --- /dev/null +++ b/docs/content/reference/resource-schema/overview/index.md @@ -0,0 +1,62 @@ +--- +type: docs +title: "Overview: Resource schemas" +linkTitle: "Overview" +description: "Schema docs for the resources that can comprise a Radius Application" +categories: "Overview" +weight: 100 +--- + +## Common values + +The following properties and values are available across all Radius resources: + +| Key | Required | Description | Example | +|------|:--------:|-------------|---------| +| name | y | The name of your resource. | `mycontainer` +| location | y | The location of your resource. See [below](#location) for more information. The rad CLI defaults the value to 'global' for Radius resources. Direct API calls require `location` to be set to `'global'`. | `global` +| environment | y | The environment used by your resources for deployment. | `environment` | + +### Name + +The name of the resource defines how to address the resource within the context of the application. + +#### Naming constraints + +Radius resource names follow the DNS-1035 naming convention. This, plus other control-plane requirements, result in resource names that must: + +- Contain at most 63 user-entered characters +- Contain only alphanumeric characters or '-' +- Start with an alphabetic character +- End with an alphanumeric character + +#### Rendered names + +The combination of the resource name and application name results in the rendered resource name in a self-hosted Kubernetes environment. The resource group name and resource name also result in the full Universal Control Plane (UCP) identifier of the resource. + +For example, take the following values: + +- **Resource name:** `mycontainer` +- **Application name:** `myapp` +- **Resource group name:** `myrg` + +The resulting names are: + +- **Rendered Kubernetes pod name:** `myapp-mycontainer` +- **Universal Control Plane (UCP) ID:** `/planes/local/resourcegroups/myrg/providers/Applications.Core/containers/mycontainer` + +### Location + +The location property defines where to deploy a resource within the targeted platform. + +For self-hosted environments, the location property is defaulted to `global` by the rad CLI to indicate the resource is scoped to the entire underlying cluster. Direct API calls require `location` to be set to `'global'`. This is a point-in-time implementation that will be revisited in a future revision of self-hosted Kubernetes environments. + +### Environment parameter + +The `environment` string parameter is automatically injected into your Bicep template using the environment ID value specified in your default [workspace]({{< ref workspaces >}}). This value can also be overridden with the rad CLI: `rad deploy --params environment="/planes/radius/..."`. + +To access the auto-injected value, specify an `environment` string parameter in your Bicep file: + +```bicep +param environment string +```