Skip to content

Commit

Permalink
H2 heading updates and language cleanup on various docs, mostly on ge…
Browse files Browse the repository at this point in the history
…tting_started
  • Loading branch information
Charles Broadfoot committed Oct 18, 2024
1 parent 2fd39da commit d082d4f
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 46 deletions.
6 changes: 3 additions & 3 deletions docs/azure_jumpstart_hcibox/RB/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 7

Azure Stack HCI supports [VM provisioning the Azure portal](https://learn.microsoft.com/azure-stack/hci/manage/manage-arc-virtual-machines). Like all Azure Stack HCI clusters, the HCIBox cluster comes preconfigured with the components needed for VM management through Azure portal. Follow this guide to configure a basic VM from a marketplace image.

Check failure on line 8 in docs/azure_jumpstart_hcibox/RB/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'HCIBox'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'HCIBox'?", "location": {"path": "docs/azure_jumpstart_hcibox/RB/_index.md", "range": {"start": {"line": 8, "column": 181}}}, "severity": "ERROR"}

### Create Virtual Machine images from Azure marketplace
## Create Virtual Machine images from Azure marketplace

Before you can create virtual machines on your HCI cluster from Azure portal, you must create some VM images that can be used as a base. These images can be imported from Azure marketplace or provided directly by the user. In this use case, you will create an image from Azure marketplace.

Expand All @@ -29,7 +29,7 @@ Before you can create virtual machines on your HCI cluster from Azure portal, yo

- Monitor the image as needed until is it finished downloading. While you wait, proceed to the next section to create the logical network on the cluster.

### Create a logical network on your HCI cluster
## Create a logical network on your HCI cluster

HCIBox networking includes a 192.168.200.0/24 subnet tagged to VLAN200. This network is designed for use with Arc-enabled VMs on HCIBox. To use this preconfigured network, you must create a logical network resource that maps to this subnet.

Check failure on line 34 in docs/azure_jumpstart_hcibox/RB/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'HCIBox'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'HCIBox'?", "location": {"path": "docs/azure_jumpstart_hcibox/RB/_index.md", "range": {"start": {"line": 34, "column": 1}}}, "severity": "ERROR"}

Check failure on line 34 in docs/azure_jumpstart_hcibox/RB/_index.md

View workflow job for this annotation

GitHub Actions / lint

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

Expand All @@ -48,7 +48,7 @@ HCIBox networking includes a 192.168.200.0/24 subnet tagged to VLAN200. This net

![Screenshot showing logical network in Azure portal](./logical_network.png)

### Create a virtual machine
## Create a virtual machine

- Open the VM image resource and verify that your VM image has finished downloading.

Expand Down
20 changes: 10 additions & 10 deletions docs/azure_jumpstart_hcibox/cloud_deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ weight: 5

## Start post-deployment automation

Once your bicep deployment is complete with Azure CLI or Azure Developer CLI, you can open the Azure portal and see the initial HCIBox resources inside your resource group. Now you must remote into the _HCIBox-Client_ VM to continue the next phase of the deployment.
Once your bicep deployment is complete with Azure CLI or Azure Developer CLI, you can open the Azure portal to see the initial HCIBox resources inside your resource group. Now you must remote into the _HCIBox-Client_ VM to continue the next phase of the deployment.

Check failure on line 11 in docs/azure_jumpstart_hcibox/cloud_deployment/_index.md

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'HCIBox'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'HCIBox'?", "location": {"path": "docs/azure_jumpstart_hcibox/cloud_deployment/_index.md", "range": {"start": {"line": 11, "column": 128}}}, "severity": "ERROR"}

![Screenshot showing all deployed resources in the resource group](./deployed_resources.png)

> **Note:** RDP (3389) and SSH (22) ports are not open by default in HCIBox deployments. You will need to create a network security group (NSG) rule to allow network access to port 3389, or use [Azure Bastion](https://learn.microsoft.com/azure/bastion/bastion-overview) or [Just-in-Time (JIT)](https://learn.microsoft.com/azure/defender-for-cloud/just-in-time-access-usage?tabs=jit-config-asc%2Cjit-request-asc) access to connect to the VM.
### Connecting to the HCIBox Client virtual machine
## Connecting to the HCIBox Client virtual machine

Various options are available to connect to _HCIBox-Client_ VM, depending on the parameters you supplied during deployment.

- [RDP](#connecting-directly-with-rdp) - available after configuring access to port 3389 on the _Arc-App-Client-NSG_, or by enabling [Just-in-Time access (JIT)](#connect-using-just-in-time-access-jit).
- [Azure Bastion](#connect-using-azure-bastion) - available if *`true`* was the value of your _`deployBastion`_ parameter during deployment.

#### Connecting directly with RDP
### Connecting directly with RDP

By design, HCIBox does not open port 3389 on the network security group. Therefore, you must create an NSG rule to allow inbound 3389.

Expand All @@ -41,15 +41,15 @@ By design, HCIBox does not open port 3389 on the network security group. Therefo

![Screenshot showing connecting to the VM using RDP](./rdp_connect.png)

#### Connect using Azure Bastion
### Connect using Azure Bastion

- If you have chosen to deploy Azure Bastion in your deployment, use it to connect to the VM.

![Screenshot showing connecting to the VM using Bastion](./bastion_connect.png)

> **Note:** When using Azure Bastion, the desktop background image is not visible. Therefore some screenshots in this guide may not exactly match your experience if you are connecting to _HCIBox-Client_ with Azure Bastion.
#### Connect using just-in-time access (JIT)
### Connect using just-in-time access (JIT)

If you already have [Microsoft Defender for Cloud](https://learn.microsoft.com/azure/defender-for-cloud/just-in-time-access-usage?tabs=jit-config-asc%2Cjit-request-asc) enabled on your subscription and would like to use JIT to access the Client VM, use the following steps:

Expand All @@ -61,7 +61,7 @@ If you already have [Microsoft Defender for Cloud](https://learn.microsoft.com/a

![Screenshot showing connecting to the VM using JIT](./jit_rdp_connect.png)

#### The Logon scripts
### The Logon scripts

- Once you log into the _HCIBox-Client_ VM, a PowerShell script will open and start running. This script will take anywhere between 1-2 hours to finish, and once completed, the script window will close automatically. At this point, the infrastructure deployment is complete.

Expand All @@ -76,14 +76,14 @@ If you already have [Microsoft Defender for Cloud](https://learn.microsoft.com/a
- If everything looks good, and you did not choose to configure the `autoDeployClusterResource` parameter with the value `true` in your deployment, proceed to the next section to validate and deploy your cluster. If you did enable this parameter, you may proceed to the section _Deployment complete_ at the end of this page.
Visit [troubleshooting](/azure_jumpstart_hcibox/troubleshooting/) if needed for deployment issues.

### Azure portal Azure Stack HCI cluster validation and deployment
## Azure portal Azure Stack HCI cluster validation and deployment

Azure Stack HCI uses a two-step process to create and register clusters in Azure using an ARM template.

1. **Validate** - an ARM template is deployed with a "validate" flag. This begins the final cluster validation step and takes around 20 minutes.
2. **Deploy** - the same ARM template is redeployed with the "deploy" flag. This deploys the cluster and Arc infrastructure and registers the cluster. This step takes around 2-3 hours.

#### Validate cluster in Azure portal
### Validate cluster in Azure portal

- Before submitting the ARM deployment, you need to add your user account as a Key Vault Administrator on the HCIBox resource group. Navigate to the resource group then click "Access Control (IAM)" and then "Add role assignment". Select the "Key Vault Administrator role" then click on to the next screen to select your user account and assign your user the role.

Expand Down Expand Up @@ -117,7 +117,7 @@ Azure Stack HCI uses a two-step process to create and register clusters in Azure

- Monitor validation as needed until complete.

#### Deploy cluster in Azure portal
## Deploy cluster in Azure portal

- When validation is complete navigate to the cluster resource in your HCIBox resource group. The banner should indicate that your cluster is validated but not yet deployed. Click the "Deploy now" link.

Expand All @@ -127,7 +127,7 @@ Azure Stack HCI uses a two-step process to create and register clusters in Azure

![Screenshot showing progress of deploying cluster](./cluster_deployment_progress.png)

#### Deployment complete
## Deployment complete

- Once the HCIBox cluster is deployed it's time to start exploring various HCIBox features. Head on to the [Using HCIBox](/azure_jumpstart_hcibox/using_hcibox) guide for the next steps.

Expand Down
10 changes: 4 additions & 6 deletions docs/azure_jumpstart_hcibox/deployment_azd/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 3

[Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview) automates the creation or retrieval of several HCIBox deployment requirements. It's best used when the deploying user has permission to [create applications in Microsoft Entra ID](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#cloud-application-administrator).

### Prepare environment
## Prepare environment

- Clone the Azure Arc Jumpstart repository

Expand All @@ -24,11 +24,11 @@ weight: 3

![Screenshot showing azd auth login](./azd_auth_login.png)

- Run the *`azd init`* command from your cloned repo _*azure_jumpstart_hcibox*_ folder.
- Run the *`azd init`* command from the _*azure_jumpstart_hcibox*_ folder within your cloned repo.

![Screenshot showing azd init](./azd_init.png)

### Deploy the environment
## Deploy the environment

- Run the *`azd up`* command to deploy the environment. Azd will prompt you to enter the target subscription, region, and all required parameters. It is highly recommended to use _eastus_ as your region.

Expand All @@ -48,9 +48,7 @@ Once your deployment is complete, you can open the Azure portal and see the init

After you are finished with your HCIBox deployment use ```azd down``` to delete your resources.

- Clean up using Azure Developer CLI

```shell
```Azure Developer CLI
azd down
```

Expand Down
28 changes: 9 additions & 19 deletions docs/azure_jumpstart_hcibox/getting_started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 2

HCIBox is a turnkey solution that provides a complete sandbox for exploring [Azure Stack HCI](https://learn.microsoft.com/azure-stack/hci/whats-new) capabilities and hybrid cloud integration in a virtualized environment. HCIBox is designed to be completely self-contained within a single Azure subscription and resource group, which will make it easy for a user to get hands-on with Azure Stack HCI and [Azure Arc](https://learn.microsoft.com/azure/azure-arc/overview) technology without the need for physical hardware.

> **Note:** [Azure Stack HCI 23H2](https://learn.microsoft.com/azure-stack/hci/whats-new) is now generally available. 23H2 simplifies configuration and deployment of HCI clusters and related workloads like [VM management](https://learn.microsoft.com/azure-stack/hci/manage/azure-arc-vm-management-overview) for VM self-service management in Azure portal. HCIBox has also been updated and now offers clusters built on the new 23H2 OS, and prior Azure Stack HCI releases are no longer part of HCIBox or supported by the Jumpstart team. If you've used earlier versions of HCIBox you should read this guide thoroughly to understand the new HCIBox deployment process.
> **Note:** [Azure Stack HCI 23H2](https://learn.microsoft.com/azure-stack/hci/whats-new) is now generally available. 23H2 simplifies configuration and deployment of HCI clusters and related workloads like [VM management](https://learn.microsoft.com/azure-stack/hci/manage/azure-arc-vm-management-overview) for VM self-service management in Azure portal. HCIBox has also been updated and now offers clusters built on the new 23H2 OS, and prior Azure Stack HCI releases are no longer part of HCIBox or supported by the Jumpstart team. If you have used earlier versions of HCIBox you should read this guide thoroughly to understand the new HCIBox deployment process.
<img src="/img/logo/hcibox.png" alt="Jumpstart HCIBox logo" width="250">

Expand Down Expand Up @@ -43,35 +43,25 @@ Azure Stack HCI includes [Azure Kubernetes Services on Azure Stack HCI (AKS hybr

HCIBox resources generate Azure Consumption charges from the underlying Azure resources including core compute, storage, networking and auxiliary services. Note that Azure consumption costs may vary depending the region where HCIBox is deployed. Be mindful of your HCIBox deployments and ensure that you disable or delete HCIBox resources when not in use to avoid unwanted charges. Please see the [Jumpstart HCIBox FAQ](../faq/) for more information on consumption costs.

## Deployment Options and Automation Flow
## Deployment Options and Flow

HCIBox provides two methods for deploying and configuring the necessary resources in Azure.
HCIBox supports [Bicep](https://learn.microsoft.com/azure/azure-resource-manager/bicep/overview?tabs=bicep) templates for both Azure CLI and [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview) to deploy and configure necessary Azure resources.

- A [Bicep](https://learn.microsoft.com/azure/azure-resource-manager/bicep/overview?tabs=bicep) template that can be deployed manually via Azure CLI.

- An [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview) template that can be used to for a more streamlined experience.

![Screenshot showing deployment flow diagram for Bicep-based deployments](./deployment_flow.png)

## Deployment options and prerequisites

Deploying HCIBox is a multi-step process.
Deploying HCIBox is a multi-step process that includes:

1) Deploy Azure infrastructure
2) Automation scripts configure virtual HCI cluster and generate ARM template
3) User or automation deploys ARM template (HCI cluster validate phase)
4) User or automation re-deploys ARM template (HCI cluster deploy phase)

HCIBox includes Bicep templates that can be used with Azure Developer CLI or Azure CLI. If your user can create application registrations in Microsoft Entra ID, then [Azure Developer CLI](/azure_jumpstart_hcibox/deployment_azd) will be the optimal deployment option that satisfies most other prerequisites. Otherwise, [Azure CLI](/azure_jumpstart_hcibox/deployment_az) can be used with a pre-configured service principal.

- [Deploy HCIBox with Azure Developer CLI](/azure_jumpstart_hcibox/deployment_azd)
![Screenshot showing deployment flow diagram for Bicep-based deployments](./deployment_flow.png)

- [Deploy HCIBox with Azure CLI](/azure_jumpstart_hcibox/deployment_az)
## Deploy HCIBox
- [Deploy HCIBox with Azure Developer CLI](/azure_jumpstart_hcibox/deployment_azd) : Best for those with access to Microsoft Entra ID
- [Deploy HCIBox with Azure CLI](/azure_jumpstart_hcibox/deployment_az) : Alternative to Microsoft Entra ID, requires pre-configured service principle.

Looking for something else related to HCIBox?

- [Connect to HCIBox](/azure_jumpstart_hcibox/cloud_deployment)

- [HCIBox FAQ](/azure_jumpstart_hcibox/faq)

- [HCIBox FAQ](/azure_jumpstart_hcibox/faq)
- [HCIBox FAQ](/azure_jumpstart_hcibox/faq)
16 changes: 8 additions & 8 deletions docs/azure_jumpstart_hcibox/using_hcibox/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ weight: 6

HCIBox has many features that can be explored through the Azure portal or from inside the _HCIBox-Client_ virtual machine. To help you navigate all the features included, read through the following sections to understand the general architecture and how to use various features.

### Nested virtualization
## Nested virtualization

HCIBox simulates a 2-node physical deployment of Azure Stack HCI by using [nested virtualization on Hyper-V](https://learn.microsoft.com/virtualization/hyper-v-on-windows/user-guide/nested-virtualization). To ensure you have the best experience with HCIBox, take a moment to review the details below to help you understand the various nested VMs that make up the solution.

Expand All @@ -25,13 +25,13 @@ HCIBox simulates a 2-node physical deployment of Azure Stack HCI by using [neste
| _JumpstartDC_ | Domain controller | Yes (DC) | _AzSMGMT_ | Windows Server 2022 |
| _Vm-Router_ | Remote Access Server | No | _AzSMGMT_ | Windows Server 2022 |

### Active Directory domain user credentials
## Active Directory domain user credentials

Once you are logged into the _HCIBox-Client_ VM using the local admin credentials you supplied in your template parameters during deployment you will need to switch to using a domain account to access most other functions, such as logging into the HCI nodes. The default domain account is _[email protected]_.

> **Note:** The password for this account is set as the same password you supplied during deployment for the local account. Many HCIBox operations will use the domain account wherever credentials are required.
### Monitoring Azure Stack HCI
## Monitoring Azure Stack HCI

Azure Stack HCI integrates with [Azure Monitor](https://learn.microsoft.com/azure-stack/hci/manage/monitor-hci-single) to support monitoring HCI cluster insights through the Azure portal. Follow these steps to configure monitoring on your HCIBox cluster.

Expand All @@ -47,7 +47,7 @@ Azure Stack HCI integrates with [Azure Monitor](https://learn.microsoft.com/azur

![Screenshot showing logs configured](./hci_insights.png)

### Upgrading Azure Stack HCI
## Upgrading Azure Stack HCI

HCIBox is regularly updated with the latest available version of the installation medium. The product group regularly publish updates which contains security fixes and feature improvements, which may be released after the latest HCIBox update.
Due to this, it might be required to trigger an update after the initial deployment of the HCI cluster.
Expand All @@ -62,27 +62,27 @@ If the _Status_-column does not indicate _Up to date_, you can trigger the updat

See the [product documentation](https://learn.microsoft.com/azure-stack/hci/update/about-updates-23h2) for more information about HCI updates.

### Virtual machine management through Azure portal
## Virtual machine management through Azure portal

Azure Stack HCI supports [VM management through the Azure portal](https://learn.microsoft.com/azure-stack/hci/manage/azure-arc-enabled-virtual-machines). Open the [HCIBox VM provisioning documentation](/azure_jumpstart_hcibox/RB/) to get started.

![Screenshot showing VM provisioning blade](./vm_provisioning.png)

### Azure Kubernetes Service
## Azure Kubernetes Service (AKS)

HCIBox comes pre-configured with [Azure Kubernetes Service on Azure Stack HCI](https://learn.microsoft.com/azure-stack/aks-hci/). Open the [HCIBox AKS-HCI documentation](/azure_jumpstart_hcibox/AKS/) to explore currently available features.

![Screenshot showing AKS on Azure Stack HCI](./cluster_detail.png)

### Advanced Configurations
## Advanced Configurations

Some users may be interested in changing HCIBox's default configuration. Many settings can be configured by modifying the values in the [_HCIBox-Config.psd1_](https://raw.githubusercontent.com/microsoft/azure_arc/main/azure_jumpstart_hcibox/artifacts/HCIBox-Config.psd1) PowerShell file. If you wish to make changes to this file, you must fork the Jumpstart repo and make the changes in your fork, then set the optional _githubAccount_ and _githubBranch_ deployment template parameters to point to your fork.

> **Note:** Advanced configuration deployments are not supported by the Jumpstart team. Changes made to the _HCIBox-Config.psd1_ file may result in failures at any point in HCIBox deployment. Make changes to this file only if you understand the implications of the change.
![Screenshot showing advanced configuration file](./advanced_config.png)

### Next steps
## Next steps

HCIBox is a sandbox that can be used for a large variety of use cases, such as an environment for testing and training or to jumpstart proof of concept projects. You are free to do whatever you wish with HCIBox. Some suggested next steps for you to try in your HCIBox are:

Expand Down

0 comments on commit d082d4f

Please sign in to comment.