Revamp installation how-to guides by Reshrahim · Pull Request #1568 · radius-project/docs

Reshrahim · 2025-10-23T21:14:54Z

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

Read the contribution guide
Commands include options for Linux, MacOS, and Windows within codetabs
New file and folder names are globally unique
Page references use shortcodes instead of markdown or URL links
Images use HTML style and have alternative text
Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Issue reference

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

docs/content/guides/installation/_index.md

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

docs/content/guides/installation/install/index.md

ytimocin · 2025-11-05T21:30:59Z

docs/content/guides/installation/_index.md

+
+  - **Dashboard** – The Backstage based UI for managing Radius resources. You can disable it during installation.
+
+- **Bicep extensions** – Radius packages Resource Type definitions as Bicep extensions stored in OCI registries or a file share. To use the Resource Types in your application, a workstation or CI runner must have config file (`bicepconfig.json`) that points to the extensions. Checkout the [how-to generate Bicep extensions](TODO) for more information.


@willdavsmith may have more information here

docs/content/guides/installation/_index.md

ytimocin · 2025-11-05T21:33:16Z

docs/content/reference/helminstallation.md

+---
+type: docs
+title: "Helm Installation Options"
+linkTitle: "Helm Installation"


Do we need Helm Upgrade page?

Not a separate Helm Upgrade page but will be part of the upgrade page under Installation.

This is a reference page for Helm configuration options. Do we have specific upgrade related options?

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>

Updated prerequisites for Azure Container Instances guide to reflect changes in Radius installation and Kubernetes requirements. Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

zachcasper

Only reviewed through "Deploy to Air-gapped environments". Will review again when complete.

docs/content/guides/installation/_index.md

zachcasper · 2025-12-01T21:31:10Z

docs/content/guides/installation/_index.md

+
+- **Observability back ends** – Prometheus and Zipkin/Jaeger endpoints collect metrics and traces using the chart settings. Checkout the [Observability guide](TODO) for more information.
+
+## Installation Requirements


The only requirements I see here are:

Kubernetes 1.23.8 and higher

cluster-admin permissions in order to install Radius

zachcasper · 2025-12-01T21:33:51Z

docs/content/guides/installation/install/index.md

+title: "How-To: Install Radius on Kubernetes"
+linkTitle: "Install"
+description: "Learn how to install Radius on Kubernetes"
+weight: 100
+categories: "How-To"
+tags: ["Kubernetes"]


Suggested change

title: "How-To: Install Radius on Kubernetes"

linkTitle: "Install"

description: "Learn how to install Radius on Kubernetes"

weight: 100

categories: "How-To"

tags: ["Kubernetes"]

title: "How-To: Install Radius"

linkTitle: "Install"

description: "Learn how to install Radius on Kubernetes"

weight: 100

zachcasper · 2025-12-01T22:24:06Z

docs/content/guides/installation/install/index.md

+#### Deploy to Air-gapped environments
+
+Radius pulls container images for control plane services from the GitHub Container Registry (ghcr.io). In environments with strict security controls or no internet access (air‑gapped), mirror the required images to an internal registry and configure Radius to use that registry.
+
+Example of mirroring images (requires access to both registries):
+


Suggested change

#### Deploy to Air-gapped environments

Radius pulls container images for control plane services from the GitHub Container Registry (ghcr.io). In environments with strict security controls or no internet access (air‑gapped), mirror the required images to an internal registry and configure Radius to use that registry.

Example of mirroring images (requires access to both registries):

#### Installing Radius in air-gapped environments

The default Radius installation references container images stored in GitHub Container Registry (ghcr.io). In environments without direct access to ghci.io, the container images must be manually pulled and stored in a local OCI registry. For example, the script below pulls from ghcr.io and pushes the images to an internal OCI registry:

zachcasper · 2025-12-01T22:25:50Z

docs/content/guides/installation/install/index.md

+
+SOURCE_REGISTRY="ghcr.io/radius-project"
+TARGET_REGISTRY="myregistry.azurecr.io"
+VERSION="latest"  # or specific version like "0.48"


