Skip to content

Commit

Permalink
Misc changes (#171)
Browse files Browse the repository at this point in the history
* Add dotnet --list-sdks and note about version

* Update .NET 8 patch version

* Add note to adhere closely to prereqs and not use PS 5.1

* Add PowerShell version check

* Add Hyper-V requirement for Windows

* Add new troubleshooting page

* Clarify dapr init
  • Loading branch information
simonkurtz-MSFT authored Jan 28, 2025
1 parent 390d8a4 commit aa7dc5c
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 4 deletions.
10 changes: 8 additions & 2 deletions docs/aca/00-workshop-intro/4-prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,22 @@ nav_order: 4

The workshop is divided into separate modules. Each module will guide you through building the solution code step-by-step. Ensure that you finish the modules in the right order as they have dependencies on each other.

!!! note
Please follow these prerequisites exactly. We understand you have many choices in tooling and personal preferences. However, adhering closely to the workshop's approach increases the likelihood of your success with these labs.

Make sure you have your development environment set up and configured.

1. An Azure account with an active subscription - [Create an account for free](https://azure.microsoft.com/free/?ref=microsoft.com&utm_source=microsoft.com&utm_medium=docs&utm_campaign=visualstudio){target=_blank}
1. .NET SDK 8 or a higher version (we primarily focus on LTS versions) - [Install](https://dotnet.microsoft.com/download){target=_blank}
1. PowerShell 7.0 or higher version (For Windows Users only!) - [Install](https://learn.microsoft.com/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.4#installing-the-msi-package){target=_blank}
> [Do not use PowerShell 5.1!](https://github.com/Azure/aca-dotnet-workshop/issues/150){target=_blank}
> If you are unsure which version of PowerShell is running, you can execute `$PSVersionTable.PSVersion` in a PowerShell terminal.
1. On Windows, please [ensure that Hyper-V is enabled](https://learn.microsoft.com/virtualization/windowscontainers/deploy-containers/linux-containers){target=_blank} to run Linux containers in Docker.
1. Docker Desktop - [Install](https://docs.docker.com/desktop/install/windows-install/){target=_blank}
> As of November 2024, Docker Desktop continues to be free for education purposes. Please consult the [Docker Desktop license agreement](https://docs.docker.com/subscription/desktop-license/) for any updates.
1. Visual Studio Code - [Install](https://code.visualstudio.com/){target=_blank}
1. VS Code Docker extension - [Install](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker){target=_blank}
1. Dapr CLI - [Install](https://docs.dapr.io/getting-started/install-dapr-cli/){target=_blank} and [Initialize](https://docs.dapr.io/getting-started/install-dapr-selfhost/){target=_blank}
1. Dapr CLI - [Install](https://docs.dapr.io/getting-started/install-dapr-cli/){target=_blank} and [Initialize](https://docs.dapr.io/getting-started/install-dapr-selfhost/){target=_blank}(`dapr init`, not `dapr init --slim`, as we need configuration and containers in place)
1. VS Code Dapr extension. Depends on Dapr CLI - [Install](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-dapr){target=_blank}
1. Azure CLI - [Install](https://docs.microsoft.com/cli/azure/install-azure-cli){target=_blank}
1. Git CLI - [Install](https://git-scm.com){target=_blank}
Expand All @@ -30,7 +36,7 @@ Make sure you have your development environment set up and configured.

This workshop typically spans several days. As such, you may close your tools, end CLI sessions, reboot, or simply want to persist working implementations in a repository as each module builds upon the one before it. A local Git repository can help.

- Open a command-line terminal and create a folder for your project, then switch to that folder.
- Open a command-line terminal and create this folder for the workshop, then switch to that folder.

=== "Windows"
```shell
Expand Down
2 changes: 1 addition & 1 deletion docs/aca/01-deploy-api-to-aca/global-dotnet8.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"sdk": {
"version": "8.0.403",
"version": "8.0.405",
"rollForward": "latestFeature"
}
}
5 changes: 4 additions & 1 deletion docs/aca/01-deploy-api-to-aca/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,13 @@ In this module, we will accomplish three objectives:

- If a terminal is not yet open, from VS Code's *Terminal* tab, select *New Terminal* to open a (PowerShell) terminal in the project folder *TasksTracker.ContainerApps* (also referred to as *root*).

- We need to define the .NET version we will use throughout this workshop. In the terminal execute `dotnet --info`. Take note of the intalled .NET SDK versions and select the one with which you wish to proceed.
- We need to define the .NET version we will use throughout this workshop. In the terminal execute `dotnet --info` or, more specifically, `dotnet --list-sdks`. Take note of the intalled .NET SDK versions and select the one with which you wish to proceed.

- In the root folder create a new file and set the .NET SDK version from the above command:

!!! note
The version in the *global.json* files below may be outdated. Please ensure you use the correct versions based on what is on your machine.

=== ".NET 8"

=== "global.json"
Expand Down
21 changes: 21 additions & 0 deletions docs/aca/30-appendix/04-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Troubleshooting
parent: Appendix
has_children: false
nav_order: 5
---

## Troubleshooting

You may encounter some challenges while progressing through this workshop. Please [update or create an issue](https://github.com/Azure/aca-dotnet-workshop/issues?q=is%3Aissue){target=_blank} to help us resolutions below. Thank you!

### Dapr

#### ERR_DIRECT_INVOKE

![dapr-vscode-extension](../../assets/images/appendix/dapr-err-direct-invoke.png)

If you encounter an `ERR_DIRECT_INVOKE` error with Dapr, check that ...

- You have [installed and initialized Dapr](../00-workshop-intro/4-prerequisites.md){target=_blank}, and
- You do not have a restrictive VPN or firewall running.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ nav:
- Debug and Launch Dapr Applications in VSCode: aca/30-appendix/01-run-debug-dapr-app-vscode.md
- Testing Changes Locally or with GitHub Codespaces: aca/30-appendix/02-github-local-codespaces.md
- Variables: aca/30-appendix/03-variables.md
- Troubleshooting: aca/30-appendix/04-troubleshooting.md

theme:
name: material
Expand Down

0 comments on commit aa7dc5c

Please sign in to comment.