Skip to content

Commit

Permalink
Update FAQ document (#681)
Browse files Browse the repository at this point in the history
* Update Radius FAQs

Signed-off-by: Will Tsai <[email protected]>

* add spellcheck excp

Signed-off-by: Will Tsai <[email protected]>

* fix page ref

Signed-off-by: Will Tsai <[email protected]>

* fix page ref

Signed-off-by: Will Tsai <[email protected]>

* commit Aaron's suggestion

Co-authored-by: Aaron Crawfis <[email protected]>

* address feedback re:Terraform

Signed-off-by: Will Tsai <[email protected]>

* address feedback re: AWS and GCP support

Signed-off-by: Will Tsai <[email protected]>

---------

Signed-off-by: Will Tsai <[email protected]>
Co-authored-by: Aaron Crawfis <[email protected]>
  • Loading branch information
willtsai and AaronCrawfis authored Aug 16, 2023
1 parent 2dcd1d5 commit 705ff07
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 11 deletions.
3 changes: 3 additions & 0 deletions .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -433,3 +433,6 @@ rabbitMQ
azureCache
listKeys
primaryKey
GCP
Fargate
untyped
56 changes: 45 additions & 11 deletions docs/content/reference/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,31 @@ description: "Commonly asked questions about best practices"
weight: 999
---

## Applications
## General

### Is Kubernetes required to use Radius?

Currently yes. Today Kubernetes is the only hosting platform for Radius. We are working on additional hosting platforms and container runtimes, so stay tuned for updates.

### Can I incrementally adopt, or "try out" Radius?

**Yes**. You can use the [Bicep `existing` keyword](https://docs.microsoft.com/azure/azure-resource-manager/bicep/resource-declaration?tabs=azure-powershell#existing-resources) to add a Radius application to previously deployed resources. Learn more in the [Radius authoring guide]({{< ref author-apps >}}). In the future we will also support other experiences in Bicep and the Azure portal for adding Radius to existing resources.
Yes. Teams can incrementally adopt the Radius platform as they write new applications or add existing applications. Direct connections allow apps with existing platform dependencies (such as Azure and AWS) move to Radius without any code rewrites. Dapr support allows existing Dapr apps to be brought to Radius without any code rewrites as well. Portability and automation can be layered on with Radius portable resources and Recipes. In the future we will add Kubernetes YAML support which enables developers to wrap their existing Kubernetes YAML objects in a Radius container so that they may bring their existing deployments and pods as-is into a Radius application.

### Do I have to self-host Radius? Is there a managed service for Radius?

Open-source Radius requires that you self-host and run your own Radius instance in your Kubernetes cluster. In the future, we hope for providers to include Radius as a part of their managed service offerings. Stay tuned for updates.

### What languages does Radius support?

For core application source code, Radius supports any language as long as it is containerized.

For Radius application and environment definitions, Radius currently only supports Bicep. Terraform is on our backlog and is being investigated. Stay tuned for updates.

## Environments

### Can I connect to an existing environment?

**Yes**. When you initialize an environment via `rad init`, you can provide an existing Kubernetes cluster context. Radius will update your `config.yaml` file with the appropriate values.
Yes. When you initialize an environment via `rad init`, you can provide an existing Kubernetes cluster context. Radius will update your `config.yaml` file with the appropriate values.

### When would/should I use more than one environment?

Expand All @@ -27,6 +41,18 @@ Users can employ multiple environments for isolation and organization, for examp

## Recipes

### What resources can Recipes deploy?

Recipes support any resource that can be modeled in Bicep. Terraform support is on our backlog and is being investigated. Stay tuned for updates.

### What resources do Recipes support?

Recipes currently support the set of Radius portable resources: Redis, Mongo, RabbitMQ, SQL, Dapr State Stores, Dapr Secret Stores, Dapr Pub/Sub, the untyped extender resource, and more to come in the future. See the [Radius resource schema]({{< ref resource-schema >}}) for more details. Additional support for other resources (Azure, AWS, etc.) will come in a future release. Stay tuned for updates.

### Do developers need contributor or owner access to a cloud provider (Azure subscription, AWS account, etc.) to leverage Radius Recipes?

No. Recipes are deployed on-behalf-of the Radius environment so developers do not need any write access to an Azure subscription, resource group, or AWS account. This allows a least-privilege access model to cloud resources and for IT operators to only allow approved IaC templates to be deployed to their cloud environments.

### Why do I need to manually output a Kubernetes UCP ID as part of my Bicep Recipe?

The Bicep deployment engine currently does not output Kubernetes resource (UCP) IDs upon completion, meaning Recipes cannot automatically link a Recipe-enabled resource to the underlying infrastructure. This also means Kubernetes resources are not automatically cleaned up when a Recipe-enabled resource is deleted.
Expand Down Expand Up @@ -56,22 +82,30 @@ output values object = {

### Can one bicep file represent more than one application?

**Yes**. You can have multiple application resources defined in one file.
Yes. You can have multiple application resources defined in one file.

### Can a bicep file represent something other than applications?

**Yes**. Bicep files can contain both Radius resources and Azure resources. Everything in a Bicep file becomes an ARM deployment.
Yes. Bicep files can contain both Radius resources and Azure resources. Everything in a Bicep file becomes an ARM deployment.

## Resources

### Can I modify a resource after it’s been deployed?
### Can I modify a resource after it's been deployed?

Yes. You will need to modify the resource definition in your .bicep file's application definition and re-deploy the application.

### 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.

### What Azure services does Radius support?

**Yes**. You will need to modify the resource definition in your .bicep file’s application definition and re-deploy the application.
Radius applications can include any non-compute Azure service, with support for direct connections and managed identities. Compute services (Web Apps, Container Apps, App Service, Functions, Logic Apps, and others) will be added in a future release.

### Is Azure App Service supported?
### Does Radius support Google Cloud Platform (GCP)?

**Not yet**. For now we're focusing on containers, but in the future we plan on expanding to other Azure services such as App Service, Functions, Logic Apps, and others. Stay tuned for more information.
Not yet, but it is on the backlog. Stay tuned for updates.

### Does Radius support all Azure resources?
### Does Radius support Dapr?

**Yes**. You can use any Azure resource type by modeling it in Bicep outside the `Applications.Core/applications` resource and defining a connection to the resource from a `Applications.Core/containers`. See the [connections page]({{< ref application-graph>}}) for more details.
Yes. Radius has first-class support for Dapr building blocks such as state stores, secret stores, and pub/sub brokers. Developers can add Dapr resources to their applications and operators can define Recipes that deploy and manage the underlying infrastructure.

0 comments on commit 705ff07

Please sign in to comment.