diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index 4c4fb861d..08523f645 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -86,8 +86,6 @@ PowerShell Pre PubSub ProjectRadius -Quickstart -Quickstarts RBAC RabbitMQ ResourceDeploymentClient @@ -291,8 +289,6 @@ publickey publicEndpointOverride pubsub px -quickstart -quickstarts rabbitMQMessageQueues rabbitmq radapp @@ -437,6 +433,8 @@ hl azureCache listKeys primaryKey +quickstart +quickstarts mygroup Kubeconfig unregister @@ -451,4 +449,5 @@ mongodb MYCONNECTION VHOST DiΓ‘taxis -yourworkspace \ No newline at end of file +yourworkspace +howto diff --git a/docs/assets/scss/_nav.scss b/docs/assets/scss/_nav.scss new file mode 100644 index 000000000..9b5137509 --- /dev/null +++ b/docs/assets/scss/_nav.scss @@ -0,0 +1,218 @@ +// +// Main navbar +// + +.td-navbar-cover { + background: $primary; + + @include media-breakpoint-up(md) { + background: transparent !important; + + .nav-link { + text-shadow: 1px 1px 2px $dark; + } + + } + + &.navbar-bg-onscroll .nav-link { + text-shadow: none; + } +} + +.navbar-bg-onscroll { + background: $primary !important; + opacity: inherit; +} + +.td-navbar { + background: $primary; + min-height: 4rem; + margin: 0; + z-index: 32; + + @include media-breakpoint-up(md) { + position: fixed; + top: 0; + width: 100%; + } + + + .navbar-brand { + text-transform: none; + text-align: middle; + + .nav-link { + display: inline-block; + margin-right: -30px; + } + + svg { + display: inline-block; + margin: 0 10px; + height: 30px; + } + } + + .nav-link { + text-transform: none; + font-weight: $font-weight-bold; + } + + .td-search-input { + border: none; + color: $navbar-dark-color; + @include placeholder { + color: $navbar-dark-color; + } + } + + .dropdown { + min-width: 100px; + } + + @include media-breakpoint-down(md) { + padding-right: .5rem; + padding-left: .75rem; + + .td-navbar-nav-scroll { + max-width: 100%; + height: 2.5rem; + margin-top: .25rem; + overflow: hidden; + font-size: .875rem; + + .nav-link { + padding-right: .25rem; + padding-left: 0; + } + + .navbar-nav { + padding-bottom: 2rem; + overflow-x: auto; + white-space: nowrap; + -webkit-overflow-scrolling: touch; + + } + } + } +} + +// Icons +#main_navbar { + li i { + padding-right: 0.5em; + + &:before { + display: inline-block; + text-align: center; + min-width: 1em; + } + } + .alert { + background-color: inherit; + padding:0; + color: $secondary; + border: 0; + font-weight: inherit; + + &:before { + display: inline-block; + font-style: normal; + font-variant: normal; + text-rendering: auto; + -webkit-font-smoothing: antialiased; + font-family: "Font Awesome 5 Free"; + font-weight: 900; + content: "\f0d9"; + padding-left: 0.5em; + padding-right: 0.5em; + } + } +} + +// Foldable sidebar menu +nav.foldable-nav { + + &#td-section-nav { + position: relative; + } + + &#td-section-nav label { + margin-bottom: 0; + width: 100%; + } + + .td-sidebar-nav__section, .with-child ul { + list-style: none; + padding: 0; + margin: 0; + } + + .ul-1 > li { + padding-left: 1.5em; + } + + ul.foldable { + max-height: 0; + overflow: hidden; + transition: max-height 0.5s cubic-bezier(0, 1, 0, 1); + } + + input:checked ~ ul.foldable { + max-height: 100000vmax; + transition: max-height 1s ease-in-out; + } + + input[type=checkbox] { display: none; } + + .with-child, .without-child { + position: relative; + padding-left: 1.3em; + } + + .ul-1 .with-child > label:before { + display: inline-block; + font-style: normal; + font-variant: normal; + text-rendering: auto; + -webkit-font-smoothing: antialiased; + font-family: "Font Awesome 5 Free"; font-weight: 900; content: "\f0da"; + position: absolute; + left: 0.1em; + padding-left: 0.4em; + padding-right: 0.4em; + font-size: 1em; + color: $gray-900; + transition: all 0.5s; + &:hover{ + transform: rotate(90deg); + } + } + + .ul-1 .with-child > input:checked ~ label:before { + color: $primary; + transform: rotate(90deg); + transition: transform 0.5s; + } + + .with-child ul { margin-top: 0.1em; } + +} + +@media (hover: hover) and (pointer: fine) { + + nav.foldable-nav { + + .ul-1 .with-child > label:hover:before { + color: $primary; + transform: rotate(30deg); + transition: transform 0.5s; + } + + .ul-1 .with-child > input:checked ~ label:hover:before { + color: $primary; + transform: rotate(60deg) !important; + transition: transform 0.5s; + } + } +} diff --git a/docs/assets/scss/_sidebar-tree.scss b/docs/assets/scss/_sidebar-tree.scss index 8a4dfb840..55ae80b57 100644 --- a/docs/assets/scss/_sidebar-tree.scss +++ b/docs/assets/scss/_sidebar-tree.scss @@ -2,9 +2,9 @@ // Left side navigation // .td-sidebar-nav { - padding-right: 0.5rem; - margin-right: -15px; - margin-left: -15px; + padding-right: 0.1rem; + margin-right: -20px; + margin-left: -20px; @include media-breakpoint-up(md) { @supports (position: sticky) { @@ -54,7 +54,7 @@ .td-sidebar-link { display: block; - padding-bottom: 0.3rem; + padding-bottom: 0.15rem; &__page { color: $gray-700; @@ -62,6 +62,7 @@ } a { + font-size: .9rem; &:hover { color: $blue; text-decoration: none; @@ -101,6 +102,7 @@ color: $td-sidebar-tree-root-color; border-bottom: 1px $td-sidebar-tree-root-color solid; margin-bottom: 1rem; + margin-top: 1rem; } } diff --git a/docs/content/_index.md b/docs/content/_index.md index 9226bb14a..b99d357ee 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -47,7 +47,7 @@ Teams can offload the complexity of wiring-up applications and let Radius employ Networking logo - Dapr logo + }}">Dapr logo diff --git a/docs/content/author-apps/platform-resources/_index.md b/docs/content/author-apps/platform-resources/_index.md deleted file mode 100644 index fc4bcf111..000000000 --- a/docs/content/author-apps/platform-resources/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: docs -title: "Platform resources" -linkTitle: "Platform resources" -description: "Deploy and connect to resources that are hosted in Kubernetes, Azure and AWS" -weight: 1000 ---- - -Kubernetes, Azure and AWS resources can all be added to your Radius application. Simply model your resources and add a connection from a Radius container. diff --git a/docs/content/author-apps/portability/_index.md b/docs/content/author-apps/portability/_index.md deleted file mode 100644 index 49359d00d..000000000 --- a/docs/content/author-apps/portability/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -type: docs -title: "Application portability" -linkTitle: "Portability" -description: "Learn how to make your applications portable" -weight: 500 -tags: ["portability"] ---- - -Radius applications can be deployed across Kubernetes, Azure and AWS environments. Using the set of Radius resources that act as abstractions across popular open-source technologies, developers can author their application once and operators can deploy across any cloud or on-premises Radius environment. \ No newline at end of file diff --git a/docs/content/author-apps/vscode/_index.md b/docs/content/author-apps/vscode/_index.md deleted file mode 100644 index d599eb7ea..000000000 --- a/docs/content/author-apps/vscode/_index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -type: docs -title: "Visual Studio Code extension" -linkTitle: "Visual Studio Code" -description: "Overview of the Radius Visual Studio Code extension" -weight: 300 -toc_hide: true -hide_summary: true ---- - - - -Developers can use the *preview* Radius Visual Studio Code extension which offers a variety of features to help manage Radius applications across cloud and edge. - -{{% alert title="Bicep extension" color="info" %}} -In addition to the Radius extension described in this page, a forked Bicep extension is also used for formatting and linting. This requirement will be removed in a future release. Visit the [getting started guide]({{< ref "getting-started#setup-vscode" >}}) for instructions on installing the custom Bicep extension. -{{% /alert %}} - -## Features - -### Manage your environments, applications, and resources - -View and interact with environments, applications and resources deployed to your Radius environments. - -Simply open the Radius extension and the extension will list all the environments in your local config, along with all of the applications and resources deployed to them: - -Screenshot of environments, applications, and resources listed inside of VS Code - -### View logs from container resources - -The Radius extension helps you debug your applications by streaming logs directly from a container resource to the terminal window inside the VS Code IDE. - -From the Visual Studio command palette, select `Radius: Show Container Logs` and select your environment, application, and container: - -Screenshot of viewing container logs - -## Installation - -1. Download the latest [VSCode extension file](https://get.radapp.dev/tools/vscode-extensibility/stable/rad-vscode.vsix) - -2. Install the `.vsix` file: - - {{< tabs UI Terminal >}} - - {{% codetab %}} - In VSCode, manually install the extension using the *Install from VSIX* command in the Extensions view command drop-down. - - Screenshot of installing a vsix extension - {{% /codetab %}} - - {{% codetab %}} - You can also import this extension on the [command-line](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) with: - - ```bash - code --install-extension rad-vscode.vsix - ``` - - {{% /codetab %}} - {{< /tabs >}} - -3. If running on Windows Subsystem for Linux (WSL), make sure to install the extension in WSL as well: - - Screenshot of installing a vsix extension in WSL - -## Additional resources - -- [Edge extension download](https://radiuspublic.blob.core.windows.net/tools/vscode-extensibility/edge/rad-vscode-bicep.vsix) diff --git a/docs/content/author-apps/vscode/vscode-logs.png b/docs/content/author-apps/vscode/vscode-logs.png deleted file mode 100644 index 4ce128d68..000000000 Binary files a/docs/content/author-apps/vscode/vscode-logs.png and /dev/null differ diff --git a/docs/content/author-apps/vscode/vscode-tree.png b/docs/content/author-apps/vscode/vscode-tree.png deleted file mode 100644 index 0ba4d423e..000000000 Binary files a/docs/content/author-apps/vscode/vscode-tree.png and /dev/null differ diff --git a/docs/content/author-apps/vscode/wsl-extension.png b/docs/content/author-apps/vscode/wsl-extension.png deleted file mode 100644 index ab0ff3a9b..000000000 Binary files a/docs/content/author-apps/vscode/wsl-extension.png and /dev/null differ diff --git a/docs/content/community/_index.md b/docs/content/community/_index.md new file mode 100644 index 000000000..f0fd89bda --- /dev/null +++ b/docs/content/community/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Radius Community" +linkTitle: "Community" +description: "Information about the Radius community" +weight: 80 +--- diff --git a/docs/content/community/contributing/_index.md b/docs/content/community/contributing/_index.md new file mode 100644 index 000000000..76447d68c --- /dev/null +++ b/docs/content/community/contributing/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Contributing to Radius" +linkTitle: "Contributing" +description: "Guides and requirements for contributing to Radius" +weight: 200 +--- \ No newline at end of file diff --git a/docs/content/contributing/architecture.png b/docs/content/community/contributing/architecture.png similarity index 100% rename from docs/content/contributing/architecture.png rename to docs/content/community/contributing/architecture.png diff --git a/docs/content/contributing/contributing-docs/diataxis.png b/docs/content/community/contributing/contributing-docs/diataxis.png similarity index 100% rename from docs/content/contributing/contributing-docs/diataxis.png rename to docs/content/community/contributing/contributing-docs/diataxis.png diff --git a/docs/content/contributing/contributing-docs/index.md b/docs/content/community/contributing/contributing-docs/index.md similarity index 98% rename from docs/content/contributing/contributing-docs/index.md rename to docs/content/community/contributing/contributing-docs/index.md index 1bd85f247..4616446fe 100644 --- a/docs/content/contributing/contributing-docs/index.md +++ b/docs/content/community/contributing/contributing-docs/index.md @@ -1,7 +1,7 @@ --- type: docs -title: "Contributing to Radius documentation" -linkTitle: "Docs" +title: "How-To: Contribute to the Radius documentation" +linkTitle: "Contribute to docs" description: "How to contribute to the Radius documentation" weight: 200 slug: "docs" @@ -204,7 +204,6 @@ Front-matter should be completed with all fields including type, title, linkTitl - `categories` should be one of the following: - Concept - Overview - - Quickstart - Reference application - How-To - `tags` should be a comma-separated list of metadata tags. @@ -575,15 +574,15 @@ By default, buttons are padded with new lines below the button. To remove these You can use the `categorizeby` shortcode to pull and organize content by either categories and tags. This is useful when you want to categorize content by tags and the type of the document ``` -{{ categorizeby category="Quickstart" tag= "containers" }} +{{ categorizeby category="How-To" tag= "containers" }} ``` -This categorizes and lists all the docs that has both "quickstart" as the category and "container" as the tag. +This categorizes and lists all the docs that has both "How-To" as the category and "container" as the tag. ``` -{{ categorizeby category="Quickstart" }} +{{ categorizeby category="How-To" }} ``` -This categorizes and lists all the docs that are quickstart by the available tags. +This categorizes and lists all the docs that are How-To by the available tags. ### References diff --git a/docs/content/contributing/github.md b/docs/content/community/contributing/github.md similarity index 98% rename from docs/content/contributing/github.md rename to docs/content/community/contributing/github.md index 6d3b05cf2..bc904ba79 100644 --- a/docs/content/contributing/github.md +++ b/docs/content/community/contributing/github.md @@ -3,7 +3,7 @@ type: docs title: "Radius GitHub organization" linkTitle: "GitHub" description: "Learn where the Radius source code and issues are located" -weight: 100 +weight: 200 --- Radius is a community-driven project that lives on GitHub within the [Radius organization](https://github.com/project-radius). diff --git a/docs/content/contributing/_index.md b/docs/content/community/contributing/overview/index.md similarity index 94% rename from docs/content/contributing/_index.md rename to docs/content/community/contributing/overview/index.md index 654a18052..f835f801d 100644 --- a/docs/content/contributing/_index.md +++ b/docs/content/community/contributing/overview/index.md @@ -1,10 +1,9 @@ --- type: docs -title: "Contributing to Radius" -linkTitle: "Contributing" +title: "Overview: Contributing to Radius" +linkTitle: "Overview" description: "Guides and requirements for contributing to Radius" -weight: 70 -no_list: true +weight: 100 --- We welcome contributions to the Radius! Check out the following table to learn where and how you can contribute: diff --git a/docs/content/contributing/maintainers/_index.md b/docs/content/community/maintainers/_index.md similarity index 74% rename from docs/content/contributing/maintainers/_index.md rename to docs/content/community/maintainers/_index.md index e31f577ea..e7b6220ad 100644 --- a/docs/content/contributing/maintainers/_index.md +++ b/docs/content/community/maintainers/_index.md @@ -5,5 +5,3 @@ linkTitle: "Maintainers" description: "Guides and requirements for Radius maintainers" weight: 999 --- - -This section contains guides for Radius maintainers. diff --git a/docs/content/contributing/maintainers/docs-maintainers.md b/docs/content/community/maintainers/docs-maintainers.md similarity index 97% rename from docs/content/contributing/maintainers/docs-maintainers.md rename to docs/content/community/maintainers/docs-maintainers.md index d58be98ce..86a25c5eb 100644 --- a/docs/content/contributing/maintainers/docs-maintainers.md +++ b/docs/content/community/maintainers/docs-maintainers.md @@ -1,7 +1,7 @@ --- type: docs -title: "Maintaining Radius docs" -linkTitle: "Docs" +title: "How-To: Maintain the Radius docs" +linkTitle: "Maintain docs" weight: 200 description: "Learn about the Radius docs maintenance process" --- diff --git a/docs/content/community.md b/docs/content/community/overview.md similarity index 99% rename from docs/content/community.md rename to docs/content/community/overview.md index debdfd224..3cec7823e 100644 --- a/docs/content/community.md +++ b/docs/content/community/overview.md @@ -1,7 +1,7 @@ --- type: docs title: "Radius Community" -linkTitle: "Community" +linkTitle: "Overview" description: "Information about the Radius community" weight: 80 --- diff --git a/docs/content/concepts/_index.md b/docs/content/concepts/_index.md index 3a4ea3eaa..79a8188cf 100644 --- a/docs/content/concepts/_index.md +++ b/docs/content/concepts/_index.md @@ -2,6 +2,6 @@ type: docs title: "Radius concepts" linkTitle: "Concepts" -description: "Learn about the Radius mission, core concepts, and architecture" -weight: 10 +description: "Learn about Radius background, core concepts, and architecture" +weight: 80 --- diff --git a/docs/content/concepts/application-graph/index.md b/docs/content/concepts/application-graph/index.md index 6257f15cc..1fbc86dab 100644 --- a/docs/content/concepts/application-graph/index.md +++ b/docs/content/concepts/application-graph/index.md @@ -8,13 +8,13 @@ weight: 200 ## Radius applications -Radius offers an [application resource]({{< ref "/author-apps/application" >}}) which teams can use to define and deploy their entire application, including all of the compute, relationships, and infrastructure that make up the application. Since the graph of relationships between deployed resources is much more descriptive than a basic list of resources, the Radius application graph can automate complex deployment tasks and enable rich visualization experiences. +Radius offers an [application resource]({{< ref "guides/author-apps/application" >}}) which teams can use to define and deploy their entire application, including all of the compute, relationships, and infrastructure that make up the application. Since the graph of relationships between deployed resources is much more descriptive than a basic list of resources, the Radius application graph can automate complex deployment tasks and enable rich visualization experiences. A diagram showing an application and all it's resources ## Graphs are better than lists -Within an application deployed with Radius, developers can express both the resources (_containers, databases, message queues, etc._), as well as all the relationships between them. This forms the Radius application graph. This graph is powerful because it allows Radius to understand the relationships between resources, simplifying the [deployment]({{< ref "deploy-applications" >}}) and [configuration]({{< ref "application" >}}) of your application. Plus, it allows you to visualize your application in a way that is more intuitive than a list of resources. +Within an application deployed with Radius, developers can express both the resources (_containers, databases, message queues, etc._), as well as all the relationships between them. This forms the Radius application graph. This graph is powerful because it allows Radius to understand the relationships between resources, simplifying the [deployment]({{< ref "/guides/deploy-apps" >}}) and [configuration]({{< ref "application" >}}) of your application. Plus, it allows you to visualize your application in a way that is more intuitive than a list of resources. A diagram showing the move from a set of infrastructure lists to a graph of resources diff --git a/docs/content/concepts/architecture-concept/index.md b/docs/content/concepts/architecture-concept/index.md index b63e21095..9ba1cbfff 100644 --- a/docs/content/concepts/architecture-concept/index.md +++ b/docs/content/concepts/architecture-concept/index.md @@ -171,5 +171,5 @@ When using the `tf` CLI to deploy a Radius application using Terraform: Now that you have an understanding of the Radius architecture, try Radius out: -{{< button text="Get started" page="first-app" size="btn-lg" color="success" >}} +{{< button text="Get started" page="getting-started" size="btn-lg" color="success" >}} diff --git a/docs/content/concepts/environments-concept/_index.md b/docs/content/concepts/environments-concept/index.md similarity index 91% rename from docs/content/concepts/environments-concept/_index.md rename to docs/content/concepts/environments-concept/index.md index 9e5aeb02c..b0c0fa2f7 100644 --- a/docs/content/concepts/environments-concept/_index.md +++ b/docs/content/concepts/environments-concept/index.md @@ -22,11 +22,11 @@ Environments provide a grouping structure for applications and the resources the In many small to medium-sized organizations, a full stack developer might write application code, author the Radius app definition, and create the Radius environment. In larger orgs, there may be separate teams of central operations and developers, where the central teams build environment templates which development teams leverage and deploy to. The separation of an app from an environment makes a separation of concerns possible. -With Radius environments, central operations and IT teams can define and share environments with development teams for them to deploy applications into. Ops teams can focus on configuring the compute, dependencies, networking, and other infrastructure concerns through [Recipes]({{< ref "/author-apps/recipes">}}), while developers focus on the business and application concerns. This allows each team to focus on what matters most to them, without needing to become experts in every aspect of the infrastructure and application. +With Radius environments, central operations and IT teams can define and share environments with development teams for them to deploy applications into. Ops teams can focus on configuring the compute, dependencies, networking, and other infrastructure concerns through [Recipes]({{< ref "guides/recipes/overview">}}), while developers focus on the business and application concerns. This allows each team to focus on what matters most to them, without needing to become experts in every aspect of the infrastructure and application. ### Developer productivity -Once an environment template is defined, developers can get up and running with a prepared development, pre-production, or production environment in minutes. No more waiting for manual provisioning, configuration or inter-team coordination. Simply use the [Recipes]({{< ref "/author-apps/recipes" >}}) linked to your Radius environment and deploy your application. +Once an environment template is defined, developers can get up and running with a prepared development, pre-production, or production environment in minutes. No more waiting for manual provisioning, configuration or inter-team coordination. Simply use the [Recipes]({{< ref "guides/recipes/overview" >}}) linked to your Radius environment and deploy your application. ### Replication and consistency @@ -46,7 +46,7 @@ Organizational best-practices such as cost-optimization, resource sharing, and l | **Networking** *(coming soon)* | Define networking requirements such that applications are automatically configured with network isolation best-practices. | **Identity & access** *(coming soon)* | Limit access to deployments, resources and capabilities based on user roles and assignments. | **Dependencies** *(coming soon)* | Define environment requirements such as policy, packages, or other organization requirements. -| **Infrastructure provisioning** | Automatically provision infrastructure at deployment time through [Recipes]({{< ref "/author-apps/recipes" >}}). +| **Infrastructure provisioning** | Automatically provision infrastructure at deployment time through [Recipes]({{< ref "guides/recipes/overview" >}}). | **Dependency management** *(coming soon)* | Manage dependencies and environment capabilities such as packages, frameworks, and other configuration. ## Example: Handoff between teams diff --git a/docs/content/concepts/overview/_index.md b/docs/content/concepts/overview/index.md similarity index 100% rename from docs/content/concepts/overview/_index.md rename to docs/content/concepts/overview/index.md diff --git a/docs/content/deploy-apps/dev-environment/initialize-environment.md b/docs/content/deploy-apps/dev-environment/initialize-environment.md deleted file mode 100644 index 1411b23f8..000000000 --- a/docs/content/deploy-apps/dev-environment/initialize-environment.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -type: docs -title: "How-To: Setup a development environment" -linkTitle: "Developer environments" -description: "Learn how to initialize a new Radius development environment" -weight: 100 -categories: "How-To" -tags: ["environments"] ---- - -## Overview - -Radius development environments enable you to quickly get started with Radius and begin writing new applications. Dev environments come preloaded with a set of development [recipes]({{< ref "author-apps/recipes" >}}) with lightweight containers for commonly used resources such as Redis and Mongo, helping you get up and running instantly. - -## Pre-requisites - -1. Have a [Kubernetes cluster]({{< ref "/operations/platforms/kubernetes" >}}) handy. - - *Visit the [Kubernetes platform docs]({{< ref "/operations/platforms/kubernetes" >}}) for a list of supported clusters and specific cluster requirements.* - -1. Ensure your target kubectl context is set as the default: - ```bash - kubectl config current-context - ``` - -## How-to: Initialize a new dev environment - -1. Initialize a new [Radius environment]({{< ref "operations/environments/overview">}}) with [`rad init`]({{< ref rad_init >}}): - ```bash - rad init - ``` - - Select `Yes` to setup the app.bicep in the current directory - - ``` - Initializing Radius... - - πŸ•” Install Radius 0.21 - - Kubernetes cluster: kind - - Kubernetes namespace: radius-system - ⏳ Create new environment default - - Kubernetes namespace: default - - Recipe pack: dev - ⏳ Scaffold application - ⏳ Update local configuration - ``` - -2. Verify the initialization by running: - ```bash - kubectl get deployments -n radius-system - ``` - - You should see: - - ``` - NAME READY UP-TO-DATE AVAILABLE AGE - ucp 1/1 1 1 53s - appcore-rp 1/1 1 1 53s - bicep-de 1/1 1 1 53s - contour-contour 1/1 1 1 46s - ``` - - You can also use [`rad env list`]({{< ref rad_env_list.md >}}) to view your environment: - - ```bash - rad env list - ``` -3. Use `rad recipe list` to see the list of available recipes: - ```bash - rad recipe list - ``` - ``` - NAME TYPE TEMPLATE KIND TEMPLATE - default Applications.Link/mongoDatabases bicep radius.azurecr.io/recipes/dev/mongodatabases:latest - default Applications.Link/redisCaches bicep radius.azurecr.io/recipes/dev/rediscaches:latest - ``` - You can follow the [recipes]({{< ref "author-apps/recipes" >}}) documentation to learn more about the recipes and how to use them in your application. - -## Resource schema - -- [Environment schema]({{< ref environment-schema >}}) - -## Further reading - -Refer to the [environments]({{< ref "/tags/environments" >}}) tag for more guides on the environment resource. diff --git a/docs/content/getting-started/_index.md b/docs/content/getting-started/_index.md deleted file mode 100644 index bdc0b8b2d..000000000 --- a/docs/content/getting-started/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Getting started" -linkTitle: "Getting started" -description: "How to get up and running with Radius tooling in just a few minutes" -weight: 20 ---- diff --git a/docs/content/getting-started/first-app/demo-screenshot.png b/docs/content/getting-started/demo-screenshot.png similarity index 100% rename from docs/content/getting-started/first-app/demo-screenshot.png rename to docs/content/getting-started/demo-screenshot.png diff --git a/docs/content/getting-started/first-app/demo-with-redis-screenshot.png b/docs/content/getting-started/demo-with-redis-screenshot.png similarity index 100% rename from docs/content/getting-started/first-app/demo-with-redis-screenshot.png rename to docs/content/getting-started/demo-with-redis-screenshot.png diff --git a/docs/content/getting-started/first-app/demo-with-todolist.png b/docs/content/getting-started/demo-with-todolist.png similarity index 100% rename from docs/content/getting-started/first-app/demo-with-todolist.png rename to docs/content/getting-started/demo-with-todolist.png diff --git a/docs/content/getting-started/first-app/_index.md b/docs/content/getting-started/index.md similarity index 82% rename from docs/content/getting-started/first-app/_index.md rename to docs/content/getting-started/index.md index f10f369af..87f8b23a8 100644 --- a/docs/content/getting-started/first-app/_index.md +++ b/docs/content/getting-started/index.md @@ -1,20 +1,20 @@ --- type: docs -title: "Run your first app" -linkTitle: "Run your first app" -weight: 50 -description: "Take a tour of Radius by running your first app" +title: "Getting started with Radius: Run your first app" +linkTitle: "Getting started" +weight: 10 +description: "Take a tour of Radius by getting started with your first app" aliases: - /getting-started/tutorial/ --- -This guide offers the quickest way to get started using Radius. You'll walk through both installing Radius and running your first Radius app. +This guide will show you how to quickly get started with Radius. You'll walk through both installing Radius and running your first Radius app. **Estimated time to complete: 10 min** ## 1. Have your Kubernetes cluster handy -Radius runs inside [Kubernetes]({{< ref "/operations/platforms/kubernetes" >}}). However you run Kubernetes, get a cluster ready. +Radius runs inside [Kubernetes]({{< ref "guides/operations/kubernetes" >}}). However you run Kubernetes, get a cluster ready. > *If you don't have a preferred way to create Kubernetes clusters, you could try using [k3d](https://k3d.io/), which runs a minimal Kubernetes distribution in Docker.* Ensure your cluster is set as your current context: @@ -47,7 +47,7 @@ iwr -useb "https://get.radapp.dev/tools/rad/install.ps1" | iex {{< /tabs >}} -Visit the [installation]({{< ref install >}}) page for troubleshooting or additional options. +Visit the [rad CLI]({{< ref howto-rad-cli >}}) page for troubleshooting or additional options. Verify the rad CLI is installed correctly by running `rad version`. @@ -113,7 +113,7 @@ When you're ready to move on to the next step, use `CTRL+C` to exit the command. This step will add a database (Redis Cache) to the application. -You can create a Redis Cache using [Recipes]({{< ref "/author-apps/recipes" >}}) provided by Radius. The Radius community provides Recipes for running commonly used application dependencies, including Redis. +You can create a Redis Cache using [Recipes]({{< ref "guides/recipes/overview" >}}) provided by Radius. The Radius community provides Recipes for running commonly used application dependencies, including Redis. In this step you will: @@ -126,7 +126,7 @@ First add some new code to `app.bicep` by pasting in the content below at the en {{< rad file="snippets/app-with-redis-snippets.bicep" embed=true marker="//REDIS" markdownConfig="{linenos=table,linenostart=21}" >}} -Next, update your container definition to include `connections` inside `properties`. This code creates a connection between the container and the database. Based on this connection, Radius will [inject environment variables]({{< ref "container#connections" >}}) into the container that inform the container how to connect. You will view these in the next step. +Next, update your container definition to include `connections` inside `properties`. This code creates a connection between the container and the database. Based on this connection, Radius will [inject environment variables]({{< ref "/guides/author-apps/containers/overview#connections" >}}) into the container that inform the container how to connect. You will view these in the next step. {{< rad file="snippets/app-with-redis-snippets.bicep" embed=true marker="//CONNECTION" markdownConfig="{linenos=table,hl_lines=[\"13-17\"],linenostart=7}" >}} @@ -161,4 +161,4 @@ It's easy to build on the default app and add more resources to the app. To delete your app, see [rad app delete]({{< ref rad_application_delete >}}).
-{{< button text="Next step: Radius Quickstarts" page="getting-started/quickstarts" >}} +{{< button text="Next step: Radius Tutorials" page="tutorials" >}} diff --git a/docs/content/getting-started/install/index.md b/docs/content/getting-started/install/index.md deleted file mode 100644 index 0dab4ac74..000000000 --- a/docs/content/getting-started/install/index.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -type: docs -title: "Install Radius" -linkTitle: "Install Radius" -description: "Learn how to install the Radius tools on your local machine" -weight: 100 -categories: "How-To" -tags: ["rad CLI", "Bicep"] ---- - -{{< alert title="Get started in seconds with a Codespace" color="primary" >}} -Use a free [GitHub Codespace](https://github.com/features/codespaces) to test out the sample applications and build your own in a pre-configured container complete with the rad CLI, Bicep extension, and a pre-deployed environment. Once launched, you can [run your first app]({{< ref first-app >}}). - -Launch a new Codespace - -_Visit the [GitHub docs]({{< ref github >}}) if you need access to the organization._ -{{< /alert >}} - -## Install `rad` CLI - -The `rad` CLI manages your applications, resources, and environments. Begin by installing it on your machine: - -{{< tabs MacOS "Linux/WSL" "Windows PowerShell" "Cloud Shell" Binaries >}} - -{{% codetab %}} -{{< latest >}} -```bash -curl -fsSL "https://get.radapp.dev/tools/rad/install.sh" | /bin/bash -``` -{{< /latest >}} -{{< edge >}} -To install the latest edge version: - -```bash -curl -fsSL "https://radiuspublic.blob.core.windows.net/tools/rad/install.sh" | /bin/bash -s edge -``` -{{< /edge >}} -{{% /codetab %}} - -{{% codetab %}} -{{< latest >}} -```bash -wget -q "https://get.radapp.dev/tools/rad/install.sh" -O - | /bin/bash -``` -{{< /latest >}} -{{< edge >}} -To install the latest edge version: - -```bash -wget -q "https://radiuspublic.blob.core.windows.net/tools/rad/install.sh" -O - | /bin/bash -s edge -``` -{{< /edge >}} -{{% /codetab %}} - -{{% codetab %}} -{{< latest >}} -Run the following in a PowerShell window: - -```powershell -iwr -useb "https://get.radapp.dev/tools/rad/install.ps1" | iex -``` - -You may need to refresh your $PATH environment variable to access `rad`: -```powershell -$Env:Path = [System.Environment]::GetEnvironmentVariable("Path","User") -``` -{{< /latest >}} -{{< edge >}} -To install the latest edge version: - -```powershell -$script=iwr -useb https://radiuspublic.blob.core.windows.net/tools/rad/install.ps1; $block=[ScriptBlock]::Create($script); invoke-command -ScriptBlock $block -ArgumentList edge -``` -{{< /edge >}} -{{% /codetab %}} - -{{% codetab %}} -[Azure Cloud Shell](https://docs.microsoft.com/en-us/azure/cloud-shell/overview) is an interactive, authenticated, browser-accessible shell for managing Azure resources. - -Azure Cloud Shell for bash doesn't have a sudo command, so users are unable to install Radius to the default `/usr/local/bin` installation path. To install the rad CLI to the home directory, run the following commands: - -```bash -export RADIUS_INSTALL_DIR=./ -wget -q "https://get.radapp.dev/tools/rad/install.sh" -O - | /bin/bash -``` - -You can now run the rad CLI with `./rad`. - -PowerShell for Cloud Shell is currently not supported. -{{% /codetab %}} - -{{% codetab %}} -{{< latest >}} -1. Download the `rad` CLI from one of these URLs: - - MacOS x64: https://get.radapp.dev/tools/rad/0.23/macos-x64/rad - - MacOS arm64: https://get.radapp.dev/tools/rad/0.23/macos-arm64/rad - - Linux x64: https://get.radapp.dev/tools/rad/0.23/linux-x64/rad - - Windows x64: https://get.radapp.dev/tools/rad/0.23/windows-x64/rad.exe -1. Ensure the user has permission to execute the binary and place it somewhere on your PATH so it can be invoked easily. -{{< /latest >}} -{{< edge >}} -1. Download the `rad` CLI from one of these URLs: - - MacOS: https://radiuspublic.blob.core.windows.net/tools/rad/edge/macos-x64/rad - - Linux: https://radiuspublic.blob.core.windows.net/tools/rad/edge/linux-x64/rad - - Windows: https://radiuspublic.blob.core.windows.net/tools/rad/edge/windows-x64/rad.exe -1. Ensure the user has permission to execute the binary and place it somewhere on your PATH so it can be invoked easily. -{{< /edge >}} -{{% /codetab %}} - -{{< /tabs >}} - -> You may be prompted for your sudo password during installation, as the installer places the `rad` binary under `/usr/local/bin`. If you are unable to sudo you can install the rad CLI to another directory by setting the `RADIUS_INSTALL_DIR` environment variable with your intended install path. Make sure you add this to your path ([Unix](https://www.howtogeek.com/658904/how-to-add-a-directory-to-your-path-in-linux/), [Windows](https://windowsloop.com/how-to-add-to-windows-path/)) if you wish to reference it via `rad`, like in the docs. - -Verify the rad CLI is installed correctly by running `rad`. - -## Setup VS Code - -Visual Studio Code offers the best authoring experience for Radius and Bicep. Download and install the Radius Bicep extension to easily author and validate Bicep templates: - -1. Download the latest extensions - - {{< tabs Links Terminal >}} - - {{% codetab %}} - {{< button link="https://get.radapp.dev/tools/vscode-extensibility/stable/rad-vscode-bicep.vsix" text="Download Bicep extension" >}} - - {{< edge >}} - {{< button link="https://get.radapp.dev/tools/vscode-extensibility/edge/rad-vscode-bicep.vsix" text="Download Bicep extension (edge)" >}} - {{< /edge >}} - {{% /codetab %}} - - {{% codetab %}} - - Stable Version - - ```bash - curl https://get.radapp.dev/tools/vscode-extensibility/stable/rad-vscode-bicep.vsix --output rad-vscode-bicep.vsix - ``` - - Edge Version - - ```bash - curl https://get.radapp.dev/tools/vscode-extensibility/edge/rad-vscode-bicep.vsix --output rad-vscode-bicep.vsix - ``` - - {{% /codetab %}} - - {{< /tabs >}} - -2. Install the `.vsix` file: - - {{< tabs UI Terminal >}} - - {{% codetab %}} - In VSCode, manually install the extension using the *Install from VSIX* command in the Extensions view command drop-down. - - Screenshot of installing a vsix extension - - {{% /codetab %}} - - {{% codetab %}} - You can also import this extension on the [command-line](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) with: - - ```bash - code --install-extension rad-vscode-bicep.vsix - ``` - - If you're on macOS, make sure to [setup the `code` alias](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line). - - {{% /codetab %}} - - {{< /tabs >}} - -3. **Disable the official Bicep extension** if you have it installed. Do not install it if prompted, our custom extension needs to be responsible for handling `.bicep` files and you cannot have both extensions enabled at once. - -4. If running on Windows Subsystem for Linux (WSL), make sure to install the extension in WSL as well: - - Screenshot of installing a vsix extension in WSL - -## Learn Radius - -| Guides | Description | -| --- | ----------- | -| [Run your first app]({{< ref first-app >}}) | Take a tour of Radius by running your first app | -| [Quickstarts]({{< ref quickstarts >}}) | Learn about Radius topics via quickstart guides, complete with code samples | -| [Reference Applications]({{< ref reference-apps >}}) | See how full applications are modeled in Radius | -| [Supported Languages]({{< ref supported-languages >}}) | Learn how to model apps using various IaC tools | diff --git a/docs/content/getting-started/quickstarts/_index.md b/docs/content/getting-started/quickstarts/_index.md deleted file mode 100644 index f0de7bf14..000000000 --- a/docs/content/getting-started/quickstarts/_index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -type: docs -title: "Quickstart guides" -linkTitle: "Quickstarts" -description: "Learn about Radius topics via quickstart guides, complete with code samples" -weight: 200 -no_list: true ---- - -{{< categorizeby category="Quickstart">}} - diff --git a/docs/content/getting-started/first-app/snippets/app-with-redis-snippets.bicep b/docs/content/getting-started/snippets/app-with-redis-snippets.bicep similarity index 100% rename from docs/content/getting-started/first-app/snippets/app-with-redis-snippets.bicep rename to docs/content/getting-started/snippets/app-with-redis-snippets.bicep diff --git a/docs/content/getting-started/first-app/snippets/app-with-redis.bicep b/docs/content/getting-started/snippets/app-with-redis.bicep similarity index 100% rename from docs/content/getting-started/first-app/snippets/app-with-redis.bicep rename to docs/content/getting-started/snippets/app-with-redis.bicep diff --git a/docs/content/getting-started/first-app/snippets/app.bicep b/docs/content/getting-started/snippets/app.bicep similarity index 100% rename from docs/content/getting-started/first-app/snippets/app.bicep rename to docs/content/getting-started/snippets/app.bicep diff --git a/docs/content/getting-started/supported-languages/_index.md b/docs/content/getting-started/supported-languages/_index.md deleted file mode 100644 index 3dfac0fc6..000000000 --- a/docs/content/getting-started/supported-languages/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: docs -title: "Supported languages" -linkTitle: "Languages" -description: "Learn how to model apps using various IaC tools" -weight: 900 -categories: "How-To" -tags: ["infrastructure-as-code"] ---- diff --git a/docs/content/getting-started/supported-languages/bicep-language/_index.md b/docs/content/getting-started/supported-languages/bicep-language/_index.md deleted file mode 100644 index 1ad140869..000000000 --- a/docs/content/getting-started/supported-languages/bicep-language/_index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -type: docs -title: "Bicep language overview" -linkTitle: "Bicep" -description: "Learn about the Bicep language and how Radius integrates with it" -weight: 200 -categories: "How-To" -tags: ["bicep"] ---- - -Radius uses the [Bicep language](https://docs.microsoft.com/EN-US/azure/azure-resource-manager/bicep/) to describe your application and its resources. - -## Bicep - -The Bicep language makes it easy to model your infrastructure in a declarative way. This means you declare your resources and resource properties in a Bicep file, without writing a sequence of programming commands to create resources. - - - -### Declarative vs. Imperative - -For example, compare creating a database *declaratively* with Bicep, vs. *imperatively* with the az CLI: - -{{< tabs "Bicep (Declarative)" "az CLI (Imperative)" >}} - -{{% codetab %}} -The following template defines a CosmosDB account and MongoDB database. Deploying it to Azure will create the resources, and re-deploying it will update the resources to match the latest definition. - -```sh -resource cosmosAccount 'Microsoft.DocumentDB/databaseAccounts@2021-04-15' = { - name: 'myaccount' - location: 'westus2' - properties: {...} - - resource db 'mongodbDatabases' = { - name: 'mydb' - properties: {...} - } - -} -``` - -{{% /codetab %}} - -{{% codetab %}} -The following commands will create CosmosDB account and MongoDB resources on each respective command entry. Re-running commands will throw an error as the resources have already been created. - -```bash -$ az cosmosdb create \ - -n $accountName \ - -g $resourceGroupName \ - --kind MongoDB \ - --server-version $serverVersion - ... -$ az cosmosdb create \ - -n $accountName \ - -g $resourceGroupName \ - --kind MongoDB \ - --server-version $serverVersion -``` - -{{% /codetab %}} - -{{< /tabs >}} - -## Install Bicep - -Visit the [Radius getting started guide]({{< ref getting-started >}}) to install the Radius CLI, Bicep CLI and compiler, and the Bicep extension for VS Code. - -## Radius resource types - -Radius resource types are available in Bicep, allowing you to model and connect Radius resources to Azure, AWS and Kubernetes resources. - -In the below example, a Radius resource of type `Applications.Core/applications` is defined:" - -{{< rad file="snippets/app.bicep" embed=true replace-key-resources="//RESOURCES" replace-value-resources="..." >}} - -You can find more details on the supported resource types for your application [here]({{< ref author-apps >}}) diff --git a/docs/content/getting-started/supported-languages/bicep-language/snippets/app.bicep b/docs/content/getting-started/supported-languages/bicep-language/snippets/app.bicep deleted file mode 100644 index 0c95714bd..000000000 --- a/docs/content/getting-started/supported-languages/bicep-language/snippets/app.bicep +++ /dev/null @@ -1,13 +0,0 @@ -import radius as radius - -param environment string - -resource myapp 'Applications.Core/applications@2022-03-15-privatepreview' = { - name: 'my-application' - properties: { - environment: environment - } -} - -//RESOURCES -//RESOURCES diff --git a/docs/content/getting-started/supported-languages/terraform/_index.md b/docs/content/getting-started/supported-languages/terraform/_index.md deleted file mode 100644 index 063367ab1..000000000 --- a/docs/content/getting-started/supported-languages/terraform/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -type: docs -title: "Terraform guides" -linkTitle: "Terraform " -description: "Learn how to model apps using Terraform" -weight: 300 -toc_hide: true -hide_summary: true ---- - - - - -> πŸ‘·β€β™‚οΈ Under construction 🚧
-This page is still under construction. Please come back soon. \ No newline at end of file diff --git a/docs/content/getting-started/supported-languages/yaml/_index.md b/docs/content/getting-started/supported-languages/yaml/_index.md deleted file mode 100644 index bbf28b433..000000000 --- a/docs/content/getting-started/supported-languages/yaml/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -type: docs -title: "YAML guides" -linkTitle: "YAML guides" -description: "Learn how to model apps using YAML" -weight: 100 -toc_hide: true -hide_summary: true ---- - - - - -> πŸ‘·β€β™‚οΈ Under construction 🚧
-This page is still under construction. Please come back soon. \ No newline at end of file diff --git a/docs/content/guides/_index.md b/docs/content/guides/_index.md new file mode 100644 index 000000000..98e2cb8c7 --- /dev/null +++ b/docs/content/guides/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Radius user guides" +linkTitle: "User guides" +description: "Learn how to use Radius with user guides" +weight: 40 +--- \ No newline at end of file diff --git a/docs/content/author-apps/_index.md b/docs/content/guides/author-apps/_index.md similarity index 92% rename from docs/content/author-apps/_index.md rename to docs/content/guides/author-apps/_index.md index 6b95b82bb..1a98f9892 100644 --- a/docs/content/author-apps/_index.md +++ b/docs/content/guides/author-apps/_index.md @@ -3,5 +3,5 @@ type: docs title: "Authoring applications" linkTitle: "Authoring applications" description: "Learn how to author a Radius application" -weight: 30 +weight: 100 --- \ No newline at end of file diff --git a/docs/content/guides/author-apps/application/_index.md b/docs/content/guides/author-apps/application/_index.md new file mode 100644 index 000000000..eb1f60cb3 --- /dev/null +++ b/docs/content/guides/author-apps/application/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Radius applications" +linkTitle: "Applications" +description: "Learn about Radius applications" +weight: 100 +--- \ No newline at end of file diff --git a/docs/content/author-apps/application/graph-automation.png b/docs/content/guides/author-apps/application/overview/graph-automation.png similarity index 100% rename from docs/content/author-apps/application/graph-automation.png rename to docs/content/guides/author-apps/application/overview/graph-automation.png diff --git a/docs/content/author-apps/application/index.md b/docs/content/guides/author-apps/application/overview/index.md similarity index 74% rename from docs/content/author-apps/application/index.md rename to docs/content/guides/author-apps/application/overview/index.md index 2ed2fd97d..20c36f047 100644 --- a/docs/content/author-apps/application/index.md +++ b/docs/content/guides/author-apps/application/overview/index.md @@ -1,8 +1,8 @@ --- type: docs -title: "Radius application" -linkTitle: "Application" -description: "Learn how to model your application and its services in Radius" +title: "Overview: Radius applications" +linkTitle: "Overview" +description: "Learn about Radius applications" weight: 100 categories: "Overview" tags: ["applications"] @@ -14,7 +14,7 @@ An [application]({{< ref application-graph>}}) is the primary resource that cont 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. -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 "container#connections" >}}) from their container to a Storage Account, and Radius sets up all the required configuration automatically. +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#connections" >}}) from their container to a Storage Account, and Radius sets up all the required configuration automatically. 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. @@ -28,7 +28,7 @@ The Kubernetes namespace extension allows you to customize how all of the resour ### Kubernetes Metadata extension -The [Kubernetes Metadata extension]({{< ref "/operations/platforms/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 diff --git a/docs/content/author-apps/application/snippets/blank.bicep b/docs/content/guides/author-apps/application/overview/snippets/blank.bicep similarity index 100% rename from docs/content/author-apps/application/snippets/blank.bicep rename to docs/content/guides/author-apps/application/overview/snippets/blank.bicep diff --git a/docs/content/guides/author-apps/aws/_index.md b/docs/content/guides/author-apps/aws/_index.md new file mode 100644 index 000000000..4f0e8a85e --- /dev/null +++ b/docs/content/guides/author-apps/aws/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "AWS resources" +linkTitle: "AWS" +description: "Deploy and connect to AWS resources in your application" +weight: 700 +--- \ No newline at end of file diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/icon.png b/docs/content/guides/author-apps/aws/howto-aws-resources/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/icon.png rename to docs/content/guides/author-apps/aws/howto-aws-resources/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/_index.md b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md similarity index 92% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/_index.md rename to docs/content/guides/author-apps/aws/howto-aws-resources/index.md index 6bcb73dea..06e1e5b41 100644 --- a/docs/content/getting-started/quickstarts/quickstart-aws-s3/_index.md +++ b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md @@ -1,14 +1,14 @@ --- type: docs -title: "Quickstart: Deploy AWS resources" +title: "How-To: Deploy AWS resources" linkTitle: "Deploy AWS resources" description: "Learn about how to add AWS resources to your application and deploy them with Radius" -categories: "Quickstart" +categories: "How-To" tags: ["AWS"] - +weight: 200 --- -This quickstart will show you: +This how-to guide will show you: - How to model an AWS S3 resource in Bicep - How to use a sample application to interact with AWS S3 bucket @@ -34,7 +34,7 @@ eksctl create cluster --name --region= ## Step 2: Create a Radius environment with the AWS cloud provider -Create a [Radius environment]({{< ref "/operations/environments" >}}) where you will deploy your application. +Create a [Radius environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) where you will deploy your application. Run [`rad init --full`]({{< ref rad_init >}}) to initialize a new environment into your current kubectl context: @@ -42,7 +42,7 @@ Run [`rad init --full`]({{< ref rad_init >}}) to initialize a new environment in rad init --full ``` -Follow the prompts to install the [control plane services]({{< ref architecture-concept >}}), create an [environment resource]({{< ref "operations/environments" >}}), and create a [local workspace]({{< ref workspaces >}}). You will be asked for: +Follow the prompts to install the [control plane services]({{< ref architecture-concept >}}), create an [environment resource]({{< ref "/guides/deploy-apps/environments" >}}), and create a [local workspace]({{< ref workspaces >}}). You will be asked for: - **Namespace** - When an application is deployed, this is the namespace where your containers and other Kubernetes resources will be run. By default, this will be in the `default` namespace. {{% alert title="πŸ’‘ About namespaces" color="success" %}} When you initialize a Radius Kubernetes environment, Radius installs the control plane resources within the `radius-system` namespace in your cluster, separate from your applications. The namespace specified in this step will be used for your application deployments. @@ -56,7 +56,7 @@ Create a new file called `app.bicep` and add the following bicep code to model a {{< rad file="snippets/s3.bicep" embed=true >}} -Radius uses the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html) to interact with AWS resources. This means that you can model your AWS resources in Bicep and Radius will be able to deploy and manage them. You can find the list of supported AWS resources in the [AWS resource library]({{< ref "/author-apps/platform-resources/aws#resource-library" >}}). +Radius uses the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html) to interact with AWS resources. This means that you can model your AWS resources in Bicep and Radius will be able to deploy and manage them. You can find the list of supported AWS resources in the [AWS resource library]({{< ref "guides/author-apps/aws/overview#resource-library" >}}). ## Step 4: Add a Radius container to interact with the AWS S3 Bucket diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/s3app.png b/docs/content/guides/author-apps/aws/howto-aws-resources/s3app.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/s3app.png rename to docs/content/guides/author-apps/aws/howto-aws-resources/s3app.png diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/s3appdiagram.png b/docs/content/guides/author-apps/aws/howto-aws-resources/s3appdiagram.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/s3appdiagram.png rename to docs/content/guides/author-apps/aws/howto-aws-resources/s3appdiagram.png diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/app.bicep b/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/app.bicep rename to docs/content/guides/author-apps/aws/howto-aws-resources/snippets/app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/s3.bicep b/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/s3.bicep rename to docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/s3app.bicep b/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/s3app.bicep rename to docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3app.bicep diff --git a/docs/content/author-apps/platform-resources/aws/index.md b/docs/content/guides/author-apps/aws/overview/index.md similarity index 89% rename from docs/content/author-apps/platform-resources/aws/index.md rename to docs/content/guides/author-apps/aws/overview/index.md index b2b6ccf67..a6291c440 100644 --- a/docs/content/author-apps/platform-resources/aws/index.md +++ b/docs/content/guides/author-apps/aws/overview/index.md @@ -1,9 +1,9 @@ --- type: docs title: "AWS resources" -linkTitle: "AWS" +linkTitle: "Overview" description: "Deploy and connect to AWS resources in your application" -weight: 900 +weight: 100 categories: "Overview" tags: ["AWS"] --- @@ -26,7 +26,7 @@ The AWS provider allows you to deploy and connect to AWS resources from a Radius {{< tabs Bicep >}} {{% codetab %}} -In the following example, a [Container]({{< ref container >}}) is connecting to an S3 bucket. +In the following example, a [Container]({{< ref "guides/author-apps/containers" >}}) is connecting to an S3 bucket. {{< rad file="snippets/aws.bicep" embed=true >}} {{% /codetab %}} diff --git a/docs/content/author-apps/platform-resources/aws/snippets/aws.bicep b/docs/content/guides/author-apps/aws/overview/snippets/aws.bicep similarity index 100% rename from docs/content/author-apps/platform-resources/aws/snippets/aws.bicep rename to docs/content/guides/author-apps/aws/overview/snippets/aws.bicep diff --git a/docs/content/guides/author-apps/azure/_index.md b/docs/content/guides/author-apps/azure/_index.md new file mode 100644 index 000000000..b7d1a17be --- /dev/null +++ b/docs/content/guides/author-apps/azure/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Microsoft Azure resources" +linkTitle: "Azure" +description: "Deploy and connect to Azure resources in your application" +weight: 800 +--- diff --git a/docs/content/getting-started/quickstarts/quickstart-container-wi/icon.png b/docs/content/guides/author-apps/azure/howto-azure-resources/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-container-wi/icon.png rename to docs/content/guides/author-apps/azure/howto-azure-resources/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-container-wi/index.md b/docs/content/guides/author-apps/azure/howto-azure-resources/index.md similarity index 77% rename from docs/content/getting-started/quickstarts/quickstart-container-wi/index.md rename to docs/content/guides/author-apps/azure/howto-azure-resources/index.md index 3eaadafa1..88ed0e843 100644 --- a/docs/content/getting-started/quickstarts/quickstart-container-wi/index.md +++ b/docs/content/guides/author-apps/azure/howto-azure-resources/index.md @@ -1,15 +1,15 @@ --- type: docs -title: "Quickstart: Connect a container to an Azure resource" -linkTitle: "Connect to Azure resources" +title: "How-To: Connect a container to an Azure resource" +linkTitle: "Deploy Azure resources" description: "Learn how to connect a container to an Azure resource with managed identities and RBAC" weight: 600 slug: 'azure-connection' -categories: "Quickstart" +categories: "How-To" tags: ["Azure","containers"] --- -This quickstart will provide an overview of how to: +This how-to guide will provide an overview of how to: - Setup a Radius environment with an identity provider - Define a connection to an Azure resource with Azure AD role-based access control (RBAC) assignments @@ -20,7 +20,7 @@ The steps below will showcase a "rad-ified" version of the existing [Azure AD wo ## Prerequisites - [rad CLI]({{< ref getting-started >}}) installed on your machine -- [Supported Kubernetes cluster]({{< ref "/operations/platforms/kubernetes" >}}) +- [Supported Kubernetes cluster]({{< ref "guides/operations/kubernetes" >}}) - [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/installation.html) installed in your cluster ## Step 1: Initialize Radius @@ -33,13 +33,13 @@ rad init --full ## Step 2: Define a Radius environment -Create a file named `app.bicep` and define a Radius environment with [identity property]({{< ref "operations/environments/overview" >}}) set. This configures your environment to use your Azure AD workload identity installation with your cluster's OIDC endpoint: +Create a file named `app.bicep` and define a Radius environment with [identity property]({{< ref "/guides/deploy-apps/environments/overview" >}}) set. This configures your environment to use your Azure AD workload identity installation with your cluster's OIDC endpoint: {{< rad file="snippets/container-wi.bicep" embed=true marker="//ENVIRONMENT">}} ## Step 3: Define an app and a container -Add a Radius application, a Radius [container]({{< ref container >}}), and an Azure Key Vault to your `app.bicep` file. Note the connection from the container to the Key Vault, with an iam property set for the Azure AD RBAC role: +Add a Radius application, a Radius [container]({{< ref "guides/author-apps/containers" >}}), and an Azure Key Vault to your `app.bicep` file. Note the connection from the container to the Key Vault, with an iam property set for the Azure AD RBAC role: {{< rad file="snippets/container-wi.bicep" embed=true marker="//CONTAINER" >}} diff --git a/docs/content/getting-started/quickstarts/quickstart-container-wi/snippets/container-wi.bicep b/docs/content/guides/author-apps/azure/howto-azure-resources/snippets/container-wi.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-container-wi/snippets/container-wi.bicep rename to docs/content/guides/author-apps/azure/howto-azure-resources/snippets/container-wi.bicep diff --git a/docs/content/author-apps/platform-resources/azure/index.md b/docs/content/guides/author-apps/azure/overview/index.md similarity index 82% rename from docs/content/author-apps/platform-resources/azure/index.md rename to docs/content/guides/author-apps/azure/overview/index.md index 85ec9667a..7c53daf29 100644 --- a/docs/content/author-apps/platform-resources/azure/index.md +++ b/docs/content/guides/author-apps/azure/overview/index.md @@ -1,9 +1,9 @@ --- type: docs title: "Microsoft Azure resources" -linkTitle: "Microsoft Azure" +linkTitle: "Overview" description: "Deploy and connect to Azure resources in your application" -weight: 800 +weight: 500 categories: "Overview" tags: ["Azure"] --- @@ -25,7 +25,7 @@ Visit [the Microsoft docs](https://docs.microsoft.com/azure/templates/) to refer {{< tabs Bicep >}} {{% codetab %}} -In the following example, a [Container]({{< ref container >}}) is connecting to an Azure Cache for Redis resource. The Container is assigned the `Redis Cache Contributor` role: +In the following example, a [Container]({{< ref "guides/author-apps/containers" >}}) is connecting to an Azure Cache for Redis resource. The Container is assigned the `Redis Cache Contributor` role: {{< rad file="snippets/azure-connection.bicep" embed=true >}} {{% /codetab %}} diff --git a/docs/content/author-apps/platform-resources/azure/snippets/azure-connection.bicep b/docs/content/guides/author-apps/azure/overview/snippets/azure-connection.bicep similarity index 100% rename from docs/content/author-apps/platform-resources/azure/snippets/azure-connection.bicep rename to docs/content/guides/author-apps/azure/overview/snippets/azure-connection.bicep diff --git a/docs/content/guides/author-apps/containers/_index.md b/docs/content/guides/author-apps/containers/_index.md new file mode 100644 index 000000000..8c99dea1f --- /dev/null +++ b/docs/content/guides/author-apps/containers/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Radius containers" +linkTitle: "Containers" +description: "Learn how to model and run container workloads in your Radius application" +weight: 200 +--- diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/icon.png b/docs/content/guides/author-apps/containers/howto-environment-variables/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/icon.png rename to docs/content/guides/author-apps/containers/howto-environment-variables/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/index.md b/docs/content/guides/author-apps/containers/howto-environment-variables/index.md similarity index 86% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/index.md rename to docs/content/guides/author-apps/containers/howto-environment-variables/index.md index 57a11e344..a2bf26d8d 100644 --- a/docs/content/getting-started/quickstarts/quickstart-environment-variables/index.md +++ b/docs/content/guides/author-apps/containers/howto-environment-variables/index.md @@ -1,15 +1,15 @@ --- type: docs -title: "Quickstart: Environment Variables" -linkTitle: "Environment variables" +title: "How-To: Set environment variables on a container" +linkTitle: "Set Env vars" description: "Learn how to set environment variables manually and through connections" -weight: 100 +weight: 400 slug: "environment-variables" -categories: "Quickstart" +categories: "How-To" tags: ["containers"] --- -This quickstart will teach you: +This how-to guide will teach you: 1. How to set environment variables manually 1. How to set environment variables through connections @@ -17,11 +17,11 @@ This quickstart will teach you: ## Prerequisites - [Radius CLI]({{< ref "getting-started" >}}) -- [Radius environment]({{< ref "operations/environments/overview" >}}) +- [Radius environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) ## Step 1: Model an app and container -Create a new file named `app.bicep` and add an application and a [container]({{< ref container >}}): +Create a new file named `app.bicep` and add an application and a [container]({{< ref "guides/author-apps/containers" >}}): {{< rad file="snippets/1-app.bicep" embed=true >}} @@ -53,7 +53,7 @@ Add an `env` property which will contain a list of environment variables to set. ## Step 4: Add a Mongo Link -Next, add to `app.bicep` a [Mongo link]({{< ref links-resources >}}), leveraging the default "dev" Recipe: +Next, add to `app.bicep` a [Mongo link]({{< ref portable-resources >}}), leveraging the default "dev" Recipe: {{< rad file="snippets/3-app.bicep" embed=true marker="//LINK" >}} diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/screenshot-all.jpg b/docs/content/guides/author-apps/containers/howto-environment-variables/screenshot-all.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/screenshot-all.jpg rename to docs/content/guides/author-apps/containers/howto-environment-variables/screenshot-all.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/screenshot.jpg b/docs/content/guides/author-apps/containers/howto-environment-variables/screenshot.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/screenshot.jpg rename to docs/content/guides/author-apps/containers/howto-environment-variables/screenshot.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/1-app.bicep b/docs/content/guides/author-apps/containers/howto-environment-variables/snippets/1-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/1-app.bicep rename to docs/content/guides/author-apps/containers/howto-environment-variables/snippets/1-app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/2-app.bicep b/docs/content/guides/author-apps/containers/howto-environment-variables/snippets/2-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/2-app.bicep rename to docs/content/guides/author-apps/containers/howto-environment-variables/snippets/2-app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/3-app.bicep b/docs/content/guides/author-apps/containers/howto-environment-variables/snippets/3-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/3-app.bicep rename to docs/content/guides/author-apps/containers/howto-environment-variables/snippets/3-app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-keyvault-wi/icon.png b/docs/content/guides/author-apps/containers/howto-keyvault-volume/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-keyvault-wi/icon.png rename to docs/content/guides/author-apps/containers/howto-keyvault-volume/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-keyvault-wi/index.md b/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md similarity index 87% rename from docs/content/getting-started/quickstarts/quickstart-keyvault-wi/index.md rename to docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md index 2da0bc9c5..85dd76afd 100644 --- a/docs/content/getting-started/quickstarts/quickstart-keyvault-wi/index.md +++ b/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md @@ -1,15 +1,15 @@ --- type: docs -title: "Quickstart: Mount an Azure Key Vault as a volume to a container" -linkTitle: "Persistent Key Vault volume" +title: "How-To: Mount an Azure Key Vault as a volume to a container" +linkTitle: "Mount a Key Vault" description: "Learn how to mount an Azure Key Vault as a volume to a container" -weight: 700 +weight: 600 slug: 'volume-keyvault' -categories: "Quickstart" +categories: "How-To" tags: ["Azure","containers"] --- -This quickstart will provide an overview of how to: +This how-to guide will provide an overview of how to: - Setup a Radius environment with an identity provider - Define a connection to an Azure resource with Azure AD role-based access control (RBAC) assignments @@ -19,7 +19,7 @@ This quickstart will provide an overview of how to: ## Prerequisites - [rad CLI]({{< ref getting-started >}}) -- [Supported Kubernetes cluster]({{< ref "/operations/platforms/kubernetes" >}}) +- [Supported Kubernetes cluster]({{< ref "guides/operations/kubernetes" >}}) - [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/installation.html) installed on your cluster - [Azure Keyvault Provider](https://azure.github.io/secrets-store-csi-driver-provider-azure/docs/getting-started/installation/) - The above installation will also install the required [Secrets Store CSI Driver](https://secrets-store-csi-driver.sigs.k8s.io/getting-started/installation.html) @@ -46,7 +46,7 @@ Add a Radius application, an Azure Key Vault, and a Radius volume which uses the ## Step 4: Define an app, Key Vault, and volume -Now add a Radius [container]({{< ref container >}}) with a volume mount for the Radius volume: +Now add a Radius [container]({{< ref "guides/author-apps/containers" >}}) with a volume mount for the Radius volume: {{< rad file="snippets/keyvault-wi.bicep" embed=true marker="//CONTAINER" >}} diff --git a/docs/content/getting-started/quickstarts/quickstart-keyvault-wi/snippets/keyvault-wi.bicep b/docs/content/guides/author-apps/containers/howto-keyvault-volume/snippets/keyvault-wi.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-keyvault-wi/snippets/keyvault-wi.bicep rename to docs/content/guides/author-apps/containers/howto-keyvault-volume/snippets/keyvault-wi.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/icon.png b/docs/content/guides/author-apps/containers/howto-volumes/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/icon.png rename to docs/content/guides/author-apps/containers/howto-volumes/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/index.md b/docs/content/guides/author-apps/containers/howto-volumes/index.md similarity index 88% rename from docs/content/getting-started/quickstarts/quickstart-volumes/index.md rename to docs/content/guides/author-apps/containers/howto-volumes/index.md index d442808f5..46ff231c8 100644 --- a/docs/content/getting-started/quickstarts/quickstart-volumes/index.md +++ b/docs/content/guides/author-apps/containers/howto-volumes/index.md @@ -1,26 +1,26 @@ --- type: docs -title: "Quickstart: Mount a volume to a container" -linkTitle: "Volume mounts" +title: "How-To: Mount a volume to a container" +linkTitle: "Mount a volume" description: "Learn how to mount a volume to a container" -weight: 200 +weight: 500 slug: 'volumes' -categories: "Quickstart" +categories: "How-To" tags: ["containers"] --- -This quickstart will provide an overview of how to: +This how-to guide will provide an overview of how to: - Mount an ephemeral (short-lived) volume to a container ## Prerequisites - [rad CLI]({{< ref getting-started >}}) -- [Radius environment]({{< ref "operations/environments/overview" >}}) +- [Radius environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) ## Step 1: Define an app and a container -Begin by creating a file named `app.bicep` with a Radius application and [container]({{< ref container >}}): +Begin by creating a file named `app.bicep` with a Radius application and [container]({{< ref "guides/author-apps/containers" >}}): {{< rad file="snippets/1-app.bicep" embed=true >}} diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/screenshot-empty.jpg b/docs/content/guides/author-apps/containers/howto-volumes/screenshot-empty.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/screenshot-empty.jpg rename to docs/content/guides/author-apps/containers/howto-volumes/screenshot-empty.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/screenshot-error.jpg b/docs/content/guides/author-apps/containers/howto-volumes/screenshot-error.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/screenshot-error.jpg rename to docs/content/guides/author-apps/containers/howto-volumes/screenshot-error.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/screenshot.jpg b/docs/content/guides/author-apps/containers/howto-volumes/screenshot.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/screenshot.jpg rename to docs/content/guides/author-apps/containers/howto-volumes/screenshot.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/snippets/1-app.bicep b/docs/content/guides/author-apps/containers/howto-volumes/snippets/1-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/snippets/1-app.bicep rename to docs/content/guides/author-apps/containers/howto-volumes/snippets/1-app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/snippets/2-app.bicep b/docs/content/guides/author-apps/containers/howto-volumes/snippets/2-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/snippets/2-app.bicep rename to docs/content/guides/author-apps/containers/howto-volumes/snippets/2-app.bicep diff --git a/docs/content/author-apps/container/index.md b/docs/content/guides/author-apps/containers/overview/index.md similarity index 92% rename from docs/content/author-apps/container/index.md rename to docs/content/guides/author-apps/containers/overview/index.md index d1e0456d9..588b90e59 100644 --- a/docs/content/author-apps/container/index.md +++ b/docs/content/guides/author-apps/containers/overview/index.md @@ -1,22 +1,20 @@ --- type: docs -title: "Containerized workloads" -linkTitle: "Containers" -description: "Model and run container workloads in your Radius application" -weight: 300 +title: "Overview: Radius containers" +linkTitle: "Overview" +description: "Learn how to model and run container workloads in your Radius application" +weight: 100 categories: "Overview" tags: ["containers"] --- -## Overview - A Radius container provides an abstraction to model and run your container workloads as part of your Radius application. {{< rad file="snippets/container.bicep" embed=true marker="//CONTAINER" >}} ## Supported runtimes -Containers are run on the same Kubernetes cluster as your [Radius installation]({{< ref platforms >}}). We plan to support additional container runtimes and configurations in the future +Containers are run on the same Kubernetes cluster as your [Radius installation]({{< ref "guides/operations/kubernetes" >}}). We plan to support additional container runtimes and configurations in the future ## Capabilities @@ -28,7 +26,7 @@ Additionally you can customize the behavior of the containers with the help of [ An image can be specified for your container workload to pull and run. Refer to the [container reference docs]({{< ref container-schema >}}) for more information on image requirements. -If you want to pull the container image from a private container register, you need to allow access from your Kubernetes cluster. Follow the documentation to [configure private container registries access]({{< ref "/operations/platforms/kubernetes/supported-clusters#configure-container-registry-access" >}}). +If you want to pull the container image from a private container register, you need to allow access from your Kubernetes cluster. Follow the documentation to [configure private container registries access]({{< ref "guides/operations/kubernetes/supported-clusters#configure-container-registry-access" >}}). ### Ports @@ -85,7 +83,7 @@ CONNECTION_MYCONNECTION_DATABASE="my-database" CONNECTION_MYCONNECTION_USERNAME="admin" ``` -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 quickstart-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 quickstart]({{< ref howto-environment-variables >}}) for more details. ### Extensions @@ -109,5 +107,4 @@ The `daprSidecar` extensions adds and configures a [Dapr](https://dapr.io) sidec ## Further reading -{{< categorizeby category="Quickstart" tag="containers" >}} {{< categorizeby category="How-To" tag="containers" >}} diff --git a/docs/content/author-apps/container/snippets/container.bicep b/docs/content/guides/author-apps/containers/overview/snippets/container.bicep similarity index 100% rename from docs/content/author-apps/container/snippets/container.bicep rename to docs/content/guides/author-apps/containers/overview/snippets/container.bicep diff --git a/docs/content/author-apps/portability/dapr-resources/dapr-buildingblocks.png b/docs/content/guides/author-apps/dapr/dapr-buildingblocks.png similarity index 100% rename from docs/content/author-apps/portability/dapr-resources/dapr-buildingblocks.png rename to docs/content/guides/author-apps/dapr/dapr-buildingblocks.png diff --git a/docs/content/author-apps/portability/dapr-resources/dapr-sidecar.png b/docs/content/guides/author-apps/dapr/dapr-sidecar.png similarity index 100% rename from docs/content/author-apps/portability/dapr-resources/dapr-sidecar.png rename to docs/content/guides/author-apps/dapr/dapr-sidecar.png diff --git a/docs/content/author-apps/portability/dapr-resources/index.md b/docs/content/guides/author-apps/dapr/index.md similarity index 98% rename from docs/content/author-apps/portability/dapr-resources/index.md rename to docs/content/guides/author-apps/dapr/index.md index 80de3fcfe..ec64e4dc7 100644 --- a/docs/content/author-apps/portability/dapr-resources/index.md +++ b/docs/content/guides/author-apps/dapr/index.md @@ -23,7 +23,7 @@ A [Dapr sidecar](https://docs.dapr.io/concepts/dapr-services/sidecar/) allows yo Diagram of the Dapr sidecar
-You can easily add the Dapr sidecar to your [Containers]({{< ref container >}}) using a Dapr sidecar extension: +You can easily add the Dapr sidecar to your [Containers]({{< ref "guides/author-apps/containers" >}}) using a Dapr sidecar extension: {{< tabs Bicep >}} diff --git a/docs/content/author-apps/portability/dapr-resources/snippets/dapr-componentname.bicep b/docs/content/guides/author-apps/dapr/snippets/dapr-componentname.bicep similarity index 100% rename from docs/content/author-apps/portability/dapr-resources/snippets/dapr-componentname.bicep rename to docs/content/guides/author-apps/dapr/snippets/dapr-componentname.bicep diff --git a/docs/content/author-apps/portability/dapr-resources/snippets/service-invocation.bicep b/docs/content/guides/author-apps/dapr/snippets/service-invocation.bicep similarity index 100% rename from docs/content/author-apps/portability/dapr-resources/snippets/service-invocation.bicep rename to docs/content/guides/author-apps/dapr/snippets/service-invocation.bicep diff --git a/docs/content/author-apps/portability/dapr-resources/snippets/sidecar.bicep b/docs/content/guides/author-apps/dapr/snippets/sidecar.bicep similarity index 100% rename from docs/content/author-apps/portability/dapr-resources/snippets/sidecar.bicep rename to docs/content/guides/author-apps/dapr/snippets/sidecar.bicep diff --git a/docs/content/author-apps/portability/dapr-resources/snippets/statestore.bicep b/docs/content/guides/author-apps/dapr/snippets/statestore.bicep similarity index 100% rename from docs/content/author-apps/portability/dapr-resources/snippets/statestore.bicep rename to docs/content/guides/author-apps/dapr/snippets/statestore.bicep diff --git a/docs/content/guides/author-apps/howto-vscode/index.md b/docs/content/guides/author-apps/howto-vscode/index.md new file mode 100644 index 000000000..39f1c49c3 --- /dev/null +++ b/docs/content/guides/author-apps/howto-vscode/index.md @@ -0,0 +1,71 @@ +--- +type: docs +title: "How-To: Install the Radius-Bicep VSCode extension" +linkTitle: "Install VS Code extension" +description: "Learn how to use Radius in Visual Studio Code" +weight: 150 +categories: "How-To" +tags: ["Bicep", "VSCode"] +--- + +Visual Studio Code offers the best authoring experience for Radius and Bicep. Download and install the Radius Bicep extension to easily author and validate Bicep templates: + +1. Download the latest extensions + + {{< tabs Links Terminal >}} + + {{% codetab %}} + {{< button link="https://get.radapp.dev/tools/vscode-extensibility/stable/rad-vscode-bicep.vsix" text="Download Bicep extension" >}} + + {{< edge >}} + {{< button link="https://get.radapp.dev/tools/vscode-extensibility/edge/rad-vscode-bicep.vsix" text="Download Bicep extension (edge)" >}} + {{< /edge >}} + {{% /codetab %}} + + {{% codetab %}} + + Stable Version + + ```bash + curl https://get.radapp.dev/tools/vscode-extensibility/stable/rad-vscode-bicep.vsix --output rad-vscode-bicep.vsix + ``` + + Edge Version + + ```bash + curl https://get.radapp.dev/tools/vscode-extensibility/edge/rad-vscode-bicep.vsix --output rad-vscode-bicep.vsix + ``` + + {{% /codetab %}} + + {{< /tabs >}} + +2. Install the `.vsix` file: + + {{< tabs UI Terminal >}} + + {{% codetab %}} + In VSCode, manually install the extension using the *Install from VSIX* command in the Extensions view command drop-down. + + Screenshot of installing a vsix extension + + {{% /codetab %}} + + {{% codetab %}} + You can also import this extension on the [command-line](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) with: + + ```bash + code --install-extension rad-vscode-bicep.vsix + ``` + + If you're on macOS, make sure to [setup the `code` alias](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line). + + {{% /codetab %}} + + {{< /tabs >}} + +3. **Disable the official Bicep extension** if you have it installed. Do not install it if prompted, our custom extension needs to be responsible for handling `.bicep` files and you cannot have both extensions enabled at once. + +4. If running on Windows Subsystem for Linux (WSL), make sure to install the extension in WSL as well: + + Screenshot of installing a vsix extension in WSL diff --git a/docs/content/getting-started/install/vsix-install.png b/docs/content/guides/author-apps/howto-vscode/vsix-install.png similarity index 100% rename from docs/content/getting-started/install/vsix-install.png rename to docs/content/guides/author-apps/howto-vscode/vsix-install.png diff --git a/docs/content/getting-started/install/wsl-extension.png b/docs/content/guides/author-apps/howto-vscode/wsl-extension.png similarity index 100% rename from docs/content/getting-started/install/wsl-extension.png rename to docs/content/guides/author-apps/howto-vscode/wsl-extension.png diff --git a/docs/content/guides/author-apps/kubernetes/_index.md b/docs/content/guides/author-apps/kubernetes/_index.md new file mode 100644 index 000000000..dbc77129d --- /dev/null +++ b/docs/content/guides/author-apps/kubernetes/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Kubernetes resources" +linkTitle: "Kubernetes" +description: "Deploy and connect to Kubernetes resources in your application" +weight: 600 +--- \ No newline at end of file diff --git a/docs/content/author-apps/platform-resources/kubernetes/index.md b/docs/content/guides/author-apps/kubernetes/overview/index.md similarity index 96% rename from docs/content/author-apps/platform-resources/kubernetes/index.md rename to docs/content/guides/author-apps/kubernetes/overview/index.md index 00168dcf7..fb4274b93 100644 --- a/docs/content/author-apps/platform-resources/kubernetes/index.md +++ b/docs/content/guides/author-apps/kubernetes/overview/index.md @@ -1,7 +1,7 @@ --- type: docs title: "Kubernetes resources" -linkTitle: "Kubernetes" +linkTitle: "Overview" description: "Deploy and connect to Kubernetes resources in your application" weight: 1000 categories: "Overview" diff --git a/docs/content/author-apps/platform-resources/kubernetes/snippets/kubernetes-connection.bicep b/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-connection.bicep similarity index 100% rename from docs/content/author-apps/platform-resources/kubernetes/snippets/kubernetes-connection.bicep rename to docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-connection.bicep diff --git a/docs/content/author-apps/platform-resources/kubernetes/snippets/kubernetes-resource.bicep b/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-resource.bicep similarity index 100% rename from docs/content/author-apps/platform-resources/kubernetes/snippets/kubernetes-resource.bicep rename to docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-resource.bicep diff --git a/docs/content/author-apps/networking/_index.md b/docs/content/guides/author-apps/networking/_index.md similarity index 70% rename from docs/content/author-apps/networking/_index.md rename to docs/content/guides/author-apps/networking/_index.md index a995eac9d..8ed58fdf5 100644 --- a/docs/content/author-apps/networking/_index.md +++ b/docs/content/guides/author-apps/networking/_index.md @@ -3,7 +3,5 @@ type: docs title: "Application networking" linkTitle: "Networking" description: "Learn how to add networking to your Radius application" -weight: 400 -categories: "Concept" -tags: ["routes","gateways"] +weight: 300 --- diff --git a/docs/content/author-apps/networking/howto-tls-termination-cert-manager/certificate.png b/docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/certificate.png similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination-cert-manager/certificate.png rename to docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/certificate.png diff --git a/docs/content/author-apps/networking/howto-tls-termination-cert-manager/index.md b/docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/index.md similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination-cert-manager/index.md rename to docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/index.md diff --git a/docs/content/author-apps/networking/howto-tls-termination-cert-manager/snippets/app.bicep b/docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/snippets/app.bicep similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination-cert-manager/snippets/app.bicep rename to docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/snippets/app.bicep diff --git a/docs/content/author-apps/networking/howto-tls-termination-cert-manager/snippets/certificate.yaml b/docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/snippets/certificate.yaml similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination-cert-manager/snippets/certificate.yaml rename to docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/snippets/certificate.yaml diff --git a/docs/content/author-apps/networking/howto-tls-termination-cert-manager/snippets/clusterissuer-http01.yaml b/docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/snippets/clusterissuer-http01.yaml similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination-cert-manager/snippets/clusterissuer-http01.yaml rename to docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/snippets/clusterissuer-http01.yaml diff --git a/docs/content/author-apps/networking/howto-tls-termination-cert-manager/snippets/delegation.yaml b/docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/snippets/delegation.yaml similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination-cert-manager/snippets/delegation.yaml rename to docs/content/guides/author-apps/networking/howto-tls-termination-cert-manager/snippets/delegation.yaml diff --git a/docs/content/author-apps/networking/howto-tls-termination/https-app.png b/docs/content/guides/author-apps/networking/howto-tls-termination/https-app.png similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination/https-app.png rename to docs/content/guides/author-apps/networking/howto-tls-termination/https-app.png diff --git a/docs/content/author-apps/networking/howto-tls-termination/index.md b/docs/content/guides/author-apps/networking/howto-tls-termination/index.md similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination/index.md rename to docs/content/guides/author-apps/networking/howto-tls-termination/index.md diff --git a/docs/content/author-apps/networking/howto-tls-termination/snippets/tls-termination-data.bicep b/docs/content/guides/author-apps/networking/howto-tls-termination/snippets/tls-termination-data.bicep similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination/snippets/tls-termination-data.bicep rename to docs/content/guides/author-apps/networking/howto-tls-termination/snippets/tls-termination-data.bicep diff --git a/docs/content/author-apps/networking/howto-tls-termination/snippets/tls-termination-k8s-secret.bicep b/docs/content/guides/author-apps/networking/howto-tls-termination/snippets/tls-termination-k8s-secret.bicep similarity index 100% rename from docs/content/author-apps/networking/howto-tls-termination/snippets/tls-termination-k8s-secret.bicep rename to docs/content/guides/author-apps/networking/howto-tls-termination/snippets/tls-termination-k8s-secret.bicep diff --git a/docs/content/author-apps/networking/overview/index.md b/docs/content/guides/author-apps/networking/overview/index.md similarity index 74% rename from docs/content/author-apps/networking/overview/index.md rename to docs/content/guides/author-apps/networking/overview/index.md index 3dd2c3cbf..240ee3ac6 100644 --- a/docs/content/author-apps/networking/overview/index.md +++ b/docs/content/guides/author-apps/networking/overview/index.md @@ -1,7 +1,7 @@ --- type: docs title: "Overview: Application networking" -linkTitle: "Application networking" +linkTitle: "Overview" description: "Learn how to add networking to your Radius application" weight: 100 categories: "Overview" @@ -15,7 +15,7 @@ Radius networking resources allow you to model: ## HTTP Routes -An `HttpRoute` resources defines HTTP communication between two [services]({{< ref container >}}). They can be used to define both one-way communication, as well as cycles of communication between services. +An `HttpRoute` resources defines HTTP communication between two [services]({{< ref "guides/author-apps/containers" >}}). They can be used to define both one-way communication, as well as cycles of communication between services. Diagram of Radius service-to-service networking with cycles
@@ -42,36 +42,3 @@ Gateways support TLS termination. This allows incoming encrypted traffic to be d A gateway can be configured to passthrough encrypted SSL traffic to an HTTP route and container. This is useful for applications that already have SSL termination configured, and do not want to terminate SSL at the gateway. To set up SSL passthrough, set `tls.sslPassthrough` to `true` on the gateway, and set a single route with no `path` defined (just `destination`). - -## Example - -### Path-based HTTP routing - -{{< tabs Bicep >}} - -{{< codetab >}} -{{< rad file="snippets/networking.bicep" embed=true >}} -{{< /codetab >}} - -{{< /tabs >}} - -### TLS termination - -{{< tabs Bicep >}} - -{{< codetab >}} -{{< rad file="snippets/networking-tlstermination.bicep" embed=true marker="//GATEWAY" >}} -{{< /codetab >}} - -{{< /tabs >}} - - -### SSL Passthrough - -{{< tabs Bicep >}} - -{{< codetab >}} -{{< rad file="snippets/networking-sslpassthrough.bicep" embed=true marker="//GATEWAY" >}} -{{< /codetab >}} - -{{< /tabs >}} diff --git a/docs/content/author-apps/networking/overview/networking-cycles.png b/docs/content/guides/author-apps/networking/overview/networking-cycles.png similarity index 100% rename from docs/content/author-apps/networking/overview/networking-cycles.png rename to docs/content/guides/author-apps/networking/overview/networking-cycles.png diff --git a/docs/content/author-apps/networking/overview/networking-gateways.png b/docs/content/guides/author-apps/networking/overview/networking-gateways.png similarity index 100% rename from docs/content/author-apps/networking/overview/networking-gateways.png rename to docs/content/guides/author-apps/networking/overview/networking-gateways.png diff --git a/docs/content/author-apps/networking/overview/snippets/networking-sslpassthrough.bicep b/docs/content/guides/author-apps/networking/overview/snippets/networking-sslpassthrough.bicep similarity index 100% rename from docs/content/author-apps/networking/overview/snippets/networking-sslpassthrough.bicep rename to docs/content/guides/author-apps/networking/overview/snippets/networking-sslpassthrough.bicep diff --git a/docs/content/author-apps/networking/overview/snippets/networking-tlstermination.bicep b/docs/content/guides/author-apps/networking/overview/snippets/networking-tlstermination.bicep similarity index 100% rename from docs/content/author-apps/networking/overview/snippets/networking-tlstermination.bicep rename to docs/content/guides/author-apps/networking/overview/snippets/networking-tlstermination.bicep diff --git a/docs/content/author-apps/networking/overview/snippets/networking.bicep b/docs/content/guides/author-apps/networking/overview/snippets/networking.bicep similarity index 100% rename from docs/content/author-apps/networking/overview/snippets/networking.bicep rename to docs/content/guides/author-apps/networking/overview/snippets/networking.bicep diff --git a/docs/content/guides/author-apps/portable-resources/_index.md b/docs/content/guides/author-apps/portable-resources/_index.md new file mode 100644 index 000000000..3cab3e652 --- /dev/null +++ b/docs/content/guides/author-apps/portable-resources/_index.md @@ -0,0 +1,8 @@ +--- +type: docs +title: "Radius portable resources" +linkTitle: "Links" +description: "Learn how to make your applications portable with Links" +weight: 400 +tags: ["portability"] +--- diff --git a/docs/content/author-apps/portability/links-resources/_index.md b/docs/content/guides/author-apps/portable-resources/overview/index.md similarity index 86% rename from docs/content/author-apps/portability/links-resources/_index.md rename to docs/content/guides/author-apps/portable-resources/overview/index.md index af86e0077..414923181 100644 --- a/docs/content/author-apps/portability/links-resources/_index.md +++ b/docs/content/guides/author-apps/portable-resources/overview/index.md @@ -1,10 +1,10 @@ --- type: docs -title: "Radius Links" -linkTitle: "Links" +title: "Overview: Radius Links" +linkTitle: "Overview" description: "Add links to your Radius application for infrastructure portability" weight: 600 -categories: "Concept" +categories: "Overview" tags: ["links","portability"] --- @@ -16,7 +16,7 @@ Links provide **abstraction** and **portability** to Radius applications. This a ### Example -The following examples show how a [container]({{< ref container >}}) can connect to a Redis link, which in turn binds to an Azure Cache for Redis or a Kubernetes Pod. +The following examples show how a [container]({{< ref "guides/author-apps/containers" >}}) can connect to a Redis link, which in turn binds to an Azure Cache for Redis or a Kubernetes Pod. {{< tabs Kubernetes Azure >}} diff --git a/docs/content/author-apps/portability/links-resources/links.png b/docs/content/guides/author-apps/portable-resources/overview/links.png similarity index 100% rename from docs/content/author-apps/portability/links-resources/links.png rename to docs/content/guides/author-apps/portable-resources/overview/links.png diff --git a/docs/content/author-apps/portability/links-resources/snippets/redis-azure.bicep b/docs/content/guides/author-apps/portable-resources/overview/snippets/redis-azure.bicep similarity index 100% rename from docs/content/author-apps/portability/links-resources/snippets/redis-azure.bicep rename to docs/content/guides/author-apps/portable-resources/overview/snippets/redis-azure.bicep diff --git a/docs/content/author-apps/portability/links-resources/snippets/redis-container.bicep b/docs/content/guides/author-apps/portable-resources/overview/snippets/redis-container.bicep similarity index 100% rename from docs/content/author-apps/portability/links-resources/snippets/redis-container.bicep rename to docs/content/guides/author-apps/portable-resources/overview/snippets/redis-container.bicep diff --git a/docs/content/guides/author-apps/secrets/_index.md b/docs/content/guides/author-apps/secrets/_index.md new file mode 100644 index 000000000..1c11dc59f --- /dev/null +++ b/docs/content/guides/author-apps/secrets/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Secrets management" +linkTitle: "Secrets" +description: "Learn how to create and reference secrets in your Radius application" +weight: 500 +--- diff --git a/docs/content/author-apps/secrets/_index.md b/docs/content/guides/author-apps/secrets/overview/index.md similarity index 95% rename from docs/content/author-apps/secrets/_index.md rename to docs/content/guides/author-apps/secrets/overview/index.md index 75f7af20c..566f7c35d 100644 --- a/docs/content/author-apps/secrets/_index.md +++ b/docs/content/guides/author-apps/secrets/overview/index.md @@ -1,10 +1,10 @@ --- type: docs -title: "Secrets management" -linkTitle: "Secrets" +title: "Overview: Secrets management" +linkTitle: "Overview" description: "Learn how to create and reference secrets in your Radius application" -weight: 410 -categories: "Concept" +weight: 500 +categories: "Overview" tags: ["secrets"] --- diff --git a/docs/content/author-apps/secrets/snippets/secretstore.bicep b/docs/content/guides/author-apps/secrets/overview/snippets/secretstore.bicep similarity index 100% rename from docs/content/author-apps/secrets/snippets/secretstore.bicep rename to docs/content/guides/author-apps/secrets/overview/snippets/secretstore.bicep diff --git a/docs/content/deploy-apps/_index.md b/docs/content/guides/deploy-apps/_index.md similarity index 93% rename from docs/content/deploy-apps/_index.md rename to docs/content/guides/deploy-apps/_index.md index 7ea7c754a..f94f2a451 100644 --- a/docs/content/deploy-apps/_index.md +++ b/docs/content/guides/deploy-apps/_index.md @@ -3,5 +3,5 @@ type: docs title: "Deploying applications" linkTitle: "Deploying applications" description: "Learn how to deploy a Radius application to an environment" -weight: 40 +weight: 200 --- \ No newline at end of file diff --git a/docs/content/operations/environments/_index.md b/docs/content/guides/deploy-apps/environments/_index.md similarity index 100% rename from docs/content/operations/environments/_index.md rename to docs/content/guides/deploy-apps/environments/_index.md diff --git a/docs/content/operations/environments/howto-environment/index.md b/docs/content/guides/deploy-apps/environments/howto-environment/index.md similarity index 77% rename from docs/content/operations/environments/howto-environment/index.md rename to docs/content/guides/deploy-apps/environments/howto-environment/index.md index 65c2961ac..5f5241227 100644 --- a/docs/content/operations/environments/howto-environment/index.md +++ b/docs/content/guides/deploy-apps/environments/howto-environment/index.md @@ -8,14 +8,67 @@ categories: "How-To" tags: ["environments"] --- -Radius environments are prepared landing zones for applications that contain configuration and Recipes. To learn more visit the [environments overview]({{< ref "/operations/environments/overview" >}}) page. +Radius environments are prepared landing zones for applications that contain configuration and Recipes. To learn more visit the [environments overview]({{< ref "/guides/deploy-apps/environments/overview" >}}) page. Radius environments can be setup with the rad CLI via two paths: interactive or manual. ## Pre-requisites - Install the [rad CLI]({{< ref getting-started >}}) -- Setup a supported [Kubernetes cluster]({{< ref "/operations/platforms/kubernetes" >}}) +- Setup a supported [Kubernetes cluster]({{< ref "guides/operations/kubernetes" >}}) + +## Create a development environment + +1. Initialize a new [Radius environment]({{< ref "/guides/deploy-apps/environments/overview">}}) with [`rad init`]({{< ref rad_init >}}): + ```bash + rad init + ``` + + Select `Yes` to setup the app.bicep in the current directory + + ``` + Initializing Radius... + + πŸ•” Install Radius 0.21 + - Kubernetes cluster: kind + - Kubernetes namespace: radius-system + ⏳ Create new environment default + - Kubernetes namespace: default + - Recipe pack: dev + ⏳ Scaffold application + ⏳ Update local configuration + ``` + +2. Verify the initialization by running: + ```bash + kubectl get deployments -n radius-system + ``` + + You should see: + + ``` + NAME READY UP-TO-DATE AVAILABLE AGE + ucp 1/1 1 1 53s + appcore-rp 1/1 1 1 53s + bicep-de 1/1 1 1 53s + contour-contour 1/1 1 1 46s + ``` + + You can also use [`rad env list`]({{< ref rad_env_list.md >}}) to view your environment: + + ```bash + rad env list + ``` +3. Use `rad recipe list` to see the list of available recipes: + ```bash + rad recipe list + ``` + ``` + NAME TYPE TEMPLATE KIND TEMPLATE + default Applications.Link/mongoDatabases bicep radius.azurecr.io/recipes/dev/mongodatabases:latest + default Applications.Link/redisCaches bicep radius.azurecr.io/recipes/dev/rediscaches:latest + ``` + You can follow the [recipes]({{< ref "/guides/recipes/overview" >}}) documentation to learn more about the recipes and how to use them in your application. ## Create an environment interactively diff --git a/docs/content/operations/environments/overview/environments.png b/docs/content/guides/deploy-apps/environments/overview/environments.png similarity index 100% rename from docs/content/operations/environments/overview/environments.png rename to docs/content/guides/deploy-apps/environments/overview/environments.png diff --git a/docs/content/operations/environments/overview/index.md b/docs/content/guides/deploy-apps/environments/overview/index.md similarity index 93% rename from docs/content/operations/environments/overview/index.md rename to docs/content/guides/deploy-apps/environments/overview/index.md index b488a477b..c74b12c81 100644 --- a/docs/content/operations/environments/overview/index.md +++ b/docs/content/guides/deploy-apps/environments/overview/index.md @@ -16,7 +16,7 @@ The following configuration options are available for environments: ### Container runtime -Radius environments can be configured with a container runtime, where Radius [containers]({{< ref container >}}) will be run, along with [gateways and routes]({{< ref networking >}}). +Radius environments can be configured with a container runtime, where Radius [containers]({{< ref "guides/author-apps/containers" >}}) will be run, along with [gateways and routes]({{< ref networking >}}). A Kubernetes namespace is specified on the environment to tell Radius where to render application resources at deploy time. @@ -41,8 +41,6 @@ Supported identity providers: - [Azure AD workload identity](https://azure.github.io/azure-workload-identity/docs/introduction.html) -Visit the Azure direct connection quickstart for more information. (coming soon) - ## CLI commands The following commands let you interact with Radius environments: @@ -105,9 +103,9 @@ The following example shows an environment configured with Kubernetes as the tar ## How-to: Initialize a new environment -1. Begin by deploying a compatible [Kubernetes cluster]({{< ref "/operations/platforms/kubernetes" >}}) +1. Begin by deploying a compatible [Kubernetes cluster]({{< ref "guides/operations/kubernetes" >}}) - *Visit the [Kubernetes platform docs]({{< ref "/operations/platforms/kubernetes" >}}) for a list of supported clusters and specific cluster requirements.* + *Visit the [Kubernetes platform docs]({{< ref "guides/operations/kubernetes" >}}) for a list of supported clusters and specific cluster requirements.* 1. Ensure your target kubectl context is set as the default: ```bash diff --git a/docs/content/operations/providers/providers-overview.png b/docs/content/guides/deploy-apps/environments/overview/providers-overview.png similarity index 100% rename from docs/content/operations/providers/providers-overview.png rename to docs/content/guides/deploy-apps/environments/overview/providers-overview.png diff --git a/docs/content/operations/environments/overview/snippets/environment.bicep b/docs/content/guides/deploy-apps/environments/overview/snippets/environment.bicep similarity index 100% rename from docs/content/operations/environments/overview/snippets/environment.bicep rename to docs/content/guides/deploy-apps/environments/overview/snippets/environment.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-cicd/icon.png b/docs/content/guides/deploy-apps/howto-cicd/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-cicd/icon.png rename to docs/content/guides/deploy-apps/howto-cicd/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-cicd/index.md b/docs/content/guides/deploy-apps/howto-cicd/index.md similarity index 95% rename from docs/content/getting-started/quickstarts/quickstart-cicd/index.md rename to docs/content/guides/deploy-apps/howto-cicd/index.md index d1a70c57c..c9946e17c 100644 --- a/docs/content/getting-started/quickstarts/quickstart-cicd/index.md +++ b/docs/content/guides/deploy-apps/howto-cicd/index.md @@ -1,10 +1,10 @@ --- type: docs -title: "Quickstart: Github Actions CI/CD integration" -linkTitle: "GitHub Actions CI/CD" -description: "Learn about adding your Radius apps to your deployment pipelines" -weight: 300 -categories: "Quickstart" +title: "How-To: Deploy an application with Github Actions" +linkTitle: "Deploy with GitHub Actions" +description: "Learn about adding your Radius apps to your deployment pipelines with GitHub Actions" +weight: 500 +categories: "How-To" tags: ["CI/CD"] --- diff --git a/docs/content/getting-started/quickstarts/quickstart-cicd/snippets/app.bicep b/docs/content/guides/deploy-apps/howto-cicd/snippets/app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-cicd/snippets/app.bicep rename to docs/content/guides/deploy-apps/howto-cicd/snippets/app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-cicd/snippets/env.bicep b/docs/content/guides/deploy-apps/howto-cicd/snippets/env.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-cicd/snippets/env.bicep rename to docs/content/guides/deploy-apps/howto-cicd/snippets/env.bicep diff --git a/docs/content/deploy-apps/delete-applications/index.md b/docs/content/guides/deploy-apps/howto-delete/index.md similarity index 97% rename from docs/content/deploy-apps/delete-applications/index.md rename to docs/content/guides/deploy-apps/howto-delete/index.md index d66844171..73703c28f 100644 --- a/docs/content/deploy-apps/delete-applications/index.md +++ b/docs/content/guides/deploy-apps/howto-delete/index.md @@ -1,9 +1,9 @@ --- type: docs title: "How-To: Delete an application from a Radius environment" -linkTitle: "Delete applications" +linkTitle: "Delete apps" description: "Learn how to delete a Radius application" -weight: 300 +weight: 400 categories: "How-To" tags: ["delete"] --- diff --git a/docs/content/deploy-apps/deploy-applications/index.md b/docs/content/guides/deploy-apps/howto-deploy/index.md similarity index 96% rename from docs/content/deploy-apps/deploy-applications/index.md rename to docs/content/guides/deploy-apps/howto-deploy/index.md index 717b43ed0..f8f8a98bf 100644 --- a/docs/content/deploy-apps/deploy-applications/index.md +++ b/docs/content/guides/deploy-apps/howto-deploy/index.md @@ -1,9 +1,9 @@ --- type: docs title: "Overview: Deploying applications into a Radius environment" -linkTitle: "Deploy applications" +linkTitle: "Deploy apps" description: "Learn how to deploy a Radius application" -weight: 200 +weight: 300 categories: "Overview" tags: ["deployments"] --- diff --git a/docs/content/guides/deploy-apps/howto-rad-cli/index.md b/docs/content/guides/deploy-apps/howto-rad-cli/index.md new file mode 100644 index 000000000..106c0e030 --- /dev/null +++ b/docs/content/guides/deploy-apps/howto-rad-cli/index.md @@ -0,0 +1,95 @@ +--- +type: docs +title: "How-To: Install the rad CLI" +linkTitle: "Install rad CLI" +description: "Learn how to install the rad CLI on your local machine" +weight: 100 +categories: "How-To" +tags: ["rad CLI", "Bicep"] +--- + +The `rad` CLI manages your applications, resources, and environments. You can install it on your local machine with the following installation scripts: + +{{< tabs MacOS "Linux/WSL" "Windows PowerShell" "Cloud Shell" Binaries >}} + +{{% codetab %}} +{{< latest >}} +```bash +curl -fsSL "https://get.radapp.dev/tools/rad/install.sh" | /bin/bash +``` +{{< /latest >}} +{{< edge >}} +To install the latest edge version: + +```bash +curl -fsSL "https://radiuspublic.blob.core.windows.net/tools/rad/install.sh" | /bin/bash -s edge +``` +{{< /edge >}} +{{% /codetab %}} + +{{% codetab %}} +{{< latest >}} +```bash +wget -q "https://get.radapp.dev/tools/rad/install.sh" -O - | /bin/bash +``` +{{< /latest >}} +{{< edge >}} +To install the latest edge version: + +```bash +wget -q "https://radiuspublic.blob.core.windows.net/tools/rad/install.sh" -O - | /bin/bash -s edge +``` +{{< /edge >}} +{{% /codetab %}} + +{{% codetab %}} +{{< latest >}} +Run the following in a PowerShell window: + +```powershell +iwr -useb "https://get.radapp.dev/tools/rad/install.ps1" | iex +``` + +You may need to refresh your $PATH environment variable to access `rad`: +```powershell +$Env:Path = [System.Environment]::GetEnvironmentVariable("Path","User") +``` +{{< /latest >}} +{{< edge >}} +To install the latest edge version: + +```powershell +$script=iwr -useb https://radiuspublic.blob.core.windows.net/tools/rad/install.ps1; $block=[ScriptBlock]::Create($script); invoke-command -ScriptBlock $block -ArgumentList edge +``` +{{< /edge >}} +{{% /codetab %}} + +{{% codetab %}} +[Azure Cloud Shell](https://docs.microsoft.com/en-us/azure/cloud-shell/overview) is an interactive, authenticated, browser-accessible shell for managing Azure resources. + +Azure Cloud Shell for bash doesn't have a sudo command, so users are unable to install Radius to the default `/usr/local/bin` installation path. To install the rad CLI to the home directory, run the following commands: + +```bash +export RADIUS_INSTALL_DIR=./ +wget -q "https://get.radapp.dev/tools/rad/install.sh" -O - | /bin/bash +``` + +You can now run the rad CLI with `./rad`. + +PowerShell for Cloud Shell is currently not supported. +{{% /codetab %}} + +{{% codetab %}} +1. Download the `rad` CLI from one of these URLs: + - MacOS x64: https://get.radapp.dev/tools/rad/{{< param version >}}/macos-x64/rad + - MacOS arm64: https://get.radapp.dev/tools/rad/{{< param version >}}/macos-arm64/rad + - Linux x64: https://get.radapp.dev/tools/rad/{{< param version >}}/linux-x64/rad + - Windows x64: https://get.radapp.dev/tools/rad/{{< param version >}}/windows-x64/rad.exe +1. Ensure the user has permission to execute the binary and place it somewhere on your PATH so it can be invoked easily. +{{% /codetab %}} + +{{< /tabs >}} + +> You may be prompted for your sudo password during installation, as the installer places the `rad` binary under `/usr/local/bin`. If you are unable to sudo you can install the rad CLI to another directory by setting the `RADIUS_INSTALL_DIR` environment variable with your intended install path. Make sure you add this to your path ([Unix](https://www.howtogeek.com/658904/how-to-add-a-directory-to-your-path-in-linux/), [Windows](https://windowsloop.com/how-to-add-to-windows-path/)) if you wish to reference it via `rad`, like in the docs. + +Verify the rad CLI is installed correctly by running `rad`. diff --git a/docs/content/author-apps/vscode/vsix-install.png b/docs/content/guides/deploy-apps/howto-rad-cli/vsix-install.png similarity index 100% rename from docs/content/author-apps/vscode/vsix-install.png rename to docs/content/guides/deploy-apps/howto-rad-cli/vsix-install.png diff --git a/docs/content/guides/deploy-apps/howto-rad-cli/wsl-extension.png b/docs/content/guides/deploy-apps/howto-rad-cli/wsl-extension.png new file mode 100644 index 000000000..a8d9c136c Binary files /dev/null and b/docs/content/guides/deploy-apps/howto-rad-cli/wsl-extension.png differ diff --git a/docs/content/guides/operations/_index.md b/docs/content/guides/operations/_index.md new file mode 100644 index 000000000..d0eb2d045 --- /dev/null +++ b/docs/content/guides/operations/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Environment operations guides" +linkTitle: "Operations" +description: "Learn how to deploy and operate Radius environments" +weight: 400 +--- diff --git a/docs/content/guides/operations/control-plane/_index.md b/docs/content/guides/operations/control-plane/_index.md new file mode 100644 index 000000000..aa559bb23 --- /dev/null +++ b/docs/content/guides/operations/control-plane/_index.md @@ -0,0 +1,9 @@ +--- +type: docs +title: "Control plane" +linkTitle: "Control plane" +description: "Configure and manage your Radius control plane" +weight: 200 +categories: "How-To" +tags: ["control plane"] +--- diff --git a/docs/content/operations/control-plane/groups/group-diagram.png b/docs/content/guides/operations/control-plane/groups/group-diagram.png similarity index 100% rename from docs/content/operations/control-plane/groups/group-diagram.png rename to docs/content/guides/operations/control-plane/groups/group-diagram.png diff --git a/docs/content/operations/control-plane/groups/group.svg b/docs/content/guides/operations/control-plane/groups/group.svg similarity index 100% rename from docs/content/operations/control-plane/groups/group.svg rename to docs/content/guides/operations/control-plane/groups/group.svg diff --git a/docs/content/operations/control-plane/groups/index.md b/docs/content/guides/operations/control-plane/groups/index.md similarity index 100% rename from docs/content/operations/control-plane/groups/index.md rename to docs/content/guides/operations/control-plane/groups/index.md diff --git a/docs/content/operations/control-plane/howto-postman/index.md b/docs/content/guides/operations/control-plane/howto-postman/index.md similarity index 100% rename from docs/content/operations/control-plane/howto-postman/index.md rename to docs/content/guides/operations/control-plane/howto-postman/index.md diff --git a/docs/content/operations/control-plane/howto-postman/postman-auth.png b/docs/content/guides/operations/control-plane/howto-postman/postman-auth.png similarity index 100% rename from docs/content/operations/control-plane/howto-postman/postman-auth.png rename to docs/content/guides/operations/control-plane/howto-postman/postman-auth.png diff --git a/docs/content/operations/control-plane/howto-postman/postman-url.png b/docs/content/guides/operations/control-plane/howto-postman/postman-url.png similarity index 100% rename from docs/content/operations/control-plane/howto-postman/postman-url.png rename to docs/content/guides/operations/control-plane/howto-postman/postman-url.png diff --git a/docs/content/operations/control-plane/observability/_index.md b/docs/content/guides/operations/control-plane/observability/_index.md similarity index 100% rename from docs/content/operations/control-plane/observability/_index.md rename to docs/content/guides/operations/control-plane/observability/_index.md diff --git a/docs/content/operations/control-plane/observability/logging/_index.md b/docs/content/guides/operations/control-plane/observability/logging/_index.md similarity index 100% rename from docs/content/operations/control-plane/observability/logging/_index.md rename to docs/content/guides/operations/control-plane/observability/logging/_index.md diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/fluentd-config-map.yaml b/docs/content/guides/operations/control-plane/observability/logging/fluentd/fluentd-config-map.yaml similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/fluentd-config-map.yaml rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/fluentd-config-map.yaml diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/fluentd-radius-with-rbac.yaml b/docs/content/guides/operations/control-plane/observability/logging/fluentd/fluentd-radius-with-rbac.yaml similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/fluentd-radius-with-rbac.yaml rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/fluentd-radius-with-rbac.yaml diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/index.md b/docs/content/guides/operations/control-plane/observability/logging/fluentd/index.md similarity index 97% rename from docs/content/operations/control-plane/observability/logging/fluentd/index.md rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/index.md index ba109d005..eec52a7aa 100644 --- a/docs/content/operations/control-plane/observability/logging/fluentd/index.md +++ b/docs/content/guides/operations/control-plane/observability/logging/fluentd/index.md @@ -88,7 +88,7 @@ tags: ["logs","observability"] ## Install Radius control plane -Visit [supported platforms]({{< ref platforms >}}) to learn how to install the Radius control plane. By default, Radius has JSON logging enabled. +Visit the [Kubernetes docs]({{< ref "guides/operations/kubernetes" >}}) to learn how to install the Radius control plane. By default, Radius has JSON logging enabled. For Kubernetes, you can install with the rad CLI: diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/kibana-1.png b/docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-1.png similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/kibana-1.png rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-1.png diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/kibana-2.png b/docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-2.png similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/kibana-2.png rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-2.png diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/kibana-3.png b/docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-3.png similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/kibana-3.png rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-3.png diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/kibana-4.png b/docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-4.png similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/kibana-4.png rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-4.png diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/kibana-5.png b/docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-5.png similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/kibana-5.png rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-5.png diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/kibana-6.png b/docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-6.png similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/kibana-6.png rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-6.png diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/kibana-7.png b/docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-7.png similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/kibana-7.png rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-7.png diff --git a/docs/content/operations/control-plane/observability/logging/fluentd/kibana-8.png b/docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-8.png similarity index 100% rename from docs/content/operations/control-plane/observability/logging/fluentd/kibana-8.png rename to docs/content/guides/operations/control-plane/observability/logging/fluentd/kibana-8.png diff --git a/docs/content/operations/control-plane/observability/logging/logs.md b/docs/content/guides/operations/control-plane/observability/logging/logs.md similarity index 100% rename from docs/content/operations/control-plane/observability/logging/logs.md rename to docs/content/guides/operations/control-plane/observability/logging/logs.md diff --git a/docs/content/operations/control-plane/observability/metrics/_index.md b/docs/content/guides/operations/control-plane/observability/metrics/_index.md similarity index 100% rename from docs/content/operations/control-plane/observability/metrics/_index.md rename to docs/content/guides/operations/control-plane/observability/metrics/_index.md diff --git a/docs/content/operations/control-plane/observability/metrics/grafana/index.md b/docs/content/guides/operations/control-plane/observability/metrics/grafana/index.md similarity index 100% rename from docs/content/operations/control-plane/observability/metrics/grafana/index.md rename to docs/content/guides/operations/control-plane/observability/metrics/grafana/index.md diff --git a/docs/content/operations/control-plane/observability/metrics/grafana/radius-overview-1.png b/docs/content/guides/operations/control-plane/observability/metrics/grafana/radius-overview-1.png similarity index 100% rename from docs/content/operations/control-plane/observability/metrics/grafana/radius-overview-1.png rename to docs/content/guides/operations/control-plane/observability/metrics/grafana/radius-overview-1.png diff --git a/docs/content/operations/control-plane/observability/metrics/grafana/radius-overview-2.png b/docs/content/guides/operations/control-plane/observability/metrics/grafana/radius-overview-2.png similarity index 100% rename from docs/content/operations/control-plane/observability/metrics/grafana/radius-overview-2.png rename to docs/content/guides/operations/control-plane/observability/metrics/grafana/radius-overview-2.png diff --git a/docs/content/operations/control-plane/observability/metrics/grafana/radius-resource-provider-1.png b/docs/content/guides/operations/control-plane/observability/metrics/grafana/radius-resource-provider-1.png similarity index 100% rename from docs/content/operations/control-plane/observability/metrics/grafana/radius-resource-provider-1.png rename to docs/content/guides/operations/control-plane/observability/metrics/grafana/radius-resource-provider-1.png diff --git a/docs/content/operations/control-plane/observability/metrics/grafana/radius-resource-provider-2.png b/docs/content/guides/operations/control-plane/observability/metrics/grafana/radius-resource-provider-2.png similarity index 100% rename from docs/content/operations/control-plane/observability/metrics/grafana/radius-resource-provider-2.png rename to docs/content/guides/operations/control-plane/observability/metrics/grafana/radius-resource-provider-2.png diff --git a/docs/content/operations/control-plane/observability/metrics/prometheus/index.md b/docs/content/guides/operations/control-plane/observability/metrics/prometheus/index.md similarity index 100% rename from docs/content/operations/control-plane/observability/metrics/prometheus/index.md rename to docs/content/guides/operations/control-plane/observability/metrics/prometheus/index.md diff --git a/docs/content/operations/control-plane/observability/tracing/_index.md b/docs/content/guides/operations/control-plane/observability/tracing/_index.md similarity index 100% rename from docs/content/operations/control-plane/observability/tracing/_index.md rename to docs/content/guides/operations/control-plane/observability/tracing/_index.md diff --git a/docs/content/operations/control-plane/observability/tracing/jaeger/index.md b/docs/content/guides/operations/control-plane/observability/tracing/jaeger/index.md similarity index 100% rename from docs/content/operations/control-plane/observability/tracing/jaeger/index.md rename to docs/content/guides/operations/control-plane/observability/tracing/jaeger/index.md diff --git a/docs/content/operations/control-plane/observability/tracing/jaeger/jaeger.yaml b/docs/content/guides/operations/control-plane/observability/tracing/jaeger/jaeger.yaml similarity index 100% rename from docs/content/operations/control-plane/observability/tracing/jaeger/jaeger.yaml rename to docs/content/guides/operations/control-plane/observability/tracing/jaeger/jaeger.yaml diff --git a/docs/content/operations/control-plane/observability/tracing/jaeger/jaeger_ui.png b/docs/content/guides/operations/control-plane/observability/tracing/jaeger/jaeger_ui.png similarity index 100% rename from docs/content/operations/control-plane/observability/tracing/jaeger/jaeger_ui.png rename to docs/content/guides/operations/control-plane/observability/tracing/jaeger/jaeger_ui.png diff --git a/docs/content/operations/control-plane/observability/tracing/zipkin/index.md b/docs/content/guides/operations/control-plane/observability/tracing/zipkin/index.md similarity index 100% rename from docs/content/operations/control-plane/observability/tracing/zipkin/index.md rename to docs/content/guides/operations/control-plane/observability/tracing/zipkin/index.md diff --git a/docs/content/operations/control-plane/observability/tracing/zipkin/zipkin_ui.png b/docs/content/guides/operations/control-plane/observability/tracing/zipkin/zipkin_ui.png similarity index 100% rename from docs/content/operations/control-plane/observability/tracing/zipkin/zipkin_ui.png rename to docs/content/guides/operations/control-plane/observability/tracing/zipkin/zipkin_ui.png diff --git a/docs/content/guides/operations/kubernetes/_index.md b/docs/content/guides/operations/kubernetes/_index.md new file mode 100644 index 000000000..bd6df30b7 --- /dev/null +++ b/docs/content/guides/operations/kubernetes/_index.md @@ -0,0 +1,8 @@ +--- +type: docs +title: "Kubernetes platform" +linkTitle: "Kubernetes" +description: "Learn how Radius can run on Kubernetes" +weight: 10 +tags: ["Kubernetes"] +--- diff --git a/docs/content/operations/platforms/kubernetes/kubernetes-install.md b/docs/content/guides/operations/kubernetes/kubernetes-install.md similarity index 100% rename from docs/content/operations/platforms/kubernetes/kubernetes-install.md rename to docs/content/guides/operations/kubernetes/kubernetes-install.md diff --git a/docs/content/operations/platforms/kubernetes/kubernetes-mapping/index.md b/docs/content/guides/operations/kubernetes/kubernetes-mapping/index.md similarity index 100% rename from docs/content/operations/platforms/kubernetes/kubernetes-mapping/index.md rename to docs/content/guides/operations/kubernetes/kubernetes-mapping/index.md diff --git a/docs/content/operations/platforms/kubernetes/kubernetes-mapping/kubernetes-mapping.png b/docs/content/guides/operations/kubernetes/kubernetes-mapping/kubernetes-mapping.png similarity index 100% rename from docs/content/operations/platforms/kubernetes/kubernetes-mapping/kubernetes-mapping.png rename to docs/content/guides/operations/kubernetes/kubernetes-mapping/kubernetes-mapping.png diff --git a/docs/content/operations/platforms/kubernetes/kubernetes-metadata/index.md b/docs/content/guides/operations/kubernetes/kubernetes-metadata/index.md similarity index 100% rename from docs/content/operations/platforms/kubernetes/kubernetes-metadata/index.md rename to docs/content/guides/operations/kubernetes/kubernetes-metadata/index.md diff --git a/docs/content/operations/platforms/kubernetes/kubernetes-metadata/snippets/env.bicep b/docs/content/guides/operations/kubernetes/kubernetes-metadata/snippets/env.bicep similarity index 100% rename from docs/content/operations/platforms/kubernetes/kubernetes-metadata/snippets/env.bicep rename to docs/content/guides/operations/kubernetes/kubernetes-metadata/snippets/env.bicep diff --git a/docs/content/operations/platforms/kubernetes/supported-clusters.md b/docs/content/guides/operations/kubernetes/supported-clusters.md similarity index 98% rename from docs/content/operations/platforms/kubernetes/supported-clusters.md rename to docs/content/guides/operations/kubernetes/supported-clusters.md index 2f85c3959..390567eaa 100644 --- a/docs/content/operations/platforms/kubernetes/supported-clusters.md +++ b/docs/content/guides/operations/kubernetes/supported-clusters.md @@ -7,7 +7,7 @@ weight: 100 categories: "How-To" tags: ["Kubernetes", "control plane"] aliases: - - /operations/platforms/kubernetes/supported-clusters/ + - /operations/kubernetes/supported-clusters/ --- ## Minimum version diff --git a/docs/content/guides/operations/providers/_index.md b/docs/content/guides/operations/providers/_index.md new file mode 100644 index 000000000..4596372b2 --- /dev/null +++ b/docs/content/guides/operations/providers/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Cloud providers" +linkTitle: "Cloud providers" +description: "Deploy across clouds and platforms with Radius cloud providers" +weight: 300 +--- diff --git a/docs/content/operations/providers/index.md b/docs/content/guides/operations/providers/howto-cloud-providers/index.md similarity index 76% rename from docs/content/operations/providers/index.md rename to docs/content/guides/operations/providers/howto-cloud-providers/index.md index a1f8325f0..55f569bc8 100644 --- a/docs/content/operations/providers/index.md +++ b/docs/content/guides/operations/providers/howto-cloud-providers/index.md @@ -1,26 +1,13 @@ --- type: docs title: "How-To: Setup Cloud providers" -linkTitle: "Cloud providers" +linkTitle: "Setup Cloud providers" description: "Deploy across clouds and platforms with Radius cloud providers" -weight: 300 +weight: 200 categories: "How-To" tags: ["AWS","Azure"] --- -Radius cloud providers allow you to deploy and connect to cloud resources across various cloud platforms. For example, you can use the Radius Azure provider to run your application's services in your Kubernetes cluster, while deploying Azure resources to a specified Azure subscription and resource group. - -Diagram of cloud resources getting forwarded to cloud platforms upon deployment - -## Supported cloud providers - -| Provider | Description | -|----------|-------------| -| [Microsoft Azure](#azure-provider) | Deploy and connect to Azure resources | -| [Amazon Web Services](#aws-provider) | Deploy and connect to AWS resources | - -## Configure a cloud provider - When initializing a new Radius environment you can optionally configure a cloud provider for your environment {{< tabs "Azure Provider" "AWS Provider" >}} @@ -38,7 +25,7 @@ The Azure provider allows you to deploy and connect to Azure resources from a se #### Add a cloud provider when initializing an environment -1. Initialize a new [environment]({{< ref "operations/environments/overview" >}}) with `rad init` +1. Initialize a new [environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) with `rad init` 1. Select the Kubernetes cluster to install Radius into. Enter an environment name and base Kubernetes namespace to deploy the apps into. 1. Select "yes" to add a cloud provider and select Azure as the cloud provider 1. Specify your Azure subscription and resource group @@ -83,7 +70,7 @@ The AWS provider allows you to deploy and connect to AWS resources from a Radius #### Add a cloud provider when initializing an environment -1. Initialize a new [environment]({{< ref "operations/environments/overview" >}}) with `rad init` +1. Initialize a new [environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) with `rad init` 1. Select the Kubernetes cluster to install Radius into. Enter an environment name and base Kubernetes namespace to deploy the apps into. 1. Select "yes" to add a cloud provider and select AWS as the cloud provider diff --git a/docs/content/guides/operations/providers/overview/index.md b/docs/content/guides/operations/providers/overview/index.md new file mode 100644 index 000000000..169a0609c --- /dev/null +++ b/docs/content/guides/operations/providers/overview/index.md @@ -0,0 +1,20 @@ +--- +type: docs +title: "Overview: Cloud providers" +linkTitle: "Overview" +description: "Deploy across clouds and platforms with Radius cloud providers" +weight: 100 +categories: "Overview" +tags: ["AWS","Azure"] +--- + +Radius cloud providers allow you to deploy and connect to cloud resources across various cloud platforms. For example, you can use the Radius Azure provider to run your application's services in your Kubernetes cluster, while deploying Azure resources to a specified Azure subscription and resource group. + +Diagram of cloud resources getting forwarded to cloud platforms upon deployment + +## Supported cloud providers + +| Provider | Description | +|----------|-------------| +| [Microsoft Azure](#azure-provider) | Deploy and connect to Azure resources | +| [Amazon Web Services](#aws-provider) | Deploy and connect to AWS resources | diff --git a/docs/content/operations/providers/provider.svg b/docs/content/guides/operations/providers/overview/provider.svg similarity index 100% rename from docs/content/operations/providers/provider.svg rename to docs/content/guides/operations/providers/overview/provider.svg diff --git a/docs/content/operations/environments/overview/providers-overview.png b/docs/content/guides/operations/providers/overview/providers-overview.png similarity index 100% rename from docs/content/operations/environments/overview/providers-overview.png rename to docs/content/guides/operations/providers/overview/providers-overview.png diff --git a/docs/content/operations/versioning.md b/docs/content/guides/operations/versioning.md similarity index 100% rename from docs/content/operations/versioning.md rename to docs/content/guides/operations/versioning.md diff --git a/docs/content/guides/operations/workspaces/_index.md b/docs/content/guides/operations/workspaces/_index.md new file mode 100644 index 000000000..070840a61 --- /dev/null +++ b/docs/content/guides/operations/workspaces/_index.md @@ -0,0 +1,8 @@ +--- +type: docs +title: "Overview: Radius workspaces" +linkTitle: "Workspaces" +description: "Learn how to handle multiple Radius platforms and environments with workspaces" +weight: 250 +categories: "Overview" +--- \ No newline at end of file diff --git a/docs/content/operations/environments/workspaces/index.md b/docs/content/guides/operations/workspaces/howto-workspaces/index.md similarity index 52% rename from docs/content/operations/environments/workspaces/index.md rename to docs/content/guides/operations/workspaces/howto-workspaces/index.md index 5b1a6b66e..c23ab4cd8 100644 --- a/docs/content/operations/environments/workspaces/index.md +++ b/docs/content/guides/operations/workspaces/howto-workspaces/index.md @@ -1,100 +1,12 @@ --- type: docs -title: "Overview: Radius workspaces" -linkTitle: "Workspaces" +title: "How-To: Use Radius workspaces" +linkTitle: "Use Workspaces" description: "Learn how to handle multiple Radius platforms and environments with workspaces" -weight: 200 +weight: 300 categories: "Overview" --- -Workspaces allow you to manage multiple Radius platforms and environments using a local configuration file. You can easily define and switch between workspaces to deploy and manage applications across separate environments. - -Diagram showing a Radius configuration file mapping workspaces to Kubernetes clusters - -## CLI commands - -The following commands let you interact with Radius environments: - -{{< tabs create list show delete switch >}} - -{{% codetab %}} -[rad workspace init kubernetes]({{< ref rad_workspace_create >}}) creates a new workspace: - -```bash -rad workspace init kubernetes -``` -{{% /codetab %}} - -{{% codetab %}} -[rad workspace list]({{< ref rad_workspace_list >}}) lists all of the workspaces in your configuration file: - -```bash -rad workspacae list -``` -{{% /codetab %}} - -{{% codetab %}} -[rad workspace show]({{< ref rad_workspace_show >}}) prints information on the default or specified workspace: - -```bash -rad workspace show -``` -{{% /codetab %}} - -{{% codetab %}} -[rad workspace delete]({{< ref rad_workspace_delete >}}) deletes the specified workspace: - -```bash -rad workspace delete -w myenv -``` -{{% /codetab %}} - -{{% codetab %}} -[rad workspace switch]({{< ref rad_workspace_switch >}}) switches the default workspace: - -```bash -rad env switch -e myenv -``` -{{% /codetab %}} - -{{< /tabs >}} - -## Example - -Your Radius configuration file contains workspace entries that point to a Radius platform and environment: - -```yaml -workspaces: - default: dev - items: - dev: - connection: - context: DevCluster - kind: kubernetes - environment: /planes/radius/local/resourcegroups/dev/providers/applications.core/environments/dev - scope: /planes/radius/local/resourceGroups/dev - providerConfig: - azure: - subscriptionid: DEV-SUBID - resourcegroup: Dev - prod: - connection: - context: ProdCluster - kind: kubernetes - environment: /planes/radius/local/resourcegroups/prod/providers/applications.core/environments/prod - scope: /planes/radius/local/resourceGroups/prod - providerConfig: - azure: - subscriptionid: PROD-SUBID - resourcegroup: Prod -``` - -## Schema - -Visit the [`config.yaml` reference docs]({{< ref config >}}) to learn about workspace definitions. - -{{< button text="config.yaml Schema" page="config" >}} - ## How-to: Use workspaces to switch between environments When you have multiple environments initialized for different purposes workspaces enable you to switch between different environments easily. You can create separate workspaces and switch between them as you are working through your deployment lifecycle. @@ -148,4 +60,4 @@ When you have multiple environments initialized for different purposes workspace /providers/applications.core/environments/myworkspace scope: /planes/radius/local/resourceGroups/myworkspace ``` -1. You can now deploy applications to both myworkspace and yourworkspace using [`rad deploy`]({{< ref rad_deploy >}}), specifying the `-w` flag. \ No newline at end of file +1. You can now deploy applications to both myworkspace and yourworkspace using [`rad deploy`]({{< ref rad_deploy >}}), specifying the `-w` flag. diff --git a/docs/content/guides/operations/workspaces/overview/index.md b/docs/content/guides/operations/workspaces/overview/index.md new file mode 100644 index 000000000..e6ff96d64 --- /dev/null +++ b/docs/content/guides/operations/workspaces/overview/index.md @@ -0,0 +1,96 @@ +--- +type: docs +title: "Overview: Radius workspaces" +linkTitle: "Overview" +description: "Learn how to handle multiple Radius platforms and environments with workspaces" +weight: 200 +categories: "Overview" +--- + +Workspaces allow you to manage multiple Radius platforms and environments using a local configuration file. You can easily define and switch between workspaces to deploy and manage applications across separate environments. + +Diagram showing a Radius configuration file mapping workspaces to Kubernetes clusters + +## CLI commands + +The following commands let you interact with Radius environments: + +{{< tabs create list show delete switch >}} + +{{% codetab %}} +[rad workspace init kubernetes]({{< ref rad_workspace_create >}}) creates a new workspace: + +```bash +rad workspace init kubernetes +``` +{{% /codetab %}} + +{{% codetab %}} +[rad workspace list]({{< ref rad_workspace_list >}}) lists all of the workspaces in your configuration file: + +```bash +rad workspacae list +``` +{{% /codetab %}} + +{{% codetab %}} +[rad workspace show]({{< ref rad_workspace_show >}}) prints information on the default or specified workspace: + +```bash +rad workspace show +``` +{{% /codetab %}} + +{{% codetab %}} +[rad workspace delete]({{< ref rad_workspace_delete >}}) deletes the specified workspace: + +```bash +rad workspace delete -w myenv +``` +{{% /codetab %}} + +{{% codetab %}} +[rad workspace switch]({{< ref rad_workspace_switch >}}) switches the default workspace: + +```bash +rad env switch -e myenv +``` +{{% /codetab %}} + +{{< /tabs >}} + +## Example + +Your Radius configuration file contains workspace entries that point to a Radius platform and environment: + +```yaml +workspaces: + default: dev + items: + dev: + connection: + context: DevCluster + kind: kubernetes + environment: /planes/radius/local/resourcegroups/dev/providers/applications.core/environments/dev + scope: /planes/radius/local/resourceGroups/dev + providerConfig: + azure: + subscriptionid: DEV-SUBID + resourcegroup: Dev + prod: + connection: + context: ProdCluster + kind: kubernetes + environment: /planes/radius/local/resourcegroups/prod/providers/applications.core/environments/prod + scope: /planes/radius/local/resourceGroups/prod + providerConfig: + azure: + subscriptionid: PROD-SUBID + resourcegroup: Prod +``` + +## Schema + +Visit the [`config.yaml` reference docs]({{< ref config >}}) to learn about workspace definitions. + +{{< button text="config.yaml Schema" page="config" >}} diff --git a/docs/content/operations/environments/workspaces/workspaces.png b/docs/content/guides/operations/workspaces/overview/workspaces.png similarity index 100% rename from docs/content/operations/environments/workspaces/workspaces.png rename to docs/content/guides/operations/workspaces/overview/workspaces.png diff --git a/docs/content/guides/recipes/_index.md b/docs/content/guides/recipes/_index.md new file mode 100644 index 000000000..4af065e94 --- /dev/null +++ b/docs/content/guides/recipes/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Radius Recipes" +linkTitle: "Recipes" +description: "Learn how to automate infrastructure deployment for your resources with Radius recipes" +weight: 300 +--- diff --git a/docs/content/operations/custom-recipes/index.md b/docs/content/guides/recipes/howto-author-recipes/index.md similarity index 96% rename from docs/content/operations/custom-recipes/index.md rename to docs/content/guides/recipes/howto-author-recipes/index.md index 2013e6437..6ba17eeb5 100644 --- a/docs/content/operations/custom-recipes/index.md +++ b/docs/content/guides/recipes/howto-author-recipes/index.md @@ -1,7 +1,7 @@ --- type: docs -title: "Author Custom Radius Recipes" -linkTitle: "Custom Recipes" +title: "How-To: Author Custom Radius Recipes" +linkTitle: "Author Recipes" description: "Learn how to author custom Recipe templates to automate infrastructure deployment" weight: 500 categories: "How-To" @@ -12,7 +12,7 @@ Recipes enable a **separation of concerns** between infrastructure operators and Learn more in the Recipes overview page: -{{< button page="/author-apps/recipes" text="Recipes overview" newline=false >}} +{{< button page="/guides/recipes/overview" text="Recipes overview" newline=false >}} ## Author a custom Recipe @@ -106,7 +106,7 @@ rad recipe register myrecipe --environment myenv --template-kind bicep --templat ### Done -You can now use your custom recipe in its accompanying resource. Visit the [Recipe developer guide]({{< ref "/author-apps/recipes" >}}) for more information. +You can now use your custom recipe in its accompanying resource. Visit the [Recipe developer guide]({{< ref "/guides/recipes/overview" >}}) for more information. ## `context` parameter properties @@ -156,5 +156,5 @@ In the following tables, "resource" refers to the resource "calling" the Recipe. ## Further reading -- [Recipes overview]({{< ref "/author-apps/recipes" >}}) +- [Recipes overview]({{< ref "/guides/recipes/overview" >}}) - [`rad recipe CLI reference`]({{< ref rad_recipe >}}) diff --git a/docs/content/operations/custom-recipes/snippets/environment.bicep b/docs/content/guides/recipes/howto-author-recipes/snippets/environment.bicep similarity index 100% rename from docs/content/operations/custom-recipes/snippets/environment.bicep rename to docs/content/guides/recipes/howto-author-recipes/snippets/environment.bicep diff --git a/docs/content/operations/custom-recipes/snippets/recipe-outputs.bicep b/docs/content/guides/recipes/howto-author-recipes/snippets/recipe-outputs.bicep similarity index 100% rename from docs/content/operations/custom-recipes/snippets/recipe-outputs.bicep rename to docs/content/guides/recipes/howto-author-recipes/snippets/recipe-outputs.bicep diff --git a/docs/content/operations/custom-recipes/snippets/recipe-params.bicep b/docs/content/guides/recipes/howto-author-recipes/snippets/recipe-params.bicep similarity index 100% rename from docs/content/operations/custom-recipes/snippets/recipe-params.bicep rename to docs/content/guides/recipes/howto-author-recipes/snippets/recipe-params.bicep diff --git a/docs/content/operations/custom-recipes/snippets/recipe.bicep b/docs/content/guides/recipes/howto-author-recipes/snippets/recipe.bicep similarity index 100% rename from docs/content/operations/custom-recipes/snippets/recipe.bicep rename to docs/content/guides/recipes/howto-author-recipes/snippets/recipe.bicep diff --git a/docs/content/author-apps/recipes/index.md b/docs/content/guides/recipes/overview/index.md similarity index 91% rename from docs/content/author-apps/recipes/index.md rename to docs/content/guides/recipes/overview/index.md index 03e52d26d..a60717574 100644 --- a/docs/content/author-apps/recipes/index.md +++ b/docs/content/guides/recipes/overview/index.md @@ -1,16 +1,13 @@ --- type: docs -title: "Radius Recipes" -linkTitle: "Recipes" -description: "Automate infrastructure deployment for your resources with Radius recipes" -weight: 700 -categories: "Concept" +title: "Overview: Radius Recipes" +linkTitle: "Overview" +description: "Learn how to automate infrastructure deployment for your resources with Radius recipes" +weight: 100 +categories: "Overview" tags: ["recipes"] -slug: recipes --- -## Overview - Recipes enable a **separation of concerns** between infrastructure operators and developers by **automating infrastructure deployment**. Developers select the resource they want in their app (_Mongo Database, Redis Cache, Dapr State Store, etc._), and infrastructure operators codify in their environment how these resources should be deployed and configured (_lightweight containers, Azure resources, AWS resources, etc._). When a developer deploys their application and its resources, Recipes automatically deploy the backing infrastructure and bind it to the developer's resources. Diagram showing developers adding Redis to their app and operators adding a Recipe that Redis should deploy an Azure Cache for Redis @@ -43,7 +40,7 @@ You can use [**rad recipe show**]({{< ref rad_recipe_show >}}) to view the param ### Author custom Recipes -It's easy to author and register your own Recipes which define how to deploy and configure infrastructure that meets your organization's needs. See the [custom Recipes guide]({{< ref custom-recipes >}}) for more information. +It's easy to author and register your own Recipes which define how to deploy and configure infrastructure that meets your organization's needs. See the [custom Recipes guide]({{< ref howto-author-recipes >}}) for more information. ## Supported resources @@ -70,5 +67,5 @@ The lifecycle of Recipe infrastructure is tied to the resource calling the Recip ## Further Reading -- [Author custom recipes]({{< ref custom-recipes >}}) +- [Author custom recipes]({{< ref howto-author-recipes >}}) - [`rad recipe` CLI reference]({{< ref rad_recipe >}}) diff --git a/docs/content/author-apps/recipes/recipes.png b/docs/content/guides/recipes/overview/recipes.png similarity index 100% rename from docs/content/author-apps/recipes/recipes.png rename to docs/content/guides/recipes/overview/recipes.png diff --git a/docs/content/author-apps/recipes/snippets/recipe-link-example.bicep b/docs/content/guides/recipes/overview/snippets/recipe-link-example.bicep similarity index 100% rename from docs/content/author-apps/recipes/snippets/recipe-link-example.bicep rename to docs/content/guides/recipes/overview/snippets/recipe-link-example.bicep diff --git a/docs/content/installation/index.md b/docs/content/installation/index.md new file mode 100644 index 000000000..57a837796 --- /dev/null +++ b/docs/content/installation/index.md @@ -0,0 +1,33 @@ +--- +type: docs +title: "Overview: Radius installation" +linkTitle: "Installation" +description: "Learn how to get install Radius tooling and services" +weight: 25 +--- + +Radius consists of a set of tools and services that together form the Radius platform. + +Diagram showing rad CLI and VSCode extension on local machine plus the Radius control plane on a Kubernetes cluster + +## Step 1: Install the rad CLI + +The rad CLI is the main tool for interacting with Radius. It is used to create and manage Radius environments, and to deploy and manage Radius applications. + +Visit the [rad CLI how-to guide]({{< ref howto-rad-cli >}}) for more information on how to install the rad CLI. + +{{< button text="How-To: rad CLI" page="howto-rad-cli" newtab="true" >}} + +## Step 2: Install the Radius-Bicep VS Code extension + +The Radius-Bicep VS Code extension provides a set of tools for working with Bicep files in VS Code. Visit the [VSCode how-to guide]({{< ref howto-vscode >}}) for more information on how to install the Radius-Bicep VS Code extension. + +{{< button text="How-To: VS Code" page="howto-vscode" newtab="true" >}} + +## Step 3: Initialize the Radius control-plane + +The Radius control-plane is a set of services that provide the core functionality of Radius. It is deployed as a set of containers in a Kubernetes cluster. + +Visit the [environments how-to guide]({{< ref howto-environment >}}) for more information on how to install the Radius control-plane and create your first Radius environment. + +{{< button text="How-To: Init an environment" page="howto-environment" newtab="true" >}} diff --git a/docs/content/installation/radius.png b/docs/content/installation/radius.png new file mode 100644 index 000000000..a046dff38 Binary files /dev/null and b/docs/content/installation/radius.png differ diff --git a/docs/content/operations/_index.md b/docs/content/operations/_index.md deleted file mode 100644 index 0a0e30083..000000000 --- a/docs/content/operations/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Operating application environments" -linkTitle: "Operating environments" -description: "Learn about operating Radius environments and apps" -weight: 50 ---- diff --git a/docs/content/operations/control-plane/_index.md b/docs/content/operations/control-plane/_index.md deleted file mode 100644 index 41cce0c69..000000000 --- a/docs/content/operations/control-plane/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -type: docs -title: "Control plane" -linkTitle: "Control plane" -description: "Configure and manage your Radius control plane" -weight: 200 -categories: "How-To" -tags: ["control plane"] ---- - -The Radius control plane is the central management system for your Radius applications and deployments. It is responsible for managing the lifecycle of your applications, including deploying, updating, and deleting them. - -View the [control plane architecture]({{< ref architecture-concept >}}) to learn more about how the control plane works. diff --git a/docs/content/operations/high-availability.md b/docs/content/operations/high-availability.md deleted file mode 100644 index 05fb14e24..000000000 --- a/docs/content/operations/high-availability.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -type: docs -title: "HA for apps" -linkTitle: "HA for apps" -description: "Learn how to build out high availability for Radius apps" -weight: 600 -toc_hide: true -hide_summary: true ---- - - - -> πŸ‘·β€β™‚οΈ Under construction 🚧
-This page is still under construction. Please come back soon. \ No newline at end of file diff --git a/docs/content/operations/platforms/_index.md b/docs/content/operations/platforms/_index.md deleted file mode 100644 index d04de0a84..000000000 --- a/docs/content/operations/platforms/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -type: docs -title: "Supported Radius platforms" -linkTitle: "Platforms" -description: "Learn what platforms are supported by Radius" -weight: 100 -categories: "Concept" ---- - -Radius supports the following platforms: diff --git a/docs/content/operations/platforms/kubernetes/_index.md b/docs/content/operations/platforms/kubernetes/_index.md deleted file mode 100644 index 6d15377f3..000000000 --- a/docs/content/operations/platforms/kubernetes/_index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -type: docs -title: "Kubernetes platform" -linkTitle: "Kubernetes" -description: "Learn how Radius can run on Kubernetes" -weight: 10 -categories: "How-To" -tags: ["Kubernetes"] ---- - -Radius can be [installed]({{< ref kubernetes-install >}}) and run on top of Kubernetes clusters. This allows you to deploy and manage Radius applications across any cloud or on-premises cluster. diff --git a/docs/content/operations/rollout/_index.md b/docs/content/operations/rollout/_index.md deleted file mode 100644 index 5b9ca5909..000000000 --- a/docs/content/operations/rollout/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -type: docs -title: "Rollout" -linkTitle: "Rollout" -description: "Learn about rollout orchestration with Radius apps" -weight: 900 -toc_hide: true -hide_summary: true ---- - - - - - - -> πŸ‘·β€β™‚οΈ Under construction 🚧
-This page is still under construction. Please come back soon. \ No newline at end of file diff --git a/docs/content/operations/scaling.md b/docs/content/operations/scaling.md deleted file mode 100644 index 6a80ba7a3..000000000 --- a/docs/content/operations/scaling.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -type: docs -title: "Scaling apps" -linkTitle: "Scaling apps" -description: "Learn methods for setting up manual and automated scaling for Radius apps" -weight: 700 -toc_hide: true -hide_summary: true ---- - - - -> πŸ‘·β€β™‚οΈ Under construction 🚧
-This page is still under construction. Please come back soon. \ No newline at end of file diff --git a/docs/content/operations/security.md b/docs/content/operations/security.md deleted file mode 100644 index ea564d72a..000000000 --- a/docs/content/operations/security.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -type: docs -title: "Securing apps" -linkTitle: "Securing apps" -description: "Learn how to secure Radius apps" -weight: 800 -toc_hide: true -hide_summary: true ---- - - - -> πŸ‘·β€β™‚οΈ Under construction 🚧
-This page is still under construction. Please come back soon. \ No newline at end of file diff --git a/docs/content/reference/_index.md b/docs/content/reference/_index.md index d2a00814c..796a51a47 100644 --- a/docs/content/reference/_index.md +++ b/docs/content/reference/_index.md @@ -3,5 +3,5 @@ type: docs title: "Radius reference documentation" linkTitle: "Reference" description: "Detailed reference documentation on various Radius components" -weight: 60 +weight: 90 --- diff --git a/docs/content/reference/cli/rad_install_kubernetes.md b/docs/content/reference/cli/rad_install_kubernetes.md index c310b9bb3..440360594 100644 --- a/docs/content/reference/cli/rad_install_kubernetes.md +++ b/docs/content/reference/cli/rad_install_kubernetes.md @@ -17,7 +17,7 @@ By default 'rad install kubernetes' will install Radius with the version matchin Radius will be installed in the 'radius-system' namespace. For more information visit https://docs.radapp.dev/concepts/architecture/ -Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit https://docs.radapp.dev/operations/platforms/kubernetes/install/. +Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit https://docs.radapp.dev/operations/kubernetes/install/. ``` diff --git a/docs/content/reference/faq.md b/docs/content/reference/faq.md index 33c02b1d6..69f86d88e 100644 --- a/docs/content/reference/faq.md +++ b/docs/content/reference/faq.md @@ -96,7 +96,7 @@ Yes. You will need to modify the resource definition in your .bicep file's appli ### What AWS services does Radius support -Radius applications can include AWS services that are also supported by the AWS cloud control API. See the [AWS resource library]({{< ref "author-apps/platform-resources/aws#resource-library" >}}) for the complete list of supported AWS resources. Radius does not currently support direct connections to AWS resources, but it is on the backlog. Stay tuned for updates. +Radius applications can include AWS services that are also supported by the AWS cloud control API. See the [AWS resource library]({{< ref "/guides/author-apps/aws/overview#resource-library" >}}) for the complete list of supported AWS resources. Radius does not currently support direct connections to AWS resources, but it is on the backlog. Stay tuned for updates. ### What Azure services does Radius support? diff --git a/docs/content/reference/limitations.md b/docs/content/reference/limitations.md index c30c3bcc1..38b746923 100644 --- a/docs/content/reference/limitations.md +++ b/docs/content/reference/limitations.md @@ -10,7 +10,7 @@ weight: 998 ### `rad install kubernetes` and `rad init` installs Contour in addition to Radius -Contour is also installed into the `radius-system` namespace to help get you up and running quickly for our quickstarts and tutorial. This is a point-in-time limitation that will be addressed with richer environment customization in a future update. +Contour is also installed into the `radius-system` namespace to help get you up and running quickly. This is a point-in-time limitation that will be addressed with richer environment customization in a future update. ## Radius resources 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 index 0964bda1a..af1bcd2fe 100644 --- a/docs/content/reference/resource-schema/core-schema/application-schema/_index.md +++ b/docs/content/reference/resource-schema/core-schema/application-schema/_index.md @@ -40,7 +40,7 @@ The Kubernetes namespace extension allows you to customize how all of the resour ##### kubernetesMetadata -The [Kubernetes Metadata extension]({{< ref "/operations/platforms/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. For examples, please refer to the extension overview page. +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. For examples, please refer to the extension overview page. ###### Properties 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 index 79cde0541..c0a1fab11 100644 --- a/docs/content/reference/resource-schema/core-schema/container-schema/_index.md +++ b/docs/content/reference/resource-schema/core-schema/container-schema/_index.md @@ -118,7 +118,7 @@ Additional properties are available and required depending on the 'kind' of the #### kubernetesMetadata -The [Kubernetes Metadata extension]({{< ref "/operations/platforms/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. For examples refer to the extension overview page. +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. For examples refer to the extension overview page. ##### Properties diff --git a/docs/content/reference/resource-schema/core-schema/environment-schema/index.md b/docs/content/reference/resource-schema/core-schema/environment-schema/index.md index e49a7e058..d75e15f21 100644 --- a/docs/content/reference/resource-schema/core-schema/environment-schema/index.md +++ b/docs/content/reference/resource-schema/core-schema/environment-schema/index.md @@ -65,7 +65,7 @@ Extensions allow you to customize how resources are generated or customized as p #### kubernetesMetadata -The [Kubernetes Metadata extension]({{< ref "/operations/platforms/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. For examples, please refer to the extension overview page. +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. For examples, please refer to the extension overview page. ##### Properties @@ -89,4 +89,4 @@ The [Kubernetes Metadata extension]({{< ref "/operations/platforms/kubernetes/ku ## Further reading -- [Radius environments]({{< ref "operations/environments/overview" >}}) +- [Radius environments]({{< ref "/guides/deploy-apps/environments/overview" >}}) diff --git a/docs/content/reference/resource-schema/core-schema/httproute/index.md b/docs/content/reference/resource-schema/core-schema/httproute/index.md index 954a37bb0..e81188b25 100644 --- a/docs/content/reference/resource-schema/core-schema/httproute/index.md +++ b/docs/content/reference/resource-schema/core-schema/httproute/index.md @@ -34,7 +34,7 @@ The following example shows two containers, one providing an HttpRoute and the o ### Providing container -Once an HttpRoute is defined, you can provide it from a [container]({{< ref container >}}) by using the `provides` property: +Once an HttpRoute is defined, you can provide it from a [container]({{< ref "guides/author-apps/containers" >}}) by using the `provides` property: {{< rad file="snippets/httproute.bicep" embed=true marker="//BACKEND" >}} diff --git a/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/index.md b/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/index.md index f07cc2812..6fbb5c945 100644 --- a/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/index.md +++ b/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/index.md @@ -12,7 +12,7 @@ Radius supports mounting an Azure Key Vault as a persistent volume to the contai - [Azure Key Vault CSI Driver](https://azure.github.io/secrets-store-csi-driver-provider-azure/demos/standard-walkthrough/) installed on your cluster - [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/installation.html) installed on your cluster -- `azure.com.workload` identity configured on your [environment]({{< ref "operations/environments/overview" >}}) +- `azure.com.workload` identity configured on your [environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) - Your Azure Key Vault access policy should be set to [Azure role-based access control](https://learn.microsoft.com/azure/key-vault/general/rbac-guide?tabs=azure-cli) ## Resource format diff --git a/docs/content/reference/resource-schema/link-schema/cache/redis/index.md b/docs/content/reference/resource-schema/link-schema/cache/redis/index.md index 605c4871e..6c09ee5f7 100644 --- a/docs/content/reference/resource-schema/link-schema/cache/redis/index.md +++ b/docs/content/reference/resource-schema/link-schema/cache/redis/index.md @@ -8,7 +8,7 @@ categories: "Schema" ## Overview -The `redislabs.com/Redis` link is a [portable link]({{< ref links-resources >}}) which can be deployed to any platform Radius supports. +The `redislabs.com/Redis` link is a [portable link]({{< ref portable-resources >}}) which can be deployed to any platform Radius supports. ## Resource format @@ -85,7 +85,7 @@ The following methods are available on the Redis link: ### Provision with a Recipe -[Recipes]({{< ref custom-recipes >}}) automate infrastructure provisioning using approved templates. +[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. When no Recipe configuration is set, Radius will use the currently registered Recipe as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set to override this default. ### Provision manually @@ -94,7 +94,7 @@ If you want to manually manage your infrastructure provisioning without the use ## Environment variables for connections -Other Radius resources, such as [containers]({{< ref "container" >}}), may connect to a Redis resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Redis named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Redis resource: +Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Redis resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Redis named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Redis resource: | Environment variable | Example(s) | |----------------------|------------| diff --git a/docs/content/reference/resource-schema/link-schema/dapr-schema/_index.md b/docs/content/reference/resource-schema/link-schema/dapr-schema/_index.md index 0b7bfdf5c..f5b91108c 100644 --- a/docs/content/reference/resource-schema/link-schema/dapr-schema/_index.md +++ b/docs/content/reference/resource-schema/link-schema/dapr-schema/_index.md @@ -6,9 +6,3 @@ description: "Learn what Dapr links are available in your application" weight: 600 slug: "dapr" --- - -Radius provides built-in Dapr hosting, plus integrations with [Radius resources]({{< ref "container.md#dapr-sidecar" >}}). - -Additionally, there are Dapr links which offer abstractions for [Dapr building blocks](https://docs.dapr.io/developing-applications/building-blocks/). - -## Dapr links diff --git a/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-extension/index.md b/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-extension/index.md index 0370148df..0b92ec8ec 100644 --- a/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-extension/index.md +++ b/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-extension/index.md @@ -14,7 +14,7 @@ The `daprSidecar` extensions adds and configures a [Dapr](https://dapr.io) sidec ## Extension format -In this example a [container]({{< ref container >}}) adds a Dapr extension to add a Dapr sidecar: +In this example a [container]({{< ref "guides/author-apps/containers" >}}) adds a Dapr extension to add a Dapr sidecar: {{< rad file="snippets/dapr.bicep" embed=true marker="//SAMPLE" replace-key-run="//CONTAINER" replace-value-run="container: {...}" >}} diff --git a/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-pubsub/_index.md b/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-pubsub/_index.md index c0c2f3235..c5aa2f5ea 100644 --- a/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-pubsub/_index.md +++ b/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-pubsub/_index.md @@ -68,7 +68,7 @@ An `Applications.Link/daprPubSubBrokers` resource represents a [Dapr pub/sub](ht ### Provision with a Recipe -[Recipes]({{< ref "/author-apps/recipes" >}}) automate infrastructure provisioning using approved templates. +[Recipes]({{< ref "guides/recipes/overview" >}}) automate infrastructure provisioning using approved templates. You can specify a Recipe name that is registered in the environment or omit the name and use the "default" Recipe. @@ -80,7 +80,7 @@ If you want to manually manage your infrastructure provisioning outside of Recip ## Environment variables for connections -Other Radius resources, such as [containers]({{< ref "container" >}}), may connect to a Dapr pub/sub resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Dapr pub/sub named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr pub/sub resource: +Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Dapr pub/sub resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Dapr pub/sub named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr pub/sub resource: | Environment variable | Example(s) | |----------------------|------------| diff --git a/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-secretstore/_index.md b/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-secretstore/_index.md index f7cafb528..06434f8b1 100644 --- a/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-secretstore/_index.md +++ b/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-secretstore/_index.md @@ -69,7 +69,7 @@ This resource will automatically create and deploy the Dapr component spec for t ### Provision with a Recipe -[Recipes]({{< ref custom-recipes >}}) automate infrastructure provisioning using approved templates. +[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. When no Recipe configuration is set Radius will use the Recipe registered as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set. ### Provision manually @@ -78,7 +78,7 @@ If you want to manually manage your infrastructure provisioning outside of Recip ## Environment variables for connections -Other Radius resources, such as [containers]({{< ref "container" >}}), may connect to a Dapr secret store resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Dapr secret store named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr secret store resource: +Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Dapr secret store resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Dapr secret store named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr secret store resource: | Environment variable | Example(s) | |----------------------|------------| diff --git a/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-statestore/_index.md b/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-statestore/_index.md index 40281a6ad..62d6c9dd7 100644 --- a/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-statestore/_index.md +++ b/docs/content/reference/resource-schema/link-schema/dapr-schema/dapr-statestore/_index.md @@ -71,7 +71,7 @@ This resource will automatically create and deploy the Dapr component spec for t ### Provision with a Recipe -[Recipes]({{< ref custom-recipes >}}) automate infrastructure provisioning using approved templates. +[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. When no Recipe configuration is set Radius will use the Recipe registered as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set. ### Provision manually @@ -80,7 +80,7 @@ If you want to manually manage your infrastructure provisioning outside of Recip ## Environment variables for connections -Other Radius resources, such as [containers]({{< ref "container" >}}), may connect to a Dapr state store resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Dapr state store named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr state store resource: +Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Dapr state store resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Dapr state store named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr state store resource: | Environment variable | Example(s) | |----------------------|------------| diff --git a/docs/content/reference/resource-schema/link-schema/databases/microsoft-sql/index.md b/docs/content/reference/resource-schema/link-schema/databases/microsoft-sql/index.md index be5c96d36..844f4fdeb 100644 --- a/docs/content/reference/resource-schema/link-schema/databases/microsoft-sql/index.md +++ b/docs/content/reference/resource-schema/link-schema/databases/microsoft-sql/index.md @@ -75,7 +75,7 @@ This application showcases how Radius can use a user-manged Azure SQL Database. ### Provision with a Recipe -[Recipes]({{< ref custom-recipes >}}) automate infrastructure provisioning using approved templates. +[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. When no Recipe configuration is set Radius will use the Recipe registered as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set. ### Provision manually @@ -84,7 +84,7 @@ If you want to manually manage your infrastructure provisioning outside of Recip ## Environment variables for connections -Other Radius resources, such as [containers]({{< ref "container" >}}), may connect to a Azure SQL resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Azure SQL named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Azure SQL resource: +Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Azure SQL resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to Azure SQL named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Azure SQL resource: | Environment variable | Example(s) | |----------------------|------------| diff --git a/docs/content/reference/resource-schema/link-schema/databases/mongodb/index.md b/docs/content/reference/resource-schema/link-schema/databases/mongodb/index.md index ab09b2cb9..d108b9282 100644 --- a/docs/content/reference/resource-schema/link-schema/databases/mongodb/index.md +++ b/docs/content/reference/resource-schema/link-schema/databases/mongodb/index.md @@ -7,7 +7,7 @@ description: "Learn how to use a MongoDB link in your application" ## Overview -The `mongodb.com/MongoDatabase` link is a [portable link]({{< ref links-resources >}}) which represents a Mongo Database. +The `mongodb.com/MongoDatabase` link is a [portable link]({{< ref portable-resources >}}) which represents a Mongo Database. ## Resource format @@ -84,7 +84,7 @@ The following methods are available on the MongoDB link: ### Provision with a Recipe -[Recipes]({{< ref "/author-apps/recipes" >}}) automate infrastructure provisioning using approved templates. +[Recipes]({{< ref "guides/recipes/overview" >}}) automate infrastructure provisioning using approved templates. You can specify a Recipe name that is registered in the environment or omit the name and use the "default" Recipe. Parameters can also optionally be specified for the Recipe. @@ -95,7 +95,7 @@ If you want to manually manage your infrastructure provisioning outside of Recip ## Environment variables for connections -Other Radius resources, such as [containers]({{< ref "container" >}}), may connect to a MongoDB resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to MongoDB named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected MongoDB resource: +Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a MongoDB resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to MongoDB named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected MongoDB resource: | Environment variable | Example(s) | |----------------------|------------| diff --git a/docs/content/reference/resource-schema/link-schema/extender/_index.md b/docs/content/reference/resource-schema/link-schema/extender/_index.md index e2cdff88f..41399ae7f 100644 --- a/docs/content/reference/resource-schema/link-schema/extender/_index.md +++ b/docs/content/reference/resource-schema/link-schema/extender/_index.md @@ -65,7 +65,7 @@ The following methods are available on the Extender link: ### Provision with a Recipe -[Recipes]({{< ref "/author-apps/recipes" >}}) automate infrastructure provisioning using approved templates. +[Recipes]({{< ref "guides/recipes/overview" >}}) automate infrastructure provisioning using approved templates. You can specify a Recipe name that is registered in the environment or omit the name and use the "default" Recipe. Parameters can also optionally be specified for the Recipe. diff --git a/docs/content/reference/resource-schema/link-schema/messaging/rabbitmq/index.md b/docs/content/reference/resource-schema/link-schema/messaging/rabbitmq/index.md index 141f3cbc5..6d8454bff 100644 --- a/docs/content/reference/resource-schema/link-schema/messaging/rabbitmq/index.md +++ b/docs/content/reference/resource-schema/link-schema/messaging/rabbitmq/index.md @@ -85,7 +85,7 @@ Secrets are used when defining a RabbitMQ link with a container or external serv ### Provision with a Recipe -[Recipes]({{< ref custom-recipes >}}) automate infrastructure provisioning using approved templates. +[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. When no Recipe configuration is set Radius will use the Recipe registered as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set. ### Provision manually @@ -94,7 +94,7 @@ If you want to manually manage your infrastructure provisioning outside of Recip ## Environment variables for connections -Other Radius resources, such as [containers]({{< ref "container" >}}), may connect to a RabbitMQ resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to RabbitMQ named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected RabbitMQ resource: +Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a RabbitMQ resource via [connections]({{< ref "application-graph#connections-and-injected-values" >}}). When a connection to RabbitMQ named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected RabbitMQ resource: | Environment variable | Example(s) | |----------------------|------------| diff --git a/docs/content/tutorials/_index.md b/docs/content/tutorials/_index.md new file mode 100644 index 000000000..29e25b55b --- /dev/null +++ b/docs/content/tutorials/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Tutorials" +linkTitle: "Tutorials" +description: "Follow along with a set of tutorials to learn how to use the Radius platform" +weight: 30 +--- diff --git a/docs/content/getting-started/quickstarts/quickstart-dapr/frontend.png b/docs/content/tutorials/tutorial-dapr/frontend.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-dapr/frontend.png rename to docs/content/tutorials/tutorial-dapr/frontend.png diff --git a/docs/content/getting-started/quickstarts/quickstart-dapr/icon.png b/docs/content/tutorials/tutorial-dapr/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-dapr/icon.png rename to docs/content/tutorials/tutorial-dapr/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-dapr/index.md b/docs/content/tutorials/tutorial-dapr/index.md similarity index 77% rename from docs/content/getting-started/quickstarts/quickstart-dapr/index.md rename to docs/content/tutorials/tutorial-dapr/index.md index 47a0c0d59..a41d815c5 100644 --- a/docs/content/getting-started/quickstarts/quickstart-dapr/index.md +++ b/docs/content/tutorials/tutorial-dapr/index.md @@ -1,30 +1,30 @@ --- type: docs -title: "Quickstart: Dapr Microservices" +title: "How-To: Dapr Microservices" linkTitle: "Dapr microservices" description: "Learn Radius by authoring templates and deploying a Dapr application" weight: 300 slug: "dapr" -categories: "Quickstart" +categories: "How-To" tags : ["Dapr"] --- -This quickstart will teach you: +This how-to guide will teach you: - How to use Radius to deploy a Dapr microservices sample application for an online shop -- How [Dapr and Radius]({{< ref dapr-resources >}}) seamlessly work together +- How [Dapr and Radius]({{< ref "guides/author-apps/dapr" >}}) seamlessly work together -For more details on the app and access to the source code, visit the `quickstarts/dapr` directory in the [samples repo](https://github.com/project-radius/samples). _For access to the project-radius GitHub org, please complete and submit [this form](https://aka.ms/ProjectRadius/GitHubAccess)._ +For more details on the app and access to the source code, visit the `tutorials/dapr` directory in the [samples repo](https://github.com/project-radius/samples). _For access to the project-radius GitHub org, please complete and submit [this form](https://aka.ms/ProjectRadius/GitHubAccess)._ ## Prerequisites - [Kubernetes cluster]({{< ref "supported-clusters" >}}) - [Radius CLI]({{< ref "getting-started" >}}) -- [Radius environment]({{< ref "operations/environments/overview" >}}) +- [Radius environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) - [Dapr installed on your Kubernetes cluster](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/) - [Visual Studio Code](https://code.visualstudio.com/) (recommended) - The [Radius VSCode extension]({{< ref "getting-started" >}}) is highly recommended to provide syntax highlighting, completion, and linting - - Although not recommended, you can also complete this quickstart with any basic text editor + - Although not recommended, you can also complete This how-to guide with any basic text editor ## Step 1: Define the application, `backend` container, and Dapr state store @@ -58,7 +58,7 @@ Begin by creating a new file named `dapr.bicep` with a Radius application that c 1. Press CTRL+C to terminate the port-forward. -1. A [local-dev Recipe]({{< ref "author-apps/recipes" >}}) was run during application deployment to automatically create a lightweight Redis container plus a Dapr component configuration. Confirm that the Dapr Redis statestore was successfully created: +1. A [local-dev Recipe]({{< ref "/guides/recipes/overview" >}}) was run during application deployment to automatically create a lightweight Redis container plus a Dapr component configuration. Confirm that the Dapr Redis statestore was successfully created: ```sh dapr components -k -A @@ -73,7 +73,7 @@ Begin by creating a new file named `dapr.bicep` with a Radius application that c ## Step 3: Define the `frontend` container -Add a `frontend` [container]({{< ref container >}}) which will serve as the application's user interface. +Add a `frontend` [container]({{< ref "guides/author-apps/containers" >}}) which will serve as the application's user interface. {{< rad file="snippets/dapr.bicep" embed=true marker="//FRONTEND" >}} @@ -115,11 +115,11 @@ In your browser, navigate to the endpoint (e.g. [http://localhost:8080](http://l ## Next steps -- If you'd like to try another tutorial with your existing environment, go back to the [Radius quickstarts]({{< ref quickstarts >}}) page. +- If you'd like to try another tutorial with your existing environment, go back to the [Radius tutorials]({{< ref tutorials >}}) page. - Related links for Dapr: - [Dapr documentation](https://docs.dapr.io/) - [Dapr quickstarts](https://github.com/dapr/quickstarts/tree/v1.0.0/hello-world)
-{{< button text="Try another quickstart" page="quickstarts" >}} \ No newline at end of file +{{< button text="Try another tutorial" page="tutorials" >}} \ No newline at end of file diff --git a/docs/content/getting-started/quickstarts/quickstart-dapr/snippets/dapr.bicep b/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-dapr/snippets/dapr.bicep rename to docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/icon.png b/docs/content/tutorials/tutorial-recipe/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/icon.png rename to docs/content/tutorials/tutorial-recipe/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/index.md b/docs/content/tutorials/tutorial-recipe/index.md similarity index 86% rename from docs/content/getting-started/quickstarts/quickstart-recipe/index.md rename to docs/content/tutorials/tutorial-recipe/index.md index 282cec5e4..34cab973a 100644 --- a/docs/content/getting-started/quickstarts/quickstart-recipe/index.md +++ b/docs/content/tutorials/tutorial-recipe/index.md @@ -1,15 +1,15 @@ --- type: docs -title: "Quickstart: Deploy Recipes in your Radius Application" +title: "How-To: Deploy Recipes in your Radius Application" linkTitle: "Recipes" description: "Learn how to use Radius Recipes within your application" weight: 500 slug: "recipes" -categories: "Quickstart" +categories: "How-To" tags : ["recipes"] --- -This quickstart will teach you: +This how-to guide will teach you: * How to use β€œdev” Recipes in your Radius Environment to quickly run with containerized infrastructure. * How to deploy your own Recipes in your Radius Environment to leverage cloud resources. @@ -17,17 +17,17 @@ This quickstart will teach you: ## Prerequisites - Install the [rad CLI]({{< ref getting-started >}}) -- Setup a supported [Kubernetes cluster]({{< ref "/operations/platforms/kubernetes" >}}) +- Setup a supported [Kubernetes cluster]({{< ref "guides/operations/kubernetes" >}}) ## Overview -[Recipes]({{< ref "/author-apps/recipes">}}) enable a separation of concerns between infrastructure teams and developers by automating infrastructure deployment. Developers define _what_ they need (_Redis, Mongo, etc._), and operators define _how_ it will be deployed (_Azure/AWS/Kubernetes infrastructure_). +[Recipes]({{< ref "guides/recipes/overview">}}) enable a separation of concerns between infrastructure teams and developers by automating infrastructure deployment. Developers define _what_ they need (_Redis, Mongo, etc._), and operators define _how_ it will be deployed (_Azure/AWS/Kubernetes infrastructure_). -{{< button text="Learn more about Recipes here" page="/author-apps/recipes" newtab="true" >}} +{{< button text="Learn more about Recipes here" page="/guides/recipes/overview" newtab="true" >}} ## Application overview -This application is a simple to-do list which stores and visualizes to-do items. It consists of a frontend [container]({{< ref container >}}) and a backend [Redis Cache]({{< ref redis >}}). +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 @@ -65,7 +65,7 @@ Developers don't need to specify what cloud resources they're using in their app ``` {{< alert title="πŸ’‘ Dev Recipes" color="info" >}} - Dev environments are preloaded with [`dev` Recipes]({{< ref "/author-apps/recipes#use-community-dev-recipes" >}}), a set of Recipes that allow you to quickly get up and running with lightweight containerized infrastructure. In this quickstart, the dev Redis Recipe deploys a lightweight Redis container into your Kubernetes cluster. + Dev environments are preloaded with [`dev` Recipes]({{< ref "guides/recipes/overview#use-community-dev-recipes" >}}), a set of Recipes that allow you to quickly get up and running with lightweight containerized infrastructure. In This how-to guide, the dev Redis Recipe deploys a lightweight Redis container into your Kubernetes cluster. When a Recipe is named "default" it will be used by default when deploying resources when a Recipe is not specified. {{< /alert >}} @@ -220,4 +220,4 @@ rad env delete default --yes ## Next steps -- To learn how to create your own custom Recipe visit our [administrator guide]({{< ref custom-recipes.md >}}) +- To learn how to create your own custom Recipe visit our [administrator guide]({{< ref howto-author-recipes.md >}}) diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/recipe-quickstart-diagram.png b/docs/content/tutorials/tutorial-recipe/recipe-quickstart-diagram.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/recipe-quickstart-diagram.png rename to docs/content/tutorials/tutorial-recipe/recipe-quickstart-diagram.png diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/snippets/app-azure.bicep b/docs/content/tutorials/tutorial-recipe/snippets/app-azure.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/snippets/app-azure.bicep rename to docs/content/tutorials/tutorial-recipe/snippets/app-azure.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/snippets/app.bicep b/docs/content/tutorials/tutorial-recipe/snippets/app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/snippets/app.bicep rename to docs/content/tutorials/tutorial-recipe/snippets/app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/todoapp.png b/docs/content/tutorials/tutorial-recipe/todoapp.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/todoapp.png rename to docs/content/tutorials/tutorial-recipe/todoapp.png diff --git a/docs/content/getting-started/reference-apps/_index.md b/holding-pen/reference-apps/_index.md similarity index 100% rename from docs/content/getting-started/reference-apps/_index.md rename to holding-pen/reference-apps/_index.md diff --git a/docs/content/getting-started/reference-apps/aws-rds/icon.png b/holding-pen/reference-apps/aws-rds/icon.png similarity index 100% rename from docs/content/getting-started/reference-apps/aws-rds/icon.png rename to holding-pen/reference-apps/aws-rds/icon.png diff --git a/docs/content/getting-started/reference-apps/aws-rds/index.md b/holding-pen/reference-apps/aws-rds/index.md similarity index 98% rename from docs/content/getting-started/reference-apps/aws-rds/index.md rename to holding-pen/reference-apps/aws-rds/index.md index e971fbdb6..d8bfaf3be 100644 --- a/docs/content/getting-started/reference-apps/aws-rds/index.md +++ b/holding-pen/reference-apps/aws-rds/index.md @@ -15,7 +15,7 @@ This reference app will show you: ## Prerequisites -- [Complete the getting started guide for AWS up to Step 2]({{< ref quickstart-aws-s3 >}}) +- [Complete the getting started guide for AWS up to Step 2]({{< ref howto-aws-resources >}}) ## Step 1: Create a Bicep file which uses AWS RDS diff --git a/docs/content/getting-started/reference-apps/aws-rds/snippets/app.bicep b/holding-pen/reference-apps/aws-rds/snippets/app.bicep similarity index 100% rename from docs/content/getting-started/reference-apps/aws-rds/snippets/app.bicep rename to holding-pen/reference-apps/aws-rds/snippets/app.bicep diff --git a/docs/content/getting-started/reference-apps/aws-s3/_index.md b/holding-pen/reference-apps/aws-s3/_index.md similarity index 100% rename from docs/content/getting-started/reference-apps/aws-s3/_index.md rename to holding-pen/reference-apps/aws-s3/_index.md diff --git a/docs/content/getting-started/reference-apps/aws-sqs/_index.md b/holding-pen/reference-apps/aws-sqs/_index.md similarity index 88% rename from docs/content/getting-started/reference-apps/aws-sqs/_index.md rename to holding-pen/reference-apps/aws-sqs/_index.md index bd8f964c5..d97aee3ec 100644 --- a/docs/content/getting-started/reference-apps/aws-sqs/_index.md +++ b/holding-pen/reference-apps/aws-sqs/_index.md @@ -17,7 +17,7 @@ This reference app will show you: ## Prerequisites -- [Complete the getting started guide for AWS up to Step 2]({{< ref quickstart-aws-s3 >}}) +- [Complete the getting started guide for AWS up to Step 2]({{< ref howto-aws-resources >}}) ## Step 1: Create a Bicep file which uses AWS Simple Queue Service (SQS) @@ -37,7 +37,7 @@ This application models two http services: (1) `producer` and (2) `consumer` tha rad deploy ./app.bicep -p aws_access_key_id=$AWS_ACCESS_KEY_ID -p aws_secret_access_key=$AWS_SECRET_ACCESS_KEY -p aws_region=$AWS_REGION -p queue_name='queue' ``` - The access key, secret key, and region can be the same values you used in the [AWS Quickstart]({{< ref quickstart-aws-s3 >}}). These are used so the container we are deploying can connect to AWS. The AWS SQS Queue name must follow the [`Queue name` conventions](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-queues.html). + The access key, secret key, and region can be the same values you used in the [AWS How-To guide]({{< ref howto-aws-resources >}}). These are used so the container we are deploying can connect to AWS. The AWS SQS Queue name must follow the [`Queue name` conventions](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-queues.html). 1. Port-forward the container to your machine with [`rad resource expose`]({{< ref rad_resource_expose >}}): diff --git a/docs/content/getting-started/reference-apps/aws-sqs/diagram.jpg b/holding-pen/reference-apps/aws-sqs/diagram.jpg similarity index 100% rename from docs/content/getting-started/reference-apps/aws-sqs/diagram.jpg rename to holding-pen/reference-apps/aws-sqs/diagram.jpg diff --git a/docs/content/getting-started/reference-apps/aws-sqs/icon.png b/holding-pen/reference-apps/aws-sqs/icon.png similarity index 100% rename from docs/content/getting-started/reference-apps/aws-sqs/icon.png rename to holding-pen/reference-apps/aws-sqs/icon.png diff --git a/docs/content/getting-started/reference-apps/aws-sqs/snippets/app.bicep b/holding-pen/reference-apps/aws-sqs/snippets/app.bicep similarity index 100% rename from docs/content/getting-started/reference-apps/aws-sqs/snippets/app.bicep rename to holding-pen/reference-apps/aws-sqs/snippets/app.bicep diff --git a/docs/content/getting-started/reference-apps/eshop-dapr/_index.md b/holding-pen/reference-apps/eshop-dapr/_index.md similarity index 100% rename from docs/content/getting-started/reference-apps/eshop-dapr/_index.md rename to holding-pen/reference-apps/eshop-dapr/_index.md diff --git a/docs/content/getting-started/reference-apps/eshop-dapr/architecture.png b/holding-pen/reference-apps/eshop-dapr/architecture.png similarity index 100% rename from docs/content/getting-started/reference-apps/eshop-dapr/architecture.png rename to holding-pen/reference-apps/eshop-dapr/architecture.png diff --git a/docs/content/getting-started/reference-apps/eshop-dapr/icon.png b/holding-pen/reference-apps/eshop-dapr/icon.png similarity index 100% rename from docs/content/getting-started/reference-apps/eshop-dapr/icon.png rename to holding-pen/reference-apps/eshop-dapr/icon.png diff --git a/docs/content/getting-started/reference-apps/eshop/_index.md b/holding-pen/reference-apps/eshop/_index.md similarity index 100% rename from docs/content/getting-started/reference-apps/eshop/_index.md rename to holding-pen/reference-apps/eshop/_index.md diff --git a/docs/content/getting-started/reference-apps/eshop/architecture.png b/holding-pen/reference-apps/eshop/architecture.png similarity index 100% rename from docs/content/getting-started/reference-apps/eshop/architecture.png rename to holding-pen/reference-apps/eshop/architecture.png diff --git a/docs/content/getting-started/reference-apps/eshop/deploy.png b/holding-pen/reference-apps/eshop/deploy.png similarity index 100% rename from docs/content/getting-started/reference-apps/eshop/deploy.png rename to holding-pen/reference-apps/eshop/deploy.png diff --git a/docs/content/getting-started/reference-apps/eshop/icon.png b/holding-pen/reference-apps/eshop/icon.png similarity index 100% rename from docs/content/getting-started/reference-apps/eshop/icon.png rename to holding-pen/reference-apps/eshop/icon.png