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

ArcBox 3.0 - Updated deployment options and prerequisites #346

Merged
merged 7 commits into from
Aug 1, 2024
Merged
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
8 changes: 5 additions & 3 deletions docs/azure_jumpstart_arcbox/DataOps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Overview

ArcBox for DataOps is a special "flavor" of ArcBox that is intended for users who want to experience Azure Arc-enabled SQL Managed Instance capabilities in a sandbox environment.

Check failure on line 11 in docs/azure_jumpstart_arcbox/DataOps/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.Contractions] Use 'that's' instead of 'that is'. Raw Output: {"message": "[Microsoft.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "docs/azure_jumpstart_arcbox/DataOps/_index.md", "range": {"start": {"line": 11, "column": 52}}}, "severity": "ERROR"}

![Screenshot showing ArcBox architecture diagram](./arch_dataops.png)

Expand All @@ -27,9 +27,9 @@

ArcBox for DataOps deploys three Kubernetes clusters to give you multiple options for exploring Azure Arc-enabled Kubernetes capabilities and potential integrations.

- _**ArcBox-CAPI-Data-xxxx**_ - A single-node Rancher K3s cluster which is then transformed to a [Cluster API](https://cluster-api.sigs.k8s.io/user/concepts.html) management cluster using the Cluster API Provider for Azure (CAPZ), and a workload cluster (_ArcBox-CAPI-Data_) is deployed onto the management cluster. The workload cluster is onboarded as an Azure Arc-enabled Kubernetes resource. ArcBox automatically deploys an Azure Arc Data Controller, an Active Directory connector and an Azure Arc-enabled SQL Managed Instance on top of the connected cluster.

Check failure on line 30 in docs/azure_jumpstart_arcbox/DataOps/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'onboarded'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'onboarded'?", "location": {"path": "docs/azure_jumpstart_arcbox/DataOps/_index.md", "range": {"start": {"line": 30, "column": 341}}}, "severity": "ERROR"}
- _**ArcBox-AKS-Data-xxxx**_ - An AKS cluster that is connected to Azure as an Azure Arc-enabled Kubernetes resource. ArcBox automatically deploys an Azure Arc Data Controller, an Active Directory connector and an Azure Arc-enabled SQL Managed Instance on top of the connected cluster.

Check failure on line 31 in docs/azure_jumpstart_arcbox/DataOps/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.Contractions] Use 'that's' instead of 'that is'. Raw Output: {"message": "[Microsoft.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "docs/azure_jumpstart_arcbox/DataOps/_index.md", "range": {"start": {"line": 31, "column": 47}}}, "severity": "ERROR"}
- _**ArcBox-AKS-DR-Data-xxxx**_ - An AKS cluster that is deployed in a separate virtual network, designating a disaster recovery site. This cluster is then connected to Azure as an Azure Arc-enabled Kubernetes resource. ArcBox automatically deploys an Azure Arc Data Controller, an Active Directory connector and an Azure Arc-enabled SQL Managed Instance on top of the connected cluster. This cluster is then configured with _ArcBox-CAPI-Data-xxxx_ to be part of a distributed availability group for disaster recovery.

Check failure on line 32 in docs/azure_jumpstart_arcbox/DataOps/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.Contractions] Use 'that's' instead of 'that is'. Raw Output: {"message": "[Microsoft.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "docs/azure_jumpstart_arcbox/DataOps/_index.md", "range": {"start": {"line": 32, "column": 50}}}, "severity": "ERROR"}

### Sample applications

Expand All @@ -37,13 +37,13 @@

The sample applications included in ArcBox are:

- **The Bookstore Application** - An MVC web application. ArcBox will deploy **one Kubernetes pod replica** of the _Bookstore_ application in the _arc_ namespace onto the _ArcBox-CAPI-Data-xxxx_ and the _ArcBox-AKS-DR-Data-xxxx_ clusters.

Check failure on line 40 in docs/azure_jumpstart_arcbox/DataOps/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Arc' instead of 'arc'. Raw Output: {"message": "[Vale.Terms] Use 'Arc' instead of 'arc'.", "location": {"path": "docs/azure_jumpstart_arcbox/DataOps/_index.md", "range": {"start": {"line": 40, "column": 148}}}, "severity": "ERROR"}

Check failure on line 40 in docs/azure_jumpstart_arcbox/DataOps/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'namespace'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'namespace'?", "location": {"path": "docs/azure_jumpstart_arcbox/DataOps/_index.md", "range": {"start": {"line": 40, "column": 153}}}, "severity": "ERROR"}

