Skip to content

docs: make AWS and Azure support more discoverable - #2042

Open
willtsai wants to merge 6 commits into
v0.61from
willtsai-cloud-support-visibility
Open

willtsai wants to merge 6 commits into
v0.61from
willtsai-cloud-support-visibility

Conversation

@willtsai

@willtsai willtsai commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Propose documentation changes that make Radius support for AWS and Azure easier to find, while keeping the wording technical and avoiding claims of universal portability.

  • Name AWS and Azure in the home-page introduction and add cloud deployment cards after What you can do with Radius, with direct links to credential setup.
  • Add a top-level AWS and Azure sidebar section between Install Radius and Manage Radius. Its overview connects credentials, Environment configuration, Recipe Packs, and application deployment.
  • Move the credential index and its four guides, images, and script snippet from installation/cloud-providers/ to aws-and-azure/cloud-providers/. Keep cloud setup within one sidebar section and direct each guide's next steps to Recipe Pack management.
  • Redirect the former overview URLs to /aws-and-azure/, and former credential URLs to their corresponding pages under /aws-and-azure/cloud-providers/. Update internal links to the new canonical paths.
  • Explain the difference between hosting Radius on EKS or AKS and provisioning cloud services. Use PostgreSQL examples to explain when an application definition can be reused across clouds.

This is a documentation-only proposal. It does not change Radius behavior, tutorial commands, or supported cloud services. Getting Started remains unchanged: cloud deployments are an advanced topic outside the quickstart's scope.

Reason for change

Customer and user feedback indicates that the documentation does not make AWS and Azure support sufficiently visible. The home page previously described Radius as multi-cloud without naming either provider, and cloud setup was nested under installation as Cloud provider credentials.

Cloud support should be visible to readers evaluating Radius as well as those configuring a deployment. Grouping credential setup under AWS and Azure keeps that journey in one section rather than sending readers back into installation. Install Radius still links to cloud setup; Environment and Recipe Pack management remain under Manage Radius, since they also apply to local Kubernetes.

Portability remains conditional on recipes implementing the Resource Types and properties an application uses; the overview does not imply service parity between clouds.

No linked issue.

How to test

Validation completed:

  • npm run build from docs/ with Node 24.20.0 and HUGO_MODULE_PROXY=https://proxy.golang.org: passed after the guide moves. Hugo generated the site with one existing Docsy deprecation warning for .Language.LanguageDirection.
  • git diff --check: passed.
  • git diff --cached --check: passed before committing.
  • git diff --exit-code 71e40a5c^ -- docs/content/getting-started/_index.md: passed, confirming that the quickstart exactly matches its original content.
  • Checked generated HTML: all 15 overview, credential, and legacy aliases redirect to the intended canonical pages; the home page and credential index link to all four moved guides.
  • Verified that the three IRSA images render from their new paths and match their original bytes. The workload identity script was moved unchanged and its embedded code renders in the browser.
  • Checked the local preview sidebar: Cloud provider credentials and its four guides are nested under AWS and Azure, not Install Radius. The cloud section remains between Install Radius and Manage Radius.
  • Checked that the guides' next-step links lead to Recipe Pack management and old installation paths remain only as redirect aliases in the Markdown sources.

Reviewer walkthrough:

  1. From docs/, run npm ci if dependencies are not installed, then npm start with Node 24.
  2. Open the home page and confirm that Deploy to AWS and Azure follows What you can do with Radius, with AWS, Azure, and deployment-target cards.
  3. Expand AWS and Azure, then Cloud provider credentials, and open each identity guide. Confirm that the IRSA images and workload identity script render.
  4. Visit /installation/cloud-providers/ and confirm that it redirects to /aws-and-azure/. Visit /installation/cloud-credentials/ and an old guide URL such as /installation/cloud-providers/aws-irsa/; confirm that each redirects to its matching page under /aws-and-azure/cloud-providers/.
  5. Follow installation and management links to cloud setup. Read the Concepts changes for the distinction between Kubernetes deployment, cloud resource provisioning, and conditional application portability. Confirm that Getting Started is unchanged.

No AWS or Azure resources were deployed as part of this documentation change.

File change summary

Paths below are relative to docs/content/. Moved files retain their content except for the redirect metadata and next-step changes noted below.

File Summary of change
_index.md Name both clouds, add cloud deployment cards and canonical setup links, and qualify application portability.
aws-and-azure/_index.md Add the top-level deployment overview, identity links, portability boundaries, and overview redirects.
aws-and-azure/cloud-providers/_index.md Move the credential index from installation, remove its explicit URL override, and redirect /installation/cloud-credentials/ to it.
aws-and-azure/cloud-providers/aws-access-key/_index.md Move the guide, retain its legacy alias, add a redirect from its previous URL, and link next steps to Recipe Packs.
aws-and-azure/cloud-providers/aws-irsa/_index.md Move the guide, retain its legacy alias, add a redirect from its previous URL, and link next steps to Recipe Packs.
aws-and-azure/cloud-providers/aws-irsa/create-role.png Move the image unchanged with the guide.
aws-and-azure/cloud-providers/aws-irsa/get-role-arn.png Move the image unchanged with the guide.
aws-and-azure/cloud-providers/aws-irsa/select-trust-entity.png Move the image unchanged with the guide.
aws-and-azure/cloud-providers/azure-service-principal/_index.md Move the guide, retain its legacy alias, add a redirect from its previous URL, and link next steps to Recipe Packs.
aws-and-azure/cloud-providers/azure-workload-identity/_index.md Move the guide, retain its legacy alias, add a redirect from its previous URL, and link next steps to Recipe Packs.
aws-and-azure/cloud-providers/azure-workload-identity/snippets/install-radius-azwi.sh Move the embedded script unchanged with the guide.
concepts/_index.md Explain cross-cloud deployment with local Kubernetes, AWS RDS, and Azure PostgreSQL examples.
installation/_index.md Name EKS and AKS up front, keep the installation scope focused, and link to cloud setup.
installation/control-plane/_index.md Update credential links and direct readers to cloud setup after control-plane installation.
management/container-platforms/_index.md Update the credential prerequisite link to the new location.
management/environments/_index.md Update the credential guide link to the new location.

Add cloud deployment cards and a top-level AWS and Azure overview, preserve credential guide URLs, and clarify cross-cloud deployment requirements.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 2207d197-43e3-4de1-8249-98fabc591815
Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@github-actions

github-actions Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Static Web App Preview

Environment Deployment
pr2042 View workflow run

Deployed from commit 19e23787d1b0de5d191959d22514e8f371982835 via the publisher workflow.

Restore the Getting Started overview to its original content.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 2207d197-43e3-4de1-8249-98fabc591815
Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>
Move credential pages and assets into the cloud section, preserve old URLs with redirects, and update setup links and next steps.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 2207d197-43e3-4de1-8249-98fabc591815
Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>
@willtsai
willtsai marked this pull request as ready for review October 19, 2026 20:13
@willtsai
willtsai requested review from a team as code owners October 19, 2026 20:13
@Reshrahim

Copy link
Copy Markdown
Contributor

@willtsai - Thanks for making this change. I like the home page updates. I was wondering if we should have the standalone AWS and Azure section as "Deploy to AWS and Azure" section under Manage Radius and also cover cloud provider recipe packs in addition to credentials and environments. Install Radius can be just in cluster configurations and we can cross reference cloud provider credentials wherever required. Right now I feel its not complete in terms what it is required to deploy to Azure and AWS. wdyt?

This branch was successfully deployed

1 active deployment
latest — 19e23787 Deployed Oct 27, 2026 by willtsai via Dispatch Static Web App Preview #7101
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants