Skip to content

Commit

Permalink
Merge branch 'edge' into willtsai/k8s-inc-adopt
Browse files Browse the repository at this point in the history
  • Loading branch information
willtsai authored Sep 27, 2023
2 parents e6b1992 + eef2c69 commit c10f63f
Show file tree
Hide file tree
Showing 12 changed files with 171 additions and 114 deletions.
12 changes: 11 additions & 1 deletion docs/content/community/contributing/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,14 @@ The source code for Radius is available on GitHub within the [radius repo](https

Documentation is housed at https://github.com/radius-project/docs.

Samples are location at https://github.com/radius-project/samples.
Samples are located at https://github.com/radius-project/samples.

## Troubleshooting common issues

### 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
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ If you have issues with the sample application, where the container doesn't conn
```bash
rad resource logs containers frontend -a s3app
```
Also please make sure to [open an Issue](https://github.com/radius-project/radius/issues/new?assignees=&labels=kind%2Fbug&template=bug.md&title=%3CBUG+TITLE%3E) if you encounter a generic `Internal server error` message or an error message that is not self-serviceable, so we can address the root error not being forwarded to the user.
Also make sure to [open an Issue](https://github.com/radius-project/radius/issues/new/choose) if you encounter a generic `Internal server error` message or an error message that is not self-serviceable, so we can address the root error not being forwarded to the user.

## Further Reading

Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/deploy-apps/howto-delete/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags: ["delete"]

## Pre-requisites

A [deployed application]({{< ref deploy-apps >}}) in a Radius environment.
- A [deployed application]({{< ref deploy-apps >}}) in a Radius environment.

## Step 1: Delete the Radius application from the environment

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: docs
title: "How-To: Deploy an application with Github Actions"
linkTitle: "Deploy via GitHub Actions"
description: "Learn about adding your Radius apps to your deployment pipelines with GitHub Actions"
weight: 200
weight: 300
categories: "How-To"
tags: ["CI/CD"]
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,35 +1,31 @@
---
type: docs
title: "Overview: Deploying applications into a Radius environment"
title: "How-To: Deploying applications into a Radius environment"
linkTitle: "Deploy via CLI"
description: "Learn how to deploy a Radius application"
weight: 100
categories: "Overview"
weight: 200
categories: "How-To"
tags: ["deployments"]
---

## Run an application
## Pre-requisites
- [An authored Radius application]({{< ref author-apps >}})

Once you have [authored an application]({{< ref author-apps >}}), you can run an application using the [`rad run`]({{< ref rad_run >}}) command.
## Step 1 : Deploy an application into a Radius environment

```bash
rad run app.bicep
```

This will deploy the application to your environment, create port-forwards for all container ports, and stream container logs to the console.

## Deploy an application
{{< tabs Deploy-app Deploy-app-with-parameters >}}

{{% codetab %}}
An application can be deployed to an environment with [`rad deploy`]({{< ref rad_deploy>}}):

```bash
rad deploy app.bicep
```
This will deploy the application to the created Radius environment.
{{% /codetab %}}

### Parameters

Parameters can be included as part of `rad run` or `rad deploy` via the `-p/--parameters` flag:
{{% codetab %}}
Parameters can be included as part of `rad deploy` via the `-p/--parameters` flag:

```bash
rad deploy app.bicep -p param1=value1 -p param2=value2
Expand All @@ -38,4 +34,9 @@ Parameters can be included as part of `rad run` or `rad deploy` via the `-p/--pa
This will deploy the application to the created Radius environment injecting the parameters into the application.

You can find more examples of deploying applications with parameters [here]({{< ref "rad_deploy#examples" >}}).

{{% /codetab %}}

{{< /tabs >}}

> Follow the [how-to guide]({{< ref howto-troubleshootapps >}}) for guidance on troubleshooting your Radius application
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
type: docs
title: "How-To: Run applications on Radius"
linkTitle: "Run apps"
description: "Learn how to run applications on Radius"
weight: 100
categories: "How-To"
tags: ["deployments"]
---

## Pre-requisites
- [An authored Radius application]({{< ref author-apps >}})

## Step 1: Run an application

{{< tabs Run-app Run-app-with-parameters >}}

{{% codetab %}}
You can run an application using the [`rad run`]({{< ref rad_run >}}) command.

```bash
rad run app.bicep
```

This will deploy the application to your environment, create port-forwards for all container ports, and stream container logs to the console.
{{% /codetab %}}

{{% codetab %}}
Parameters can be included as part of `rad run` via the `-p/--parameters` flag:

```bash
rad run app.bicep -p param1=value1 -p param2=value2
```

This will deploy the application to the created Radius environment injecting the parameters into the application.

You can find more examples of deploying applications with parameters [here]({{< ref "rad_run#examples" >}}).
{{% /codetab %}}

{{< /tabs >}}

> Follow the [how-to guide]({{< ref howto-troubleshootapps >}}) for guidance on troubleshooting your apps
43 changes: 43 additions & 0 deletions docs/content/guides/deploy-apps/howto-troubleshootapps/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
type: docs
title: "How-To: Troubleshoot applications"
linkTitle: "Troubleshoot apps"
description: "Learn how to troubleshoot issues with the Radius application"
weight: 900
categories: "How-To"
tags: ["troubleshooting"]
---

## Pre-requisites

- A [deployed application]({{< ref deploy-apps >}}) in a Radius environment.

## Step 1: Port-forward container to your local machine

Use the below command to port-forward the container to your local machine. This enables you to access the container from your local machine.

```bash
rad resource expose containers <container_name> -a <app_name> --port <port_number>
```
Refer to [`rad resource expose`]({{< ref rad_resource_expose >}}) for more details on the command.

## Step 2: Inspect container logs

If your Radius application is unresponsive or does not connect to its dependencies, Use the below command to inspect logs from container:

```bash
rad resource logs containers frontend -a <app_name>
```

> Also refer to the [connections section]({{< ref "guides/author-apps/containers/overview#connections" >}}) to know about the naming convention of the environment variables and inspect if your application uses the right variables.
## Step 3: Inspect control-plane logs

If you hit errors while deploying the application, look at the control plane logs to see if there are any errors. You can use the following command to view the logs:

```bash
rad debug-logs
```
Inspect the UCP and DE logs to see if there are any errors

>Also make sure to [open an Issue](https://github.com/radius-project/radius/issues/new/choose) if you encounter a generic `Internal server error` message or an error message that is not self-serviceable, so we can address the root error not being forwarded to the user.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: docs
title: "Set Kubernetes metadata"
linkTitle: "Kubernetes metadata"
description: "Learn how to configure Kubernetes labels and annotations for generated objects"
weight: 300
weight: 400
categories: "How-To"
tags: ["containers","Kubernetes","applications","environments"]
---
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
type: docs
title: "How-To: Upgrade Radius on Kubernetes "
linkTitle: "Upgrade Radius on Kubernetes"
description: "Learn how to upgrade Radius on Kubernetes"
weight: 300
categories: "How-To"
---

Radius does not offer backward compatibility with previous releases. Breaking changes may happen between releases and we recommend doing a fresh installation of the latest version of Radius after every release.

## Step 1 : Delete any existing Radius environments

To delete any existing Radius environments, run the following command:

```bash
rad env delete
```

## Step 2: Uninstall the existing Radius control-plane

To uninstall the existing Radius control-plane, run the following command:

```bash
rad uninstall kubernetes
```

## Step 3: Install the rad CLI

The rad CLI is the main tool for interacting with Radius. It is used to create and manage Radius environments, and to deploy and manage Radius applications.

Visit the [rad CLI how-to guide]({{< ref howto-rad-cli >}}) for more information on how to install the rad CLI.

{{< button text="How-To: rad CLI" page="howto-rad-cli" newtab="true" >}}

## Step 4: Install the Radius-Bicep VS Code extension

The Radius-Bicep VS Code extension provides a set of tools for working with Bicep files in VS Code. Visit the [VSCode how-to guide]({{< ref howto-vscode >}}) for more information on how to install the Radius-Bicep VS Code extension.

{{< button text="How-To: VS Code" page="howto-vscode" newtab="true" >}}

## Step 5: Initialize the Radius control-plane

The Radius control-plane is a set of services that provide the core functionality of Radius. It is deployed as a set of containers in a Kubernetes cluster.

Visit the [environments how-to guide]({{< ref howto-environment >}}) for more information on how to install the Radius control-plane and create your first Radius environment.

{{< button text="How-To: Init an environment" page="howto-environment" newtab="true" >}}




2 changes: 2 additions & 0 deletions docs/content/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ The Radius control-plane is a set of services that provide the core functionalit
Visit the [environments how-to guide]({{< ref howto-environment >}}) for more information on how to install the Radius control-plane and create your first Radius environment.

{{< button text="How-To: Init an environment" page="howto-environment" newtab="true" >}}

>If you are looking to upgrade Radius to the latest version, refer to [upgrade Radius on Kubernetes]({{< ref kubernetes-upgrade >}}) for more information.
93 changes: 0 additions & 93 deletions docs/content/reference/troubleshooting-radius.md

This file was deleted.

0 comments on commit c10f63f

Please sign in to comment.