- **DB Connection Application** - An MVC application. ArcBox will deploy **one Kubernetes pod replica** as part of the DB connection app and an Ingress controller to demonstrate the active connections to the different Azure Arc-enabled SQL Managed Instances replicas.

### Azure Monitor integration

ArcBox deploys metrics and logs upload to Azure Monitor for the deployed data services, in addition to the out-of-the-box Grafana and Kibana dashboards that get deployed as part of Arc-enabled Data services.

Check failure on line 46 in docs/azure_jumpstart_arcbox/DataOps/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Kibana'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Kibana'?", "location": {"path": "docs/azure_jumpstart_arcbox/DataOps/_index.md", "range": {"start": {"line": 46, "column": 135}}}, "severity": "ERROR"}

### Hybrid Unified Operations

Expand All @@ -65,7 +65,7 @@
ArcBox uses an advanced automation flow to deploy and configure all necessary resources with minimal user interaction. The previous diagrams provide an overview of the deployment flow. A high-level summary of the deployment is:

- User deploys the Bicep template (_main.bicep_). These objects contain several nested objects that will run simultaneously.
- Client virtual machine ARM template/plan - deploys a domain-joined Client Windows VM. This is a Windows Server VM that comes preconfigured with kubeconfig files to work with the three Kubernetes clusters, as well multiple tools such as VSCode, Azure Data Studio and SQL Server Management Studio to make working with ArcBox simple and easy.

Check failure on line 68 in docs/azure_jumpstart_arcbox/DataOps/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'preconfigured'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'preconfigured'?", "location": {"path": "docs/azure_jumpstart_arcbox/DataOps/_index.md", "range": {"start": {"line": 68, "column": 130}}}, "severity": "ERROR"}

Check failure on line 68 in docs/azure_jumpstart_arcbox/DataOps/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'VSCode'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'VSCode'?", "location": {"path": "docs/azure_jumpstart_arcbox/DataOps/_index.md", "range": {"start": {"line": 68, "column": 241}}}, "severity": "ERROR"}
- Storage account template/plan - used for staging files in automation scripts.
- Management artifacts template/plan - deploys Azure Log Analytics workspace, its required Solutions, a domain controller and two virtual networks.
- User remotes into the Client Windows VM using domain credentials, which automatically kicks off multiple scripts that:
Expand Down Expand Up @@ -103,7 +103,7 @@
- Korea Central
- Southeast Asia

- **ArcBox DataOps requires 42 B-series vCPUs and 56 DSv4 vCPUs** when deploying with default parameters such as VM series/size. Ensure you have sufficient vCPU quota available in your Azure subscription and the region where you plan to deploy ArcBox. You can use the below Az CLI command to check your vCPU utilization.
- **ArcBox DataOps requires 42 B-series vCPUs and 56 DSv5 vCPUs** when deploying with default parameters such as VM series/size. Ensure you have sufficient vCPU quota available in your Azure subscription and the region where you plan to deploy ArcBox. You can use the below Az CLI command to check your vCPU utilization.

```shell
az vm list-usage --location <your location> --output table
Expand Down Expand Up @@ -176,16 +176,18 @@
az bicep upgrade
```

- Edit the [main.bicepparam](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_arcbox/bicep/main.bicepparam) template parameters file and supply some values for your environment.
- Edit the [main.bicepparam](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_arcbox/bicep/main.bicepparam) template parameters file and supply values for your environment.
- _`sshRSAPublicKey`_ - Your SSH public key
- _`tenantId`_ - Your Azure tenant id
- _`windowsAdminUsername`_ - Client Windows VM Administrator username
- _`windowsAdminPassword`_ - Client Windows VM Password. Password must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. The value must be between 12 and 123 characters long
- _`logAnalyticsWorkspaceName`_ - Name for the ArcBox Log Analytics workspace that will be created
- _`flavor`_ - Use the value "DataOps" to specify that you want to deploy the DataOps flavor of ArcBox
- _`deployBastion`_ - Set to *`true`* if you want to use Azure Bastion to connect to _ArcBox-Client_
- _`resourceTags`_ - Tags to assign for all ArcBox resources
- _`namingPrefix`_ - The naming prefix for the nested virtual machines and all Azure resources deployed. The maximum length for the naming prefix is 7 characters,example if the value is _Contoso_: `Contoso-Win2k19`

