1. Contents
  2. Troubleshooting Instructor Solution
  3. 1. TAs ONLY: Discussion: Components of a Functioning System

1. TAs ONLY: Discussion: Components of a Functioning System

This is the first group step of the walkthrough. You should allot 20-30 minutes (instructor discretion). This step takes place before the student setup steps of the walkthrough.

Warning

Do not allow students to do the setup before this discussion. This is a thought exercise before beginning troubleshooting for students to have an understanding of the entire system to prepare them for troubleshooting it.

Note

This should be a group discussion. Encourage points that aren’t listed below if the students go in that direction.

There isn’t an exact script for this section. At the halfway mark if the group hasn’t covered the topics listed below move the discussion in that direction.

If the students are stuck you can give them breadcrumbs in the following pattern going through each level:

  1. Use the top level bullet as a prompt to start a dialogue around that component
  2. Follow each sub-list down so everything is covered

Deployment Components

Let’s consider the components in each layer of our system.

Network Level

NSG Rules

  • what rules do you expect?
    • SSH (22)
    • HTTP (80)
    • HTTPS (443)

Service Level

KeyVault

  • a secret: database connection string
  • an access policy for our VM

AADB2C

  • tenant directory
  • linked to a subscription
  • protected API (user_impersonation scope)
  • Postman client application
  • SUSI flow

Hosting Environment Level

VM External Configuration

  • size
  • status
  • image (defines available tools)
  • system assigned identity for KV access

VM internal configuration

  • runtime dependencies
    • dotnet
    • mysql
    • nginx
  • self-signed SSL cert
  • what running services are needed?
    • embedded MySQL database server
    • NGINX web server (reverse proxy)
    • Coding Events API service
  • MySQL service configuration
    • user and database for the API
  • NGINX service configuration
    • RP configuration
    • using SSL cert
  • Coding Events API service configuration
    • unit file
    • published artifact in service directory

Application Level

  • appsettings.json (external configuration)
  • source code
    • could have issues but we will assume it is working as expected