-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated documentation and moved elastic source to helm repo from git. (…
- Loading branch information
1 parent
e36c809
commit d4be482
Showing
7 changed files
with
177 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| # Command Line (AZD) | ||
|
|
||
| ??? info "_Article Audience_" | ||
| :fontawesome-solid-cloud:{ .lg .middle } __Cloud Architects__: Working with Infrastructure and Software | ||
|
|
||
| :fontawesome-solid-code:{ .lg .middle } __Application Developer__: Working with Services and Applications | ||
|
|
||
| :fontawesome-brands-git-alt:{ .lg .middle } __DevOps Engineers__: Automation and Deployment Customizations | ||
|
|
||
| The Azure Developer CLI (azd) simplifies deployment and management of Azure resources through intuitive commands and built-in best practices. The CLI enables rapid provisioning combined with management tasks via hook-executed scripts. Built-in environment management capabilities support isolated environments with automatic environment variable configuration. | ||
|
|
||
| ??? Tip "Learning Opportunity" | ||
| Learn more about the [Azure Developer CLI (azd)](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/overview?tabs=linux) and how to use it. | ||
|
|
||
| _Supports [Containers](https://code.visualstudio.com/docs/devcontainers/containers) as an alternative for local workstation._ | ||
|
|
||
| [](https://github.com/codespaces/new?skip_quickstart=true&machine=basicLinux32gb&repo=742135816&ref=main&devcontainer_path=.devcontainer%2Fdevcontainer.json&geo=UsEast) | ||
|
|
||
| [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Azure/osdu-developer) | ||
|
|
||
|
|
||
|
|
||
| ## Instructions | ||
|
|
||
| 1. Clone the repository to your file system. | ||
|
|
||
| === "Command" | ||
|
|
||
| ```powershell | ||
| git clone https://github.com/Azure/osdu-developer.git | ||
| ``` | ||
|
|
||
| 2. Authenticate and select the subscription. | ||
|
|
||
| === "Command" | ||
|
|
||
| ```powershell | ||
| az login --scope https://graph.microsoft.com//.default | ||
| azd auth login | ||
| az account set --subscription <your_subscription_id> | ||
| ``` | ||
|
|
||
| 3. Enable required features. | ||
|
|
||
| === "Command" | ||
|
|
||
| ```powershell | ||
| azd config set alpha.resourceGroupDeployments on | ||
| ``` | ||
|
|
||
|
|
||
| 4. Initialize the environment and enable any feature flags. | ||
|
|
||
| === "Command" | ||
|
|
||
| ```powershell | ||
| azd init -e <your_env_name> | ||
| azd env set <feature_flag> <value> | ||
| ``` | ||
|
|
||
| 5. Deploy the solution. | ||
|
|
||
| === "Command" | ||
|
|
||
| ```powershell | ||
| azd provision | ||
| ``` | ||
|
|
||
| !!! Warning | ||
| Deployment can exceed 1 hour. For timeouts execute `azd provision` again to continue. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| # Portal Template (ARM) | ||
|
|
||
| ??? info "_Article Audience_" | ||
| :fontawesome-solid-user-tie:{ .lg .middle } __Domain Experts__: Working with OSDU services. | ||
|
|
||
| :fontawesome-solid-chart-line:{ .lg .middle } __Data Scientists__: Working with data and machine learning. | ||
|
|
||
| :fontawesome-solid-database:{ .lg .middle } __Data Engineers__: Working with data and databases. | ||
|
|
||
| The Azure Resource Manager (ARM) custom template deployment provides a simple way to provision the solution through the Azure Portal. This method uses a pre-configured ARM template that has been transpiled from Bicep, enabling rapid deployment through a guided portal experience. | ||
|
|
||
| ??? Tip "Learning Opportunity" | ||
| Learn more about [ARM Templates](https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/overview) and how they work in Azure. | ||
|
|
||
| !!! Warning | ||
| The template leverages complex configuration objects that are built in a way that can be integrated later with an [Azure Managed Application](https://learn.microsoft.com/en-us/azure/azure-resource-manager/managed-applications/overview). This can make configuration of feature flags more challenging. | ||
|
|
||
|
|
||
| ## Instructions | ||
|
|
||
| 1. Create a [Microsoft Entra Application Registration](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate). | ||
|
|
||
| === "Collected Values" | ||
| - Application Client Id (clientId) | ||
| - Application Client Secret (clientSecret) | ||
| - Enterprise Application Object Id (principalId) | ||
|
|
||
|
|
||
| 2. Open the custom ARM Template deployment. | ||
|
|
||
| [](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fosdu-developer%2Fmain%2Fazuredeploy.json) | ||
|
|
||
|
|
||
| 3. Provide the required values. | ||
|
|
||
| === "Required Values" | ||
| - Email Address: _`Valid email address for the admin user`_ | ||
| - Application Client Id: _`Valid Client Id from the app registration`_ | ||
| - Application Client Secret: _`Valid Client Secret from the app registration`_ | ||
| - Application Client Principal OID: _`Valid Enterprise Application Object Id`_ | ||
|
|
||
| 4. Modify the optional parameters as desired. | ||
|
|
||
| === "Optional Parameters" | ||
| - Enable Burstable: _`Feature Flag: Enable burstable server types.`_ | ||
| - Custom VM Size: _`Set Custom VM size cluster nodes.`_ | ||
| - Ingress Type: _`Switch: Ingress type to use.`_ | ||
| - Enable Blob Public Access: _`Feature Flag: Enable Blob Storage public access.`_ | ||
| - Enable Manage: _`Feature Flag: Deploy virtual machine with bastion.`_ | ||
| - Vm Admin Username: _`Set admin username for the virtual machine.`_ | ||
| - Enable Pod Subnet: _`Feature Flag: Enhanced AKS subnet configuration.`_ | ||
| - Vnet Configuration: _`Network configuration object.`_ | ||
| - Cluster Software: _`Software configuration object.`_ | ||
| - Experimental Software: _`Experimental Software configuration object.`_ | ||
| - Cluster Network: _`Cluster network configuration object.`_ | ||
| - Cluster Network Plugin: _`Switch: Network plugin to use.`_ | ||
| - Cluster Admin Ids: _`Set cluster admin user ids to enable RBAC.`_ | ||
|
|
||
| 4. Deploy the Solution. | ||
|
|
||
| !!! Warning | ||
| Deployment can exceed 1 hour. Includes both infrastructure and software deployment. | ||
|
|
||
| 4. Configure Authentication. | ||
|
|
||
| === "Steps" | ||
| - Locate the ingress IP address in the AKS service | ||
| - Add a redirect URI to your Entra application: | ||
| - Format: `https://<ingress_ip>/auth/spa/` | ||
| - Platform type: Single-page application (SPA) | ||
|
|
||
| 5. Validate Access. | ||
|
|
||
| === "Portal" | ||
| - Check Successful deployment in the resource group deployments | ||
| - Check Successful deployment in the AKS gitops status | ||
|
|
||
| === "API Access" | ||
| - Navigate to `https://<ingress_ip>/auth/spa/` | ||
| - Click Authorize to receive an authorization code | ||
| - Use Get Tokens to retrieve an access token | ||
| - Test the token with service swagger pages |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters