Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updating with bug reporting guidelines and explanation what AKS hybrid is
  • Loading branch information
mkostersitz authored Jan 6, 2023
1 parent ed01d1e commit 686562c
Showing 1 changed file with 58 additions and 5 deletions.
63 changes: 58 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,34 @@
# Welcome to the AKS hybrid deployment options repo

As you can tell we have changed our name from AKS-HCI to AKS hybrid this allows us to encompass all of the AKS hybrid deployment options we support. Check out the [Ignite 2022 blog\(https://aka.ms/aks-hybrid-blog22) for details.
## What's new
We have changed our name from AKS-HCI to AKS hybrid this allows us to encompass all of the AKS hybrid deployment options we support. Check out the [Ignite 2022 blog\(https://aka.ms/aks-hybrid-blog22) for details.
This is where the AKS hybrid team will track features and issues with AKS hybrid. We will monitor this repo in order to engage with our community and discuss questions, customer scenarios, or feature requests.

## Overview

All AKS versions Microsoft ships for edge or datacenter deployment are part of the "AKS hybrid" family, this includes:
* [AKS on Azure Stack HCI and Windows Server (GA product)](https://aka.ms/aks-hybrid)
* This is the Arc Connected version of AKS hybrid. AKS clusters created on premise are connnected to Azure using Azure Arc enabled Kubernetes agents and are managed using PowerShell or Windows Admin Center
* [AKS on Azure Stack Hub](https://learn.microsoft.com/azure-stack/user/azure-stack-kubernetes-aks-engine-overview)
* [AKS on IoT (AKS Edge Essentials)](https://learn.microsoft.com/en-us/azure/aks/hybrid/aks-edge-overview)
* [AKS hybrid cluster provisioning from Azure (Public Preview)](https://learn.microsoft.com/en-us/azure/aks/hybrid/aks-hybrid-preview-overview)
* This is the Arc Resource Bridge based implementation which allows you to provision AKS hybrid clusters on premise. Thes clustes are always Arc enabled and managed entirely from the cloud like a cloud based AKS cluster would be.

## What you will find here
This repository is offered for tracking features and issues with the AKS hybrid. This repository is monitored by the product team in order to engage with our community and discuss questions, customer scenarios, or feature requests.

Support through issues on this repository is provided on a best-effort basis for issues that are reproducible outside of a specific cluster configuration. If you need immidiate assistance please open a support case through the Azure Portal.
Support through issues on this repository is provided on a best-effort basis for issues that are reproducible outside of a specific cluster configuration (see Bug Guidance below). To receive urgent support you must file a support request through official Azure support channels as urgent support is explicitly out of scope of this repository's objectives.

> **IMPORTANT**: For official customer support with response-time SLAs please see
[Azure Support options][1] and [AKS Support Policies][2].

Do not file issues for AKS-Engine, Virtual-Kubelet, Azure Container Instances, or services on this repository unless it is related to that feature/service and functionality with AKS. For other tools, products and services see the Upstream Azure Compute projects page.

Do not file issues for AKS, AKS-Engine, Virtual-Kubelet, Azure Container Instances, or services on this repository unless it is related to that feature/service and functionality with AKS hybrid.

We want to hear from you! Fill in this [anonymous survey](https://aka.ms/AKSHCIPreviewSurvey) to share your thoughts with us.
We want to hear from you! Respond to this short and [anonymous survey](https://aka.ms/AKSHCIPreviewSurvey) to share your thoughts with us.

# Important AKS hybrid links
## Important AKS hybrid links
|||
|-----|-----|
|Evaluation Guide|https://aka.ms/aks-hybrid-evaluate|
Expand All @@ -22,7 +39,43 @@ We want to hear from you! Fill in this [anonymous survey](https://aka.ms/AKSHCIP
|Customer Voice Community|https://aka.ms/aks-hybrid-community|
|Meet the product team in Microsoft Teams<br>Fill in the form and we will add you to the channel ASAP.|https://aka.ms/aks-hybrid-teams|

# Contributing
## Bug Reports <a name="bugs"></a>

> **IMPORTANT**: An inability to meet the below requirements for bug reports are subject to being closed by maintainers and routed to official Azure support channels to provide the proper support experience to resolve user issues.
Bug reports filed on this repository should follow the default issue template
that is shown when opening a new issue. At a bare minimum, issues reported on
this repository must:

1. Be reproducible outside of the current cluster

* This means that if you file an issue that would require direct access to
your cluster and/or Azure resources you will be redirected to open an Azure
support ticket. Microsoft employees may not ask for personal / subscription
information on Github.
* For example, if your issue is related to custom scenarios such as
custom network devices, configuration, authentication issues related to
your Azure subscription, etc.

2. Contain the following information:

* A good title: Clear, relevant and descriptive - so that a general idea of the
problem can be grasped immediately
* Description: Before you go into the detail of steps to replicate the issue,
you need a brief description.
* Assume that whomever is reading the report is unfamiliar with the
issue/system in question
* Clear, concise steps to replicate the issue outside of your specific cluster.
* These should let anyone clearly see what you did to see the problem, and
also allow them to recreate it easily themselves. This section should also
include results - both expected and the actual - along with relevant URLs.
* Be sure to include any supporting information you might have that could aid the developers.
* This includes YAML files/deployments, scripts to reproduce, exact commands used, screenshots, etc.

[1]: https://azure.microsoft.com/support/options/
[2]: [https://docs.microsoft.com/en-us/azure/aks/support-policies](https://learn.microsoft.com/en-us/azure/aks/hybrid/support-policies)

## Contributing

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 us
Expand Down

0 comments on commit 686562c

Please sign in to comment.