AzureNamingToolInstallation.mp4
The Naming Tool was developed using a naming pattern based on Microsoft's best practices . Once the organizational components have been defined by an administrator, users can use the tool to geernated name for the desired Azure resource.
Further documentation on the script can be found on Microsoft's Cloud Adoption Framework GitHub repo.
The Azure Naming Tool is a .NET 6 Blazor application, with a RESTful API. The UI consists of several pages to allow the configuration and generation of Azure Resource names. The API provides a programmatic interface for the functionality. The application contains Docker support, allowing the site to be run as a stand-alone application, or a container.
Project Components
- UI/Admin
- API
- JSON configuration files
- Dockerfile
The following are important notes/aspects of the Azure Naming Tool:
-
The application is designed to run as a stand-alone solution, with no internet/Azure connection.
-
The application can be run as a .NET 6 site, or as a Docker container.
-
The site can be hosted in any environment, including internal or in a public/private cloud.
-
The application uses local JSON files to store the configuration of the components.
-
The application requires persistent storage. If running as a container, a volume is required to store configuration files.
-
The application contains a repository folder, which contains the default component configuration JSON files. When deployed, these files are copied to the settings folder.
-
The Admin interface allows configurations to be "reset", if needed. This process copies the configuration from the repository folder to the settings folder.
-
The API requires an API Key for all executions. A default API Key (guid) will be generated on first launch. This value can be updated in the Admin section.
-
On first launch, the application will prompt for the Admin password to be set.
The Home Page provides an overview of the tool and the components.
The Configuration Page shows the current Name Generation configuration. This page also provides an Admin section for updating the configuration.
The References Page provides examples for each type of Azure resource. The example values do not include any excluded naming components. Optional components are always displayed and are identified below the example. Since unique names are only required at specific scopes, the examples provided are only generated for the scopes above the resource scope: resource group, resource group & region, region, global, subscription, and tenant.
The Generator Page provides a dropdown menu to select an Azure resource. Once a resource is selected, naming component options are provided. Read-only components cannot be changed, like the value for a resource type or organization. Optional components, if left blank, will be null and not shown in the output. Required components do not allow a null value, and the first value in the array is set as the default.
This project contains a .NET 6 application, with Docker support. To use, complete the following:
NOTE
The Azure Naming Tool requires persistent storage for the configuration files when run as a container. The following processes will explain how to create this volume in your respective environment. All configuration JSON files will be stored in the volume to ensure the configuration is persisted.
This process will allow you to deploy the Azure Naming Tool using Docker to your local environment.
-
On the <>Code tab, select the <>Code button and select Download ZIP
-
Extract the zipped files to your local machine
-
Change directory to the project folder
NOTE
- Ensure you can see the project files and are not in the parent folder
-
Open a Command Prompt and change directory to the current project folder
-
Run the following Docker command to build the image
docker build -t azurenamingtool .
NOTE
- Ensure the '.' is included in the command
-
Run the following ##Docker command** to create a new container and mount a new volume
docker run -d -p 8081:80 --mount source=azurenamingtoolvol,target=/app/settings azurenamingtool:latest
NOTES
- Substitute 8081 for any port not in use on your machine
- You may see warnings in the command prompt regarding DataProtection and keys. These indicate that the keys are not persisted and are only local to the container instances.
-
Access the site using the following URL
NOTE
- Substitute 8081 for the port you used in the docker run command
The Azure Naming Tool requires persistent storage for the configuration files when run as a container. The following processes will explain how to create this volume for your Azure App Service Container. All configuration JSON files will be stored in the volume to ensure the configuration is persisted.
NOTE
For many of the steps, a sample process is provided, however, there are many ways to accomplish each step.
-
On the <>Code tab, select the <>Code button and select Download ZIP
-
Extract the zipped files to your local machine
-
Change directory to the project folder
NOTE
- Ensure you can see the project files and are not in the parent folder
-
Open a Command Prompt and change directory to the current project folder
-
Run the following Docker command to build the image
docker build -t azurenamingtool .
NOTE
- Ensure the '.' is included in the command
-
Create an Azure Container Registry
Create an Azure container registry using the Azure portal -
Build and publish you image to the Azure Container Registry
Push your first image to your Azure container registry using the Docker CLI -
Create an Azure Storage Fileshare for the persistent storage
Create an Azure file share
-
Create an Azure App Service - Web App
Run a custom container in Azure -
Mount the fileshare as local storage for the Azure App Service
Mount Azure Storage as a local share in a custom container in App Service
-
Deploy the image from the Azure Container Registry to the Azure App Service
Continuous deployment with custom containers in Azure App Service -
Access the site using your Azure App Service URL
