Skip to content
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

Follow consistent casing across docs #826

Merged
merged 16 commits into from
Oct 11, 2023
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
2 changes: 1 addition & 1 deletion docs/content/concepts/api-concept/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The following tables shows some examples of resource ids from different resource

#### Resource manager: Radius

This example shows a Radius application named `my-app` in the `my-group` resource group, running on the local cluster:
This example shows a Radius Application named `my-app` in the `my-group` resource group, running on the local cluster:

| Key | Example |
| ------------------ | ------------------------------------------------------------------------------------ |
Expand Down
10 changes: 5 additions & 5 deletions docs/content/concepts/application-graph/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,29 @@ weight: 200
toc_hide: true
---

## Radius applications
## Radius Applications

Radius offers an [application resource]({{< ref "guides/author-apps/application" >}}) which teams can use to define and deploy their entire application, including all of the compute, relationships, and infrastructure that make up the application. Since the graph of relationships between deployed resources is much more descriptive than a basic list of resources, the Radius application graph can automate complex deployment tasks and enable rich visualization experiences.
Radius offers an [application resource]({{< ref "guides/author-apps/application" >}}) which teams can use to define and deploy their entire application, including all of the compute, relationships, and infrastructure that make up the application. Since the graph of relationships between deployed resources is much more descriptive than a basic list of resources, the Radius Application graph can automate complex deployment tasks and enable rich visualization experiences.

<img src="application.png" alt="A diagram showing an application and all it's resources" width=400px >

## Graphs are better than lists

Within an application deployed with Radius, developers can express both the resources (_containers, databases, message queues, etc._), as well as all the relationships between them. This forms the Radius application graph. This graph is powerful because it allows Radius to understand the relationships between resources, simplifying the [deployment]({{< ref "/guides/deploy-apps" >}}) and [configuration]({{< ref "application" >}}) of your application. Plus, it allows you to visualize your application in a way that is more intuitive than a list of resources.
Within an application deployed with Radius, developers can express both the resources (_containers, databases, message queues, etc._), as well as all the relationships between them. This forms the Radius Application graph. This graph is powerful because it allows Radius to understand the relationships between resources, simplifying the [deployment]({{< ref "/guides/deploy-apps" >}}) and [configuration]({{< ref "application" >}}) of your application. Plus, it allows you to visualize your application in a way that is more intuitive than a list of resources.

<img src="list-to-graph.png" alt="A diagram showing the move from a set of infrastructure lists to a graph of resources" width=600px >

## Self-documenting applications

The Radius application graph also allows your application to be self-documenting, where developers and operators can query and reason about the same application definition. Instead of multiple views of logs, infrastructure, and code, Radius provides a single source of truth for your application.
The Radius Application graph also allows your application to be self-documenting, where developers and operators can query and reason about the same application definition. Instead of multiple views of logs, infrastructure, and code, Radius provides a single source of truth for your application.

<img src="dashboard.png" alt="A mockup of a dashboard UI showing an application, its resources, and its connections" width=700px >

> **Note:** A Radius dashboard is still on the roadmap, but in the meantime you can use the [Radius API]({{< ref api-concept >}}) to build your own visual experiences today.

## Mine the app graph API

The Radius application graph is also exposed as an API, allowing you to build your own visualizations, workflows, and more on top of Radius. Learn more in the [API docs]({{< ref api-concept >}}).
The Radius Application graph is also exposed as an API, allowing you to build your own visualizations, workflows, and more on top of Radius. Learn more in the [API docs]({{< ref api-concept >}}).

For example, I can get the status of my `frontend` container, and get its definition and its connections to other resources:

Expand Down
4 changes: 2 additions & 2 deletions docs/content/concepts/architecture-concept/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ When listing applications using the `rad` CLI:
{{% /codetab %}}

{{% codetab %}}
When using Bicep to author and deploy Radius applications:
When using Bicep to author and deploy Radius Applications:

