Community
Questions Library
Docs
Blog
Events
Swag
Github
Slack
JupiterOne
Discussions
Release Notes
Contact Us
GitLab - AskJ1 Community
<main> <article class="userContent"> <h2 data-id="gitlab-jupiterone-integration-benefits">GitLab + JupiterOne Integration Benefits</h2> <ul><li><p>Visualize GitLab users, groups, code repositories, and merge requests in the<br> JupiterOne graph.</p></li> <li><p>Map GitLab users to employees in your JupiterOne account.</p></li> <li>Map GitLab users to development/security trainings.</li> <li><p>Monitor GitLab software development activities within repositories including<br> changes and approvals.</p></li> <li><p>Monitor changes to GitLab user groups, users, code repositories, and merge<br> requests using JupiterOne alerts.</p></li> </ul><h2 data-id="how-it-works">How it Works</h2> <ul><li><p>JupiterOne periodically fetches GitLab users, code repositories, and pull<br> requests in those repositories to update the graph.</p></li> <li><p>Write JupiterOne queries to review and monitor updates to the graph.</p></li> <li>Configure alerts to take action when the JupiterOne graph changes.</li> </ul><h2 data-id="requirements">Requirements</h2> <ul><li><p>JupiterOne requires a personal access token configured with read access and<br> the API base URL, such as <a href="https://gitlab.com" rel="nofollow">https://gitlab.com</a>.</p></li> <li><p>You must have permission in JupiterOne to install new integrations.</p></li> </ul><h2 data-id="support">## Support</h2> <p>If you need help with this integration, contact<br><a rel="nofollow" href="https://support.jupiterone.io">JupiterOne Support</a>.</p> <h2 data-id="integration-walkthrough">Integration Walkthrough</h2> <h3 data-id="in-gitlab">In GitLab</h3> <p>See GitLab's documentation for<br><a rel="nofollow" href="https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token">Creating a personal access token</a>.</p> <h3 data-id="in-jupiterone">In JupiterOne</h3> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>GitLab</strong> integration tile and click it.</li> <li>Click the <strong>Add Configuration</strong> button and configure the following settings:</li> </ol><ul><li><p>Enter the <strong>Account Name</strong> by which you'd like to identify this GitLab account<br> in JupiterOne. Ingested entities will have this value stored in<br><code class="code codeInline" spellcheck="false" tabindex="0">tag.AccountName</code> when <strong>Tag with Account Name</strong> is checked.</p></li> <li><p>Enter a <strong>Description</strong> that will further assist your team when identifying<br> the integration instance.</p></li> <li><p>Select a <strong>Polling Interval</strong> that you feel is sufficient for your monitoring<br> needs. You may leave this as <code class="code codeInline" spellcheck="false" tabindex="0">DISABLED</code> and manually execute the integration.</p></li> <li><p>Enter the <strong>Personal Access Token</strong> configured for read access in GitLab.</p></li> <li>Enter the <strong>API Base URL</strong> (such as <a href="https://gitlab.com)" rel="nofollow">https://gitlab.com)</a> of your self-managed<br> GitLab instance.</li> </ul><ol start="4"><li>Click <strong>Create Configuration</strong> once all values are provided.</li> </ol><h2 data-id="how-to-uninstall">How to Uninstall</h2> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>GitLab</strong> integration tile and click it.</li> <li>Identify and click the <strong>integration to delete</strong>.</li> <li>Click the <strong>trash can</strong> icon.</li> <li>Click the <strong>Remove</strong> button to delete the integration.</li> </ol><p><br></p> <h2 data-id="data-model">Data Model</h2> <h3 data-id="entities">Entities</h3> <p>The following entities are created:</p> <table><thead><tr><th>Resources</th> <th>Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Entity <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> </tr></thead><tbody><tr><td>Account</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_account</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Account</code></td> </tr><tr><td>Commit</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_commit</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">CodeCommit</code></td> </tr><tr><td>Group</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_group</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Group</code></td> </tr><tr><td>Merge Request</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_merge_request</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">CodeReview</code>, <code class="code codeInline" spellcheck="false" tabindex="0">PR</code></td> </tr><tr><td>Project</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_project</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">CodeRepo</code>, <code class="code codeInline" spellcheck="false" tabindex="0">Project</code></td> </tr><tr><td>User</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_user</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">User</code></td> </tr></tbody></table><h3 data-id="relationships">Relationships</h3> <p>The following relationships are created:</p> <table><thead><tr><th>Source Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Relationship <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> <th>Target Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> </tr></thead><tbody><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_group</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_account</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_project</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_group</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_group</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_group</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_project</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_group</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_user</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_merge_request</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_commit</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_project</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_merge_request</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_project</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_user</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_user</code></td> <td><strong>APPROVED</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_merge_request</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_user</code></td> <td><strong>OPENED</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">gitlab_merge_request</code></td> </tr></tbody></table><p><br></p> </article> </main>
.png)