Skip to content

Commit

Permalink
Merge branch 'edge' into Reshrahim-patch-3
Browse files Browse the repository at this point in the history
  • Loading branch information
Reshrahim authored Jan 8, 2025
2 parents 972f80d + 9a47acf commit 3d688fe
Show file tree
Hide file tree
Showing 53 changed files with 740 additions and 199 deletions.
11 changes: 2 additions & 9 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,9 +1,2 @@
# Documentation and examples for what this does:
#
# https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners

# This file is a list of rules, with the last rule being most specific
# All of the people (and only those people) from the matching rule will be notified

# Default rule: anything that doesn't match a more specific rule goes here
* @radius-project/maintainers-docs @radius-project/approvers-docs
# These owners are the maintainers and approvers of this repo
* @radius-project/maintainers-docs @radius-project/approvers-docs
2 changes: 1 addition & 1 deletion .github/workflows/upmerge.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ jobs:
git fetch origin $SOURCE_BRANCH
git merge --no-commit origin/$SOURCE_BRANCH
git checkout edge -- docs/config.toml docs/layouts/partials/hooks/body-end.html
git commit -m "Upmerge to edge"
git commit --signoff --message "Upmerge to edge"
if git diff --quiet edge; then
echo "No changes to merge from $SOURCE_BRANCH to edge"
Expand Down
3 changes: 1 addition & 2 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
# These owners are the maintainers and approvers of this repo
* @radius-project/maintainers-docs @radius-project/approvers-docs
# See the owners for this repo at .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ eksctl create cluster --name <my-cluster> --region=<my-region>

Create a [Radius Environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) where you will deploy your application.

Run [`rad init --full`]({{< ref rad_init >}}) to initialize a new environment into your current kubectl context:
Run [`rad init --full`]({{< ref rad_initialize >}}) to initialize a new environment into your current kubectl context:

```bash
rad init --full
Expand Down Expand Up @@ -105,7 +105,7 @@ This creates a container that will be deployed to your Kubernetes cluster. This

## Step 7: Cleanup

1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_env_delete.md >}}) to delete all Radius resources running on the EKS Cluster.
1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_environment_delete.md >}}) to delete all Radius resources running on the EKS Cluster.
1. Cleanup AWS Resources - AWS resources are not deleted when deleting a Radius Environment, so make sure to delete all resources created in this reference app to prevent additional charges. You can delete these resources in the AWS Console or via the AWS CLI. Instructions to delete an AWS S3 Bucket are available [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-bucket.html).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The steps below will showcase a "rad-ified" version of the existing [Azure AD wo

## Step 1: Initialize Radius

Begin by running [`rad init --full`]({{< ref rad_init >}}). Make sure to configure an Azure cloud provider:
Begin by running [`rad init --full`]({{< ref rad_initialize >}}). Make sure to configure an Azure cloud provider:

```bash
rad init --full
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This how-to guide will provide an overview of how to:

## Step 1: Initialize Radius

Begin by running [`rad init --full`]({{< ref rad_init >}}). Make sure to configure an Azure cloud provider:
Begin by running [`rad init --full`]({{< ref rad_initialize >}}). Make sure to configure an Azure cloud provider:

```bash
rad init --full
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or

## Create a development environment

1. Initialize a new [Radius Environment]({{< ref "/guides/deploy-apps/environments/overview">}}) with [`rad init`]({{< ref rad_init >}}):
1. Initialize a new [Radius Environment]({{< ref "/guides/deploy-apps/environments/overview">}}) with [`rad init`]({{< ref rad_initialize >}}):
```bash
rad init
```
Expand Down Expand Up @@ -55,7 +55,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or
contour-contour 1/1 1 1 46s
```

You can also use [`rad env list`]({{< ref rad_env_list.md >}}) to view your environment:
You can also use [`rad env list`]({{< ref rad_environment_list.md >}}) to view your environment:

```bash
rad env list
Expand All @@ -75,7 +75,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or

## Create an environment interactively

1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}):
1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}):

```bash
rad init --full
Expand Down Expand Up @@ -120,7 +120,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or
contour-contour 1/1 1 1 2m33s
```

1. Verify an environment was created with [`rad env show`]({{< ref rad_env_show.md >}}):
1. Verify an environment was created with [`rad env show`]({{< ref rad_environment_show.md >}}):

```bash
rad env show -o json
Expand Down Expand Up @@ -185,7 +185,7 @@ Radius can also be installed and an environment created with manual rad CLI comm
1. Create your Radius Environment:
Run [`rad env create`]({{< ref rad_env_create >}}) to create a new environment in your resource group. Specify the `--namespace` flag to select the Kubernetes namespace to deploy resources into:
Run [`rad env create`]({{< ref rad_environment_create >}}) to create a new environment in your resource group. Specify the `--namespace` flag to select the Kubernetes namespace to deploy resources into:
```bash
rad env create myEnvironment --group myGroup --namespace my-namespace
Expand Down Expand Up @@ -213,7 +213,7 @@ Radius can also be installed and an environment created with manual rad CLI comm
contour-contour 1/1 1 1 2m33s
```

