Skip to content

Commit e496e80

Browse files
authored
Update deploy-cli.md
1 parent f837461 commit e496e80

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

articles/azure-arc/resource-bridge/deploy-cli.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ ms.date: 02/06/2023
55
ms.topic: overview
66
---
77

8+
89
# Azure Arc resource bridge (preview) deployment command overview
910

1011
[Azure CLI](/cli/azure/install-azure-cli) is required to deploy the Azure Arc resource bridge. When deploying Arc resource bridge with a corresponding partner product, the Azure CLI commands may be combined into an automation script, along with additional provider-specific commands. To learn about installing Arc resource bridge with a corresponding partner product, see:
@@ -16,35 +17,45 @@ ms.topic: overview
1617

1718
This topic provides an overview of the [Azure CLI commands](/cli/azure/arcappliance) that are used to manage Arc resource bridge (preview) deployment, in the order in which they are typically used for deployment.
1819

20+
1921
## az arcappliance createconfig
2022

2123
Creates the configuration files used by Arc resource bridge. Credentials that are provided during `createconfig`, such as vCenter credentials for VMware vSphere, are stored in a configuration file and locally within Arc resource bridge. These credentials should be a separate user account used only by Arc resource bridge, with permission to view, create, delete, and manage on-premises resources. If the credentials change, then the credentials on the resource bridge should be rotated.
2224

23-
The `createconfig` command features two modes: interactive and non-interactive. Interactive mode provides helpful prompts that explain the parameter and what to pass. To initiate interactive mode, pass only the three required parameters. Non-interactive mode allows you to pass all the parameters needed to create the configuration files without being prompted, which saves time and is useful for automation scripts. Three configuration files are generated: resource.yaml, appliance.yaml and infra.yaml. These files should be kept and stored in a secure location, as they're required for maintenance of Arc resource bridge.
25+
The `createconfig` command features two modes: interactive and non-interactive. Interactive mode provides helpful prompts that explain the parameter and what to pass. To initiate interactive mode, pass only the three required parameters. Non-interactive mode allows you to pass all the parameters needed to create the configuration files without being prompted, which saves time and is useful for automation scripts.
26+
27+
Three configuration files are generated: resource.yaml, appliance.yaml and infra.yaml. These files should be kept and stored in a secure location, as they're required for maintenance of Arc resource bridge.
28+
29+
This command also calls the `validate` command to check the configuration files.
2430

2531
> [!NOTE]
2632
> Azure Stack HCI and Hybrid AKS use different commands to create the Arc resource bridge configuration files.
2733
34+
2835
## az arcappliance validate
2936

30-
Checks the configuration files for a valid schema, cloud and core validations (such as management machine connectivity to required URLs), network settings, and no proxy settings.
37+
Checks the configuration files for a valid schema, cloud and core validations (such as management machine connectivity to required URLs), network settings, and proxy settings. It also performs tests on identity privileges and role assignments, network configuration, loadbalancer configuration and content delivery network connectivity.
38+
3139

3240
## az arcappliance prepare
3341

3442
Downloads the OS images from Microsoft and uploads them to the on-premises cloud image gallery to prepare for the creation of the appliance VM.
3543

36-
This command can take about 15-30+ minutes to complete, depending on the network speed. Allow the command to complete before continuing with the deployment.
44+
This command takes about 10-30+ minutes to complete, depending on the network speed. Allow the command to complete before continuing with the deployment.
45+
3746

3847
## az arcappliance deploy
3948

40-
Deploys an on-premises instance of Arc resource bridge as an appliance VM, bootstrapped to be a Kubernetes management cluster. Gets all necessary pods into a running state.
49+
Deploys an on-premises instance of Arc resource bridge as an appliance VM, bootstrapped to be a Kubernetes management cluster. This command gets all necessary pods into a running state.
50+
4151

4252
## az arcappliance create
4353

4454
Creates Arc resource bridge in Azure as an ARM resource, then establishes the connection between the ARM resource and on-premises appliance VM.
4555

4656
Once the `create` command initiates the connection, it will return in the terminal even though the connection between the ARM resource and on-premises appliance VM is not yet complete. The resource bridge needs about 5 minutes to establish the connection between the ARM resource and the on-premises VM.
4757

58+
4859
## az arcappliance show
4960

5061
Gets the status of the Arc resource bridge and ARM resource information.
@@ -57,11 +68,13 @@ While the Arc resource bridge is connecting the ARM resource to the on-premises
5768

5869
Successful Arc resource bridge creation results in `ProvisioningState = Succeeded` and `Status = Running`.
5970

71+
6072
## az arcappliance delete
6173

6274
Deletes the appliance VM and Azure resources. It doesn't clean up the OS image, which remains in the on-premises cloud gallery.
6375

64-
If a deployment fails, you must run this command to clean up the environment before you attempt to deploy again.
76+
If a deployment fails, run this command to clean up the environment before you attempt to deploy again.
77+
6578

6679
## Next steps
6780

0 commit comments

Comments
 (0)