1. The client compiles the Bicep file to an ARM-JSON template and submits a request for processing as a `Bicep.Deployments/deployments` resource.
2. UCP receives the request for the `Bicep.Deployments/deployments` Create operation and looks up the internal address for the `Bicep.Deployments` resource provider.
Expand All @@ -153,7 +153,7 @@ When using Bicep to author and deploy Radius applications:
{{% /codetab %}}

{{% codetab %}}
When using the `tf` CLI to deploy a Radius application using Terraform:
When using the `tf` CLI to deploy a Radius Application using Terraform:

1. Terraform reads the configuration, loads credentials, parses the file, and instantiates its providers. For each resource in the file:
a. Terraform asks the appropriate provider to Create or Update the resource.
Expand Down
20 changes: 10 additions & 10 deletions docs/content/concepts/environments-concept/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
type: docs
title: "Radius environments"
title: "Radius Environments"
linkTitle: "Environments"
description: "Learn about Radius Environments"
weight: 300
Expand All @@ -10,31 +10,31 @@ toc_hide: true

## Introduction

Radius environments are a prepared landing zone for applications. They contain a prepared pool of compute, networking, and shared resources. Radius applications deployed to that environment "bind" to that infrastructure. Configuration on the environment allow for operators to enforce organizational requirements and best practices for app teams.
Radius Environments are a prepared landing zone for applications. They contain a prepared pool of compute, networking, and shared resources. s deployed to that environment "bind" to that infrastructure. Configuration on the environment allow for operators to enforce organizational requirements and best practices for app teams.

Environments provide a grouping structure for applications and the resources they share. For example, an org might choose to setup separate Radius environments for staging and production. When appropriate, multiple applications can be deployed into the same environment.
Environments provide a grouping structure for applications and the resources they share. For example, an org might choose to setup separate Radius Environments for staging and production. When appropriate, multiple applications can be deployed into the same environment.

<img src="env-with-apps-example.png" alt="Diagram of multiple Radius environments deployed to Azure. One environment contains 1 app, the other environment contains multiple apps." width="350px" />
<img src="env-with-apps-example.png" alt="Diagram of multiple Radius Environments deployed to Azure. One environment contains 1 app, the other environment contains multiple apps." width="350px" />

## Concerns that environments manage

### Separation of concerns

In many small to medium-sized organizations, a full stack developer might write application code, author the Radius app definition, and create the Radius environment. In larger orgs, there may be separate teams of central operations and developers, where the central teams build environment templates which development teams leverage and deploy to. The separation of an app from an environment makes a separation of concerns possible.
In many small to medium-sized organizations, a full stack developer might write application code, author the Radius app definition, and create the Radius Environment. In larger orgs, there may be separate teams of central operations and developers, where the central teams build environment templates which development teams leverage and deploy to. The separation of an app from an environment makes a separation of concerns possible.

With Radius environments, central operations and IT teams can define and share environments with development teams for them to deploy applications into. Ops teams can focus on configuring the compute, dependencies, networking, and other infrastructure concerns through [Recipes]({{< ref "guides/recipes/overview">}}), while developers focus on the business and application concerns. This allows each team to focus on what matters most to them, without needing to become experts in every aspect of the infrastructure and application.
With Radius Environments, central operations and IT teams can define and share environments with development teams for them to deploy applications into. Ops teams can focus on configuring the compute, dependencies, networking, and other infrastructure concerns through [Recipes]({{< ref "guides/recipes/overview">}}), while developers focus on the business and application concerns. This allows each team to focus on what matters most to them, without needing to become experts in every aspect of the infrastructure and application.

### Developer productivity

Once an environment template is defined, developers can get up and running with a prepared development, pre-production, or production environment in minutes. No more waiting for manual provisioning, configuration or inter-team coordination. Simply use the [Recipes]({{< ref "guides/recipes/overview" >}}) linked to your Radius environment and deploy your application.
Once an environment template is defined, developers can get up and running with a prepared development, pre-production, or production environment in minutes. No more waiting for manual provisioning, configuration or inter-team coordination. Simply use the [Recipes]({{< ref "guides/recipes/overview" >}}) linked to your Radius Environment and deploy your application.

### Replication and consistency

