diff --git a/docs/azure_jumpstart_arcbox/DataOps/_index.md b/docs/azure_jumpstart_arcbox/DataOps/_index.md index 33215609..3e2316d0 100644 --- a/docs/azure_jumpstart_arcbox/DataOps/_index.md +++ b/docs/azure_jumpstart_arcbox/DataOps/_index.md @@ -60,15 +60,12 @@ ArcBox provides multiple paths for deploying and configuring ArcBox resources. D - Azure portal - ARM template via Azure CLI - Azure Bicep -- HashiCorp Terraform ![Deployment flow diagram for ARM-based deployments](./deployment_flow.png) -![Deployment flow diagram for Terraform-based deployments](./deployment_flow_tf.png) - 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 primary ARM template (_azuredeploy.json_), Bicep file (_main.bicep_), or Terraform plan (_main.tf_). These objects contain several nested objects that will run simultaneously. +- User deploys the primary ARM template (_azuredeploy.json_) or Bicep file (_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. - 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. @@ -292,69 +289,7 @@ ArcBox uses an advanced automation flow to deploy and configure all necessary re az group create --name "" --location "" az deployment group create -g "" -f "main.bicep" -p "main.parameters.json" ``` - - > **Note:** The deployment can take up to 45 minutes. If it keeps running for more than that, please check the [troubleshooting guide](#basic-troubleshooting). - -## Deployment Option 4: HashiCorp Terraform Deployment - -- Clone the Azure Arc Jumpstart repository - - ```shell - git clone https://github.com/microsoft/azure_arc.git - ``` - -- Download and install the latest version of Terraform [here](https://www.terraform.io/downloads.html) - - > **Note:** Terraform 1.x or higher is supported for this deployment. Tested with Terraform v1.0.9+. - -- Create a `terraform.tfvars` file in the root of the terraform folder and supply some values for your environment. - - ```HCL - azure_location = "westus2" - resource_group_name = "ArcBoxDataOps" - spn_client_id = "1414133c-9786-53a4-b231-f87c143ebdb1" - spn_client_secret = "fakeSecretValue123458125712ahjeacjh" - spn_tenant_id = "33572583-d294-5b56-c4e6-dcf9a297ec17" - client_admin_ssh = "C:/Temp/rsa.pub" - deployment_flavor = "DataOps" - deploy_bastion = false - ``` - -- Variable Reference: - - **_`azure_location`_** - Azure location code (e.g. 'eastus', 'westus2', etc.) - - **_`resource_group_name`_** - Resource group which will contain all of the ArcBox artifacts - - **_`spn_client_id`_** - Your Azure service principal id - - **_`spn_client_secret`_** - Your Azure service principal secret - - **_`spn_tenant_id`_** - Your Azure tenant id - - **_`client_admin_ssh`_** - SSH public key path, used for Linux VMs - - **_`deployment_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_ - - _`client_admin_username`_ - Admin username for Windows & Linux VMs - - _`client_admin_password`_ - Admin password for Windows VMs. 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. - - **_`workspace_name`_** - Unique name for the ArcBox Log Analytics workspace that will be created - - > **Note:** Any variables in bold are required. If any optional parameters are not provided, defaults will be used. - -- Now you will deploy the Terraform file. Navigate to the local cloned [deployment folder](https://github.com/microsoft/azure_arc/tree/main/azure_jumpstart_arcbox/bicep) and run the commands below: - - ```shell - terraform init - terraform plan -out=infra.out - terraform apply "infra.out" - ``` - -- Example output from `terraform init`: - - ![terraform init](./terraform_init.png) - -- Example output from `terraform plan -out=infra.out`: - ![terraform plan](./terraform_plan.png) - -- Example output from `terraform apply "infra.out"`: - - ![terraform plan](./terraform_apply.png) - > **Note:** The deployment can take up to 45 minutes. If it keeps running for more than that, please check the [troubleshooting guide](#basic-troubleshooting). ## Start post-deployment automation @@ -816,7 +751,6 @@ The following tools are including on the _ArcBox-Client_ VM. - SQL StressTest application - Putty - 7zip -- Terraform - Git - ZoomIt diff --git a/docs/azure_jumpstart_arcbox/DataOps/terraform_apply.png b/docs/azure_jumpstart_arcbox/DataOps/terraform_apply.png deleted file mode 100644 index 1239577e..00000000 Binary files a/docs/azure_jumpstart_arcbox/DataOps/terraform_apply.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/DataOps/terraform_init.png b/docs/azure_jumpstart_arcbox/DataOps/terraform_init.png deleted file mode 100644 index 0418a0de..00000000 Binary files a/docs/azure_jumpstart_arcbox/DataOps/terraform_init.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/DataOps/terraform_plan.png b/docs/azure_jumpstart_arcbox/DataOps/terraform_plan.png deleted file mode 100644 index 2a643ba5..00000000 Binary files a/docs/azure_jumpstart_arcbox/DataOps/terraform_plan.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/DevOps/_index.md b/docs/azure_jumpstart_arcbox/DevOps/_index.md index ab11a3f9..725b3512 100644 --- a/docs/azure_jumpstart_arcbox/DevOps/_index.md +++ b/docs/azure_jumpstart_arcbox/DevOps/_index.md @@ -93,15 +93,12 @@ ArcBox provides multiple paths for deploying and configuring ArcBox resources. D - Azure portal - ARM template via Azure CLI - Azure Bicep -- HashiCorp Terraform ![Deployment flow diagram for ARM-based deployments](./deployment_flow.png) -![Deployment flow diagram for Terraform-based deployments](./deployment_flow_tf.png) - 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 primary ARM template (_azuredeploy.json_), Bicep file (_main.bicep_), or Terraform plan (_main.tf_). These objects contain several nested objects that will run simultaneously. +- User deploys the primary ARM template (_azuredeploy.json_) or Bicep file (_main.bicep_). These objects contain several nested objects that will run simultaneously. - Client virtual machine ARM template/plan - deploys the Client Windows VM. This is a Windows Server VM that comes preconfigured with kubeconfig files to work with the two Kubernetes clusters, as well multiple tools such as VSCode to make working with ArcBox simple and easy. - Storage account template/plan - used for staging files in automation scripts. - Management artifacts template/plan - deploys Azure Log Analytics workspace, its required Solutions, and Azure Policy artifacts. @@ -328,70 +325,6 @@ ArcBox uses an advanced automation flow to deploy and configure all necessary re > **Note:** If you see any failure in the deployment, please check the [troubleshooting guide](#basic-troubleshooting). -## Deployment Option 4: HashiCorp Terraform Deployment - -- Clone the Azure Arc Jumpstart repository - - ```shell - git clone https://github.com/microsoft/azure_arc.git - ``` - -- Download and install the latest version of Terraform [here](https://www.terraform.io/downloads.html) - - > **Note:** Terraform 1.x or higher is supported for this deployment. Tested with Terraform v1.0.9+. - -- Create a `terraform.tfvars` file in the root of the terraform folder and supply some values for your environment. - - ```HCL - azure_location = "westus2" - resource_group_name = "ArcBoxDevOps" - spn_client_id = "1414133c-9786-53a4-b231-f87c143ebdb1" - spn_client_secret = "fakeSecretValue123458125712ahjeacjh" - spn_tenant_id = "33572583-d294-5b56-c4e6-dcf9a297ec17" - client_admin_ssh = "C:/Temp/rsa.pub" - deployment_flavor = "DevOps" - deploy_bastion = false - github_username = "GitHubUser" - ``` - -- Variable Reference: - - **_`azure_location`_** - Azure location code (e.g. 'eastus', 'westus2', etc.) - - **_`resource_group_name`_** - Resource group which will contain all of the ArcBox artifacts - - **_`spn_client_id`_** - Your Azure service principal id - - **_`spn_client_secret`_** - Your Azure service principal secret - - **_`spn_tenant_id`_** - Your Azure tenant id - - **_`client_admin_ssh`_** - SSH public key path, used for Linux VMs - - **_`deployment_flavor`_** - Use the value "DevOps" to specify that you want to deploy the DevOps flavor of ArcBox - - _`deployBastion`_ - Set to *`true`* if you want to use Azure Bastion to connect to _ArcBox-Client_ - - _`client_admin_username`_ - Admin username for Windows & Linux VMs - - _`client_admin_password`_ - Admin password for Windows VMs. 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. - - **_`workspace_name`_** - Unique name for the ArcBox Log Analytics workspace - - _`github_username`_ - Specify the name of your GitHub account where you cloned the Sample Apps repo - - > **Note:** Any variables in bold are required. If any optional parameters are not provided, defaults will be used. - -- Now you will deploy the Terraform file. Navigate to the local cloned [deployment folder](https://github.com/microsoft/azure_arc/tree/main/azure_jumpstart_arcbox/bicep) and run the commands below: - - ```shell - terraform init - terraform plan -out=infra.out - terraform apply "infra.out" - ``` - -- Example output from `terraform init`: - - ![terraform init](./terraform_init.png) - -- Example output from `terraform plan -out=infra.out`: - - ![terraform plan](./terraform_plan.png) - -- Example output from `terraform apply "infra.out"`: - - ![terraform plan](./terraform_apply.png) - - > **Note:** If you see any failure in the deployment, please check the [troubleshooting guide](#basic-troubleshooting). - ## Start post-deployment automation Once your deployment is complete, you can open the Azure portal and see the ArcBox resources inside your resource group. You will be using the _ArcBox-Client_ Azure virtual machine to explore various capabilities of ArcBox such as GitOps configurations and Key Vault integration. You will need to remotely access _ArcBox-Client_. @@ -847,7 +780,6 @@ The following tools are including on the _ArcBox-Client_ VM. - Visual Studio Code - Putty - 7zip -- Terraform - Git - ZoomIt diff --git a/docs/azure_jumpstart_arcbox/DevOps/terraform_apply.png b/docs/azure_jumpstart_arcbox/DevOps/terraform_apply.png deleted file mode 100644 index 43983c81..00000000 Binary files a/docs/azure_jumpstart_arcbox/DevOps/terraform_apply.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/DevOps/terraform_init.png b/docs/azure_jumpstart_arcbox/DevOps/terraform_init.png deleted file mode 100644 index e4a69bd2..00000000 Binary files a/docs/azure_jumpstart_arcbox/DevOps/terraform_init.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/DevOps/terraform_plan.png b/docs/azure_jumpstart_arcbox/DevOps/terraform_plan.png deleted file mode 100644 index 62640929..00000000 Binary files a/docs/azure_jumpstart_arcbox/DevOps/terraform_plan.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/Full/_index.md b/docs/azure_jumpstart_arcbox/Full/_index.md index 579b24ae..4bccd014 100644 --- a/docs/azure_jumpstart_arcbox/Full/_index.md +++ b/docs/azure_jumpstart_arcbox/Full/_index.md @@ -58,15 +58,12 @@ ArcBox provides multiple paths for deploying and configuring ArcBox resources. D - Azure portal - ARM template via Azure CLI - Bicep -- Terraform ![Deployment flow diagram for ARM-based deployments](./deploymentflow.png) -![Deployment flow diagram for Terraform-based deployments](./deploymentflow_tf.png) - 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 primary ARM template (_azuredeploy.json_), Bicep file (_main.bicep_), or Terraform plan (_main.tf_). These objects contain several nested objects that will run simultaneously. +- User deploys the primary ARM template (_azuredeploy.json_) or Bicep file (_main.bicep_). These objects contain several nested objects that will run simultaneously. - ClientVM ARM template/plan - deploys the Client Windows VM. This is the Hyper-V host VM where all user interactions with the environment are made from. - Storage account template/plan - used for staging files in automation scripts - Management artifacts template/plan - deploys Azure Log Analytics workspace and solutions and Azure Policy artifacts @@ -280,65 +277,6 @@ ArcBox uses an advanced automation flow to deploy and configure all necessary re > **Note:** If you see any failure in the deployment, please check the [troubleshooting guide](#basic-troubleshooting). -## Deployment Option 4: Terraform Deployment - -- Clone the Azure Arc Jumpstart repository - - ```shell - git clone https://github.com/microsoft/azure_arc.git - ``` - -- Download and install the latest version of Terraform [here](https://www.terraform.io/downloads.html) - - > **Note:** Terraform 1.x or higher is supported for this deployment. Tested with Terraform v1.011. - -- Create a `terraform.tfvars` file in the root of the terraform folder and supply some values for your environment. - - ```HCL - azure_location = "westus2" - spn_client_id = "1414133c-9786-53a4-b231-f87c143ebdb1" - spn_client_secret = "fakeSecretValue123458125712ahjeacjh" - spn_tenant_id = "33572583-d294-5b56-c4e6-dcf9a297ec17" - client_admin_ssh = "C:/Temp/rsa.pub" - deployment_flavor = "Full" - ``` - -- Variable Reference: - - **_`azure_location`_** - Azure location code (e.g. 'eastus', 'westus2', etc.) - - **_`resource_group_name`_** - Resource group which will contain all of the ArcBox artifacts - - **_`spn_client_id`_** - Your Azure service principal id - - **_`spn_client_secret`_** - Your Azure service principal secret - - **_`spn_tenant_id`_** - Your Azure tenant id - - **_`client_admin_ssh`_** - SSH public key path, used for Linux VMs - - **_`deployment_flavor`_** - Use the value "Full" to specify that you want to deploy the full version of ArcBox - - _`client_admin_username`_ - Admin username for Windows & Linux VMs - - _`client_admin_password`_ - Admin password for Windows VMs. 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. - - **_`workspace_name`_** - Unique name for the ArcBox Log Analytics workspace - - > **Note:** Any variables in bold are required. If any optional parameters are not provided, defaults will be used. - -- Now you will deploy the Terraform file. Navigate to the local cloned [deployment folder](https://github.com/microsoft/azure_arc/tree/main/azure_jumpstart_arcbox/terraform) and run the commands below: - - ```shell - terraform init - terraform plan -out=infra.out - terraform apply "infra.out" - ``` - -- Example output from `terraform init`: - - ![terraform init](./terraform_init.png) - -- Example output from `terraform plan -out=infra.out`: - - ![terraform plan](./terraform_plan.png) - -- Example output from `terraform apply "infra.out"`: - - ![terraform plan](./terraform_apply.png) - - > **Note:** If you see any failure in the deployment, please check the [troubleshooting guide](#basic-troubleshooting). - ## Start post-deployment automation Once your deployment is complete, you can open the Azure portal and see the ArcBox resources inside your resource group. You will be using the _ArcBox-Client_ Azure virtual machine to explore various capabilities of ArcBox such as GitOps configurations and Key Vault integration. You will need to remotely access _ArcBox-Client_. @@ -622,7 +560,6 @@ The following tools are included in the _ArcBox-Client_ VM. - Visual Studio Code - Putty - 7zip -- Terraform - Git - SqlQueryStress diff --git a/docs/azure_jumpstart_arcbox/Full/terraform_apply.png b/docs/azure_jumpstart_arcbox/Full/terraform_apply.png deleted file mode 100644 index f855a030..00000000 Binary files a/docs/azure_jumpstart_arcbox/Full/terraform_apply.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/Full/terraform_init.png b/docs/azure_jumpstart_arcbox/Full/terraform_init.png deleted file mode 100644 index f5b23a07..00000000 Binary files a/docs/azure_jumpstart_arcbox/Full/terraform_init.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/Full/terraform_plan.png b/docs/azure_jumpstart_arcbox/Full/terraform_plan.png deleted file mode 100644 index b4359efd..00000000 Binary files a/docs/azure_jumpstart_arcbox/Full/terraform_plan.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/ITPro/_index.md b/docs/azure_jumpstart_arcbox/ITPro/_index.md index da1acae0..e23a8fc8 100644 --- a/docs/azure_jumpstart_arcbox/ITPro/_index.md +++ b/docs/azure_jumpstart_arcbox/ITPro/_index.md @@ -46,15 +46,12 @@ ArcBox provides multiple paths for deploying and configuring ArcBox resources. D - Azure portal - ARM template via Azure CLI - Bicep -- Terraform ![Deployment flow diagram for ARM-based deployments](./deploymentflow.png) -![Deployment flow diagram for Terraform-based deployments](./deploymentflow_tf.png) - 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 primary ARM template (azuredeploy.json), Bicep file (main.bicep), or Terraform plan (main.tf). These objects contain several nested objects that will run simultaneously. +- User deploys the primary ARM template (azuredeploy.json) or Bicep file (main.bicep). These objects contain several nested objects that will run simultaneously. - ClientVM ARM template/plan - deploys the Client Windows VM. This is the Hyper-V host VM where all user interactions with the environment are made from. - Storage account template/plan - used for staging files in automation scripts - Management artifacts template/plan - deploys Azure Log Analytics workspace and solutions and Azure Policy artifacts @@ -280,67 +277,6 @@ ArcBox uses an advanced automation flow to deploy and configure all necessary re > **Note:** If you see any failure in the deployment, please check the [troubleshooting guide](#basic-troubleshooting). -## Deployment Option 4: Terraform Deployment - -- Clone the Azure Arc Jumpstart repository - - ```shell - git clone https://github.com/microsoft/azure_arc.git - ``` - -- Download and install the latest version of Terraform [here](https://www.terraform.io/downloads.html) - - > **Note:** Terraform 1.x or higher is supported for this deployment. Tested with Terraform v1.011. - -- Create a `terraform.tfvars` file in the root of the terraform folder and supply some values for your environment. - - ```HCL - azure_location = "westus2" - spn_client_id = "1414133c-9786-53a4-b231-f87c143ebdb1" - spn_client_secret = "fakeSecretValue123458125712ahjeacjh" - spn_tenant_id = "33572583-d294-5b56-c4e6-dcf9a297ec17" - user_ip_address = "99.88.99.88" - client_admin_ssh = "C:/Temp/rsa.pub" - deployment_flavor = "ITPro" - ``` - -- Variable Reference: - - **_`azure_location`_** - Azure location code (e.g. 'eastus', 'westus2', etc.) - - **_`resource_group_name`_** - Resource group which will contain all of the ArcBox artifacts - - **_`spn_client_id`_** - Your Azure service principal id - - **_`spn_client_secret`_** - Your Azure service principal secret - - **_`spn_tenant_id`_** - Your Azure tenant id - - **_`user_ip_address`_** - Your local IP address. This is used to allow remote RDP connections to the Client Windows VM. If you don't know your public IP, you can find it [here](https://www.whatismyip.com/) - - **_`client_admin_ssh`_** - SSH public key path, used for Linux VMs - - **_`deployment_flavor`_** - Use the value "ITPro" to specify that you want to deploy ArcBox for IT Pros - - _`client_admin_username`_ - Admin username for Windows & Linux VMs - - _`client_admin_password`_ - Admin password for Windows VMs. 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. - - **_`workspace_name`_** - Unique name for the ArcBox Log Analytics workspace - - > **Note:** Any variables in bold are required. If any optional parameters are not provided, defaults will be used. - -- Now you will deploy the Terraform file. Navigate to the local cloned deployment folder and run the commands below: - - ```shell - terraform init - terraform plan -out=infra.out - terraform apply "infra.out" - ``` - -- Example output from `terraform init`: - - ![terraform init](./terraform_init.png) - -- Example output from `terraform plan -out=infra.out`: - - ![terraform plan](./terraform_plan.png) - -- Example output from `terraform apply "infra.out"`: - - ![terraform plan](./terraform_apply.png) - - > **Note:** If you see any failure in the deployment, please check the [troubleshooting guide](#basic-troubleshooting). - ## Start post-deployment automation Once your deployment is complete, you can open the Azure portal and see the ArcBox resources inside your resource group. You will be using the _ArcBox-Client_ Azure virtual machine to explore various capabilities of ArcBox such as GitOps configurations and Key Vault integration. You will need to remotely access _ArcBox-Client_. @@ -557,7 +493,6 @@ The following tools are including on the _ArcBox-Client_ VM. - Visual Studio Code - Putty - 7zip -- Terraform - Git ### Next steps diff --git a/docs/azure_jumpstart_arcbox/ITPro/terraform_apply.png b/docs/azure_jumpstart_arcbox/ITPro/terraform_apply.png deleted file mode 100644 index baf5fbe8..00000000 Binary files a/docs/azure_jumpstart_arcbox/ITPro/terraform_apply.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/ITPro/terraform_init.png b/docs/azure_jumpstart_arcbox/ITPro/terraform_init.png deleted file mode 100644 index f5b23a07..00000000 Binary files a/docs/azure_jumpstart_arcbox/ITPro/terraform_init.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/ITPro/terraform_plan.png b/docs/azure_jumpstart_arcbox/ITPro/terraform_plan.png deleted file mode 100644 index 722b10e0..00000000 Binary files a/docs/azure_jumpstart_arcbox/ITPro/terraform_plan.png and /dev/null differ diff --git a/docs/azure_jumpstart_arcbox/faq/_index.md b/docs/azure_jumpstart_arcbox/faq/_index.md index dcdaade0..472a3d72 100644 --- a/docs/azure_jumpstart_arcbox/faq/_index.md +++ b/docs/azure_jumpstart_arcbox/faq/_index.md @@ -12,7 +12,7 @@ ArcBox is a sandbox that can be used to explore Azure Arc capabilities, build qu ## What is required to deploy ArcBox? -ArcBox deployment requires an Azure service principal with a **Contributor** or **Owner** role-based access control (RBAC) on an Azure subscription and resource group. You can deploy ArcBox using the Azure portal, Azure CLI, Bicep, or Terraform. A service principal is required to run the automation scripts that deploy and configure ArcBox features. You can view how the service principal is used by exploring the ArcBox code on our [public GitHub repository](https://aka.ms/JumpstartGitHubCode). +ArcBox deployment requires an Azure service principal with a **Contributor** or **Owner** role-based access control (RBAC) on an Azure subscription and resource group. You can deploy ArcBox using the Azure portal, Azure CLI or Bicep. A service principal is required to run the automation scripts that deploy and configure ArcBox features. You can view how the service principal is used by exploring the ArcBox code on our [public GitHub repository](https://aka.ms/JumpstartGitHubCode). ## What are the different "flavors" of ArcBox?