Skip to content

Commit d74049d

Browse files
authored
Merge pull request #227066 from alt-key/patch-2
Update deploy-cli.md
2 parents c4d623e + 49144e9 commit d74049d

File tree

1 file changed

+32
-11
lines changed

1 file changed

+32
-11
lines changed

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

Lines changed: 32 additions & 11 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,44 +17,64 @@ 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

21-
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.
23+
This command 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 updated.
24+
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.
2228

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.
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+
The `validate` command 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

34-
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.
42+
This command downloads the OS images from Microsoft that are used to deploy the on-premises appliance VM. Once downloaded, the images are then uploaded to the local cloud image gallery to prepare for the creation of the appliance VM.
43+
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.
3545

36-
This command can take up to 30 minutes to complete, depending on the network download speed. Allow the command to complete before continuing with the deployment.
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+
The `deploy` command 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 and agents within the Kubernetes cluster into a running state. Once the appliance VM is up, the kubeconfig file is generated.
50+
4151

4252
## az arcappliance create
4353

44-
Creates Arc resource bridge in Azure as an ARM resource, then establishes the connection between the ARM resource and on-premises appliance VM.
54+
This command creates Arc resource bridge in Azure as an ARM resource, then establishes the connection between the ARM resource and on-premises appliance VM.
55+
56+
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.
4557

46-
Running this command is the last step in the deployment process.
4758

4859
## az arcappliance show
4960

50-
Gets the ARM resource information for Arc resource bridge. This information helps you monitor the status of the appliance. Successful appliance creation results in `ProvisioningState = Succeeded` and `Status = Running`.
61+
The `show` command gets the status of the Arc resource bridge and ARM resource information. It can be used to check the progress of the connection between the ARM resource and on-premises appliance VM.
62+
63+
While the Arc resource bridge is connecting the ARM resource to the on-premises VM, the resource bridge will progress through the stages below:
64+
65+
`ProvisioningState` will be `Creating`, `Created`, `Failed`, `Deleting`, or `Succeeded`.
66+
67+
`Status` will transition between `WaitingForHeartbeat` -> `Validating` -> `Connected` -> `Running`.
68+
69+
Successful Arc resource bridge creation results in `ProvisioningState = Succeeded` and `Status = Running`.
70+
5171

5272
## az arcappliance delete
5373

54-
Deletes the appliance VM and Azure resources. It doesn't clean up the OS image, which remains in the on-premises cloud gallery.
74+
This command deletes the appliance VM and Azure resources. It doesn't clean up the OS image, which remains in the on-premises cloud gallery.
75+
76+
If a deployment fails, run this command to clean up the environment before you attempt to deploy again.
5577

56-
If a deployment fails, you must run this command to clean up the environment before you attempt to deploy again.
5778

5879
## Next steps
5980

0 commit comments

Comments
 (0)