You can also use [`rad env list`]({{< ref rad_env_list.md >}}) to see if the created environment gets listed:
You can also use [`rad env list`]({{< ref rad_environment_list.md >}}) to see if the created environment gets listed:

```bash
rad env list --group myGroup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,31 +60,31 @@ rad init
{{% /codetab %}}

{{% codetab %}}
[rad env list]({{< ref rad_env_list >}}) lists all of the environments in your [workspace]({{< ref workspaces >}}):
[rad env list]({{< ref rad_environment_list >}}) lists all of the environments in your [workspace]({{< ref workspaces >}}):

```bash
rad env list
```
{{% /codetab %}}

{{% codetab %}}
[rad env show]({{< ref rad_env_show >}}) prints information on the default or specified environment:
[rad env show]({{< ref rad_environment_show >}}) prints information on the default or specified environment:

```bash
rad env show
```
{{% /codetab %}}

{{% codetab %}}
[rad env delete]({{< ref rad_env_delete >}}) deletes the specified environment:
[rad env delete]({{< ref rad_environment_delete >}}) deletes the specified environment:

```bash
rad env delete -e myenv
```
{{% /codetab %}}

{{% codetab %}}
[rad env switch]({{< ref rad_env_switch >}}) switches the default environment:
[rad env switch]({{< ref rad_environment_switch >}}) switches the default environment:

```bash
rad env switch -e myenv
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The AWS provider allows you to deploy and connect to AWS resources from a Radius

## Interactive configuration

1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}):
1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}):

