Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
86702e3
Installation how-to
Reshrahim Oct 23, 2025
88d0754
Revert install command
Reshrahim Oct 23, 2025
e8db5c3
Revert install command
Reshrahim Oct 23, 2025
d255ee9
Fix build
Reshrahim Oct 23, 2025
72c1f37
Merge branch 'edge' into re/installation
Reshrahim Oct 23, 2025
c62ebc2
Update uninstall guides
Reshrahim Oct 24, 2025
ae57f81
Updates
Reshrahim Oct 24, 2025
1213832
Rebase
Reshrahim Oct 27, 2025
34fc599
Rebase
Reshrahim Oct 27, 2025
331bd17
Update installation
Reshrahim Oct 27, 2025
04a6e07
Shortcode
Reshrahim Oct 27, 2025
aa93180
Shortcode
Reshrahim Oct 27, 2025
8e20c37
Upd link
Reshrahim Oct 27, 2025
8e8c98f
Upd shortcode
Reshrahim Oct 27, 2025
c2ef714
Updates
Reshrahim Oct 28, 2025
709fd64
Merge uninstall into install
Reshrahim Oct 28, 2025
4568f52
UnMerge uninstall from install
Reshrahim Oct 28, 2025
3080c88
Remove uninstall merge updates
Reshrahim Oct 28, 2025
9c49e95
Revamp installation
Reshrahim Oct 29, 2025
ff29c35
Installation guide updates
Reshrahim Oct 30, 2025
a9c692c
FIX LINK
Reshrahim Oct 30, 2025
a9898b6
Fix style
Reshrahim Oct 30, 2025
3f4eb44
Fix style
Reshrahim Oct 30, 2025
79dc781
Updates
Reshrahim Oct 30, 2025
dd7cc19
Updates to rollback and upgrade
Reshrahim Oct 30, 2025
3def165
Add upgrade docs
Reshrahim Nov 4, 2025
bdd90ae
Merge conflict
Reshrahim Nov 4, 2025
8665d59
Updates
Reshrahim Nov 4, 2025
93e9db0
Updates
Reshrahim Nov 4, 2025
1fecb53
Resolve conflicts
Reshrahim Nov 4, 2025
cef9c42
Address feedback-1)
Reshrahim Nov 7, 2025
659c127
Merge branch 'edge' into re/installation
Reshrahim Nov 7, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updates
Signed-off-by: Reshma Abdul Rahim <[email protected]>
  • Loading branch information
Reshrahim committed Oct 30, 2025
commit 79dc7811dea2fa3278803a96c8aad483d889aa7c
39 changes: 9 additions & 30 deletions docs/content/guides/installation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Radius installations spans across your Kubernetes cluster, developer workstation

- **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]() for more information.
- **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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@willdavsmith may have more information here


### External tools and services Radius interacts with

Expand All @@ -39,30 +39,12 @@ Building on the technical architecture overview, Radius runs on Kubernetes and e
{{< tabs AKS EKS k3d kind>}}
{{% codetab %}}

To learn how to setup a cluster visit the [Azure docs](https://docs.microsoft.com/azure/aks/learn/quick-kubernetes-deploy-portal?tabs=azure-cli).

Note that [AKS-managed AAD](https://docs.microsoft.com/en-us/azure/aks/managed-aad) is not supported currently.

To create a new AKS cluster and retrieve its kubecontext, you can run the following commands:

```bash
az aks create --subscription mySubscription --resource-group myResourceGroup --name myAKSCluster --node-count 1
az aks get-credentials --subscription mySubscription --resource-group myResourceGroup --name myAKSCluster
```

Once deployed and your kubectl context has been set as your default, you can run install the control plane following the [Installation how-to]({{< ref "/guides/installation/install" >}})
Visit the [Azure docs](https://docs.microsoft.com/azure/aks/learn/quick-kubernetes-deploy-portal?tabs=azure-cli) to set up an AKS cluster.

{{% /codetab %}}
{{% codetab %}}

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that you can use to run Kubernetes on AWS. Learn how to set up an EKS cluster on the [AWS docs](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html).

```bash
eksctl create cluster --name my-cluster --region region-code
```

Once deployed and your kubectl context has been set as your default, you can install the control plane following the [Installation how-to]({{< ref "/guides/installation/install" >}}).

Visit [AWS docs](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html) to set up an EKS cluster.
{{% /codetab %}}
{{% codetab %}}

Expand All @@ -74,19 +56,17 @@ First, ensure that memory resource is 8GB or more in `Resource` setting of `Pref
softwareupdate --install-rosetta --agree-to-license
```

Use the following command to create a new cluster. and install the Radius control plane, along with a new environment:

- The first parameter adds a port mapping which routes traffic from the local machine into the cluster.
- The second parameter disables [`traefik`](https://k3d.io/v5.1.0/usage/k3s/#traefik) pods because Radius provides an ingress controller.
- The third parameter disables the [k3d internal load balancer](https://k3d.io/v5.1.0/usage/k3s/#servicelb-klipper-lb).

The `rad install` command is configured to route localhost traffic on port 8081 into the cluster.
Use the following command to create a new cluster and install the Radius control plane

```bash
k3d cluster create -p "8081:80@loadbalancer" --k3s-arg "--disable=traefik@server:*" --k3s-arg "--disable=servicelb@server:*"
```

Next, install the Radius control plane, along with a new environment. The `rad install` command below adds a parameter to override the default public endpoint so that Radius knows that traffic from the local machine will enter the pod on port 8081:
- The first parameter adds a port mapping which routes traffic from the local machine into the cluster.
- The second parameter disables [`traefik`](https://k3d.io/v5.1.0/usage/k3s/#traefik) pods because Radius provides an ingress controller.
- The third parameter disables the [k3d internal load balancer](https://k3d.io/v5.1.0/usage/k3s/#servicelb-klipper-lb).

Next install the Radius control plane with an override of the default public endpoint:

```bash
rad install kubernetes --set rp.publicEndpointOverride=localhost:8081
Expand Down Expand Up @@ -124,7 +104,6 @@ Then, create a kind cluster with this config and initialize your Radius Environm
# Create the kind cluster
kind create cluster --config kind-config.yaml
```
Checkout the [Installation how-to]({{< ref "/guides/installation/install" >}}) to get started.

{{% /codetab %}}
{{< /tabs >}}
Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/installation/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ When enabled, expose it via Contour or your ingress. In locked-down clusters you
- **Existing Radius release detected** – Rerun the installer with `--reinstall` or uninstall the existing release before retrying, otherwise Helm skips the upgrade.
- **Helm reports missing permissions** – Verify the kube context and ensure the account has cluster-admin rights (`kubectl auth can-i create crd`).
- **Contour chart download fails** – Provide a local chart via `--contour-chart` if the cluster cannot reach the Bitnami registry.
- **Pods stuck after install** – Inspect with `kubectl describe pod -n radius-system` to identify image pull or workload-identity issues.
- **Pods stuck after install** – Inspect with `kubectl describe pod -n radius-system` to identify image pull issues.

## Next steps

Expand Down
Loading