![Screenshot showing example parameters](./parameters.png)
![Screenshot showing example parameters](./parameters_dataops_bicep.png)

- Now you will deploy the Bicep file. Navigate to the local cloned [deployment folder](https://github.com/microsoft/azure_arc/tree/main/azure_jumpstart_arcbox/bicep) and run the below command:

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions docs/azure_jumpstart_arcbox/DevOps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,17 +209,19 @@ ArcBox uses an advanced automation flow to deploy and configure all necessary re
az bicep upgrade
```

- Edit the [main.bicepparam](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_arcbox/bicep/main.bicepparam) template parameters file and supply some values for your environment.
- Edit the [main.bicepparam](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_arcbox/bicep/main.bicepparam) template parameters file and supply values for your environment.
- _`sshRSAPublicKey`_ - Your SSH public key
- _`tenantId`_ - Your Azure tenant id
- _`windowsAdminUsername`_ - Client Windows VM Administrator username
- _`windowsAdminPassword`_ - Client Windows VM Password. Password must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. The value must be between 12 and 123 characters long.
- _`logAnalyticsWorkspaceName`_ - Name for the ArcBox Log Analytics workspace
- _`flavor`_ - Use the value "DevOps" to specify that you want to deploy the Devops flavor of ArcBox
- _`resourceTags`_ - Tags to assign for all ArcBox resources
- _`namingPrefix`_ - The naming prefix for the nested virtual machines and all Azure resources deployed. The maximum length for the naming prefix is 7 characters,example if the value is _Contoso_: `Contoso-Win2k19`
- _`deployBastion`_ - Set to *`true`* if you want to use Azure Bastion to connect to _ArcBox-Client_
- _`githubUser`_ - Specify the name of your GitHub account where you cloned the Sample Apps repo

![Screenshot showing example parameters](./parameters.png)
![Screenshot showing example parameters](./parameters_devops_bicep.png)

- Now you will deploy the Bicep file. Navigate to the local cloned [deployment folder](https://github.com/microsoft/azure_arc/tree/main/azure_jumpstart_arcbox/bicep) and run the below command:

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 5 additions & 3 deletions docs/azure_jumpstart_arcbox/ITPro/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ ArcBox uses an advanced automation flow to deploy and configure all necessary re
- Korea Central
- Southeast Asia

- **ArcBox for IT Pros requires 16 DSv4-series vCPUs** when deploying with default parameters such as VM series/size. Ensure you have sufficient vCPU quota available in your Azure subscription and the region where you plan to deploy ArcBox. You can use the below Az CLI command to check your vCPU utilization.
- **ArcBox for IT Pros requires 16 DSv5-series vCPUs** when deploying with default parameters such as VM series/size. Ensure you have sufficient vCPU quota available in your Azure subscription and the region where you plan to deploy ArcBox. You can use the below Az CLI command to check your vCPU utilization.

```shell
az vm list-usage --location <your location> --output table
Expand Down Expand Up @@ -163,15 +163,17 @@ ArcBox uses an advanced automation flow to deploy and configure all necessary re
az bicep upgrade
```

- Edit the [main.bicepparam](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_arcbox/bicep/main.bicepparam) template parameters file and supply some values for your environment.
- Edit the [main.bicepparam](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_arcbox/bicep/main.bicepparam) template parameters file and supply values for your environment.
- _`sshRSAPublicKey`_ - Your SSH public key
- _`tenantId`_ - Your Azure tenant id
- _`windowsAdminUsername`_ - Client Windows VM Administrator username
- _`windowsAdminPassword`_ - Client Windows VM Password. Password must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. The value must be between 12 and 123 characters long.
- _`logAnalyticsWorkspaceName`_ - Unique name for the ArcBox Log Analytics workspace
- _`flavor`_ - Use the value "ITPro" to specify that you want to deploy ArcBox for IT Pros
- _`resourceTags`_ - Tags to assign for all ArcBox resources
- _`namingPrefix`_ - The naming prefix for the nested virtual machines and all Azure resources deployed. The maximum length for the naming prefix is 7 characters,example if the value is _Contoso_: `Contoso-Win2k19`

![Screenshot showing example parameters](./parameters_bicep.png)
![Screenshot showing example parameters](./parameters_itpro_bicep.png)

- Now you will deploy the Bicep file. Navigate to the local cloned [deployment folder](https://github.com/microsoft/azure_arc/tree/main/azure_jumpstart_arcbox/bicep) and run the below command:

Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading