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.

Sign up for GitHub

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

Jump to bottom

Updating H1 Headings on HCIBox docs #424

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Updating H1 Headings on HCIBox docs #424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/azure_jumpstart_hcibox/AKS/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,24 @@
weight: 8
---

## Azure Kubernetes Service on Azure Stack HCI
# Azure Kubernetes Service on your Azure Stack HCI HCIBox

Check failure on line 7 in docs/azure_jumpstart_hcibox/AKS/_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/AKS/_index.md", "range": {"start": {"line": 7, "column": 52}}}, "severity": "ERROR"}

Azure Stack HCI can provide host infrastructure for [Azure Kubernetes Service clusters](https://learn.microsoft.com/azure-stack/aks-hci/). HCIBox comes pre-configured with Azure Kubernetes Service on HCI (AKS-HCI). To see this in action, navigate to the resource group where you deployed HCIBox and follow these steps.

Check failure on line 9 in docs/azure_jumpstart_hcibox/AKS/_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/AKS/_index.md", "range": {"start": {"line": 9, "column": 140}}}, "severity": "ERROR"}

Check failure on line 9 in docs/azure_jumpstart_hcibox/AKS/_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/AKS/_index.md", "range": {"start": {"line": 9, "column": 289}}}, "severity": "ERROR"}

## Explore AKS on Azure Stack HCI

HCIBox is preconfigured with a network subnet dedicated to AKS deployment. Subnet details are as follows:

Check failure on line 13 in docs/azure_jumpstart_hcibox/AKS/_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/AKS/_index.md", "range": {"start": {"line": 13, "column": 1}}}, "severity": "ERROR"}

Check failure on line 13 in docs/azure_jumpstart_hcibox/AKS/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'subnet' instead of 'Subnet'.

Raw Output:
{"message": "[Vale.Terms] Use 'subnet' instead of 'Subnet'.", "location": {"path": "docs/azure_jumpstart_hcibox/AKS/_index.md", "range": {"start": {"line": 13, "column": 76}}}, "severity": "ERROR"}

| Network details | |
| ---------- | --------------------- |
| Subnet | 10.10.0.0/24 |

Check failure on line 17 in docs/azure_jumpstart_hcibox/AKS/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'subnet' instead of 'Subnet'.

Raw Output:
{"message": "[Vale.Terms] Use 'subnet' instead of 'Subnet'.", "location": {"path": "docs/azure_jumpstart_hcibox/AKS/_index.md", "range": {"start": {"line": 17, "column": 5}}}, "severity": "ERROR"}
| Gateway | 10.10.0.1 |
| VLAN Id | 110 |
| DNS Server | 192.168.1.254 |

Before creating an AKS workload cluster, you must create a local virtual network object. HCIBox includes a script that will complete this task using the pre-configured network. The script will then create a new AKS workload cluster.

Check failure on line 22 in docs/azure_jumpstart_hcibox/AKS/_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/AKS/_index.md", "range": {"start": {"line": 22, "column": 90}}}, "severity": "ERROR"}

- Open your HCIBox resource group and click on the _jumpstart_ custom location resource, then click "Arc-enabled services." Here you should see the hybridaksextension service available on the cluster. This is installed by default on Azure Stack HCI clusters, and is required for creating AKS workload clusters on HCI.

Check failure on line 24 in docs/azure_jumpstart_hcibox/AKS/_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/AKS/_index.md", "range": {"start": {"line": 24, "column": 13}}}, "severity": "ERROR"}

![Screenshot showing aks extension](./custom_location_resources.png)

Expand All @@ -37,7 +37,7 @@

![Screenshot showing edit with VSCode](./open_with_code.png)

- Uncomment line 6 in the script and edit the placeholder value for the _$aadgroupID_ parameter with the object ID of your Microsoft Entra group. Save the script and close VSCode when finished.

Check failure on line 40 in docs/azure_jumpstart_hcibox/AKS/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Uncomment'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Uncomment'?", "location": {"path": "docs/azure_jumpstart_hcibox/AKS/_index.md", "range": {"start": {"line": 40, "column": 3}}}, "severity": "ERROR"}

![Screenshot showing editing script](./edit_script.png)

Expand Down
3 changes: 1 addition & 2 deletions docs/azure_jumpstart_hcibox/RB/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ type: docs
linkTitle: "VM Management"
weight: 7
---

## Virtual machine provisioning with Azure Arc
# Virtual machine provisioning with Azure Arc in your HCIBox

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.

Expand Down
1 change: 1 addition & 0 deletions docs/azure_jumpstart_hcibox/cloud_deployment/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ linkTitle: "Connect to HCIBox"
isGettingStarted: false
weight: 5
---
# Connecting to HCIBox

## Start post-deployment automation

Expand Down
2 changes: 2 additions & 0 deletions docs/azure_jumpstart_hcibox/deployment_az/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ isGettingStarted: false
weight: 4
---

# Deploy HCIBox infrastructure with Azure CLI

## Azure CLI

Azure CLI can be used to deploy HCIBox into your Azure subscription. Azure CLI is recommended if you have been provided a service principal by your Azure administrator for use with HCIBox. If you 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, read on to learn how to deploy HCIBox with Azure CLI.
Expand Down
3 changes: 1 addition & 2 deletions docs/azure_jumpstart_hcibox/deployment_azd/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ linkTitle: "Azure Developer CLI Deployment"
isGettingStarted: false
weight: 3
---

## Deploy HCIBox infrastructure with Azure Developer CLI
# Deploy HCIBox infrastructure with Azure Developer CLI

[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).

Expand Down
2 changes: 1 addition & 1 deletion docs/azure_jumpstart_hcibox/faq/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linkTitle: "HCIBox FAQ"
weight: 7
---

## Jumpstart HCIBox Frequently Asked Questions (FAQ)
# Jumpstart HCIBox Frequently Asked Questions (FAQ)

## What is Jumpstart HCIBox?

Expand Down
3 changes: 2 additions & 1 deletion docs/azure_jumpstart_hcibox/troubleshooting/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ type: docs
linkTitle: "Troubleshooting"
weight: 9
---
# Troubleshooting HCIBox

## Troubleshooting
## Troubleshooting Deployments

Occasionally deployments of HCIBox may fail at various stages. Common reasons for failed deployments include:

Expand Down
1 change: 1 addition & 0 deletions docs/azure_jumpstart_hcibox/using_hcibox/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ linkTitle: "Using HCIBox"
isGettingStarted: false
weight: 6
---
# Evaluating the HCIBox

## Using HCIBox

Expand Down
Loading