Skip to content

Commit

Permalink
Merge branch 'v0.30' into v0.31
Browse files Browse the repository at this point in the history
Signed-off-by: Aaron Crawfis <[email protected]>
  • Loading branch information
AaronCrawfis committed Mar 1, 2024
2 parents 5733603 + 284e648 commit f4f713c
Show file tree
Hide file tree
Showing 26 changed files with 147 additions and 103 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/close-stale-prs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# This workflow warns and then closes PRs that have had no activity for 90 days.
#
# For more information, see:
# https://github.com/actions/stale
name: Close stale pull requests

on:
schedule:
- cron: '0 18 * * *' # Run the workflow every day at 6PM UTC (10AM PST).

jobs:
stale:

runs-on: ubuntu-latest
permissions:
pull-requests: write

steps:
- uses: actions/stale@v5
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-pr-message: 'This pull request has been automatically marked as stale because it has been inactive for 90 days. Remove stale label or comment or this PR will be closed in 7 days.'
stale-pr-label: 'stale'
days-before-pr-stale: 90 # 3 months
days-before-pr-close: 7
days-before-issue-stale: -1
days-before-issue-close: -1
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ $ git commit -s -m 'This is my commit message'
```

Visual Studio Code has a setting, `git.alwaysSignOff` to automatically add a Signed-off-by line to commit messages. Search for "sign-off" in VS Code settings to find it and enable it.

## Inactive Pull Requests

Pull requests that have been inactive for 90 days will be marked with a stale label. They will automatically be closed after a subsequent 7 days of inactivity. This timeframe may be adjusted in the future based on project needs.
4 changes: 2 additions & 2 deletions docs/content/community/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ type: docs
title: "Radius Community"
linkTitle: "Community"
description: "Information about the Radius community"
weight: 90
---
weight: 120
---
27 changes: 0 additions & 27 deletions docs/content/community/contributing/github.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/content/community/contributing/overview/index.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/content/community/maintainers/_index.md

This file was deleted.

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: 500
weight: 200
---

## Blog posts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,12 @@ The best way to interact with the community is via the Radius Discord server:

Every month we host a community meeting to showcase new features, review upcoming milestones, and engage in a Q&A. Anyone from the Radius community can participate, present a topic, or host. All are welcome! For the meeting schedule, links, and more information, visit the Radius [community repo](https://github.com/radius-project/community#community-meetings).

## GitHub Issues & repositories

If you would like to file Issues, access the source code, or use Codespaces please visit the [Radius GitHub repo](https://github.com/radius-project).

## How can I get involved?

One of the easiest ways to contribute is to participate in discussions at community engagements or via the Discord server referenced above. We are always seeking feedback, especially for suggestions around improving the product and docs.

If you are interested in contributing to the Radius project, please visit the [Contributing to Radius]({{< ref contributing >}}) page for more information.

## Press and media coverage

Visit the [press and media coverage docs]({{< ref media-coverage >}}) for a list of press articles, blog posts, presentations, and other coverage of Radius.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ linkTitle: Application graph
description: Learn how the Radius application graph allows you to model your entire application
weight: 200
toc_hide: true
hide_summary: true
---

<!-- DISABLE_ALGOLIA -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ type: docs
title: "Contributing to Radius"
linkTitle: "Contributing"
description: "Guides and requirements for contributing to Radius"
weight: 200
weight: 110
---
7 changes: 7 additions & 0 deletions docs/content/contributing/docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Radius Docs"
linkTitle: "Docs"
description: "Learn how to contribute and maintain the Radius documentation"
weight: 300
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ type: docs
title: "How-To: Contribute to the Radius documentation"
linkTitle: "Contribute to docs"
description: "How to contribute to the Radius documentation"
weight: 200
slug: "docs"
weight: 100
aliases : ["/community/contributing/docs/"]
---

The Radius docs are built on [Hugo](https://gohugo.io) with the [Docsy](https://docsy.dev) theme. GitHub Actions are used to build and deploy the docs upon each PR.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: "How-To: Maintain the Radius docs"
linkTitle: "Maintain docs"
weight: 200
description: "Learn about the Radius docs maintenance process"
aliases : ["/community/maintainers/docs-maintainers/"]
---

In this guide, you’ll learn how to perform routine Radius docs maintainer and approver responsibilities. In order to successfully accomplish these tasks, you need either approver or maintainer status in the [`radius-project/docs`](https://github.com/radius-project/docs) repo.
Expand Down
36 changes: 36 additions & 0 deletions docs/content/contributing/overview/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
type: docs
title: "Overview: Contributing to Radius"
linkTitle: "Overview"
description: "Guides and requirements for contributing to Radius"
weight: 100
aliases : ["/community/contributing/overview"]
---

We welcome contributions to Radius! Contributions can come in different ways such as engaging with the community, contributing code, or improving the documentation. This page provides an overview of the different ways you can contribute to Radius.

## Community

Check out the [Radius Community]({{< ref community >}}) page to learn about the different ways you can engage with the Radius community.

## GitHub

If you would like to file Issues, access the source code, or use Codespaces please visit the [Radius GitHub repo](https://github.com/radius-project).

### good-first-issues

To quickly get started with contributing to code on Radius, here are some identified [good-first-issues](https://aka.ms/radius-first-issues) that you can `/assign` to yourself and start contributing.

<a class="btn btn-primary" href="https://aka.ms/radius-first-issues" role="button" target="_blank">good-first-issues</a>

### Contributing to Radius

Check out the following table to learn where and how you can contribute:

| Repository | Description | Contribution guides |
|------------|-------------|---------------------|
| **Radius** | Main repository that contains source code for [`rad` CLI]((https://github.com/radius-project/radius/blob/main/docs/contributing/contributing-code/contributing-code-cli/running-rad-cli.md)), [control plane]((https://github.com/radius-project/radius/blob/main/docs/contributing/contributing-code/contributing-code-control-plane/README.md)) and other components of Radius | [radius-project/radius](https://github.com/radius-project/radius/blob/main/CONTRIBUTING.md)|
| **Docs** | Documentation for Radius | [radius-project/docs]({{< ref contributing-docs>}})|
| **Recipes** | Commonly used [Recipe](https://docs.radapp.io/recipes) templates for Radius Environments | [radius-project/recipes](https://github.com/radius-project/recipes/blob/main/CONTRIBUTING.md) |(https://github.com/radius-project/recipes/blob/main/CONTRIBUTING.md) |
| **Dashboard** | The frontend experience for Radius |[radius-project/dashboard](https://github.com/radius-project/dashboard/blob/main/CONTRIBUTING.md) |
| **Bicep** | Temporary fork of the [Bicep repo](https://github.com/azure/bicep) used to inject the Radius types into the Bicep language. Contains both the Bicep CLI and the Bicep VS Code extension. | [radius-project/bicep](https://github.com/radius-project/bicep/blob/radius-compiler/CONTRIBUTING.md) |
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: "Give a Radius presentation"
linkTitle: "Presentations"
description: "Learn how to give a Radius presentation, with downloadable slides and assets"
weight: 400
aliases : ["/community/presentations/"]
---

We welcome community members giving presentations on Radius and spreading the word about all the awesome Radius features!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,4 @@ Also make sure to [open an Issue](https://github.com/radius-project/radius/issue

## Further Reading

{{< categorizeby category="Overview" tag="AWS" >}}

{{< categorizeby category="How-To" tag="AWS" >}}
- [Supported AWS resource types]({{< ref "/reference/resource-schema/aws" >}})
8 changes: 0 additions & 8 deletions docs/content/guides/operations/workspaces/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,20 +82,12 @@ workspaces:
kind: kubernetes
environment: /planes/radius/local/resourcegroups/dev/providers/applications.core/environments/dev
scope: /planes/radius/local/resourceGroups/dev
providerConfig:
azure:
subscriptionid: DEV-SUBID
resourcegroup: Dev
prod:
connection:
context: ProdCluster
kind: kubernetes
environment: /planes/radius/local/resourcegroups/prod/providers/applications.core/environments/prod
scope: /planes/radius/local/resourceGroups/prod
providerConfig:
azure:
subscriptionid: PROD-SUBID
resourcegroup: Prod
```
## Schema
Expand Down
15 changes: 11 additions & 4 deletions docs/content/guides/recipes/howto-author-recipes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,12 @@ Add the `context` parameter to your `variable.tf` file:

