Skip to content

Commit 9fcb289

Browse files
Update contributing guide to add required RBAC roles (#8542)
* Update contributing guide to add required RBAC roles
1 parent 58b45e1 commit 9fcb289

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

src/dotnet/APIView/APIViewWeb/CONTRIBUTING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ Create following Azure resources in your Azure subscription.
9999

100100

101101
### Connect local debugging instance to Azure resource
102+
102103
Following configuration is required to connect local debug instance to Azure resources as well as to setup debugging environment. Below are the steps to follow and required configuration to be added.
103104

104105
- Right click on `APIViewWeb` project in `APIView solution` using solution explorer in Visual Studio and select `Manage User Secrets`.
@@ -110,12 +111,8 @@ Following configuration is required to connect local debug instance to Azure res
110111
"ClientId": "<Client-ID>",
111112
"ClientSecret": "<Client OAuthSecret>"
112113
},
113-
"Blob": {
114-
"ConnectionString": "<connection string to storage account>"
115-
},
116-
"Cosmos": {
117-
"ConnectionString": "<connection string to cosmos db>"
118-
},
114+
"StorageAccountUrl": "https://<storage account name>.blob.core.windows.net/",
115+
"CosmosEndpoint": "Cosmos End point URL. For e.g. https://<cosmosDBName>.documents.azure.com:443/",
119116
"CosmosDBName": "APIViewV2",
120117
"github-access-token": "",
121118
"ApiKey": "",
@@ -124,6 +121,18 @@ Following configuration is required to connect local debug instance to Azure res
124121
"APPCONFIG": "<connection string to app configuration>"
125122
}
126123

124+
Note: User requires following role based access to storage account and cosmos DB for local debugging and make sure that user is logged in to Azure from Visual studio to access Azure resources.
125+
126+
- `Storage Blob Contributor` to access storage account
127+
- `Cosmos DB Built-in Data Contributor` to access Cosmos DB
128+
129+
### Role based access requierd for deployed instances
130+
131+
APIView Azure web app instance requires role based access to storage and cosmos DB instances to access using managed identity. Following are the required RBAC roles.
132+
133+
- `Storage Blob Contributor` to access storage account
134+
- `Cosmos DB Built-in Data Contributor` to access Cosmos DB
135+
127136
### Compile TypeScript code
128137

129138
APIView web app has some type script code and this needs to be compiled for client side processing. Following are the steps to compile typescript code before starting to debug APIView.

0 commit comments

Comments
 (0)