Skip to content

Commit

Permalink
Merge branch 'v0.29' into edge
Browse files Browse the repository at this point in the history
Signed-off-by: Aaron Crawfis <[email protected]>
  • Loading branch information
AaronCrawfis committed Jan 31, 2024
2 parents 487d61c + dae2a04 commit 2d8b170
Show file tree
Hide file tree
Showing 90 changed files with 566 additions and 206 deletions.
6 changes: 6 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,9 @@

# images are binary
*.png binary

# MS Office documents are binary
*.pptx binary
*.potx binary
*.docx binary
*.dotx binary
2 changes: 2 additions & 0 deletions .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1224,3 +1224,5 @@ natively
NuGet
KubeVela
GigaOm
potx
href
5 changes: 5 additions & 0 deletions .github/workflows/website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ jobs:
run : |
mkdir -p ./docs/static/swagger
cp -r ./radius/swagger ./docs/static/
- name: Override git_branch for PR
if: github.event_name == 'pull_request'
run: |
# Within docs/config.toml, replace the line that starts with "github_branch" with "github_branch: $GITHUB_HEAD_REF"
sed -i "s|github_branch = .*|github_branch = \"$GITHUB_HEAD_REF\"|" docs/config.toml
- name: Build Hugo Site
run: |
cd docs
Expand Down
7 changes: 4 additions & 3 deletions docs/content/community/contributing/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ We welcome contributions to the Radius! Check out the following table to learn
| Component | Description | Contribution guides |
|-----------|-------------|---------------------|
| **`rad` CLI** | Deploys and manages Radius resources | [radius-project/radius](https://github.com/radius-project/radius/blob/main/docs/contributing/contributing-code/contributing-code-cli/running-rad-cli.md) |
| **Bicep** | Language and tools which includes the application model as a set of types. Will eventually be merged with https://github.com/azure/bicep | [radius-project/bicep](https://github.com/radius-project/bicep/blob/radius-compiler/CONTRIBUTING.md) |
| **ARM Deployment Engine** | Processes the output of the Bicep compiler and deploys resources. | [radius-project/deployment-engine](https://github.com/radius-project/deployment-engine/blob/main/CONTRIBUTING.md) |
| **Bicep** | Language and tools which includes the application model as a set of types which will eventually be merged with https://github.com/azure/bicep | [radius-project/bicep](https://github.com/radius-project/bicep/blob/radius-compiler/CONTRIBUTING.md) |
| **ARM Deployment Engine** | Processes the output of the Bicep compiler and deploys resources | [radius-project/deployment-engine](https://github.com/radius-project/deployment-engine/blob/main/CONTRIBUTING.md) |
| **Radius Control Plane** | Implements operations on the application model as a sequence of resource management operations | [radius-project/radius](https://github.com/radius-project/radius/tree/main/docs/contributing/contributing-code) |
| **Templates** | Deployable starter templates for getting up and running with Radius | [radius-project/templates](https://github.com/radius-project/templates) |
| **Dashboard** | The frontend experience for Radius | [radius-project/dashboard](https://github.com/radius-project/dashboard/blob/main/CONTRIBUTING.md) |
| **Recipes** | Commonly used [Recipe](https://docs.radapp.dev/recipes) templates for Radius Environments | [radius-project/recipes](https://github.com/radius-project/recipes/blob/main/CONTRIBUTING.md) |
| **Docs** | Documentation for Radius | [Contributing to docs]({{< ref contributing-docs >}}) |
8 changes: 5 additions & 3 deletions docs/content/community/media-coverage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: docs
title: "Radius press coverage and media links"
linkTitle: "Press/media coverage"
description: "Learn about Radius through press articles, blog posts, presentation and other coverage of Radius"
weight: 400
weight: 500
---

## Blog posts
Expand All @@ -13,16 +13,18 @@ weight: 400
| [The Microsoft Azure Incubations Team launches Radius, a new open application platform for the cloud](https://azure.microsoft.com/en-us/blog/the-microsoft-azure-incubations-team-launches-radius-a-new-open-application-platform-for-the-cloud/) | Microsoft Azure Blog | Oct 18, 2023 |
| [Enabling developer collaboration with Radius](https://cloudblogs.microsoft.com/opensource/2023/10/18/enabling-developer-collaboration-with-radius/) | Microsoft Open Source Blog | Oct 18, 2023 |

Ongoing blog posts can be found at [Radius Blog](https://blog.radapp.io)
Ongoing blog posts can be found at [Radius Blog](https://blog.radapp.io).

## Videos
## Presentations

| Video | Event | Date |
|-------|-------|------|
| [Brendan Burns and Mark Russinovich at Ignite about Radius](https://www.youtube.com/watch?v=gaG77PiYv5w&ab_channel=MicrosoftIgnite)| Microsoft Ignite | Nov 17, 2023 |
| [Introducing Radius - Open at Microsoft ](https://www.youtube.com/watch?v=mT_NWFnYn0A)| Open at Microsoft | Nov 7, 2023 |
| [Mark Russinovich at the Linux Foundation Member Summit](https://aka.ms/radius-lfms)|Linux Foundation Member Summit | Oct 24, 2023 |

Want to give you own presentation? Check out the [Give a Radius Presentation]({{< ref presentations >}}) page.

## Press articles

| Article Title | Media Source | Date |
Expand Down
26 changes: 26 additions & 0 deletions docs/content/community/presentations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
type: docs
title: "Give a Radius presentation"
linkTitle: "Presentations"
description: "Learn how to give a Radius presentation, with downloadable slides and assets"
weight: 400
---

We welcome community members giving presentations on Radius and spreading the word about all the awesome Radius features!

## Slides

We offer a template PowerPoint file to get started:

<a class="btn btn-primary" href="https://github.com/radius-project/docs/raw/{{< param github_branch >}}/presentation-pack/Radius.potx" role="button" target="_blank">Download the Radius PowerPoint template</a>

## Giving a Radius presentation

1. Begin by downloading the [Radius Presentation Deck](https://github.com/radius-project/docs/raw/{{< param github_branch >}}/presentation-pack/Radius.potx). This contains slides needed to give a Radius presentation.
1. Refer to the Radius [presentation pack directory](https://github.com/radius-project/docs/tree/{{< param github_branch >}}/presentation-pack) for any diagrams or images you need to create.
1. Next, review the docs to make sure you understand the [concepts]({{< ref concepts >}}).
1. Use the Radius [getting started guide]({{< ref getting-started >}}) and [samples repo](https://github.com/radius-project/samples) to show demos of how to use Radius.

## Previous presentations

Refer to the [Radius press coverage and media links]({{< ref media-coverage >}}) page for a list of previous presentations.
4 changes: 2 additions & 2 deletions docs/content/concepts/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@ Where .NET Aspire is focused on the .NET experience from moving from local devel

### How does Radius compare to Azure Developer CLI (azd)?

The [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/) is an open-source tool that provides developer-friendly commands to simplify the process of building, deploying, and managing Azure resources. While both azd and Radius are geared towards the development and deployment workflows, the most apparent difference is that azd can be only be used to manage Azure resources, whereas Radius supports multiple cloud providers. Radius also introduces a way to model (and not just deploy) entire applications and automate these through [Recipes]({{< ref "guides/recipes/overview">}}), which allows for complete [separation of concerns]({{< ref "collaboration-concept" >}}) between operators and developers. With azd, even though developers may leverage CLI templates to deploy infrastructure, they still need to understand the underlying infrastructure and how to connect to it.
The [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/) is an open-source tool that provides developer-friendly commands to simplify the process of building, deploying, and managing Azure resources. While both azd and Radius are geared towards the development and deployment workflows, the most apparent difference is that azd can be only be used to manage Azure resources, whereas Radius supports multiple cloud providers. Radius also introduces a way to model (and not just deploy) entire applications and automate these through [Recipes]({{< ref "guides/recipes/overview">}}), which allows for complete [separation of concerns]({{< ref "collaboration" >}}) between operators and developers. With azd, even though developers may leverage CLI templates to deploy infrastructure, they still need to understand the underlying infrastructure and how to connect to it.

### How does Radius compare to KubeVela?

[KubeVela](https://kubevela.io/) is an open-source platform that provides a higher level of abstraction for application deployments. Similar to Radius, it allows developers to define applications and their components, deployment across cloud providers or on-prem, and automated infrastructure provisioning with pre-defined templates. However, unlike Radius, KubeVela does not allow for modeling of connections between resources to set environment variables, configure access credentials, and more that make it simpler for developers to deploy and access resources.
[KubeVela](https://kubevela.io/) is an open-source platform that provides a higher level of abstraction for application deployments. Similar to Radius, it allows developers to define applications and their components, deployment across cloud providers or on-prem, and automated infrastructure provisioning with pre-defined templates. However, unlike Radius, KubeVela does not allow for modeling of connections between resources to set environment variables, configure access credentials, and more that make it simpler for developers to deploy and access resources.
Binary file not shown.
Binary file removed docs/content/concepts/overview/cloud-apps-today.png
Binary file not shown.
Binary file removed docs/content/concepts/overview/environments.png
Binary file not shown.
91 changes: 0 additions & 91 deletions docs/content/concepts/overview/index.md

This file was deleted.

Binary file removed docs/content/concepts/overview/platforms.png
Binary file not shown.
42 changes: 0 additions & 42 deletions docs/content/concepts/overview/snippets/appmodel-concept.bicep

This file was deleted.

Binary file removed docs/content/concepts/overview/ui-mockup-basic.png
Binary file not shown.
Binary file removed docs/content/concepts/overview/ui-mockup-list.png
Binary file not shown.
7 changes: 7 additions & 0 deletions docs/content/concepts/technical/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Technical concepts in Radius"
linkTitle: "Technical concepts"
description: "Learn about the architecture, API design, and other technical concepts of Radius"
weight: 300
---
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
type: docs
title: Radius API
linkTitle: API
linkTitle: Radius API
description: Learn about the Radius API
weight: 500
weight: 200
categories: "Concept"
aliases:
- /concepts/api-concept/
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ type: docs
title: Radius architecture
linkTitle: Architecture
description: Learn about the architecture of the Radius API and services
weight: 600
weight: 100
categories: "Concept"
tags: ["control plane"]
slug: 'architecture'
aliases:
- /concepts/architecture-concept/
---

## Overview
Expand All @@ -15,7 +17,7 @@ Radius provides an HTTP-based API and supporting tools that can deploy and manag

This page serves as documentation about the overall architecture of Radius to help educate contributors to the project or any user who wants a deeper understanding of the system and its capabilities.

**Prerequisite:** Read the [API docs]({{< ref api-concept >}}) to understand the terminology and structure of the Radius API.
**Prerequisite:** Read the [API docs]({{< ref "/concepts/technical/api" >}}) to understand the terminology and structure of the Radius API.

## Design motivations for Radius

Expand Down
7 changes: 7 additions & 0 deletions docs/content/concepts/why-radius/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Why Radius?"
linkTitle: "Why Radius?"
description: "Learn about why we created Radius and how it can help you"
weight: 100
---
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ weight: 200
toc_hide: true
---

<!-- DISABLE_ALGOLIA -->

## 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.
Expand All @@ -25,11 +27,11 @@ The Radius Application graph also allows your application to be self-documenting

{{< image 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.
> **Note:** A Radius dashboard is still on the roadmap, but in the meantime you can use the [Radius API]({{< ref "/concepts/technical/api" >}}) 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 "/concepts/technical/api" >}}).

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

Expand Down Expand Up @@ -72,4 +74,4 @@ GET /planes/radius/local/resourceGroups/default/providers/Applications.Core/cont

Now that you have an understanding of the Radius app graph, learn how you can deploy Radius applications to prepared landing zones with Radius Environments:

{{< button text="Radius Environments" page="collaboration-concept" color="success" >}}
{{< button text="Radius Environments" page="/concepts/why-radius/collaboration" color="success" >}}
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
type: docs
title: "Concept: Collaboration in Radius"
linkTitle: "Collaboration"
linkTitle: "Dev + ops collaboration"
description: "Learn how Radius Environments and Recipes support collaboration between platform engineers, application developers, and IT operators."
weight: 300
slug: collaboration
aliases:
- /concepts/collaboration-concept/
---

## What we heard
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
type: docs
title: "Concept: Why Radius?"
linkTitle: "Why Radius?"
description: "Describes the motivations for creating Radius."
title: "Introduction: Why did we create Radius?"
linkTitle: "Introduction"
description: "Learn about why we created Radius and how it can help you"
weight: 100
categories: "Concept"
aliases:
- /concepts/why-radius-concept/
---

## Our starting point
Expand Down
Loading

0 comments on commit 2d8b170

Please sign in to comment.