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.

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 on GitHub Advanced Security workbook #8862

Conversation

AlexDeMichieli
Copy link
Contributor

In this PR I am updating the current GitHub Advanced Security workbook.

New features:

  • Filtering by organizations
  • Filtering by repository topics

Screenshot 2023-08-22 at 11 04 49 AM

@v-spadarthi
@NikTripathi

I could not find a way to conditionally render filters (repositories and repo topics). The idea behind these filters is that if repositories are selected, the topics filter should not be enabled, and vice versa. I was able to find a workaround where you have to deselect all repositories in order to activate the repo topics filter, but it's not ideal. Do you have any recommendations on how to improve this functionality?

adding updated version of the GitHub Advanced Security workbook
@AlexDeMichieli AlexDeMichieli requested review from a team as code owners August 22, 2023 18:08
@v-atulyadav v-atulyadav added Workbook Workbook specialty review needed Solution Solution specialty review needed labels Aug 23, 2023
@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, Thank you for raising this PR. This PR will be investigated and will update you by 25 August, 2023.

@v-prasadboke
Copy link
Contributor

v-prasadboke commented Aug 24, 2023

Hello @AlexDeMichieli, I was trying to test the workbook but I have incomplete sample data.
Can you please share the sample data to the test the workbook, Thanks.

@AlexDeMichieli
Copy link
Contributor Author

Hello @AlexDeMichieli, I was trying to test the playbook but I have incomplete sample data. Can you please share the sample data to the test the workbook, Thanks.

Hi @v-prasadboke ; what test data are you missing? and how can I export test data from Sentinel? thanks!

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, We already have sample data for table githubscanaudit_CL but its incomplete.
Please modify these sample data (

) as per required results.

Also please share the working images of these workbook.
Thanks,
Prasad Boke.

@AlexDeMichieli
Copy link
Contributor Author

Hi @v-prasadboke, please find below the screenshots of the dashboards

Screenshot 2023-08-27 at 10 04 01 PM Screenshot 2023-08-27 at 10 04 14 PM Screenshot 2023-08-27 at 10 04 29 PM Screenshot 2023-08-27 at 10 04 42 PM

