Skip to content

Commit 9d6a636

Browse files
committed
Readme update
1 parent bd5482c commit 9d6a636

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ Typical uses would be deployment to Kubernetes, demos of Docker, CI/CD (build pi
88

99
The app has several basic pages accessed from the top navigation menu, some of which are only lit up when certain configuration variables are set (see 'Optional Features' below):
1010

11-
- **'Info'** - Will show system & runtime information, and will also display if the app is running from within a Docker container and Kubernetes.
12-
- **'Tools'** - Some tools useful in demos, such a forcing CPU load (for autoscale demos), and error/exception pages for use with App Insights or other monitoring tool.
13-
- **'Monitoring'** - Displays realtime CPU load and memory working set charts, fetched from an REST API (/api/monitoringdata) and displayed using chart.js
14-
- **'Weather'** - (Optional) Gets the location of the client page (with HTML5 Geolocation). The resulting location is used to fetch a weather forecast from the [OpenWeather API](https://openweathermap.org/)
15-
- **'User Account'** - (Optional) When configured with Azure AD (application client id and secret) user login button will be enabled, and an user-account details page enabled, which calls the Microsoft Graph API
11+
- **Info** - Will show system & runtime information, and will also display if the app is running from within a Docker container and Kubernetes.
12+
- **Tools** - Some tools useful in demos, such a forcing CPU load (for autoscale demos), and error/exception pages for use with App Insights or other monitoring tool.
13+
- **Monitoring** - Displays realtime CPU load and memory working set charts, fetched from an REST API and displayed using chart.js
14+
- **Weather** - (Optional) Gets the location of the client page (with HTML5 Geolocation). The resulting location is used to fetch a weather forecast from the [OpenWeather API](https://openweathermap.org/)
15+
- **User Account** - (Optional) When configured with Azure AD (application client id and secret) user login button will be enabled, and an user-account details page enabled, which calls the Microsoft Graph API
1616

1717
![screen](https://user-images.githubusercontent.com/14982936/71717446-0bc47400-2e10-11ea-8db2-1db5b991d566.png)
1818
![screen](https://user-images.githubusercontent.com/14982936/71717448-0bc47400-2e10-11ea-8bf0-5115d4c8c4a4.png)
@@ -91,19 +91,13 @@ The app can easily be deployed to Kubernetes using Helm, see [deploy/kubernetes/
9191

9292
# GitHub Actions CI/CD
9393

94-
A working set of CI and CD release GitHub Actions workflows are provided `.github/workflows/`, automated builds are run in GitHub hosted runners
94+
A set of CI and CD release GitHub Actions workflows are provided in `.github/workflows/`, automated builds are run in GitHub hosted runners
9595

96-
### [GitHub Actions](https://github.com/benc-uk/dotnet-demoapp/actions)
97-
98-
[![](https://img.shields.io/github/workflow/status/benc-uk/dotnet-demoapp/CI%20Build%20App)](https://github.com/benc-uk/dotnet-demoapp/actions?query=workflow%3A%22CI+Build+App%22)
99-
100-
[![](https://img.shields.io/github/workflow/status/benc-uk/dotnet-demoapp/CD%20Release%20-%20AKS?label=release-kubernetes)](https://github.com/benc-uk/dotnet-demoapp/actions?query=workflow%3A%22CD+Release+-+AKS%22)
101-
102-
[![](https://img.shields.io/github/last-commit/benc-uk/dotnet-demoapp)](https://github.com/benc-uk/dotnet-demoapp/commits/master)
96+
[![](https://img.shields.io/github/workflow/status/benc-uk/dotnet-demoapp/CI%20Build%20App)](https://github.com/benc-uk/dotnet-demoapp/actions?query=workflow%3A%22CI+Build+App%22) [![](https://img.shields.io/github/workflow/status/benc-uk/dotnet-demoapp/CD%20Release%20-%20AKS?label=release-kubernetes)](https://github.com/benc-uk/dotnet-demoapp/actions?query=workflow%3A%22CD+Release+-+AKS%22) [![](https://img.shields.io/github/last-commit/benc-uk/dotnet-demoapp)](https://github.com/benc-uk/dotnet-demoapp/commits/master)
10397

10498
# Optional Features
10599

106-
The app will start up and run with zero configuration, however the only features that will be available will be the Info, Tools & Monitoring views. The following optional features can be enabled:
100+
The app will start up and run with zero configuration, however the only features that will be available will be the *Info*, *Tools* & *Monitoring* views. The following optional features can be enabled:
107101

108102
### Application Insights
109103

@@ -174,12 +168,14 @@ If running locally, and using appsettings.Development.json, this can be configur
174168

175169
If you want to deploy to an Azure Container App, a Bicep template is provided in the [deploy](deploy/) directory
176170

177-
For a super quick deployment, use `make deploy` which will deploy to a resource group, demoapps and deploy the latest image hosted in GitHub
171+
For a quick deployment, use `make deploy` which will create a resource group, the Azure Container App instance (with supporting resources) and deploy the latest image to it
178172

179173
```bash
180174
make deploy
181175
```
182176

177+
> Note. Azure Container App doesn't currently support HTTP header forwarding, so Azure AD sign-in will not work as it mis-redirects to the wrong URL
178+
183179
# Updates
184180

185181
- Nov 2021 - Large scale rewrite to .NET 6

0 commit comments

Comments
 (0)