Add AKSHTTPCustomFeatures header support to Swagger #2757

sossickd · 2022-01-27T07:41:57Z

There are a number of issues that have been closed as duplicates of issue 6793 on the terraform-provider-azurerm project requesting support for custom headers to be passed to AKS.

Although the issue 6793 is still Open it has a PR that had a preposed solution for the issue that was Closed with the status wont-fix

@tombuildsstuff closing comment in PR 14178 was as follows:

"Thanks for this PR.

Taking a look through here unfortunately this isn't something we can ship in Terraform at this time for a number of reasons.

The primary one here is that these are sourced from an Environment Variable and thus aren't defined in the config - however even if we were to move these to schema fields, at this point in time these can only be set in/parsed from the HTTP Headers for the request/response.

Whilst this approach works insofar as it sends the headers, due to the volatility of the Azure API's there's no guarantee this won't change behaviourally between different versions of the Azure API - and since this isn't provided in the Azure SDK (or the Swagger which supports it) - in practice it'd be hard for us to detect that this functionality has changed.

In order to support this functionality (and implement #6793) we'd need these Headers to be added to the Swagger for the AKS API - at which point this'll become available in the Azure SDK (and any other tooling which uses it). Whilst that may seem like a small distinction - that means this functionality becomes covered by the ARM Deprecation policy - meaning that changes have to go through a deprecation policy such that external tooling can rely on it. In order to get that added I'd suggest opening an issue on the AKS Repository where someone from the AKS Team should be able to get that added to the next version of the Swagger, which'd allow us to support this functionality.

As such whilst I'd like to thank you for this contribution, until this information is exposed in the Azure Swagger (such that there's a compatibility guarantee) I'm going to have to close this PR for the moment.

Thanks!"

Can i request the Headers to be added to Swagger for the AKS API

FYI the header that i requested a feature for is --aks-custom-headers WindowsContainerRuntime=containerd when creating a Windows node pool

az aks nodepool add \
    --resource-group myResourceGroup \
    --cluster-name myAKSCluster \
    --os-type Windows \
    --name npwcd \
    --node-vm-size Standard_D4s_v3 \
    --kubernetes-version 1.20.5 \
    --aks-custom-headers WindowsContainerRuntime=containerd \
    --node-count 1
``

The text was updated successfully, but these errors were encountered:

ghost · 2022-01-27T07:42:00Z

Hi sossickd, AKS bot here 👋
Thank you for posting on the AKS Repo, I'll do my best to get a kind human from the AKS team to assist you.

I might be just a bot, but I'm told my suggestions are normally quite good, as such:

If this case is urgent, please open a Support Request so that our 24/7 support team may help you faster.
Please abide by the AKS repo Guidelines and Code of Conduct.
If you're having an issue, could it be described on the AKS Troubleshooting guides or AKS Diagnostics?
Make sure your subscribed to the AKS Release Notes to keep up to date with all that's new on AKS.
Make sure there isn't a duplicate of this issue already reported. If there is, feel free to close this one and '+1' the existing issue.
If you have a question, do take a look at our AKS FAQ. We place the most common ones there!

ghost · 2022-02-27T01:00:44Z

Action required from @Azure/aks-pm

ghost · 2022-03-14T06:00:40Z