azure / arc_jumpstart_docs

A public repo for hosting the Arc Jumpstart docs

Azure Arc Jumpstart documentation

Welcome to the Arc Jumpstart documentation repository! This repository is your go-to resource for in-depth guides, best practices, and detailed documentation related to Azure Arc. Whether you're a beginner exploring the basics or an experienced user optimizing your deployment, you'll find valuable insights tailored to your needs. This repository complements our source code repository and acts has the documentation source repository which populates the Arc Jumpstart website.

Note: This repository doesn't contain the source code for the automation scripts and tools of the Arc Jumpstart. The source code for Arc Jumpstart can be found in another dedicated repository.

What you'll find here

• Documents: Arc Jumpstart markdown files utilized in scenarios and solutions, offering comprehensive technical information.
• Visual Resources: Clear and concise screenshots providing visual context for easier comprehension of the documentation.
• Supportive Documents and Files: Additional resources used across the Arc Jumpstart website, aiding in various contexts and providing supplemental information.

How to utilize this repository

This documentation repository is tailored for contributors and works in tandem with the our source code repository. While not mandatory, it's highly probable that contributors will need to clone both repositories to effectively contribute to Arc Jumpstart.

Before you start, we recommend familiarizing yourself with our comprehensive contribution guidelines. These guidelines outline the standards and practices we follow, ensuring consistency and quality across our documentation.

If you're unsure about your future contribution, don't hesitate to start a GitHub discussion. This is a great place to ask questions, share ideas, or get feedback on potential contributions. Our community is here to help and we welcome all levels of experience.

Happy contributing!

Branch guidance

The Arc Jumpstart docs repository handles branching similarly to most code repositories. Two primary branches are maintained, each one attached to a specific website slot (prod/canary).

The following branches are currently maintained:

Branch	Website	Description
main (primary)	https://arcjumpstart.com/	Latest Arc Jumpstart release documentation. This is the latest documentation available in the deployed to the production slot.
canary (canary)	https://preview.arcjumpstart.com/	Pre-release documentation. Doc updates should be merged to the canary branch for preview validation before merging to the main branch.

Cloning the repositories

To contribute, you'll likely need to clone both this repository and the source code repository. Use the following commands:

git clone https://github.com/Azure/arc_jumpstart_docs.git
git clone https://github.com/microsoft/azure_arc.git

As we continuously improve and expand Arc Jumpstart, we recommend keeping your local clones of the repositories up-to-date. You can do this by pulling the latest changes from the main branch:

git pull origin main

Contribution and feedback

Your input is highly valued! If you have suggestions, feedback, or valuable insights to share, feel free to open an issue. Your contributions help improve the documentation for the entire community.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant Arc Jumpstart team the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (for example, status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using Microsoft's CLA.

This project has adopted the Microsoft Open Source Code of Conduct.

For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Writing Guidelines

This repository uses vale.sh to help tech writers and contributors adhere to Microsoft's writing styling guidelines. Vale is a command-line tool that allows you to check your writing for grammar and spelling errors against a set of style rules.

For more information about Vale configuration, local usage and GitHub CI actions, check Wiki - Vale Integration.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines.

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

arc_jumpstart_docs's Issues

Update Azure Arc-enabled vSphere documentation notes

Update Azure Arc-enabled vSphere scenario note sections to match new format and align with the product now being generally available.

Azure ArcBox Workbook missed [ITPro flavor]

Hi Team,

I recently (last evening, Nov 21st) implemented ITPro Azure ArcBox following detailed instructions from the newest version of the page Jumpstart ArcBox for IT Pros. However, after fighting with some issues - problems with implementing MA/MMA agent on ArcBOX-SQL (it was necessary to reimplement agents manually, from within the virtual machine) most problems connected with MFA challenges - I landed with lack of Arc workbook.

Based on document and rg_arc picture there should be a workbook ready to use. Sadly in my implementation it is not exist:

Here is the standard list of all resources

Here is the expanded list of all resources

And there is no errors about workbook in this deployment (only one error is with double deployment of AMA.

Can we please investigate if this is only mine problem?

Arc-enbaled servers scenario - CustomScriptExtension - Broken links

The links pointing to the scripts and the deployToAzure button are broken.

https://azurearcjumpstart.com/azure_arc_jumpstart/azure_arc_servers/day2/arc_vm_extension_customscript_arm

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Update module versions in scenario "Automanage Machine Configuration custom configurations for Windows"

• Update PowerShell module versions in scenario Automanage Machine Configuration custom configurations for Windows

HCIBox AZD use the current PowerShell context different to azd auth context #2443

This is an issue has been raised in azure arc repo. One possible solution to highlight the issue and provide guidance for user is to highlight this use case in the documentation
Reference: microsoft/azure_arc#2443

Is your issue related to a Jumpstart scenario, ArcBox, HCIBox, or Agora?
I was following the instruction from this documentation (https://azurearcjumpstart.io/azure_jumpstart_hcibox/deployment_azd)

Describe the issue or the bug
When using azd up for HCI Box scenarios, the command failed at pre-provision script. Please see screen shot

To Reproduce
1 - Login with powershell with credential - X
2 - Login with azd auth login for HCI box using anther credential - Y - which does not have the same access to X ie different tenant.
3 - Run azd up

Expected behavior
Pre-provision step using PowerShell will consider the context from azd auth

Environment summary

az 2.57.0
azd v1.6.1
Powershell 7.4.1

Have you looked at the Troubleshooting and Logs section?

Yes I did

Screenshots

Additional context

I volunteer to update the doc to hight light this problem

This repo is missing a license file

This repository is currently missing a LICENSE.MD file outlining its license. A license helps users understand how to use your project in a compliant manner. You can find the standard MIT license text at the Microsoft repo templates LICENSE file: https://github.com/microsoft/repo-templates/blob/main/shared/LICENSE.
If you would like to learn more about open source licenses, please visit the document at https://aka.ms/license.

AIO scenario - Add required resource providers registration guidance

Failed to deploy Azure Arc-enabled servers connectivity behind a proxy server

When trying to use the proxy scenario the client fails to onboard, because it cannot connect to aka.ms. See attached

Code snippet to create service principal for Microsoft Azure: Windows Server Virtual Machine has error, causing it to fail

Currently, the snippet is
az login
subscriptionId=$(az account show --query id --output tsv)
az ad sp create-for-rbac -n "<Unique SP Name>" --role "Contributor" --scopes /subscriptions/$subscriptionId

However, the $ declaring the variable subscriptionID slipped. It should be:

az login
$subscriptionId=(az account show --query id --output tsv)
az ad sp create-for-rbac -n "<Unique SP Name>" --role "Contributor" --scopes /subscriptions/$subscriptionId