```bash
rad init --full
Expand Down Expand Up @@ -62,7 +62,7 @@ The AWS provider allows you to deploy and connect to AWS resources from a Radius
rad env update myEnvironment --aws-region myAwsRegion --aws-account-id myAwsAccountId
```
This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad env update`]({{< ref rad_env_update >}})
This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad env update`]({{< ref rad_environment_update >}})
1. Add your AWS cloud provider credentials:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Now that the setup is complete, you can install Radius with AWS IRSA enabled.
## Interactive configuration
1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}):
1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}):
```bash
rad init --full
Expand Down Expand Up @@ -127,7 +127,7 @@ Now that the setup is complete, you can install Radius with AWS IRSA enabled.
rad env create default
```
1. Use [`rad env update`]({{< ref rad_env_update >}}) to update your Radius Environment with your your AWS region and AWS account ID:
1. Use [`rad env update`]({{< ref rad_environment_update >}}) to update your Radius Environment with your your AWS region and AWS account ID:
```bash
rad env update myEnvironment --aws-region myAwsRegion --aws-account-id myAwsAccountId
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The Azure provider allows you to deploy and connect to Azure resources from a se

## Interactive configuration

1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}):
1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}):

```bash
rad init --full
Expand Down Expand Up @@ -66,7 +66,7 @@ The Azure provider allows you to deploy and connect to Azure resources from a se
## Manual configuration
1. Use [`rad env update`]({{< ref rad_env_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group:
1. Use [`rad env update`]({{< ref rad_environment_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group:
```bash
rad env update myEnvironment --azure-subscription-id myAzureSubscriptionId --azure-resource-group myAzureResourceGroup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Now that the setup is complete, you can now install Radius with Azure workload i

## Interactive configuration

1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}):
1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}):

```bash
rad init --full
Expand Down Expand Up @@ -82,7 +82,7 @@ Now that the setup is complete, you can now install Radius with Azure workload i
rad env create default
```
1. Use [`rad env update`]({{< ref rad_env_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group:
1. Use [`rad env update`]({{< ref rad_environment_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group:
```bash
rad env update myEnvironment --azure-subscription-id myAzureSubscriptionId --azure-resource-group myAzureResourceGroup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ When you have multiple environments initialized for different purposes workspace
rad group create mygroup
```

1. Create an environment named `myenvironment` using [`rad env create`]({{< ref rad_env_create >}}):
1. Create an environment named `myenvironment` using [`rad env create`]({{< ref rad_environment_create >}}):

```sh
rad env create myenvironment
Expand All @@ -47,7 +47,7 @@ When you have multiple environments initialized for different purposes workspace
rad group create yourgroup
```

1. Create an environment named `yourenvironment` using [`rad env create`]({{< ref rad_env_create >}}):
1. Create an environment named `yourenvironment` using [`rad env create`]({{< ref rad_environment_create >}}):

```sh
rad env create yourenvironment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ rad env delete my-env
- [Recipes overview]({{< ref "/guides/recipes/overview" >}})
- [Radius Environments]({{< ref "/guides/deploy-apps/environments/overview" >}})
- [`rad recipe CLI reference`]({{< ref rad_recipe >}})
- [`rad env CLI reference`]({{< ref rad_env >}})
- [`rad env CLI reference`]({{< ref rad_environment >}})
2 changes: 1 addition & 1 deletion docs/content/guides/recipes/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Use [**rad recipe list**]({{< ref rad_recipe_list >}}) to view the Recipes avail

### Use lightweight "local-dev" Recipes

Radius Environments make it easy to get up and running with Recipes instantly. When you run [`rad init`]({{< ref rad_init >}}) you get a set of containerized local-dev Recipes pre-registered in your environment. These Recipes are designed to help you get started quickly with Recipes using lightweight containers. You can use these Recipes to test your app locally, or deploy them to a dev environment.
Radius Environments make it easy to get up and running with Recipes instantly. When you run [`rad init`]({{< ref rad_initialize >}}) you get a set of containerized local-dev Recipes pre-registered in your environment. These Recipes are designed to help you get started quickly with Recipes using lightweight containers. You can use these Recipes to test your app locally, or deploy them to a dev environment.

### Customize with parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ rad env delete my-env
- [Recipes overview]({{< ref "/guides/recipes/overview" >}})
- [Radius Environments]({{< ref "/guides/deploy-apps/environments/overview" >}})
- [`rad recipe CLI reference`]({{< ref rad_recipe >}})
- [`rad env CLI reference`]({{< ref rad_env >}})
- [`rad env CLI reference`]({{< ref rad_environment >}})
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,4 @@ rad env delete my-env
- [Recipes overview]({{< ref "/guides/recipes/overview" >}})
- [Radius Environments]({{< ref "/guides/deploy-apps/environments/overview" >}})
- [`rad recipe CLI reference`]({{< ref rad_recipe >}})
- [`rad env CLI reference`]({{< ref rad_env >}})
- [`rad env CLI reference`]({{< ref rad_environment >}})
6 changes: 4 additions & 2 deletions docs/content/reference/cli/rad.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,14 @@ Radius CLI
* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.
* [rad debug-logs]({{< ref rad_debug-logs.md >}}) - Capture logs from Radius control plane for debugging and diagnostics.
* [rad deploy]({{< ref rad_deploy.md >}}) - Deploy a template
* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments
* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments
* [rad group]({{< ref rad_group.md >}}) - Manage resource groups
* [rad init]({{< ref rad_init.md >}}) - Initialize Radius
* [rad initialize]({{< ref rad_initialize.md >}}) - Initialize Radius
* [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes
* [rad resource]({{< ref rad_resource.md >}}) - Manage resources
* [rad resource-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers
* [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types
* [rad run]({{< ref rad_run.md >}}) - Run an application
* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform
* [rad version]({{< ref rad_version.md >}}) - Prints the versions of the rad cli
Expand Down
1 change: 0 additions & 1 deletion docs/content/reference/cli/rad_application_graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ rad app graph my-application

```
-a, --application string The application name
-e, --environment string The environment name
-g, --group string The resource group name
-h, --help help for graph
-w, --workspace string The workspace name
Expand Down
1 change: 1 addition & 0 deletions docs/content/reference/cli/rad_bicep.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ Manage bicep compiler used by Radius
* [rad bicep delete]({{< ref rad_bicep_delete.md >}}) - Delete installed bicep compiler
* [rad bicep download]({{< ref rad_bicep_download.md >}}) - Download the bicep compiler
* [rad bicep publish]({{< ref rad_bicep_publish.md >}}) - Publish a Bicep file to an OCI registry.
* [rad bicep publish-extension]({{< ref rad_bicep_publish-extension.md >}}) - Generate or publish a Bicep extension for a set of resource types.

59 changes: 59 additions & 0 deletions docs/content/reference/cli/rad_bicep_publish-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
type: docs
title: "rad bicep publish-extension CLI reference"
linkTitle: "rad bicep publish-extension"
slug: rad_bicep_publish-extension
url: /reference/cli/rad_bicep_publish-extension/
description: "Details on the rad bicep publish-extension Radius CLI command"
---
## rad bicep publish-extension

Generate or publish a Bicep extension for a set of resource types.

### Synopsis

Generate or publish a Bicep extension for a set of resource types.
This command compiles a set of resource types (resource provider manifest) into a Bicep extension for local use or distribution.

Bicep extensions enable extensibility for the Bicep language. This command can be used to generate and distribute Bicep support for resource types authored by users. Bicep extensions can be distributed using Open Container Initiative (OCI) registry, such as Azure Container Registry, Docker Hub, or GitHub Container Registry. See https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-extension for more information on Bicep extensions.

Once an extension is been generated, it can be used locally or published to a container registry for distribution depending on the target specified.

When publishing to an OCI registry it is expected the user runs docker login (or similar command) and has the proper permission to push to the target OCI registry.


```
rad bicep publish-extension [flags]
```

### Examples

```
# Generate a Bicep extension to a local file
rad bicep publish-extension --from-file ./Example.Provider.yaml --target ./output.tgz
# Publish a Bicep extension to a container registry
bicep publish-extension ./Example.Provider.yaml --target br:ghcr.io/myregistry/example-provider:v1
```

### Options

```
-f, --from-file string The input file. May be an absolute path or a path relative to the current working directory
-h, --help help for publish-extension
--target string The destination path file or OCI registry path. OCI registry paths use the format 'br:HOST/PATH:TAG'.
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
-o, --output string output format (supported formats are json, table) (default "table")
```

### SEE ALSO

* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler

Loading

0 comments on commit 3d688fe

Please sign in to comment.