Skip to content

Commit 312e261

Browse files
authored
Train the trainers initial session feedback integration (#175)
## Purpose <!-- Describe the intention of the changes being proposed. What problem does it solve or functionality does it add? --> Integration changes to docs contents as a result of feedback from our initial Train the Trainers session on Feb 20. ## 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) [ x] Documentation content changes [ ] Other... Please describe: ``` ## How to Test Preview site available here: https://ronline-java-aca-preview.azurewebsites.net/
1 parent 931e0b0 commit 312e261

34 files changed

+59
-56
lines changed

cleanup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If you're finished with the resources that you created for these labs, clean up
1111

1212
1. Clean up the Azure OpenAI Service instance (optional).
1313

14-
If you completed the optional [Lab 5]({% link docs/05_lab_openai/05_openlab_openai_aca.md %}), you created a new Azure OpenAI instance. Use the following command to delete it before you delete any other resources. If you didn't complete Lab 5, you can ignore this step.
14+
If you completed the optional [Lab 3]({% link docs/03_lab_openai/03_openlab_openai_aca.md %}), you created a new Azure OpenAI instance. Use the following command to delete it before you delete any other resources. If you didn't complete Lab 3, you can ignore this step.
1515

1616
```bash
1717
az cognitiveservices account delete -g $RESOURCE_GROUP -n $OPEN_AI_SERVICE_NAME

docs/01_lab_plan/0101.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,12 @@ To start, you’ll learn about the Spring Petclinic workload.
1515

1616
1. On your lab computer, open a web browser, go to [GitHub](https://github.com), and sign in to your GitHub account. If you don’t have a GitHub account, create one (go to [Join GitHub](https://github.com/join), and follow the instructions at [Signing up for a new GitHub account](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account)).
1717
1. Go to the [source folder of this lab’s GitHub repo](https://github.com/Azure-Samples/java-on-aca/tree/main/src), and review the **README.md file**.
18-
1. Learn how to run the application in dev environments. Pay particular attention to the readme sections that cover [starting services locally without Docker](https://github.com/Azure-Samples/java-on-aca/tree/main/src#starting-services-locally-without-docker), [starting services locally with docker-compose](https://github.com/Azure-Samples/java-on-aca/tree/main/src#starting-services-locally-with-docker-compose), and [starting services locally with docker-compose and Java](https://github.com/Azure-Samples/java-on-aca/tree/main/src#starting-services-locally-with-docker-compose-and-java). After you’ve configured your development environment, if time permits, consider launching the application locally using one of these methods.
19-
1. In the source folder of this lab’s GitHub repo, go to each folder that contains the code of the individual spring-petclinic-\* services and review the content.
18+
1. Review the instructions for manually running the application in your dev environment. Pay particular attention to the readme sections that cover [starting services locally without Docker](https://github.com/Azure-Samples/java-on-aca/tree/main/src#starting-services-locally-without-docker), [starting services locally with docker-compose](https://github.com/Azure-Samples/java-on-aca/tree/main/src#starting-services-locally-with-docker-compose), and [starting services locally with docker-compose and Java](https://github.com/Azure-Samples/java-on-aca/tree/main/src#starting-services-locally-with-docker-compose-and-java).
19+
20+
{: .note }
21+
At this point, you **do not** need to run the app in your dev environment using these methods. Simply reviewing and understanding how you can use these instructions is sufficient for now. However, if you've got extra time after completing the rest of this lab, feel free to try launching the application and exploring its functionality locally.
22+
23+
1. In the source folder of this lab’s GitHub repo, go to each folder that contains the code of the individual spring-petclinic-\* services and spend a few minutes reviewing the contents, familiarizing yourself with the overall code structure.
2024

2125
![microservices overview](../../images/services.png)
2226

docs/02_lab_launch/0201.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ First, you’ll need to sign your lab environment in to Azure and configure it t
1111

1212
## Step-by-step guidance
1313

14-
1. In your lab environment, open a command-line environment (Windows Subsystem for Linux, Git Bash, PowerShell, or VS Code terminal) and sign in to your Azure subscription with the following command:
14+
{: .note }
15+
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** run these commands in a PowerShell session.
16+
17+
1. In your lab environment, open a command-line environment and sign in to your Azure subscription with the following command:
1518

1619
```bash
1720
az login

docs/02_lab_launch/0203.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ By default, the MySQL database you create will have a firewall enabled that will
2222
> The server name must be globally unique, so if the randomly generated name is already in use, adjust it accordingly . Keep in mind that the name can contain only lowercase letters, numbers, and hyphens.
2323
2424
{: .note }
25-
> For simplicity’s sake, in this lab, we’re using a MySQL admin password to allow apps to connect to MySQL Server. However, we don’t recommend this when operating in a production environment. For the secured managed identity solution, refer to [Lab 04: Connect to a database securely using managed identity]({% link docs/04_lab_secrets/04_openlab_secrets_aca.md %}).
25+
> For simplicity’s sake, in this lab, we’re using a MySQL admin password to allow apps to connect to MySQL Server. However, we don’t recommend this when operating in a production environment. For the secured managed identity solution, refer to [Lab 5: Connect to a database securely using managed identity]({% link docs/05_lab_secrets/05_openlab_secrets_aca.md %}).
2626
2727
```bash
2828
MYSQL_SERVER_NAME=mysql-$APPNAME-$UNIQUEID

docs/05_lab_openai/0501.md renamed to docs/03_lab_openai/0301.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: '1. Create an Azure OpenAI account (optional)'
2+
title: '1. Create an Azure OpenAI account (Optional)'
33
layout: default
44
nav_order: 1
5-
parent: 'Lab 5: Integrate Azure OpenAI Service with your apps'
5+
parent: 'Lab 3: Integrate Azure OpenAI Service with your apps'
66
---
77

8-
# Create an Azure OpenAI account (optional)
8+
# Create an Azure OpenAI account (Optional)
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

docs/05_lab_openai/0502.md renamed to docs/03_lab_openai/0302.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ layout: default
44
nav_order: 2
55
nav_exclude: true
66
search_exclude: true
7-
parent: 'Lab 5: Integrate with Azure OpenAI'
7+
parent: 'Lab 3: Integrate with Azure OpenAI'
88
---
99

1010
Deploy the sample ai servcie `chat-agent`, and explore the power of Azure Open AI service.

docs/05_lab_openai/0503.md renamed to docs/03_lab_openai/0303.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: '3. Improve the chat service experience (optional)'
2+
title: '3. Improve the chat service experience (Optional)'
33
layout: default
44
nav_order: 6
5-
parent: 'Lab 5: Integrate Azure OpenAI Service with your apps'
5+
parent: 'Lab 3: Integrate Azure OpenAI Service with your apps'
66
---
77

8-
# Improve the chat service experience (optional)
8+
# Improve the chat service experience (Optional)
99

1010
You’ve completed this lab’s step-by-step instructions and built a chatbot that integrates with the Sprint Petclinic application. The following optional sections can extend the chat service’s capabilities and improve how users interact with it.
1111

docs/05_lab_openai/0504.md renamed to docs/03_lab_openai/0304.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '4. Review'
33
layout: default
44
nav_order: 7
5-
parent: 'Lab 5: Integrate Azure OpenAI Service with your apps'
5+
parent: 'Lab 3: Integrate Azure OpenAI Service with your apps'
66
---
77

88
# Review
@@ -11,4 +11,4 @@ In this lab, you learned how to build a Spring application-based chat service po
1111

1212
The following diagram should reflect the current state of the deployed application.
1313

14-
![lab 5 overview](../../images/acalab5.png)
14+
![lab 3 overview](../../images/acalab-openai.png)

docs/05_lab_openai/05_openai.md renamed to docs/03_lab_openai/03_openai.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '2. Create AI application from scratch'
33
layout: default
44
nav_order: 3
5-
parent: 'Lab 5: Integrate Azure OpenAI Service with your apps'
5+
parent: 'Lab 3: Integrate Azure OpenAI Service with your apps'
66
---
77

88
# Create an AI application from scratch for the Petclinic workload
@@ -15,7 +15,7 @@ You’ll start by creating a new Spring Boot service application that connects w
1515

1616
- A GitHub Copilot subscription. (If you don’t already have a subscription, try [GitHub Copilot Free](https://docs.github.com/en/copilot/quickstart#sign-up-for-github-copilot).)
1717
- The [GitHub Copilot Chat extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) installed in your copy of Visual Studio Code.
18-
- A prepared Azure OpenAI instance with the `gpt-4o` model deployed. For more details, refer to the instructions [in previous section of this lab]({% link docs/05_lab_openai/0501.md %}).
18+
- A prepared Azure OpenAI instance with the `gpt-4o` model deployed. For more details, refer to the instructions [in previous section of this lab]({% link docs/03_lab_openai/0301.md %}).
1919
- The `endpoint` and `api-key` values for your Azure OpenAI instance. You can find these by going to your Azure OpenAI instance in the Azure portal and looking in the `Resource Management` \> `Keys and Endpoint` section.
2020

2121
## Step by step guidance

docs/05_lab_openai/05_openai_existing.md renamed to docs/03_lab_openai/03_openai_existing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: 'Integrate AI to existing project'
33
layout: default
4-
nav_order: 4
4+
nav_order: 5
55
nav_exclude: true
66
search_exclude: true
7-
parent: 'Lab 5: Integrate with Azure OpenAI'
7+
parent: 'Lab 3: Integrate Azure OpenAI Service with your apps'
88
---
99

1010
# Integrate AI into your existing project

docs/05_lab_openai/05_openlab_openai_aca.md renamed to docs/03_lab_openai/03_openlab_openai_aca.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: 'Lab 5: Integrate Azure OpenAI Service with your apps'
2+
title: 'Lab 3: Integrate Azure OpenAI Service with your apps'
33
layout: default
44
nav_order: 7
55
has_children: true
66
---
77

8-
# Lab 5: Integrate Azure OpenAI Service with your applications
8+
# Lab 03: Integrate Azure OpenAI Service with your applications
99

1010
## Introduction
1111

@@ -22,7 +22,7 @@ As you work through this lab, you’ll learn how to:
2222

2323
The following image illustrates how your application’s architecture should look after you’ve completed this lab.
2424

25-
![lab 5 overview](../../images/acalab5.png)
25+
![lab 3 overview](../../images/acalab-openai.png)
2626

2727
## Duration
2828

docs/03_lab_monitor/0301.md renamed to docs/04_lab_monitor/0401.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '1. Inspect in the Azure portal'
33
layout: default
44
nav_order: 1
5-
parent: 'Lab 3: Enable monitoring'
5+
parent: 'Lab 4: Enable monitoring (Optional)'
66
---
77

88
# Inspect your Azure Container Apps environment in the Azure portal

docs/03_lab_monitor/0302.md renamed to docs/04_lab_monitor/0402.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '2. Enable Log Analytics'
33
layout: default
44
nav_order: 2
5-
parent: 'Lab 3: Enable monitoring'
5+
parent: 'Lab 4: Enable monitoring (Optional)'
66
---
77

88
# Enable Log Analytics on your Azure Container Apps environment

docs/03_lab_monitor/0303.md renamed to docs/04_lab_monitor/0403.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '3. Configure Application Insights (Optional)'
33
layout: default
44
nav_order: 3
5-
parent: 'Lab 3: Enable monitoring'
5+
parent: 'Lab 4: Enable monitoring (Optional)'
66
---
77

88
# Configure Application Insights to receive monitoring information from your applications

docs/03_lab_monitor/0304.md renamed to docs/04_lab_monitor/0404.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '4. Analyze monitoring data (Optional)'
33
layout: default
44
nav_order: 4
5-
parent: 'Lab 3: Enable monitoring'
5+
parent: 'Lab 4: Enable monitoring (Optional)'
66
---
77

88
# Analyze application-specific monitoring data

docs/03_lab_monitor/0305.md renamed to docs/04_lab_monitor/0405.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '5. Azure Managed Grafana (Optional)'
33
layout: default
44
nav_order: 5
5-
parent: 'Lab 3: Enable monitoring'
5+
parent: 'Lab 4: Enable monitoring (Optional)'
66
---
77

88
# Build a Java metrics dashboard with Azure Managed Grafana
@@ -55,30 +55,30 @@ If you’d like to learn more about how Azure Managed Grafana helps visualize ex
5555
1. Choose the default built-in `Azure Monitor` as the data source.
5656
1. Select `Import`.
5757

58-
![Import Java Metrics dashboard](../../images/acalab3-05-grafana-import-dashboard.png)
58+
![Import Java Metrics dashboard](../../images/acalab-monitoring-05-grafana-import-dashboard.png)
5959

6060
1. View the Java metrics dashboard with Grafana. Now you can explore all the supported Container Apps Java metrics. Just select your Container Apps resource from the Resource filter.
6161

6262
The dashboard provides the following live metric data:
6363

6464
- Container App Overview
6565

66-
![Container App Overview](../../images/acalab3-05-grafana-overview.png)
66+
![Container App Overview](../../images/acalab-monitoring-05-grafana-overview.png)
6767

6868
- JVM Memory Usage
6969

70-
![JVM Memory Usage](../../images/acalab3-05-grafana-jvm-mem.png)
70+
![JVM Memory Usage](../../images/acalab-monitoring-05-grafana-jvm-mem.png)
7171

7272
- JVM Memory Buffer
7373

74-
![JVM Memory Buffer](../../images/acalab3-05-grafana-jvm-buffer.png)
74+
![JVM Memory Buffer](../../images/acalab-monitoring-05-grafana-jvm-buffer.png)
7575

7676
- JVM Garbage Collection
7777

78-
![JVM GC](../../images/acalab3-05-grafana-jvm-gc.png)
78+
![JVM GC](../../images/acalab-monitoring-05-grafana-jvm-gc.png)
7979

8080
- JVM Memory Usage Analysis
8181

82-
![detailed JVM Memory Usage Analysis](../../images/acalab3-05-grafana-jvm-mem-analysis.png)
82+
![detailed JVM Memory Usage Analysis](../../images/acalab-monitoring-05-grafana-jvm-mem-analysis.png)
8383

8484
You can use this dashboard as a starting point to create your own customized metric visualizations and monitoring solutions.

docs/03_lab_monitor/0306.md renamed to docs/04_lab_monitor/0406.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '6. Review'
33
layout: default
44
nav_order: 6
5-
parent: 'Lab 3: Enable monitoring'
5+
parent: 'Lab 4: Enable monitoring (Optional)'
66
---
77

88
# Review
@@ -19,4 +19,4 @@ As part of this process, you:
1919

2020
The following image should now reflect your current application architecture.
2121

22-
![lab 3 overview](../../images/acalab3.png)
22+
![lab 4 overview](../../images/acalab-monitor.png)

docs/03_lab_monitor/03_openlab_monitoring_aca.md renamed to docs/04_lab_monitor/04_openlab_monitoring_aca.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: 'Lab 3: Enable monitoring'
2+
title: 'Lab 4: Enable monitoring (Optional)'
33
layout: default
4-
nav_order: 5
4+
nav_order: 7
55
has_children: true
66
---
77

8-
# Lab 03: Enable monitoring and end-to-end event tracing
8+
# Lab 04: Enable monitoring and end-to-end event tracing (Optional)
99

1010
## Introduction
1111

@@ -25,7 +25,7 @@ As you work through this lab, you’ll learn how to:
2525

2626
The following image shows how your application’s architecture should look once you complete this lab.
2727

28-
![lab 3 overview](../../images/acalab3.png)
28+
![lab 4 overview](../../images/acalab-monitor.png)
2929

3030
## Duration
3131

docs/04_lab_secrets/0401.md renamed to docs/05_lab_secrets/0501.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '1. Create a database admin account'
33
layout: default
44
nav_order: 1
5-
parent: 'Lab 4: Connect to a database with managed identity'
5+
parent: 'Lab 5: Connect to a database with managed identity (Optional)'
66
---
77

88
# Create a database administrator account

docs/04_lab_secrets/0402.md renamed to docs/05_lab_secrets/0502.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '2. Update app configuration'
33
layout: default
44
nav_order: 2
5-
parent: 'Lab 4: Connect to a database with managed identity'
5+
parent: 'Lab 5: Connect to a database with managed identity (Optional)'
66
---
77

88
# Update application configuration to use passwordless connectivity

docs/04_lab_secrets/0403.md renamed to docs/05_lab_secrets/0503.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '3. Connect Container Apps'
33
layout: default
44
nav_order: 3
5-
parent: 'Lab 4: Connect to a database with managed identity'
5+
parent: 'Lab 5: Connect to a database with managed identity (Optional)'
66
---
77

88
# Connect Container Apps to a database by using Azure Service Connector

docs/04_lab_secrets/0404.md renamed to docs/05_lab_secrets/0504.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '4. Review'
33
layout: default
44
nav_order: 4
5-
parent: 'Lab 4: Connect to a database with managed identity'
5+
parent: 'Lab 5: Connect to a database with managed identity (Optional)'
66
---
77

88
# Review
@@ -17,4 +17,4 @@ As part of this process, you:
1717

1818
The following diagram should reflect your application’s current architecture.
1919

20-
![lab 4 overview](../../images/acalab4.png)
20+
![lab 5 overview](../../images/acalab-managed-identity.png)

docs/04_lab_secrets/04_openlab_secrets_aca.md renamed to docs/05_lab_secrets/05_openlab_secrets_aca.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: 'Lab 4: Connect to a database with managed identity'
2+
title: 'Lab 5: Connect to a database with managed identity (Optional)'
33
layout: default
4-
nav_order: 6
4+
nav_order: 8
55
has_children: true
66
---
77

8-
# Lab 04: Connect to a database securely by using managed identity
8+
# Lab 05: Connect to a database securely by using managed identity (Optional)
99

1010
## Introduction
1111

@@ -25,7 +25,7 @@ As you work through this lab, you’ll learn how to:
2525

2626
The following diagram illustrates how your application’s architecture should look after you’ve completed this lab.
2727

28-
![lab 4 overview](../../images/acalab4.png)
28+
![lab 5 overview](../../images/acalab-managed-identity.png)
2929

3030
## Duration
3131

docs/06_lab_automation/0601.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,4 @@ search_exclude: true
5050
export AAD_USER_ID=<user-object-id>
5151
```
5252

53-
{: .note }
54-
> If you run the automation in PowerShell, export environment variables with commands like
55-
```pwsh
56-
$env:USER_NAME=<user-name>
57-
$env:AAD_USER_ID=<aad-user-id>
58-
```
53+

docs/06_lab_automation/06_openlab_automation.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,10 @@ During this lab, you will:
4444
- This version of azd templates includes most operations in:
4545

4646
- [Lab 2: Launch a Spring Apps microservices application to Azure Container Apps]({% link docs/02_lab_launch/02_openlab_setup_aca.md %})
47-
- [Lab 3: Enable monitoring and end-to-end tracing]({% link docs/03_lab_monitor/03_openlab_monitoring_aca.md %})
48-
- [Lab 4: Connect to Database securely using identity]({% link docs/04_lab_secrets/04_openlab_secrets_aca.md %})
49-
- [Lab 5: Integrate with Azure OpenAI]({% link docs/05_lab_openai/05_openlab_openai_aca.md %})
47+
- [Lab 3: Integrate with Azure OpenAI]({% link docs/03_lab_openai/03_openlab_openai_aca.md %})
48+
- [(Optional) Lab 4: Enable monitoring and end-to-end tracing]({% link docs/04_lab_monitor/04_openlab_monitoring_aca.md %})
49+
- [(Optional) Lab 5: Connect to Database securely using identity]({% link docs/05_lab_secrets/05_openlab_secrets_aca.md %})
50+
5051

5152
- By default, the automation process will create MySQL server admin password with random string, you can reset the admin password in either way:
5253

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)