Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #10

Merged
merged 4 commits into from
Jan 16, 2024
Merged

Docs #10

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -36,15 +38,19 @@ 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__

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__
Expand All @@ -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= # <-- <your_ad_application_name>
azd env set AZURE_CLIENT_ID $(az ad app list --display-name $APP_NAME --query "[].appId" -otsv)
```

### Workspace
Expand All @@ -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
Expand All @@ -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"
1 change: 0 additions & 1 deletion docs/Readme.md

This file was deleted.

Binary file added docs/architecture.vsdx
Binary file not shown.
Binary file added docs/images/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
File renamed without changes.