diff --git a/docs/content/community/contributing/github.md b/docs/content/community/contributing/github.md index 5f6855523..84743cea3 100644 --- a/docs/content/community/contributing/github.md +++ b/docs/content/community/contributing/github.md @@ -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. \ No newline at end of file +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 \ No newline at end of file diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/index.md b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md index 4180a0e9b..7e4b93549 100644 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/index.md +++ b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md @@ -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 diff --git a/docs/content/guides/deploy-apps/howto-delete/index.md b/docs/content/guides/deploy-apps/howto-delete/index.md index 73703c28f..cc656edf8 100644 --- a/docs/content/guides/deploy-apps/howto-delete/index.md +++ b/docs/content/guides/deploy-apps/howto-delete/index.md @@ -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 diff --git a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-rad-cli/index.md b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-rad-cli/index.md index 918b6f83b..330bdd74a 100644 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-rad-cli/index.md +++ b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-rad-cli/index.md @@ -38,5 +38,5 @@ Parameters can be included as part of `rad deploy` via the `-p/--parameters` fla {{< /tabs >}} - > Follow the [how-to guide]({{< ref troubleshooting-radius >}}) for guidance on troubleshooting your Radius application + > Follow the [how-to guide]({{< ref howto-troubleshootapps >}}) for guidance on troubleshooting your Radius application diff --git a/docs/content/guides/deploy-apps/howto-deploy/howto-run-app/index.md b/docs/content/guides/deploy-apps/howto-deploy/howto-run-app/index.md index 288c937e8..3fb95d385 100644 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-run-app/index.md +++ b/docs/content/guides/deploy-apps/howto-deploy/howto-run-app/index.md @@ -39,4 +39,4 @@ You can find more examples of deploying applications with parameters [here]({{< {{< /tabs >}} - > Follow the [how-to guide]({{< ref troubleshooting-radius >}}) for guidance on troubleshooting your apps + > Follow the [how-to guide]({{< ref howto-troubleshootapps >}}) for guidance on troubleshooting your apps diff --git a/docs/content/guides/deploy-apps/howto-troubleshootapps/index.md b/docs/content/guides/deploy-apps/howto-troubleshootapps/index.md new file mode 100644 index 000000000..73a7737a0 --- /dev/null +++ b/docs/content/guides/deploy-apps/howto-troubleshootapps/index.md @@ -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 -a --port +``` +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 +``` + +> 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. diff --git a/docs/content/reference/troubleshooting-radius.md b/docs/content/reference/troubleshooting-radius.md deleted file mode 100644 index fe28d321a..000000000 --- a/docs/content/reference/troubleshooting-radius.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -type: docs -title: "Troubleshoot issues and common problems" -linkTitle: "Troubleshooting" -description: "Common issues users may have with Radius and how to address them" -weight: 900 -categories: "How-To" -tags: ["troubleshooting"] ---- - -## Cloning repo - -### Visual Studio not authorized for single sign-on - -If you receive an error saying Visual Studio or another application is not authorized to clone the Radius repo and you need to re-authorize the app, follow these steps: - -1. Open a browser to https://github.com/radius-project/radius -1. Select your profile and click on Settings -1. Select Applications from the left navbar -1. Select the Authorized OAuth Apps tab -1. Find the conflicting app and select Revoke -1. Reopen app on local machine and re-auth - -## Creating environment - -### Error response cannot be parsed: """ error: EOF - -If you get an error when configuring Azure cloud provider after selecting a Resource Group name, make sure you set your subscription to one within the Microsoft tenant: - -```bash -az account set --subscription -``` - -## Troubleshooting the Radius control-plane - -To troubleshoot the Radius control-plane, you can use the command [`rad debug-logs`]({{< ref rad_debug-logs >}}) to get logs from each of control plane pods. - -1. Run `rad debug-logs` to get a zip of log files for each of the pods running in the Radius control-plane. You should see the `appcore-rp`, `ucp`, and `bicep-de` logs: - - ```bash - rad debug-logs - Capturing logs from the Radius workspace "myworkspace" - Wrote zip file debug-logs.zip. Please inspect each log file and remove any private information before sharing feedback. - ``` - - -2. In these log files, look for the text "panic", "error", or "Exception" in the logs, and if you find it inspect the error message. Also please open an issue at [radius-project/radius](https://github.com/radius-project/radius/issues/new?assignees=&labels=kind%2Fbug&template=bug.md&title=%3CBUG+TITLE%3E) with the details of your error and if possible, how to recreate. Please ensure that no sensitive information is in the logs prior to attaching them to an issue. - -> Visit https://aka.ms/ProjectRadius/GitHubAccess if you need access to the repo to open a bug. - -## Troubleshooting issues with Azure Cloud Provider - -To troubleshoot issues with the [Azure cloud provider]({{< ref providers >}}) and deployments to a Microsoft Azure subscription and resource group, refer to your [ARM activity logs](https://docs.microsoft.com/azure/azure-monitor/essentials/activity-log): - -1. Visit https://portal.azure.com -1. Navigate to your target subscription and resource group -1. Select "Activity logs" from the menu -1. Inspect the logs for any errors of failed deployments - -Note that Activity logs may take up to 10 minutes to be available in Azure. - -## Example - -In this example, a failure is returned after attempting to deploy a Bicep template that contains a Radius application plus Azure resources: - -```bash -rad deploy test.bicep -Building test.bicep... -Deploying Application into workspace 'w2'... -Deployment In Progress... - -Error: ResourceDeploymentClient#CreateOrUpdate: Failure sending request: StatusCode=0 -- Original Error: Code="InternalServerError" Message="Internal server error." -``` - -This error isn't very descriptive. Let's take a look at the control-plane logs to see if they can tell us more: - -```bash -rad debug-logs -``` - -After inspecting the log files, we see in the bicep-de-... log: - -``` -fail: Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware[1] -An unhandled exception has occurred while executing the request. -Azure.RequestFailedException: The client 'APP_ID' with object id 'OBJECT_ID' does not have authorization to perform action 'Microsoft.Resources/subscriptions/resourcegroups/read' over scope '/subscriptions/SUBSCRIPTION_ID/resourcegroups/radius-rg-MZ94f' or the scope is invalid. If access was recently granted, please refresh your credentials. -Status: 403 (Forbidden) -ErrorCode: AuthorizationFailed -``` - -This tells us the service principal that was configured with the Azure cloud provider was not properly configured on the target resource group. You can now add your service principal to your resource group and try your deployment again. - -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, so we can address the root error not being forwarded to the user.