Suggested change

VERSION="latest" # or specific version like "0.48"

VERSION="0.53" # or other specific version

zachcasper · 2025-12-01T22:26:28Z

docs/content/guides/installation/install/index.md

+)
+
+SOURCE_REGISTRY="ghcr.io/radius-project"
+TARGET_REGISTRY="myregistry.azurecr.io"


Suggested change

TARGET_REGISTRY="myregistry.azurecr.io"

TARGET_REGISTRY="<internal-oci-registry-hostname>"

zachcasper · 2025-12-01T22:30:20Z

docs/content/guides/installation/install/index.md

+Then install Radius configured to pull images from your private registry, and supply image pull secrets if authentication is required.
+
+```bash
+rad install kubernetes \
+  --set global.imageRegistry=myregistry.azurecr.io \
+  --set global.imageTag={{ .Chart.AppVersion }} \
+  --set global.imagePullSecrets[0].name=myregistry-secret


Suggested change

Then install Radius configured to pull images from your private registry, and supply image pull secrets if authentication is required.

```bash

rad install kubernetes \

--set global.imageRegistry=myregistry.azurecr.io \

--set global.imageTag={{ .Chart.AppVersion }} \

--set global.imagePullSecrets[0].name=myregistry-secret

Then use the `global.imageRegistry` and `global.imageTag` installation options when installing Radius.

```bash

rad install kubernetes \

--set global.imageRegistry=<internal-oci-registry-hostname> \

--set global.imageTag=0.53

zachcasper · 2025-12-01T22:32:45Z

docs/content/guides/installation/install/index.md

+  --set global.imagePullSecrets[0].name=myregistry-secret
+```
+
+When using a custom registry, images are pulled directly from <registry>/<image-name>:<tag> format. For example, with myregistry.azurecr.io, the controller image will be pulled from myregistry.azurecr.io/controller:latest.


Suggested change

When using a custom registry, images are pulled directly from <registry>/<image-name>:<tag> format. For example, with myregistry.azurecr.io, the controller image will be pulled from myregistry.azurecr.io/controller:latest.

Replace this with instructions on using --set global.imagePullSecrets[0].name=myregistry-secret. But I don't know why this would be required. I would expect Kubernetes to already be configured for this https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/

Co-authored-by: Zach Casper <zcasper@gmail.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>

github-actions · 2025-12-03T18:57:43Z

❌ Spellcheck Failed

There are spelling errors in your PR. Visit the workflow output to see what words are failing.

Adding new words

If you are adding a new custom word refer to the docs guide

Reshrahim added 2 commits October 23, 2025 16:57

Installation how-to

86702e3

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Revert install command

88d0754

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim requested review from a team as code owners October 23, 2025 21:14

Reshrahim had a problem deploying to latest October 23, 2025 21:14 — with GitHub Actions Failure

Reshrahim changed the base branch from v0.52 to edge October 23, 2025 21:15

Revert install command

e8db5c3

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim had a problem deploying to edge October 23, 2025 21:16 — with GitHub Actions Failure

Fix build

d255ee9

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim temporarily deployed to edge October 23, 2025 21:40 — with GitHub Actions Inactive

Reshrahim temporarily deployed to edge October 23, 2025 21:41 — with GitHub Actions Inactive

Reshrahim commented Oct 23, 2025

View reviewed changes

docs/content/guides/installation/_index.md Outdated Show resolved Hide resolved

Merge branch 'edge' into re/installation

72c1f37

Reshrahim temporarily deployed to edge October 23, 2025 21:46 — with GitHub Actions Inactive

Update uninstall guides

c62ebc2

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim temporarily deployed to edge October 24, 2025 13:27 — with GitHub Actions Inactive

Reshrahim temporarily deployed to edge October 24, 2025 13:28 — with GitHub Actions Inactive

Reshrahim added 3 commits October 24, 2025 16:16

Updates

ae57f81

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Rebase

1213832

Rebase

34fc599

