Skip to content

Commit 385f0e5

Browse files
sonwan2020rotycenh
andauthored
more notes on the lab steps (#177)
## Purpose add more notes ## Does this introduce a breaking change? <!-- Mark one with an "x". --> ``` [ ] Yes [x] No ``` ## Pull Request Type What kind of change does this Pull Request introduce? <!-- Please check the one that applies to this PR using "x". --> ``` [ ] Bugfix [ ] Feature [ ] Code style update (formatting, local variables) [ ] Refactoring (no functional changes, no api changes) [ ] Documentation content changes [x] Other... Please describe: ``` --------- Co-authored-by: Tycen Hopkins <[email protected]>
1 parent 723d6e9 commit 385f0e5

File tree

9 files changed

+44
-9
lines changed

9 files changed

+44
-9
lines changed

docs/02_lab_launch/0202.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This involves three things:
2020
2121
## Step-by-step guidance
2222

23+
2324
1. Run the following commands to create a resource group, which you’ll use for all subsequent resources that you’ll create in this lab. Replace the \<*azure-region*\> placeholder with the name of the Azure region you want to use:
2425

2526
```bash
@@ -63,7 +64,12 @@ This involves three things:
6364
SUBNET_ID=$(az network vnet subnet show --resource-group $RESOURCE_GROUP --vnet-name $VIRTUAL_NETWORK_NAME --name aca-subnet --query id -o tsv)
6465
```
6566

66-
1. Create a new Azure Container Apps environment in your resource group, and configure it to use the new subnet. We’ll be creating the service on an [Azure Container Apps Dedicated plan](https://learn.microsoft.com/azure/container-apps/plans#dedicated) using the [workload profiles](https://learn.microsoft.com/azure/container-apps/workload-profiles-overview) option. This plan gives you more advanced features than the alternative [Azure Container Apps Consumption plan](https://learn.microsoft.com/azure/container-apps/plans#consumption) type:
67+
1. Create a new Azure Container Apps environment in your resource group, and configure it to use the new subnet.
68+
69+
{: .note}
70+
> If you've already successfully run the `create-azure-resources.sh` script discussed in the [installation instructions]({% link install.md %}#preparing-your-subscription), you can skip this step.
71+
72+
We’ll be creating the service on an [Azure Container Apps Dedicated plan](https://learn.microsoft.com/azure/container-apps/plans#dedicated) using the [workload profiles](https://learn.microsoft.com/azure/container-apps/workload-profiles-overview) option. This plan gives you more advanced features than the alternative [Azure Container Apps Consumption plan](https://learn.microsoft.com/azure/container-apps/plans#consumption) type:
6773
6874
```bash
6975
ACA_ENVIRONMENT=acalab-env-$APPNAME-$UNIQUEID
@@ -90,4 +96,4 @@ This involves three things:
9096
> If you don't immediately find the Container Apps environment in the resource group overview list, wait a moment and then select `Refresh` a few times until it appears.
9197

9298
{: .note }
93-
> You may also notice an additional resource group (beginning with “ME_”) in your subscription. This resource group, which you created in this set of steps, will also contain any associated resources created to support the Container Apps environment and virtual network.
99+
> You may also notice an additional resource group (beginning with “ME_”) in your subscription. This resource group, which you created in this set of steps, will also contain any associated resources created to support the Container Apps environment and virtual network.

docs/02_lab_launch/0203.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ By default, the MySQL database you create will have a firewall enabled that will
1616
1717
## Step-by-step guidance
1818

19+
{: .note}
20+
> If you've already successfully run the `create-azure-resources.sh` script discussed in the [installation instructions]({% link install.md %}#preparing-your-subscription), skip to step 2.
21+
1922
1. To create an Azure Database for MySQL - Flexible Server instance, run the following commands. Replace the \<*sqladmin-password*\> placeholder with a complex password, and record its value.
2023

2124
{: .note }

docs/02_lab_launch/0206.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,13 @@ To give your Container Apps environment secure access to the container registry,
1313

1414
## Step-by-step guidance
1515

16+
{: .note}
17+
> If you've already successfully run the `create-azure-resources.sh` script discussed in the [installation instructions]({% link install.md %}#preparing-your-subscription), skip to step 2.
18+
1619
1. Create a container registry instance to build and save your container images.
1720

21+
Note: Skip this step if ./tools/create-azure-resources.sh runs succeed.
22+
1823
```bash
1924
MYACR=acr$APPNAME$UNIQUEID
2025
az acr create \

docs/03_lab_openai/0301.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ parent: 'Lab 3: Integrate Azure OpenAI Service with your apps'
99

1010
Before you can add AI capabilities to your application, you need to create an Azure OpenAI account and deploy the language models that you want to use.
1111

12-
{: .note }
13-
> If you already have valid `AZURE-OPENAI-ENDPOINT` and `AZURE-OPENAI-API-KEY` values to use for your new Azure OpenAI instance, skip this section.
12+
{: .note}
13+
> If you've already successfully run the `create-azure-resources.sh` script discussed in the [installation instructions]({% link install.md %}#preparing-your-subscription), or if you already have valid `AZURE-OPENAI-ENDPOINT` and `AZURE-OPENAI-API-KEY` values for an existing Azure OpenAI instance, you can skip this section.
1414
1515
The following step-by-step guidance will show you how to create an Azure OpenAI account using the Azure CLI. If you’d like to learn more about creating these accounts, see the following documentation: [Create and deploy an Azure OpenAI Service resource](https://learn.microsoft.com/azure/ai-services/openai/how-to/create-resource)
1616

docs/04_lab_monitor/0402.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ To learn more about how Log Analytics works with Azure Container Apps, review:
2222

2323
## Step-by-step guidance
2424

25+
{: .note}
26+
> If you've already successfully run the `create-azure-resources.sh` script discussed in the [installation instructions]({% link install.md %}#preparing-your-subscription), skip to step 2.
27+
2528
1. In your command-line environment, create a new Log Analytics workspace:
2629

2730
```bash

docs/04_lab_monitor/0403.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ For additional information on how this works, review:
2626

2727
## Step-by-step guidance
2828

29+
{: .note}
30+
> If you've already successfully run the `create-azure-resources.sh` script discussed in the [installation instructions]({% link install.md %}#preparing-your-subscription), skip to step 2.
31+
2932
1. Your first step is to create an Application Insights resource. Execute this statement in your command-line environment:
3033

3134
```bash

docs/04_lab_monitor/0405.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ If you’d like to learn more about how Azure Managed Grafana helps visualize ex
1818

1919
## Step-by-step guidance
2020

21+
{: .note}
22+
> If you've already successfully run the `create-azure-resources.sh` script discussed in the [installation instructions]({% link install.md %}#preparing-your-subscription), skip to step 2.
23+
2124
1. Provision Azure Managed Grafana. In your command-line environment, create an Azure Managed Grafana instance:
2225

2326
Azure Managed Grafana is not supported in all regions. You can refer to the [Azure OpenAI global standard model availability](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#models-by-deployment-type) documentation for more details if you'd like.

install.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -176,12 +176,14 @@ After all these tools are installed, you can get started:
176176

177177
## Preparing your subscription
178178

179-
With your development environment set up, you're now going to run a couple scripts to perform some setup tasks on you lab subscription and then automate the deployment of some required Azure resources that you'll use during the labs.
179+
With your development environment set up, you're now going to use some scripts to perform some subscription configuration and also deploy some Azure resources that you'll use during the labs.
180180

181181

182182
{: .note }
183183
We'll be using Bash commands to complete this lab. You can use any compatible command-line environment, such as the Windows Subsystem for Linux, Git Bash, or the Visual Studio Code Bash terminal. To avoid potential errors, **do not** attempt to run these commands in a PowerShell session.
184184
185+
### Sign into Azure
186+
185187
Before you run the scripts, you'll need to sign in to Azure and configure it to access your lab subscription.
186188

187189
1. In your lab environment, open a command-line environment and sign in to your Azure subscription with the following command:
@@ -207,7 +209,9 @@ Before you run the scripts, you'll need to sign in to Azure and configure it to
207209
az account set --subscription <subscription-id>
208210
```
209211

210-
Once you're signed in you can start running the setup scripts. The first script, `prepare.sh`, will register the required resources providers, and add any necessary extensions to Azure CLI.
212+
### Run the subscription preparation script
213+
214+
Now you'll run the script `prepare.sh` to register the required resources providers on your lab subscription, and also add any necessary extensions to the Azure CLI.
211215
212216
1. In your command line windows, go to the root of the `java-on-aca` folder and run the script `./tools/prepare.sh`.
213217
@@ -217,10 +221,14 @@ Once you're signed in you can start running the setup scripts. The first script,
217221
218222
This process should take less than 10 minutes to complete.
219223
220-
Once the `prepare.sh` script finishes, you can proceed with creating the base Azure resource dependencies you'll use as you work through the labs. You'll do this using the script `create-azure-resource.sh`.
224+
1. Once the `prepare.sh` script finishes, close your current terminal window and start a new terminal session to access your fully prepared lab environment.
225+
226+
### Run the resource creation script
227+
228+
You'll now need to run the script `create-azure-resource.sh`, which will create several of the Azure resource dependencies that you'll use in the labs.
221229
222230
1. Before running the script, you'll need to edit the file `./tools/azure-resource.profile` in a code editor and update the following values:
223-
231+
224232
- `UNIQUEID` - Create a unique ID string and paste that in the code editor. You can use the following command generate an acceptable value: `openssl rand -hex 3`
225233
- `SUBSCRIPTION` - Enter the ID of the subscription you're going to work in. To quickly find this id, use the following command: `az account show --query id`
226234
- `REGION` - Enter the default Azure region you want to work in. For example `westus` or `southindia`.
@@ -257,4 +265,4 @@ Once the `prepare.sh` script finishes, you can proceed with creating the base Az
257265
>
258266
> You can also manually load the saved variables with the command `loadenv`.
259267
>
260-
> You can use these commands at any time, so feel free to run `saveenv` after creating or updating environment variables when working through the labs, or `loadenv` to reload your saved variables as needed.
268+
> You can use these commands at any time, so feel free to run `saveenv` after creating or updating environment variables when working through the labs, or `loadenv` to reload your saved variables as needed.

tools/create-azure-resource.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,7 @@ else
136136
--parameters grafanaName=$GRAFANA_NAME location=$GRAFANA_LOCATION \
137137
--output table
138138
fi
139+
140+
# Save environment variables
141+
142+
saveenv

0 commit comments

Comments
 (0)