diff --git a/README.md b/README.md index 52ad6f77..c2a237bf 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,13 @@ The guiding principal we have for this project is to focus on providing a soluti Additionally, the solution is desired to be easy to use and to support that is built with support for [Github Codespaces](https://github.com/features/codespaces) along with the [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/). -## Features +## Setup + +__Features__ -This solution uses features of Azure that are in Public Preview and might require some features to be registered for use. +This solution makes use of features in Azure that are in Public Preview and might require some features to be registered for use. -Register the AzureServiceMeshPreview feature flag by using the az feature register command: +Register the _AzureServiceMeshPreview_ feature flag by using the az feature register command: ```bash az feature register --namespace "Microsoft.ContainerService" --name "AzureServiceMeshPreview" @@ -36,7 +38,11 @@ When the status reflects Registered, refresh the registration of the Microsoft.C az provider register --namespace Microsoft.ContainerService ``` -## Setup +This solution uses Resource Group Scoped Deployments which is an Alpha Feature for the Azure Developer CLI. + +```bash +azd config set alpha.resourceGroupDeployments on # Enable Alpha Feature +``` __Login__ @@ -44,7 +50,7 @@ Log into the Azure CLI from a command line and set the subscription. If running with windows ensure that Azure Powershell is connected as well. ```bash -azd auth login # (Optional) --use-device-code +azd auth login ``` __Environment Variables__ @@ -59,9 +65,13 @@ An environment must be created using the following environment variables. | :-------------------- | :-------------------------------------- | | AZURE_SUBSCRIPTION_ID | The Azure Subscription _(GUID)_ | | AZURE_LOCATION | The Azure Region | +| AZURE_CLIENT_ID | Azure AD Application Client Id _(GUID)_ | ```bash azd init -e dev + +APP_NAME= # <-- +azd env set AZURE_CLIENT_ID $(az ad app list --display-name $APP_NAME --query "[].appId" -otsv) ``` ### Workspace @@ -74,6 +84,9 @@ The developer workspace is brought online using the azure developer cli | Stop | `azd down --purge --force` | +![[0]][0] +_Architecture Diagram_ + ## Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a @@ -95,3 +108,5 @@ trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies. + +[0]: docs/images/architecture.png "Architecture Diagram" \ No newline at end of file diff --git a/docs/Readme.md b/docs/Readme.md deleted file mode 100644 index 25f8d456..00000000 --- a/docs/Readme.md +++ /dev/null @@ -1 +0,0 @@ -# Documentation diff --git a/docs/architecture.vsdx b/docs/architecture.vsdx new file mode 100644 index 00000000..ad302339 Binary files /dev/null and b/docs/architecture.vsdx differ diff --git a/docs/images/architecture.png b/docs/images/architecture.png new file mode 100644 index 00000000..916fbf1b Binary files /dev/null and b/docs/images/architecture.png differ diff --git a/docs/pipelines.md b/docs/pipelines.md index c351fa10..41b4c368 100644 --- a/docs/pipelines.md +++ b/docs/pipelines.md @@ -50,11 +50,11 @@ The first, and often easiest activity is to test using the service. Attempting t This action will run a Validate Step to ensure any changes to bicep is acceptable. It also will trigger a Standards Check that is non blocking in order to determine if the solution passes the PSRule checks. -### Build +### Infra - Build +This action ensures that the bicep can build properly. - -### Release +### Infra - Release The release action will run whenever a release is created to ensure we have a copy of the ARM template from that release that could then be used by other systems as necessary. diff --git a/.github/README.md b/docs/setup.md similarity index 100% rename from .github/README.md rename to docs/setup.md