When an application team needs to scale an application to additional regions or instances, environments can be "stamped out" in minutes and ready for app deployments. Integrations with CI/CD systems such as GitHub Actions allow this process to be automated and repeatable.

### Organization best-practices

Organizational best-practices such as cost-optimization, resource sharing, and logging can all be codified and enforced with a Radius environment.
Organizational best-practices such as cost-optimization, resource sharing, and logging can all be codified and enforced with a Radius Environment.

## Environment features

Expand All @@ -56,8 +56,8 @@ In this example there are two teams within an organization: a central operations
A typical workflow for this team structure would look like:

1. The ops team initializes a new environment, configured with a compute runtime setup with networking, identity, diagnostics, and other configuration that matches their org's requirements.
1. The developer authors a Radius application template, including containers for their services, portable resources for their infrastructure, and routes/gateways for their networking.
1. The developer deploys the app template to the Radius environment
1. The developer authors a Radius Application template, including containers for their services, portable resources for their infrastructure, and routes/gateways for their networking.
1. The developer deploys the app template to the Radius Environment
- The app's containers automatically run on the container runtime
- The resource automatically configures security best practices and injects connection information into the consuming container

Expand Down
6 changes: 3 additions & 3 deletions docs/content/concepts/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ These new resources form the [**Radius app model**]({{< ref application-graph>}}

The result is no longer just a flat list of resources - it's a fully codified abstraction of how the services and infrastructure relate to each other:

<img alt="Diagram showing Radius application in the Azure portal" src="ui-mockup-basic.png" width="700px" /><br />
<img alt="Diagram showing Radius Application in the Azure portal" src="ui-mockup-basic.png" width="700px" /><br />

### Drastically reduce infra ops time

[App environments]({{< ref environments-concept >}}) are landing zones for applications. They are the place where you can deploy, manage, and scale your apps.

<img alt="Diagram showing Radius environments" src="environments.png" width="600px" />
<img alt="Diagram showing Radius Environments" src="environments.png" width="600px" />

Environments allow you to:

Expand Down Expand Up @@ -88,4 +88,4 @@ As teams onboard to Radius and begin deploying across platforms, the tooling and

Now that you have an overview of Radius, learn more about the Radius app model:

{{< button text="Learn about the Radius application model" page="application-graph" size="btn-lg" color="success" >}}
{{< button text="Learn about the Radius Application model" page="application-graph" size="btn-lg" color="success" >}}
2 changes: 1 addition & 1 deletion docs/content/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Press <kbd>CTRL</kbd>+ <kbd>C</kbd> when you are finished with the website.

## 7. View the application connections

Radius connections are more than just environment variables and configuration. You can also access the "application graph" and understand the connections within your application with the following command:
Radius Connections are more than just environment variables and configuration. You can also access the "application graph" and understand the connections within your application with the following command:

```bash
rad app connections
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Import the set of Radius resources (Applications.*) into Bicep
import radius as radius

@description('The app ID of your Radius application. Set automatically by the rad CLI.')
@description('The app ID of your Radius Application. Set automatically by the rad CLI.')
param application string

//CONNECTION
Expand All @@ -27,7 +27,7 @@ resource demo 'Applications.Core/containers@2023-10-01-preview' = {
//CONNECTION

//REDIS
@description('The environment ID of your Radius application. Set automatically by the rad CLI.')
@description('The environment ID of your Radius Application. Set automatically by the rad CLI.')
param environment string

resource db 'Applications.Datastores/redisCaches@2023-10-01-preview' = {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Import the set of Radius resources (Applications.*) into Bicep
import radius as radius

@description('The app ID of your Radius application. Set automatically by the rad CLI.')
@description('The app ID of your Radius Application. Set automatically by the rad CLI.')
param application string

resource demo 'Applications.Core/containers@2023-10-01-preview' = {
Expand Down
2 changes: 1 addition & 1 deletion docs/content/getting-started/snippets/app.bicep
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Import the set of Radius resources (Applications.*) into Bicep
import radius as radius

@description('The app ID of your Radius application. Set automatically by the rad CLI.')
@description('The app ID of your Radius Application. Set automatically by the rad CLI.')
param application string

resource demo 'Applications.Core/containers@2023-10-01-preview' = {
Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/author-apps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
type: docs
title: "Authoring applications"
linkTitle: "Authoring applications"
description: "Learn how to author a Radius application"
description: "Learn how to author a Radius Application"
weight: 100
---
4 changes: 2 additions & 2 deletions docs/content/guides/author-apps/application/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
type: docs
title: "Radius applications"
title: "Radius Applications"
linkTitle: "Applications"
description: "Learn about Radius applications"
description: "Learn about Radius Applications"
weight: 100
---
12 changes: 6 additions & 6 deletions docs/content/guides/author-apps/application/overview/index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
type: docs
title: "Overview: Radius applications"
title: "Overview: Radius Applications"
linkTitle: "Overview"
description: "Learn about Radius applications and how they bring all of your services, dependencies, and relationships together."
description: "Learn about Radius Applications and how they bring all of your services, dependencies, and relationships together."
weight: 100
categories: "Overview"
tags: ["applications"]
---

<img src="application.png" alt="Diagram of an application" width=350px >

A Radius application is the primary resource that brings all your "stuff" together. This can include services, dependencies, and relationships. Radius apps give you a single description and view into your entire application, and allow you to deploy and manage it easily.
A Radius Application is the primary resource that brings all your "stuff" together. This can include services, dependencies, and relationships. Radius apps give you a single description and view into your entire application, and allow you to deploy and manage it easily.

## Add portability to your application

Radius applications are designed to be cloud and platform agnostic. This means that you can define your application once, and deploy it to any cloud or platform that Radius supports. This allows you to easily move your application between clouds, or even between cloud and on-premises environments. Developers can define their requirements and dependencies (_Redis, SQL, Dapr, etc._) and operators can define the [environments]({{< ref "guides/deploy-apps/environments/overview" >}}) and [Recipes]({{< ref "guides/recipes/overview" >}}) that bind those requirements to the appropriate cloud resources.
Radius Applications are designed to be cloud and platform agnostic. This means that you can define your application once, and deploy it to any cloud or platform that Radius supports. This allows you to easily move your application between clouds, or even between cloud and on-premises environments. Developers can define their requirements and dependencies (_Redis, SQL, Dapr, etc._) and operators can define the [environments]({{< ref "guides/deploy-apps/environments/overview" >}}) and [Recipes]({{< ref "guides/recipes/overview" >}}) that bind those requirements to the appropriate cloud resources.

<img src="portable-resources.png" alt="Diagram of portable resources binding to different clouds" width=600px >

Expand All @@ -30,11 +30,11 @@ The Kubernetes namespace extension allows you to customize how all of the resour

### Kubernetes Metadata extension

The [Kubernetes Metadata extension]({{< ref "guides/operations/kubernetes/kubernetes-metadata">}}) enables you set and cascade Kubernetes metadata such as labels and Annotations on all the Kubernetes resources defined with in your Radius application.
The [Kubernetes Metadata extension]({{< ref "guides/operations/kubernetes/kubernetes-metadata">}}) enables you set and cascade Kubernetes metadata such as labels and Annotations on all the Kubernetes resources defined with in your Radius Application.

## Query and understand your application with the Radius Application Graph

Radius applications are more than just client-side configuration and automation, they also provide a server-side graph of your application. This graph can be queried and used to understand your application, and can be used to power other Radius features and custom tooling. Refer to the [API concept docs]({{< ref "api-concept" >}}) and [Postman How-To guide]({{< ref "guides/operations/control-plane/howto-postman" >}}) for more information on how to query the application graph.
Radius Applications are more than just client-side configuration and automation, they also provide a server-side graph of your application. This graph can be queried and used to understand your application, and can be used to power other Radius features and custom tooling. Refer to the [API concept docs]({{< ref "api-concept" >}}) and [Postman How-To guide]({{< ref "guides/operations/control-plane/howto-postman" >}}) for more information on how to query the application graph.

<img src="app-graph.png" alt="Diagram of the application graph" width=500px >

Expand Down
Loading
Loading