{{< rad file="snippets/redis-kubernetes-variables.tf" embed=true marker="//CONTEXT" lang="terraform" >}}

Update `main.tf` to use `context` for naming and namespace configuration:
Ensure that your `main.tf` has:

{{< rad file="snippets/redis-kubernetes-main.tf" embed=true marker="//RESOURCE" lang="terraform" >}}
- Defined `required_providers` for any providers you leverage in your module. This allows Radius to inject configuration and credentials.
- Utilizes the `context` parameter for naming and namespace configuration. This ensures your resources don't unintentionally collide with other uses of the Recipe.

{{< rad file="snippets/redis-kubernetes-main.tf" embed=true lang="terraform" >}}

{{% /codetab %}}

Expand Down Expand Up @@ -152,9 +155,13 @@ rad recipe register myrecipe --environment myenv --resource-type Applications.Da

{{< /tabs >}}

### Done
### Step 6 : Use the custom recipe in your application

You can now use your custom Recipe with its accompanying resource in your application.

> Note that if your Recipe is registered with the name "default", you do not need to provide a Recipe name in your application, as it will automatically pick up the default Recipe.
You can now use your custom Recipe with its accompanying resource. Visit the [Recipe developer guide]({{< ref "/guides/recipes/overview" >}}) for more information.
{{< rad file="snippets/redis.bicep" embed=true marker="//REDIS" >}}

