-
Notifications
You must be signed in to change notification settings - Fork 51
Revamp installation how-to guides #1568
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: edge
Are you sure you want to change the base?
Changes from 4 commits
86702e3
88d0754
e8db5c3
d255ee9
72c1f37
c62ebc2
ae57f81
1213832
34fc599
331bd17
04a6e07
aa93180
8e20c37
8e8c98f
c2ef714
709fd64
4568f52
3080c88
9c49e95
ff29c35
a9c692c
a9898b6
3f4eb44
79dc781
dd7cc19
3def165
bdd90ae
8665d59
93e9db0
1fecb53
cef9c42
659c127
4bcdf5a
1222f87
bf2c9a5
71624cc
b9a553f
2ad0802
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| type: docs | ||
| title: "Radius installation" | ||
| linkTitle: "Installation" | ||
| description: "Learn how to install and manage Radius" | ||
| weight: 100 | ||
| --- | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,145 @@ | ||||||||||||||||||||||
| --- | ||||||||||||||||||||||
| type: docs | ||||||||||||||||||||||
| title: "How-To: Install Radius on Kubernetes" | ||||||||||||||||||||||
| linkTitle: "Install" | ||||||||||||||||||||||
| description: "Learn how to install Radius on Kubernetes" | ||||||||||||||||||||||
| weight: 100 | ||||||||||||||||||||||
| categories: "How-To" | ||||||||||||||||||||||
| tags: ["Kubernetes"] | ||||||||||||||||||||||
|
Comment on lines
+3
to
+8
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||
| aliases: | ||||||||||||||||||||||
| - /guides/operations/kubernetes/kubernetes-install | ||||||||||||||||||||||
| --- | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Radius handles the deployment and management of environments, applications, and other resources with components that are installed into the Kubernetes cluster. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Prerequisites | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - A Kubernetes cluster with cluster-admin privileges for your user. | ||||||||||||||||||||||
| - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Step 1: Install the Radius CLI | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {{< read file= "/shared-content/installation/rad-cli/install-rad-cli.md" >}} | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The Radius CLI stores its configuration in a YAML file named `config.yaml` under the `rad` directory. This file contains [Workspaces]({{< ref "/guides/operations/workspaces/overview" >}}), which point to your cluster, your [Resource Group]({{< ref "/guides/operations/groups/overview" >}}), and your [Environment]({{< ref "/guides/deploy-apps/environments/overview" >}}). When the Radius CLI runs commands, it will use the configuration in the `config.yaml` file to determine which cluster, resource group, and environment to target and use. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| For more information, refer to the [`config.yaml` reference documentation]({{< ref "/reference/config" >}}). | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Step 2: Install Radius | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Install Radius using any of the following options: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {{< tabs `rad initialize` `rad install` `Using Helm` >}}{{% codetab %}} | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| [`rad initialize`](<{{< ref rad_initialize >}}>) command installs Radius and creates a pre-configured set of Resource Types, Recipes, and Environments. It is intended to get you started quickly | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ``` bash | ||||||||||||||||||||||
| rad initialize | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Select `Yes` to setup application in the current directory. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Example output: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
| Initializing Radius... | ||||||||||||||||||||||
| ✅ Install Radius {{< param version >}} | ||||||||||||||||||||||
| - Kubernetes cluster: k3d-k3s-default | ||||||||||||||||||||||
| - Kubernetes namespace: radius-system | ||||||||||||||||||||||
| ✅ Create new environment default | ||||||||||||||||||||||
| - Kubernetes namespace: default | ||||||||||||||||||||||
| - Recipe pack: local-dev | ||||||||||||||||||||||
| ✅ Scaffold application todolist | ||||||||||||||||||||||
| ✅ Update local configuration | ||||||||||||||||||||||
| Initialization complete! Have a RAD time 😎 | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| This command: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - Creates a namespace called the `radius-system` namespace and installs the Radius control plane components. | ||||||||||||||||||||||
| - Creates a default Resource group, Environment, and Workspace. | ||||||||||||||||||||||
| - Pre-configures the Environment with Recipes. | ||||||||||||||||||||||
| - Creates `app.bicep` with a sample `demo` container. | ||||||||||||||||||||||
| - Creates `bicepconfig.json` which contains the Bicep extensions for Radius resources. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {{% /codetab %}} | ||||||||||||||||||||||
| {{% codetab %}} | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| [`rad install kubernetes`]({{< ref rad_install_kubernetes >}}) installs the Radius control plane into the `radius-system` namespace. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| You can optionally use the `--set` flag to customize the installation with Helm configuration options([#helm-configuration-options](https://github.com/radius-project/radius/blob/main/deploy/Chart/values.yaml)): | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||
| # Install Radius | ||||||||||||||||||||||
| rad install kubernetes | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| # Install Radius with tracing and public endpoint override | ||||||||||||||||||||||
| rad install kubernetes --set global.zipkin.url=http://jaeger-collector.radius-monitoring.svc.cluster.local:9411/api/v2/spans,rp.publicEndpointOverride=localhost:8081 | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ### Use your own root certificate authority certificate | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Many enterprises leverage intermediate root certificate authorities (CAs) to enhance security and control over outgoing traffic originating from their employees' machines, particularly when using a firewall or proxy solution. For example, some enterprises may choose to issue CAs per org and control the traffic per org. In this setup, when Radius attempts to connect to an external endpoint, such as Azure or AWS, traffic is blocked by the firewall. You may optionally use`--set-file` when installing Radius to inject your root CA certificates into Radius: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||
| rad install kubernetes --set-file global.rootCA.cert=/etc/ssl/your-root-ca.crt | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
| {{% /codetab %}} | ||||||||||||||||||||||
| {{% codetab %}} | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Begin by adding the Radius Helm repository: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||
| helm repo add radius oci://ghcr.io/radius-project/helm-chart | ||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This gives me the following error: It may just be me or we may need to update the link.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same. The instructions on https://github.com/radius-project/radius/tree/main/deploy/Chart don't work either. |
||||||||||||||||||||||
| helm repo update | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Get all available versions: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||
| helm search repo radius --versions | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Install the specified chart: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||
| helm upgrade radius radius/radius --install --create-namespace --namespace radius-system --version {{< param chart_version >}} --wait --timeout 15m0s | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Check out the [Helm chart](https://github.com/radius-project/radius/blob/main/deploy/Chart) for more information. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {{% /codetab %}} | ||||||||||||||||||||||
| {{</tabs>}} | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Step 3: Verify the installation | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Verify if the pods are installed and running: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||
| kubectl get pods -n radius-system | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
| You should see output similar to: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
| NAME READY STATUS RESTARTS AGE | ||||||||||||||||||||||
| applications-rp 1/1 Running 0 1m | ||||||||||||||||||||||
| bicep-de 1/1 Running 0 1m | ||||||||||||||||||||||
| controller 1/1 Running 0 1m | ||||||||||||||||||||||
| dashboard 1/1 Running 0 1m | ||||||||||||||||||||||
| dynamic-rp 1/1 Running 0 1m | ||||||||||||||||||||||
| ucp 1/1 Running 0 1m | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Step 4: Install the Bicep and Terraform extensions for VS Code (optional) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Radius uses the Infrastructure as Code (IaC) language Bicep to define application resources and either Bicep or Terraform to deploy resources. Installing the Bicep and Terraform VS Code extensions provides syntax highlighting, auto-completion, and other useful features for these languages. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - [Install the Bicep extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - [Install the Terraform extension for VS Code](https://marketplace.visualstudio.com/items?itemName=HashiCorp.terraform) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Next steps | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - Refer to the [`rad install`]({{< ref rad_install >}}) command for installation options. | ||||||||||||||||||||||
| - Learn about [upgrading Radius]({{< ref "guides/installation/upgrade" >}}) | ||||||||||||||||||||||
| - Learn how to [rollback Radius]({{< ref "guides/installation/rollback" >}}) | ||||||||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.