Reshrahim temporarily deployed to edge October 27, 2025 15:26 — with GitHub Actions Inactive

Update installation

331bd17

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim had a problem deploying to edge October 27, 2025 21:56 — with GitHub Actions Failure

Shortcode

04a6e07

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim had a problem deploying to edge October 27, 2025 22:18 — with GitHub Actions Failure

Shortcode

aa93180

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim had a problem deploying to edge October 27, 2025 22:23 — with GitHub Actions Failure

Upd link

8e20c37

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim temporarily deployed to edge November 4, 2025 18:18 — with GitHub Actions Inactive

Updates

93e9db0

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim temporarily deployed to edge November 4, 2025 19:44 — with GitHub Actions Inactive

Reshrahim temporarily deployed to edge November 4, 2025 19:45 — with GitHub Actions Inactive

Resolve conflicts

1fecb53

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim temporarily deployed to edge November 4, 2025 20:00 — with GitHub Actions Inactive

Reshrahim temporarily deployed to edge November 4, 2025 20:01 — with GitHub Actions Inactive

ytimocin reviewed Nov 5, 2025

View reviewed changes

Address feedback-1)

cef9c42

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim temporarily deployed to edge November 7, 2025 19:18 — with GitHub Actions Inactive

Merge branch 'edge' into re/installation

659c127

Reshrahim temporarily deployed to edge November 7, 2025 19:18 — with GitHub Actions Inactive

Reshrahim temporarily deployed to edge November 7, 2025 19:19 — with GitHub Actions Inactive

Merge branch 'edge' into re/installation

4bcdf5a

Reshrahim temporarily deployed to edge November 18, 2025 15:07 — with GitHub Actions Inactive

Reshrahim temporarily deployed to edge November 18, 2025 15:08 — with GitHub Actions Inactive

Reshrahim and others added 2 commits November 21, 2025 14:45

Github theme

1222f87

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Merge branch 'edge' into re/installation

bf2c9a5

Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>

Reshrahim had a problem deploying to edge November 21, 2025 19:47 — with GitHub Actions Failure

Revise prerequisites for Azure Container Instances guide

71624cc

Updated prerequisites for Azure Container Instances guide to reflect changes in Radius installation and Kubernetes requirements. Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>

Reshrahim temporarily deployed to edge November 21, 2025 19:51 — with GitHub Actions Inactive

Github theme

b9a553f

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim temporarily deployed to edge November 21, 2025 19:53 — with GitHub Actions Inactive

Reshrahim temporarily deployed to edge November 21, 2025 19:54 — with GitHub Actions Inactive

zachcasper requested changes Dec 1, 2025

View reviewed changes

Apply suggestions from code review

2ad0802

Co-authored-by: Zach Casper <zcasper@gmail.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>

Reshrahim temporarily deployed to edge December 3, 2025 18:55 — with GitHub Actions Inactive

Reshrahim temporarily deployed to edge December 3, 2025 18:56 — with GitHub Actions Inactive


		- Dashboard – The Backstage based UI for managing Radius resources. You can disable it during installation.

		- Bicep extensions – Radius packages Resource Type definitions as Bicep extensions stored in OCI registries or a file share. To use the Resource Types in your application, a workstation or CI runner must have config file (`bicepconfig.json`) that points to the extensions. Checkout the [how-to generate Bicep extensions](TODO) for more information.


		- Observability back ends – Prometheus and Zipkin/Jaeger endpoints collect metrics and traces using the chart settings. Checkout the [Observability guide](TODO) for more information.

		## Installation Requirements

	VERSION="latest" # or specific version like "0.48"
	VERSION="0.53" # or other specific version

	TARGET_REGISTRY="myregistry.azurecr.io"
	TARGET_REGISTRY="<internal-oci-registry-hostname>"

Conversation

Reshrahim commented Oct 23, 2025

Description

Issue reference

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reshrahim Nov 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zachcasper left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 3, 2025

❌ Spellcheck Failed

Adding new words

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Reshrahim Nov 7, 2025 •

edited

Loading