I've included additional data in the document you've shared (here's the link to download it). It should be enough to test the "topics" filter. I left some comments in the JSON file that describe the data:

https://drive.google.com/file/d/1aBrcCORfJnTxO4IrTUIvrfTXxV1l2Z0P/view?usp=sharing

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, Thank you for sharing the sample data and working images of workbook.
Will examine this images and update you about the same before EOD.

@v-prasadboke
Copy link
Contributor

v-prasadboke commented Aug 28, 2023

Hello @AlexDeMichieli, all looks good. Please resolve the Branch conflicts so this PR can get merged and repackage the solution using V3 tool.
Link to instruction on how to use V3 tool :- https://github.com/Azure/Azure-Sentinel/blob/master/Tools/Create-Azure-Sentinel-Solution/V3/README.md

@AlexDeMichieli
Copy link
Contributor Author

Hi @v-prasadboke , for some reason I cannot solve the merge conflict nor see what areas of the workbook should get fixed. When I pull the master branch into my feature branch, no changes occur. The new file should completely override the previous one.

@v-prasadboke
Copy link
Contributor

Hi @v-prasadboke , for some reason I cannot solve the merge conflict nor see what areas of the workbook should get fixed. When I pull the master branch into my feature branch, no changes occur. The new file should completely override the previous one.

Yes that is right, Or what we can do is we can overwrite the older workbook with the new one.
First pull the latest from master and as you see a merge conflict overwrite the older one with new one.
Thanks.

…o alexdemichieli/github-workbook-update-august-2023
@AlexDeMichieli
Copy link
Contributor Author

Hi @v-prasadboke , I'm stuck, sorry! I tried following your steps with no avail. I can't seem to fix the merge conflict. Is there anything you could do on your end? Thanks!

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, I've resolved the merge conflicts. You can proceed with repackaging the solution.
Thank you.

@AlexDeMichieli
Copy link
Contributor Author

Hi @v-prasadboke , thanks for the help! Before moving forward, I wanted to pick your brain on something. Currently, the repository and topics filters are mutually exclusive, but not in a smart way. You'll need to deselect all repositories in order to activate the repo topics filter, but it's not ideal. Do you have any recommendations on how to improve this functionality?

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, We are having a discussion about this. And update you about the same before 04 September, 2023.
Meanwhile you can repackage the solution using V3 tool.
Thanks.

@v-prasadboke
Copy link
Contributor

Hi @v-prasadboke , thanks for the help! Before moving forward, I wanted to pick your brain on something. Currently, the repository and topics filters are mutually exclusive, but not in a smart way. You'll need to deselect all repositories in order to activate the repo topics filter, but it's not ideal. Do you have any recommendations on how to improve this functionality?

Hello @AlexDeMichieli, Sorry but for repo and topic I'm seeing only 1 option
image
image

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, Hope you are doing well. We just wanted to know if there are any updates on the above requested changes.
Thanks.

@AlexDeMichieli
Copy link
Contributor Author

AlexDeMichieli commented Sep 6, 2023

Hi @v-prasadboke, sorry for the late response.

I'm currently in the process of deploying the solution (i am at the last step of the guide), but I am getting the following error. Do you know what could be causing the issue? ( tried changing all references of 3.0.0 to 3.1.0 but it did not work)

Deployment template validation failed: 'The template resource '/Microsoft.SecurityInsights/-wb-lu5sbrmz6jq6c' for type 'Microsoft.OperationalInsights/workspaces/providers/contentTemplates' at line '266' and column '87' has incorrect segment lengths. A nested resource type must have identical number of segments as its resource name. A root resource type must have segment length one greater than its resource name. Please see https://aka.ms/arm-syntax-resources for usage details.'. (Code: InvalidTemplate)

Here's the link to my JSON file:

https://drive.google.com/file/d/1B3afcgMy8MTv5mTIH2t5OKeVCvSzqNGW/view?usp=drive_link

In regards to the repository topics filter, I recorded a video that illustrates the issue:

https://drive.google.com/file/d/1IqeiuyDwN5DUngkmxsgKVsx6VrguoozZ/view?usp=sharing

If you're not fetching repository topics, it means that you probably are missing some test data. I checked the data I provided and I can see that all the JSON objects include an array of topics (e.g "advanced-security","codeql","ghas","java","javascript","security", etc.) Please let me know if you need additional data from me.

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, Please drop me a mail with attached json file.
v-prasadboke@microsoft.com
Thanks.

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, I've received the json file. Will review it and update you about the same before 12 September, 2023.

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli , Reason behind zip 3.0.0 even if repackaged to 3.0.1 is the latest 3.0.0 is not live yet.

I dont have the access to partner center where github solution can be pushed to live, If you have the access to the partner center please push the solution to live

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, Looks like you have not repackaged the solution properly.
image

Please Repackage the solution again properly.

@AlexDeMichieli
Copy link
Contributor Author

Hi @v-prasadboke , I'll give it another shot and I'll let you know if I have any issues

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, Thank you for the updates.

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, The 3.0.0 of Github is live. You can repackage the solution with 3.0.1 Thanks

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, Hope the issue is resolved with 3.0.1 repackaging and you are repackaging it too. Just wanted to know some updates on the solution. Thanks.

@v-prasadboke
Copy link
Contributor

Hello @AlexDeMichieli, Please confirm on the maintemplate.
Thanks.

@AlexDeMichieli
Copy link
Contributor Author

AlexDeMichieli commented Sep 22, 2023

Hello @AlexDeMichieli, Please confirm on the maintemplate. Thanks.

Hi @v-prasadboke , I'll be back to the office next Tuesday. Thanks so much for repackaging the solution! I just wanted to confirm the next steps. Can I pull from the branch, get the mainTemplate.json and publish it?

@v-prasadboke
Copy link
Contributor

v-prasadboke commented Sep 25, 2023

Hello @AlexDeMichieli, Review is not completed yet. I was waiting for your confirmation on maintemplate. Is it ok or not?
I'll review the maintemplate and get it merged.
Please keep the solution on hold for publishing.
I'll update you before 27 September, 2023.

@AlexDeMichieli
Copy link
Contributor Author

Hi @v-prasadboke , the maintemplate looks fine to me! Thanks!

@v-prasadboke
Copy link
Contributor

Thank you @AlexDeMichieli for confirmation.

@v-atulyadav v-atulyadav merged commit 12393a0 into Azure:master Sep 26, 2023
29 checks passed
@AlexDeMichieli
Copy link
Contributor Author

Hi @v-prasadboke, what would be the next step? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Solution Solution specialty review needed Workbook Workbook specialty review needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants