Community
Questions Library
Docs
Blog
Events
Swag
Github
Slack
JupiterOne
Discussions
Release Notes
Contact Us
Sonarqube - AskJ1 Community
<main> <article class="userContent"> <h2 data-id="sonarqube-jupiterone-integration-benefits">Sonarqube + JupiterOne Integration Benefits</h2> <ul><li>Visualize Sonarqube projects, users, and projects in the JupiterOne graph.</li> <li>Map Sonarqube users to employees in your JupiterOne account.</li> <li>Monitor changes to Sonarqube users using JupiterOne alerts.</li> </ul><h2 data-id="how-it-works">How it Works</h2> <ul><li><p>JupiterOne periodically fetches projects, teams, and users from Sonarqube to<br> update the graph.</p></li> <li><p>Write JupiterOne queries to review and monitor updates to the graph, or<br> leverage existing queries.</p></li> <li><p>Configure alerts to take action when JupiterOne graph changes, or leverage<br> existing alerts.</p></li> </ul><h2 data-id="requirements">Requirements</h2> <ul><li><p>JupiterOne requires an API token. You need permission to create a user in<br> Sonarqube that will be used to obtain the API token. The token should have the<br><code class="code codeInline" spellcheck="false" tabindex="0">Administer System</code> permission to allow the ability to pull extra user<br> metadata. More information on this can be found in the sonarqube api<br> documentation of your instance<br> (<code class="code codeInline" spellcheck="false" tabindex="0"><your-instance-url>/web_api/api/users/search</code>).</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, please 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-sonarqube">In Sonarqube</h3> <ol><li><a rel="nofollow" href="https://docs.sonarqube.org/latest/user-guide/user-token/">Generate an API token</a></li> </ol><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>Sonarqube</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 Sonarqube<br> instance 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>Sonarqube base url</strong> generated for use by JupiterOne.</p></li> <li>Enter the <strong>Sonarqube API token</strong> generated for use by JupiterOne.</li> </ul><ol start="4"><li>Click <strong>Create Configuration</strong> once all values are provided.</li> </ol><h1 data-id="how-to-uninstall">How to Uninstall</h1> <p>TODO: List specific actions that must be taken to uninstall the integration.<br> Many of the following steps will be reusable; take care to be sure they remain<br> accurate.</p> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong></li> <li>Scroll to the <strong>Sonarqube</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>Project</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">sonarqube_project</code></td> <td><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">sonarqube_user</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">User</code></td> </tr><tr><td>UserGroup</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">sonarqube_user_group</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">UserGroup</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">sonarqube_user_group</code></td> <td><strong>HAS</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">sonarqube_user</code></td> </tr></tbody></table><p><br></p> </article> </main>
.png)