Add feature flag info to READMEs (#1104)

* add feature flag info to sample settings.json * add flags.json info * Update src/NuGet.Jobs.Db2AzureSearch/README.md Co-authored-by: Andrei Grigorev <[email protected]> Co-authored-by: Andrei Grigorev <[email protected]>
NuGet · Nov 8, 2022 · 4e1faec · 4e1faec
1 parent 6fc7295
commit 4e1faec
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/src/NuGet.Jobs.Db2AzureSearch/README.md b/src/NuGet.Jobs.Db2AzureSearch/README.md
@@ -54,6 +54,9 @@ In your Azure Blob Storage account, you will need to create a container named `n
 1. `downloads.v1.json` with content `[]`
 1. `ExcludedPackages.v1.json` with content `[]`
 
+You will also need to create a second container (if it does not already exist) named `content` and upload the following file:
+1. `flags.json` with content `{}`
+
 If you are on the nuget.org team, you can copy these files from the [PROD auxiliary files container](https://nuget.visualstudio.com/DefaultCollection/NuGetMicrosoft/_git/NuGetDeployment?path=%2Fsrc%2FJobs%2FNuGet.Jobs.Cloud%2FJobs%2FDb2AzureSearch%2FPROD%2Fnorthcentralus%2Fappsettings.json&version=GBmaster&line=18&lineEnd=24&lineStartColumn=1&lineEndColumn=1&lineStyle=plain).
 
 #### Settings
@@ -65,6 +68,7 @@ Once you've created your Azure resources, you can create your `settings.json` fi
 * The `SearchServiceApiKey` setting is an admin key that has write permissions to the Azure Search resource. Make sure the Azure Search resource you're connecting to has API keys enabled (either in parallel with managed identities "RBAC" access or with managed identities authentication disabled).
 * The `StorageConnectionString` and `AuxiliaryDataStorageConnectionString` settings are both the connection string to your Azure Blob Storage account.
 * The `DownloadsV1JsonUrl` setting is the URL to `downloads.v1.json` file above. Make sure it works without authentication.
+* The `FeatureFlags:ConnectionString` setting is the connection string to your Azure Blob storage account. 
 
 ```json
 {
@@ -103,6 +107,10 @@ Once you've created your Azure resources, you can create your `settings.json` fi
       "DownloadScoreBoost": 30000,
       "PopularityTransfer": 0.99
     }
+  },
+
+  "FeatureFlags": {
+    "ConnectionString": "PLACEHOLDER"
   }
 }
 ```

diff --git a/src/NuGet.Services.SearchService.Core/README.md b/src/NuGet.Services.SearchService.Core/README.md
@@ -329,6 +329,10 @@ service responses and are not called into at runtime.
     "SemVer2RegistrationsBaseUrl": "https://apidev.nugettest.org/v3/registration5-gz-semver2/",
     "StorageConnectionString": "PLACEHOLDER",
     "StorageContainer": "PLACEHOLDER"
+  },
+
+  "FeatureFlags": {
+    "ConnectionString": "PLACEHOLDER"
   }
 }
 ```