diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh index 57183f973..fcc4eafda 100755 --- a/.github/scripts/release-docs.sh +++ b/.github/scripts/release-docs.sh @@ -67,11 +67,6 @@ mv docs/config.toml.tmp docs/config.toml awk '{gsub(/indexName: '\''radapp-dev-edge'\''/, "indexName: '\''radapp-dev'\''"); print}' docs/layouts/partials/hooks/body-end.html > docs/layouts/partials/hooks/body-end.html.tmp mv docs/layouts/partials/hooks/body-end.html.tmp docs/layouts/partials/hooks/body-end.html -# In docs/content/getting-started/install/index.md, update the binary download links with the new version number -BINARY_STRING_REPLACEMENT=": https:\/\/get\.radapp\.dev\/tools\/rad\/${CHANNEL}\/" -awk -v REPLACEMENT="${BINARY_STRING_REPLACEMENT}" '{gsub(/: https:\/\/get\.radapp\.dev\/tools\/rad\/[^\/]+\//, REPLACEMENT); print}' docs/content/getting-started/install/index.md > docs/content/getting-started/install/index.md.tmp -mv docs/content/getting-started/install/index.md.tmp docs/content/getting-started/install/index.md - # Push changes to GitHub git add --all git commit -m "Update docs for ${VERSION}" diff --git a/docs/content/guides/author-apps/application/overview/app-graph.png b/docs/content/guides/author-apps/application/overview/app-graph.png new file mode 100644 index 000000000..1a33cdc74 Binary files /dev/null and b/docs/content/guides/author-apps/application/overview/app-graph.png differ diff --git a/docs/content/guides/author-apps/application/overview/application.png b/docs/content/guides/author-apps/application/overview/application.png new file mode 100644 index 000000000..acba6e2eb Binary files /dev/null and b/docs/content/guides/author-apps/application/overview/application.png differ diff --git a/docs/content/guides/author-apps/application/overview/graph-automation.png b/docs/content/guides/author-apps/application/overview/graph-automation.png deleted file mode 100644 index fa616e724..000000000 Binary files a/docs/content/guides/author-apps/application/overview/graph-automation.png and /dev/null differ diff --git a/docs/content/guides/author-apps/application/overview/index.md b/docs/content/guides/author-apps/application/overview/index.md index 6186266e1..6c6dbaa25 100644 --- a/docs/content/guides/author-apps/application/overview/index.md +++ b/docs/content/guides/author-apps/application/overview/index.md @@ -2,38 +2,44 @@ type: docs title: "Overview: Radius applications" linkTitle: "Overview" -description: "Learn about Radius applications" +description: "Learn about Radius applications and how they bring all of your services, dependencies, and relationships together." weight: 100 categories: "Overview" tags: ["applications"] --- -## Overview +Diagram of an application -An [application]({{< ref application-graph>}}) is the primary resource that contains all of your services and relationships. +A Radius application is the primary resource that brings all your "stuff" together. This can include services, dependencies, and relationships. Radius apps give you a single description and view into your entire application, and allow you to deploy and manage it easily. -Because Radius has all the relationships and requirements of an application, deployments and configurations are simplified. Developers no longer need to specify all the identity, networking, or other configuration that is normally required, and operators don't need to write custom deployment scripts. +## Add portability to your application -For example, if you want a container to read from an Azure Storage Account without using Radius, this normally requires creating managed identities, RBAC roles, identity federation, Kubernetes service accounts, and more. With Radius, developers can define a single [connection]({{< ref "guides/author-apps/containers/overview#connections" >}}) from their container to a Storage Account, and Radius sets up all the required configuration automatically. +Radius applications are designed to be cloud and platform agnostic. This means that you can define your application once, and deploy it to any cloud or platform that Radius supports. This allows you to easily move your application between clouds, or even between cloud and on-premises environments. Developers can define their requirements and dependencies (_Redis, SQL, Dapr, etc._) and operators can define the [environments]({{< ref "guides/deploy-apps/environments/overview" >}}) and [Recipes]({{< ref "guides/recipes/overview" >}}) that bind those requirements to the appropriate cloud resources. -A diagram showing a connection from a Radius container to an Azure storage account resulting in managed identities, role-based access control, and CSI drivers. +Diagram of portable resources binding to different clouds -## Extensions +Learn more about portable resources in the [portable resources docs]({{< ref "guides/author-apps/portable-resources/overview" >}}) and [Dapr docs]({{< ref "guides/author-apps/dapr/overview" >}}) + +## Customize your application with extensions Extensions allow you to customize how resources are generated or customized as part of deployment. ### Kubernetes Namespace extension -The Kubernetes namespace extension allows you to customize how all of the resources within your application generate Kubernetes resources. See the [Kubernetes mapping guide]({{< ref kubernetes-mapping >}}) for more information on namespace mapping behavior +The Kubernetes namespace extension allows you to customize how all of the resources within your application generate Kubernetes resources. See the [Kubernetes mapping guide]({{< ref kubernetes-mapping >}}) for more information on namespace mapping behavior. ### Kubernetes Metadata extension -The [Kubernetes Metadata extension]({{< ref "guides/operations/kubernetes/kubernetes-metadata">}}) enables you set and cascade Kubernetes metadata such as labels and Annotations on all the Kubernetes resources defined with in your Radius application +The [Kubernetes Metadata extension]({{< ref "guides/operations/kubernetes/kubernetes-metadata">}}) enables you set and cascade Kubernetes metadata such as labels and Annotations on all the Kubernetes resources defined with in your Radius application. -## Resource schema +## Query and understand your application with the Radius Application Graph + +Radius applications are more than just client-side configuration and automation, they also provide a server-side graph of your application. This graph can be queried and used to understand your application, and can be used to power other Radius features and custom tooling. Refer to the [API concept docs]({{< ref "api-concept" >}}) and [Postman How-To guide]({{< ref "guides/operations/control-plane/howto-postman" >}}) for more information on how to query the application graph. -- [Application schema]({{< ref application-schema >}}) +Diagram of the application graph + +## Resource schema -## Further reading +Refer to the [application schema docs]({{< ref application-schema >}}) for more information on how to define an application. -Refer to the [applications]({{< ref "/tags/applications" >}}) tag for more guides on the application resource. +{{< button text="📄 Application schema" page="application-schema" >}} \ No newline at end of file diff --git a/docs/content/guides/author-apps/application/overview/portable-resources.png b/docs/content/guides/author-apps/application/overview/portable-resources.png new file mode 100644 index 000000000..da3dfef61 Binary files /dev/null and b/docs/content/guides/author-apps/application/overview/portable-resources.png differ diff --git a/docs/content/guides/author-apps/containers/overview/index.md b/docs/content/guides/author-apps/containers/overview/index.md index c21b8c862..f4e9f0f03 100644 --- a/docs/content/guides/author-apps/containers/overview/index.md +++ b/docs/content/guides/author-apps/containers/overview/index.md @@ -77,7 +77,7 @@ For example, adding a connection called `database` that connects to a MongoDB re | `CONNECTION_DATABASE_USERNAME` | Username of the target database | | `CONNECTION_DATABASE_PASSWORD` | Password of the target database | -Alternatively, if you already have another convention you would like to follow or if you just prefer to be explicit, you may ignore the values generated by a connection and instead override it by setting your own environment variable values. Refer to the [environment variables quickstart]({{< ref howto-environment-variables >}}) for more details. +Alternatively, if you already have another convention you would like to follow or if you just prefer to be explicit, you may ignore the values generated by a connection and instead override it by setting your own environment variable values. Refer to the [environment variables how-to guide]({{< ref howto-environment-variables >}}) for more details. ## Extensions diff --git a/docs/content/guides/author-apps/dapr/_index.md b/docs/content/guides/author-apps/dapr/_index.md new file mode 100644 index 000000000..f5744fa90 --- /dev/null +++ b/docs/content/guides/author-apps/dapr/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Dapr building blocks" +linkTitle: "Dapr" +description: "Easily leverage Dapr building blocks in your application for code and infrastructure portability" +weight: 500 +--- diff --git a/docs/content/guides/author-apps/dapr/dapr-buildingblocks.png b/docs/content/guides/author-apps/dapr/overview/dapr-buildingblocks.png similarity index 100% rename from docs/content/guides/author-apps/dapr/dapr-buildingblocks.png rename to docs/content/guides/author-apps/dapr/overview/dapr-buildingblocks.png diff --git a/docs/content/guides/author-apps/dapr/dapr-sidecar.png b/docs/content/guides/author-apps/dapr/overview/dapr-sidecar.png similarity index 100% rename from docs/content/guides/author-apps/dapr/dapr-sidecar.png rename to docs/content/guides/author-apps/dapr/overview/dapr-sidecar.png diff --git a/docs/content/guides/author-apps/dapr/index.md b/docs/content/guides/author-apps/dapr/overview/index.md similarity index 97% rename from docs/content/guides/author-apps/dapr/index.md rename to docs/content/guides/author-apps/dapr/overview/index.md index 5ce0cbff8..7d4eda0c2 100644 --- a/docs/content/guides/author-apps/dapr/index.md +++ b/docs/content/guides/author-apps/dapr/overview/index.md @@ -1,11 +1,10 @@ --- type: docs -title: "Dapr building blocks" -linkTitle: "Dapr" +title: "Overview: Dapr building blocks" +linkTitle: "Overview" description: "Easily leverage Dapr building blocks in your application for code and infrastructure portability" -weight: 500 -slug: "dapr" -categories: "Concept" +weight: 100 +categories: "Overview" tags: ["Dapr"] --- diff --git a/docs/content/guides/author-apps/dapr/snippets/dapr-componentname.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/dapr-componentname.bicep similarity index 100% rename from docs/content/guides/author-apps/dapr/snippets/dapr-componentname.bicep rename to docs/content/guides/author-apps/dapr/overview/snippets/dapr-componentname.bicep diff --git a/docs/content/guides/author-apps/dapr/snippets/service-invocation.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/service-invocation.bicep similarity index 100% rename from docs/content/guides/author-apps/dapr/snippets/service-invocation.bicep rename to docs/content/guides/author-apps/dapr/overview/snippets/service-invocation.bicep diff --git a/docs/content/guides/author-apps/dapr/snippets/sidecar.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/sidecar.bicep similarity index 100% rename from docs/content/guides/author-apps/dapr/snippets/sidecar.bicep rename to docs/content/guides/author-apps/dapr/overview/snippets/sidecar.bicep diff --git a/docs/content/guides/author-apps/dapr/snippets/statestore.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/statestore.bicep similarity index 100% rename from docs/content/guides/author-apps/dapr/snippets/statestore.bicep rename to docs/content/guides/author-apps/dapr/overview/snippets/statestore.bicep diff --git a/docs/content/guides/recipes/howto-author-recipes/index.md b/docs/content/guides/recipes/howto-author-recipes/index.md index 7e60c45b1..5599d81a6 100644 --- a/docs/content/guides/recipes/howto-author-recipes/index.md +++ b/docs/content/guides/recipes/howto-author-recipes/index.md @@ -127,7 +127,7 @@ Now that your Recipe template has been stored, you can add it your Radius enviro {{% codetab %}} ```bash -rad recipe register myrecipe --environment myenv --link-type Applications.Datastores/redisCaches --template-kind bicep --template-path myregistry.azurecr.io/recipes/myrecipe:1.1.0 +rad recipe register myrecipe --environment myenv --resource-type Applications.Datastores/redisCaches --template-kind bicep --template-path myregistry.azurecr.io/recipes/myrecipe:1.1.0 ``` {{% /codetab %}} @@ -137,7 +137,7 @@ rad recipe register myrecipe --environment myenv --link-type Applications.Datast The template path value should represent the source path found in your Terraform module registry. ```bash -rad recipe register myrecipe --environment myenv --link-type Applications.Datastores/redisCaches --template-kind terraform --template-path user/recipes/myrecipe --template-version "1.1.0" +rad recipe register myrecipe --environment myenv --resource-type Applications.Datastores/redisCaches --template-kind terraform --template-path user/recipes/myrecipe --template-version "1.1.0" ``` {{% /codetab %}} diff --git a/docs/content/reference/cli/rad_resource_list.md b/docs/content/reference/cli/rad_resource_list.md index 04c967855..066cbc603 100644 --- a/docs/content/reference/cli/rad_resource_list.md +++ b/docs/content/reference/cli/rad_resource_list.md @@ -22,7 +22,7 @@ rad resource list [resourceType] [flags] ``` - sample list of resourceType: containers, gateways, httpRoutes, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores + sample list of resourceType: containers, gateways, httpRoutes, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores # list all resources of a specified type in the default environment diff --git a/docs/content/reference/context-schema/index.md b/docs/content/reference/context-schema/index.md index 6c26b4d9c..52a44872f 100644 --- a/docs/content/reference/context-schema/index.md +++ b/docs/content/reference/context-schema/index.md @@ -90,5 +90,5 @@ The `context` object is automatically injected to Bicep templates when a Recipe | Key | Type | Description | |-----|------|-------------| -| [`region`] | string | Represents the region where AWS resources are deployed. -| [`account`] | string | Represents the account id of the AWS account. +| `region` | string | Represents the region where AWS resources are deployed. +| `account` | string | Represents the account id of the AWS account. diff --git a/docs/content/tutorials/tutorial-recipe/index.md b/docs/content/tutorials/tutorial-recipe/index.md index 1c3e274cc..c4286c64c 100644 --- a/docs/content/tutorials/tutorial-recipe/index.md +++ b/docs/content/tutorials/tutorial-recipe/index.md @@ -29,7 +29,7 @@ This how-to guide will teach you: This application is a simple to-do list which stores and visualizes to-do items. It consists of a frontend [container]({{< ref "guides/author-apps/containers" >}}) and a backend [Redis Cache]({{< ref redis >}}). -Screenshot of the todoapp with Kubernetes, Azure and AWS Redis Cache options +Screenshot of the todoapp with Kubernetes, Azure and AWS Redis Cache options {{< alert title="💡 Portable resources" color="info" >}} Developers don't need to specify what cloud resources they're using in their application. Instead, they choose the portable Redis API which can be provided by any cloud provider (or a Docker container). When deployed, a Recipe will select what infrastructure to deploy and run. @@ -153,7 +153,7 @@ This step requires an Azure subscription to deploy cloud resources, which will i 2. Register the Recipe to your Radius Environment: ```bash - rad recipe register azure --environment default --template-kind bicep --template-path radius.azurecr.io/recipes/azure/rediscaches:{{< param tag_version >}} --link-type Applications.Datastores/redisCaches + rad recipe register azure --environment default --template-kind bicep --template-path radius.azurecr.io/recipes/azure/rediscaches:{{< param tag_version >}} --resource-type Applications.Datastores/redisCaches ``` 3. Update your db resource to use the `azure` Recipe, instead of the default Recipe: diff --git a/docs/content/tutorials/tutorial-recipe/recipe-quickstart-diagram.png b/docs/content/tutorials/tutorial-recipe/recipe-tutorial-diagram.png similarity index 100% rename from docs/content/tutorials/tutorial-recipe/recipe-quickstart-diagram.png rename to docs/content/tutorials/tutorial-recipe/recipe-tutorial-diagram.png