Skip to content

Commit

Permalink
docs: update runbook
Browse files Browse the repository at this point in the history
  • Loading branch information
KristianKjerstad authored and KristianKjerstad committed Jun 13, 2023
1 parent 438c09b commit 5e00c3f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions runbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,18 @@ The radix configuration handles management of TLS certificates as well as DNS en
The SharePoint site `https://statoilsrm.sharepoint.com/sites/LCMlibrary` is the main data provider for the application. Product metadata and product Particle Size Distribution (PSD) data is stored and updated here.
For the link between product data and product Particle Size Distribution (PSD) to work, the name of the product in the "Product"-list, should match the PSD.xlsx-filename.

### Updating data
To synchronize data between Sharepoint and Azure, the user have to open the LCM web application and click the "Synchronize with Sharepoint" button. This will trigger the logic app to copy data from Sharepoint to Azure.

To add a new product, the user must:
1) Go to [Sharepoint](https://statoilsrm.sharepoint.com/sites/LCMlibrary).
2) Click on "Documents".
3) Open the folder for a given supplier and click on the PSD folder. Here you can create a new LCM PSD Excel Sheet by clicking on the "+ New" button.
4) Go back to [Sharepoint](https://statoilsrm.sharepoint.com/sites/LCMlibrary) and click on Products summary.
5) Click "+ New" and add metadata for the product. Note: it must have the same name as the newly created LCM PSD Excel Sheet. NB! it is important to add metadata about the new product. If not, the data will not be uploaded to Azure when doing data synchronization.
6) Open the LCM web application and click "Synchronize with Sharepoint".


## Azure Resources

Resources outside of Radix and SharePoint are provided by Azure in the `S118-LCMlibrary-Standalone` subscription.
Expand Down Expand Up @@ -52,6 +64,12 @@ This table is recreated by the API from the blobs whenever the "Synchronize with
An _Azure Logic app_ is used to solve the problem of syncing files from SharePoint to blobs in the StorageAccount. This is not done directly by the API as there was some lacking permission features in the MS Graph API at the time.
It also translates a SharePoint List (Product) into a .csv file ("metadata.csv") that is loaded to blob storage.

Note: The access tokens used by the logic app can expire. If an "unauthorized error" occurs in the logic app, it can be fixed by:
1) Go to the TransferDocsToBlob resource in Azure.
2) Go to API connection.
3) Click on "sharepointonline" and click on edit API connection and "authorize". This will open a prompt where you have to log in with Equinor credentials.
4) Go back to the API connection list in the TransferDocsToBlob logic app and click on "azureblob" and "edit api connection". Under authorize, paste in the azure storage account access key (can be found inside the lcmdevstorage resource under the access keys tab).

### API Connection

Used to give the Logic app access to SharePoint and the StorageAccount.
Expand Down

0 comments on commit 5e00c3f

Please sign in to comment.