Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kkgthb/web-site-dotnet-02-azure-app-config

Display a value from Azure's App Configuration service in a website's HTML
https://github.com/kkgthb/web-site-dotnet-02-azure-app-config

Last synced: about 1 month ago
JSON representation

Display a value from Azure's App Configuration service in a website's HTML

Host: GitHub
URL: https://github.com/kkgthb/web-site-dotnet-02-azure-app-config
Owner: kkgthb
Created: 2023-08-25T15:18:59.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-09-11T22:27:35.000Z (over 1 year ago)
Last Synced: 2023-09-12T06:42:24.888Z (over 1 year ago)
Language: C#
Size: 24.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# A tiny ASP.NET website that displays values from Azure App Configuration

## NEXT STEPS

1. Play with Key Vault.
2. Play with Key Vault and sentinel values. (Do they help update Key Vault?)
3. And what's this 3rd thing "periodically reload..."? How does/doesn't it interact w/ sentinel usage?
* https://learn.microsoft.com/en-us/azure/azure-app-configuration/reload-key-vault-secrets-dotnet
4. And how do you avoid overprogramming or toe-stepping with "SetSecretRefreshInterval" vs. "ConfigureRefresh"?

---

## Prerequisites

1. To play with this on your local computer, you must install the .NET runtime _(preferably version 7, as that's what I coded this using)_ onto your local machine in a way that lets you run commands beginning with "`dotnet`" from your computer's command prompt _(the "dotnet" executable must be in your "PATH.")_.
* Don't have Windows admin rights? Check out David Kou's [Install the .NET runtime onto Windows without admin rights](https://dev.to/davidkou/install-anything-without-admin-rights-4p0j#install-dotnet-sdk-or-runtime-without-admin).
1. You must download a copy of this codebase onto your local computer.
1. Assign the "App Configuration Data Reader" role to whatever Azure AD identity will be logging into Azure App Configuration for this runtime. Plain old "Owner" or "Contributor" isn't adequate. Wait up to 15 minutes before you stop getting 403 errors.
1. It seems actually having a key-value pair or something else in the App Configuration resource also helps avoid 403 errors.
1. Assign the "Key Vault Secrets User" role to whatever Azure AD identity will be logging into Azure App Configuration for this runtime. Plain old "Owner" or "Contributor" isn't adequate.
1. You personally may also need "Key Vault Administrator" to go into the Azure portal and set up secrets in Key Vault.
1. Create the following secrets in your Key Vault resource:
* `indirectlyAccessedSecretFlavorPullUpdate-nonprod` with a value of "`sausage`".
* `indirectlyAccessedSecretFlavorStatic-nonprod` with a value of "`anchovy`".
* `indirectlyAccessedSecretFlavorSentinellessPull-nonprod` with a value of "`feta`".
* `indirectlyAccessedSecretFlavorPushUpdate-nonprod` with a value of "`basil`".
* `directlyAccessedSecretFlavorPullUpdate-nonprod` with a value of "`oregano`".
* _(Note: I didn't get time to implement actually using the KeyVault SDK to fetch this directly in time for the demo.)_
1. Create the following key-value pairs in your Azure App Configuration resource:
* `my-pizza-app:pull-update:sentinel-for-pull-update` with a label of "`nonprod`" and a value of "`pull attempt 1`".
```sh
az appconfig kv set --key "my-pizza-app:pull-update:sentinel-for-pull-update" --label "nonprod" --value "pull attempt 1" --name "INSERT-YOUR-APP-CONFIG-RESOURCE-NAME-HERE"
```
* `my-pizza-app:push-update:sentinel-for-push-update` with a label of "`nonprod`" and a value of "`push attempt 1`".
* `my-pizza-app:pull-update:topping-non-secret-pull-update` with a label of "`nonprod`" and a value of "`pimiento`".
* `my-pizza-app:static:topping-non-secret-static` with a label of "`nonprod`" and a value of "`pineapple`".
* `my-pizza-app:push-update:topping-non-secret-push-update` with a label of "`nonprod`" and a value of "`pepperoni`".
1. Create the following Key Vault references in your Azure App Configuration resource:
* `my-pizza-app:pull-update:pizza-flavor-indirect-secret-pull-update` with a label of "`nonprod`" and a secret reference pointing to "`indirectlyAccessedSecretFlavorPullUpdate-nonprod`".
* `my-pizza-app:static:topping-indirect-secret-static` with a label of "`nonprod`" and a secret reference pointing to "`indirectlyAccessedSecretFlavorStatic-nonprod`".
* `my-pizza-app:sentinelless-pull:topping-indirect-secret-sentinelless-pull` with a label of "`nonprod`" and a secret reference pointing to "`indirectlyAccessedSecretFlavorSentinellessPull-nonprod`".
* `my-pizza-app:push-update:topping-indirect-secret-push-update` with a label of "`nonprod`" and a secret reference pointing to "`indirectlyAccessedSecretFlavorPushUpdate-nonprod`".
1. Create the following feature flag in your Azure App Configuration resource:
* `my-pizza-app--percentage-enabled--release-red-sauce` with "Enable feature flag" checked, a label of "`nonprod`," "Use feature filter" checked, and a custom filter added with a name of "`Microsoft.Percentage`," a parameter name of "`Value`," and a Value of "`33`."
1. Log your Azure CLI into Azure.
* _(For good measure, do `azure logout` and then `azure login` if it's been a while since you played with this codebase.)_
1. Find and replace all occurrences of "`INSERT-YOUR-APP-CONFIG-RESOURCE-NAME-HERE`" under the `src/web` folder of this codebase with the actual name of your Azure App Configuration resource.

---

## Building source code into a runtime

Open up a command line interface.

Ensure that its prompt indicates that your commands will be running within the context of the folder into which you downloaded a copy of this codebase.

Run the following command:

```sh
(cd ./src/web && dotnet publish --configuration Release --output ../../my_output && cd ../..)
```

The above command should execute within a second or two.

* It will add a new subfolder called `/bin/` as well as one called `/obj/` into `/src/web/` within the folder on your computer containing a copy of this codebase, but you can ignore those.
* More importantly, it will add a new subfolder called `/my_output/` into the top level of the folder on your computer containing a copy of this codebase.

Congratulations -- you have now built an executable "runtime" for ASP.NET that, when executed, will behave as a web server.

The entirety of your "runtime" that you just built lives in the `/my_output/` folder. It should contain about 6 files, including one called `Handwritten.exe`.

---

## Running your web server

Open up a command line interface.

Ensure that its prompt indicates that your commands will be running within the context of the folder into which you downloaded a copy of this codebase.

Run the following command:

```sh
./my_output/Handwritten.exe
```

* **WARNING**: Do _not_ close the command line just yet or it will be difficult to stop your web server later in this exercise.

The output you will see will say something like:

```
info: Microsoft.Hosting.Lifetime[14]
Now listening on: http://localhost:5000
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
Hosting environment: Production
info: Microsoft.Hosting.Lifetime[0]
Content root path: C:\example
```

---

## Visiting your website

Open a web browser and navigate to [http://localhost:5000/api/sayhello](http://localhost:5000/api/sayhello) _(being sure to use an alternative port number to `5000` if indicated "`now listening on`" message you saw when you executed your runtime)_.

Take a look in the upper-left corner of the webpage you just visited: it should say "**Hello World**".

---

## Trying key-value updates

1. Reload the page a dozen or so times. Note that because we've set the "red sauce" feature to only be enabled 33% of the time, you should see it mention white sauce about 2/3 of the time and red sauce about 1/3 of the time.
1. In App Configuration, change the value of "`my-pizza-app:pull-update:topping-non-secret-pull-update`" to "`pimiento 2`". Wait 15 seconds, reload the webpage twice, and validate that it still says "`pimiento`".
1. In App Configuration, change the value of "`my-pizza-app:static:topping-non-secret-static`" to "`pineapple 2`". Wait 15 seconds, reload the webpage twice, and validate that it still says "`pineapple`".
1. In App Configuration, change the value of "`my-pizza-app:push-update:topping-non-secret-push-update`" to "`pepperoni 2`". Wait 5 seconds, reload the webpage twice, and validate that it still says "`pepperoni`".
1. In Key Vault, create a new version of "`indirectlyAccessedSecretFlavorPullUpdate-nonprod`" with a value of "`sausage 2`". Wait 15 seconds, reload the webpage twice, and validate that it still says "`sausage`".
1. In Key Vault, create a new version of "`indirectlyAccessedSecretFlavorStatic-nonprod`" with a value of "`anchovy 2`". Wait 15 seconds, reload the webpage twice, and validate that it still says "`anchovy`".
1. In Key Vault, create a new version of "`indirectlyAccessedSecretFlavorSentinellessPull-nonprod`" with a value of "`feta 2`". Wait 15 seconds, reload the webpage twice, and validate that it now says "`feta 2`".
* You should also see server logs after the first reload of this step, and before the second, reading something like this:
```
info: Microsoft.Extensions.Configuration.AzureAppConfiguration.Refresh[0]
Setting updated from Key Vault. Key:'my-pizza-app:sentinelless-pull:topping-indirect-secret-sentinelless-pull'
```
1. Change the value of "`my-pizza-app:pull-update:sentinel-for-pull-update`" to "`pull attempt 2`". Wait 15 seconds, reload the webpage twice, and validate that it now says "`pimiento 2`" and "`sausage 2`" but still just "`pineapple`" and "`anchovy`".
* You should also see server logs after the first post-sentinel-edit reload, and before the second, reading something like this:
```
info: Microsoft.Extensions.Configuration.AzureAppConfiguration.Refresh[0]
Setting updated. Key:'my-pizza-app:pull-update:sentinel-for-pull-update'
Configuration reloaded.
```
* You might also see something like:
```
info: Microsoft.Extensions.Configuration.AzureAppConfiguration.Refresh[0]
Setting updated from Key Vault. Key:'my-pizza-app:pull-update:pizza-flavor-indirect-secret-pull-update'
```
1. Change the value of "`my-pizza-app:push-update:sentinel-for-push-update`" to "`push attempt 2`". Wait 20 seconds, reload the webpage twice, and validate that it now says "`pepperoni 2`".
* You should also see server logs after the first post-sentinel-edit reload, and before the second, reading something like this:
```
info: Microsoft.Extensions.Configuration.AzureAppConfiguration.Refresh[0]
Setting updated. Key:'my-pizza-app:push-update:sentinel-for-push-update'
Configuration reloaded.
```

---

## Stopping your web server

Go back to the command line interface from which you ran `./my_output/Handwritten.exe`.

Hold Ctrl and hit c, then release them both.

---

## Notes

* Even if you set your sentinel-polling lifecycle to 15 seconds and let 15 seconds elapse, .NET won't actually bother to poll Azure App Config and check whether "sentinel" has been updated until some sort of URL _(not necessarily a valid one, just one)_ gets actually visited. Therefore, don't be surprised if you have to reload your web page twice to see your changes. _(Or visit some other page and then reload the page on which you want to see your changes.)_