From 0418e321bb2e6806f87607c13ccd2a89c09d5c25 Mon Sep 17 00:00:00 2001 From: Ashish Verma Date: Tue, 13 Sep 2022 09:54:38 -0400 Subject: [PATCH] Updated readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3852de34..11fc2bd2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This project helps you deploy AKS using different patterns using terraform. ## Requirements -- **Linux** At this time you need to use Linux environments. If you are using windows, you can [install WSL by following instructions here](https://docs.microsoft.com/en-us/windows/wsl/install). +- **Operating System** At this time we only have linux scripts available and thats why you need to use Linux environments. If you are using windows, you can [install WSL by following instructions here](https://docs.microsoft.com/en-us/windows/wsl/install). If you are using MacOS, it should work but never tested. - **Terraform** As we will be using terraform to create resources, you need to [install terraform by following instructions here](https://learn.hashicorp.com/tutorials/terraform/install-cli). ## Instructions @@ -15,10 +15,14 @@ This project helps you deploy AKS using different patterns using terraform. - You can run these scripts in following format - `/bin/bash scriptname.sh pattern-name` - For example, `/bin/bash apply.sh aks-standard-lb-2` -- Be sure to destroy the infrastucre after you are done with your tests using destroy script. +- Be sure to destroy the infrastructure after you are done with your tests using destroy script. ## Patterns |Name|Description| ------|---------- aks-standard-lb-2 | This deploys a public aks cluster with standard lb egress type| +aks-private-standard-lb | This deploys a private aks cluster with standard lb egress trype +aks-udr-firewall | This deploys private aks cluster with egress type userDefinedRouting. This uses Azure Firewall to restrict egress traffic and all [required egress traffic](https://docs.microsoft.com/en-us/azure/aks/limit-egress-traffic#required-outbound-network-rules-and-fqdns-for-aks-clusters) is allowed. +aks-udr-firewall-2 | **Under Construction.** This will replace aks-udr-firewall and will rely on newer terraform modules. +aks-standard-lb | *Deprecated*