## Further reading

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
//PROVIDER
terraform {
required_providers {
kubernetes = {
Expand All @@ -7,9 +6,7 @@ terraform {
}
}
}
//PROVIDER

//RESOURCE
resource "kubernetes_deployment" "redis" {
metadata {
name = "redis-${sha512(var.context.resource.id)}"
Expand Down Expand Up @@ -62,4 +59,3 @@ resource "kubernetes_service" "redis" {
}
}
}
//RESOURCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import radius as rad

param environment string

param application string

//REDIS
resource redis 'Applications.Datastores/redisCaches@2023-10-01-preview'= {
name: 'myresource'
properties: {
environment: environment
application: application
recipe: {
name: 'myrecipe'
}
}
}
//REDIS


13 changes: 1 addition & 12 deletions docs/content/guides/recipes/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,18 +51,7 @@ It's easy to author and register your own Recipes which define how to deploy and

## Supported resources

Recipes currently support the following resources. Support for additional resources is actively being worked on.

| Supported resources |
|---------------------|
| [`Applications.Datastores/redisCaches`]({{< ref redis >}}) |
| [`Applications.Datastores/mongoDatabases`]({{< ref mongodb >}}) |
| [`Applications.Datastores/sqlDatabases`]({{< ref microsoft-sql >}}) |
| [`Applications.Messaging/rabbitmqQueues`]({{< ref rabbitmq >}}) |
| [`Applications.Dapr/stateStores`]({{< ref dapr-statestore >}}) |
| [`Applications.Dapr/pubSubBrokers`]({{< ref dapr-pubsub >}}) |
| [`Applications.Dapr/secretStores`]({{< ref dapr-secretstore >}}) |
| [`Applications.Core/extenders`]({{< ref extender >}}) |
Recipes support all of the available portable resources listed [here]({{< ref "/guides/author-apps/portable-resources/overview" >}}).

## Infrastructure linking

Expand Down
20 changes: 20 additions & 0 deletions docs/content/reference/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,16 @@ As a workaround do not use underscores in resource names. Additional validation

See [app name constraints]({{< ref "resource-schema.md#common-values" >}}) for more information.

### Gateway resources and container resources cannot share names

Deploying a Radius Application that contains a gateway resource and a container resource that share a name will result in an error being thrown during deployment. For example, when attempting to name a container and a gateway something like "foo", you'll get an error messaging similar to:

```
Error - Type: IncludeError, Status: True, Reason: RootIncludesRoot, Message: root httpproxy cannot include another root httpproxy
```

As a workaround make sure to use distinct names for both containers and gateways.

## rad CLI

### Application and resource names are lower-cased after deployment
Expand Down Expand Up @@ -118,3 +128,13 @@ Some of the [AWS resource types](/resource-schema/aws) are 'non-idempotent', thi
We are currently building support for non-idempotent resources in Radius. Please like and comment on this [this issue](https://github.com/radius-project/radius/issues/6227) if you are interested in the same.

As a workaround, you can try using [Terraform Recipes]({{< ref "/guides/recipes/overview" >}}) to deploy and manage those non-idempotent resource types.

## GitHub

### Visual Studio not authorized for single sign-on

If you receive an error saying Visual Studio Code or another application is not authorized to clone any of the Radius repositories you may need to re-authorize the GitHub app:

1. Open a browser to https://github.com/settings/applications
1. Find the applicable app and select Revoke
1. Reopen app on local machine and re-auth
2 changes: 0 additions & 2 deletions docs/content/tutorials/eshop/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,3 @@ Adding Radius to the eShop on containers application allows teams to:
- Simplify deployment with Bicep and Azure Resource Manager (ARM)

{{< button text="View eShop sample" githubRepo="samples" githubPath="samples/eshop" color="success" size="btn-lg" >}}

*Visit the [GitHub docs]({{< ref github >}}) if you need access to the organization*
Loading

0 comments on commit f4f713c

Please sign in to comment.