Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing guide to add required RBAC roles #8542

Merged
merged 2 commits into from
Jul 15, 2024
Merged

Update contributing guide to add required RBAC roles #8542

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6aa62d2
Update contributing guide to add required RBAC roles
praveenkuttappan Jul 2, 2024
0700a04
Apply suggestions from code review
praveenkuttappan Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions src/dotnet/APIView/APIViewWeb/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Create following Azure resources in your Azure subscription.


### Connect local debugging instance to Azure resource

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.

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

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.

- `Storage Blob Contributor` to access storage account
- `Cosmos DB Built-in Data Contributor` to access Cosmos DB

### Role based access requierd for deployed instances

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.

- `Storage Blob Contributor` to access storage account
- `Cosmos DB Built-in Data Contributor` to access Cosmos DB

### Compile TypeScript code

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