From df76100f980b82835515b26ffbf757bcb063c31e Mon Sep 17 00:00:00 2001 From: "Steve.Lasker@MSFT" Date: Mon, 8 Jan 2018 12:35:32 -0800 Subject: [PATCH 1/2] Added an example, cleaned up service names --- docs/http-headers.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/http-headers.md b/docs/http-headers.md index ffed7c3..991cd44 100644 --- a/docs/http-headers.md +++ b/docs/http-headers.md @@ -15,6 +15,20 @@ X-Meta-Source-Client: // * `service`: The name of the service. * `optionalservicename`: An optional parameter for services with subservices, or for specifying a SKU. For example, Web Apps corresponds to `azure/app-service/web-apps`). +### Example + +```JSON +{ + "auths": { + "myregistry.azurecr.io": {}, + }, + "HttpHeaders": { + "X-Meta-Source-Client": "azure/aks" + }, + "credsStore": "wincred" +} +``` + ## Header values Partner services and orchestrators are encouraged to use specific header values to help with our telemetry. Users can also modify the value passed to the header if they so desire. @@ -25,13 +39,16 @@ The values we ask ACR partners to use when populating the `X-Meta-Source-Client` | ------------------------- | --------------------------------------- | | App Service - Logic Apps | `azure/app-service/logic-apps` | | App Service - Web Apps | `azure/app-service/web-apps` | -| Azure Container Service | `azure/compute/azure-container-service` | -| Batch | `azure/compute/batch` | +| Azure Container Instance | `azure/aci` | +| Azure Container Service | `azure/acs` | +| Azure Kubernetes Service | `azure/aks` | +| Azure Container Builder | `azure/acb` | +| Batch | `azure/batch` | | Cloud Console | `azure/cloud-console` | -| Functions | `azure/compute/functions` | -| HDInsight | `azure/data/hdinsight` | +| Functions | `azure/functions` | +| HDInsight | `azure/hdinsight` | | Internet of Things - Hub | `azure/iot/hub` | | Jenkins | `azure/jenkins` | -| Machine Learning | `azure/data/machine-learning` | -| Service Fabric | `azure/compute/service-fabric` | +| Machine Learning | `azure/ml` | +| Service Fabric | `azure/service-fabric` | | VSTS | `azure/vsts` | From ead201892270cf3169e4132a4d7597d0d65d4c81 Mon Sep 17 00:00:00 2001 From: "Steve.Lasker@MSFT" Date: Tue, 9 Jan 2018 10:03:08 -0800 Subject: [PATCH 2/2] Add cloud table --- docs/http-headers.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/http-headers.md b/docs/http-headers.md index 991cd44..44f86a7 100644 --- a/docs/http-headers.md +++ b/docs/http-headers.md @@ -1,17 +1,17 @@ # Azure Container Registry HTTP headers -Azure container registries are compatible with a multitude of services and orchestrators. To make it easier to track the source services and agents from which ACR is used, we have started using the `HttpHeaders` field in the Docker `config.json` file. +Azure container registries are compatible with a multitude of services and orchestrators. To help our customers, we'd like to understand which services in Azure, or outside of Azure, are issuing registry requests. To track the source services and agents from which ACR is used, we have started using the `HttpHeaders` field in the Docker `config.json` file. ## Header format -The ACR headers follow this format: +ACR will parse headers using the following format: ```HTTP X-Meta-Source-Client: // ``` -* `cloud`: Azure, Azure Stack, or other government- or country-specific Azure cloud. Although Azure Stack and government clouds are not currently supported, this parameter enables future support. +* `cloud`: Azure, Azure Stack, or other government- or country-specific Azure cloud. * `service`: The name of the service. * `optionalservicename`: An optional parameter for services with subservices, or for specifying a SKU. For example, Web Apps corresponds to `azure/app-service/web-apps`). @@ -19,12 +19,12 @@ X-Meta-Source-Client: // ```JSON { - "auths": { - "myregistry.azurecr.io": {}, - }, "HttpHeaders": { "X-Meta-Source-Client": "azure/aks" }, + "auths": { + "myregistry.azurecr.io": {}, + }, "credsStore": "wincred" } ``` @@ -33,7 +33,17 @@ X-Meta-Source-Client: // Partner services and orchestrators are encouraged to use specific header values to help with our telemetry. Users can also modify the value passed to the header if they so desire. -The values we ask ACR partners to use when populating the `X-Meta-Source-Client` field are as follows: +The values we ask ACR partners to use when populating the `X-Meta-Source-Client` field are: + +| Cloud | Header | +| ------------------------- | --------------------------------------- | +| Azure Public Cloud | `azure/` | +| Azure Stack | `azurestack/` | +| China (Mooncake) | `china/` | +| Germany | `germany/` | +| US Gov | `auzreusgov/` | +| US DOD | `auzreusdod/` | + | Service name | Header | | ------------------------- | --------------------------------------- |