Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page is an overview of what you need to do to onboard your CI/CD systems and tools and maintain a single pane of solution on Opsera.

...

  1. Solution - 1

    1. Customers who already have tools running in their own Instance and want to integrate with Opsera

  2. Solution - 2

    1. Customers who don’t have tools in place and want to integrate directly with Opsera

Solution -1: Customers who already have tools:

Jenkins Integration

  1. Follow the below process to configure the Webhook.

Step 1

  1. Log into Opsera Portal

  2. select Tool Registry from left navigation.

Image Modified

Step 2

  1. In the Tool Registry screen below, Click + New Tool Button to add a tool.

Image Modified

Step 3

  1. Once you click Add Tool, a popup will be displayed.

  2. Type Jenkins Tool Name in the Tool Name input field.

  3. Type Jenkins as Tool Identifier in the dropdown.

Image Modified

Step 4

  1. Click the Create Tool Button to continue.

Image Modified

Step 5

  1. In the Modal Popup, Choose your Tool Name from the Main Tool Registry screen.

  2. Click the Connections TAB to enter:

    1. Container URL

    2. Jenkins User ID

    3. Jenkins Password

Image Removed

Once you have entered all the fields, Hit the Save Button. With these steps completed, now Log into Jenkins Tool to complete below steps.

Step 1

  1. Log into Opsera Portal

  2. select Tool Registry from left navigation.

Image Removed

Step 2

  1. In the Tool Registry screen below, Click + New Tool Button to add a tool.

Image Removed

Step 3

  • Once you click Add Tool, a popup will be displayed.

  • Type Jenkins Tool Name in the Tool Name input field.

  • Type Jenkins as Tool Identifier in the dropdown.

  • Image Removed

    Step 5

    1. In the Modal Popup, Choose your Tool Name from the Main Tool Registry screen.

    2. Click the Connections TAB to enter:

      1. Container URL

      2. Jenkins User ID

      3. Jenkins Password

    Image Modified

    Once you have entered all the fields, Hit the Save Button. With these steps completed, now Log into Jenkins Tool to complete below steps.

    Step 4

    1. Click the Create Tool Button to continue.

    Image Removed

    Step 6

    1. Log into Jenkins tool

    2. Enter your Jenkins credentials.

    Step 7

    1. From the Dashboard screen, Click Manage Jenkins from left navigation tool bar

    Image Modified

    Step 8

    1. In the Manage Jenkins page, Choose Notification

    Image Modified

    Step 9

    1. Select the Job Name

    2. Click install

    3. Jenkins Installation will start as shown below.

    Image Modified

    Step 10

    1. Wait for the installation to conplete.

    2. Once Installation is complete, Jenkins will restart.

    Step 11

    Once the Restart is complete, Click Configure link from left Navigation.

    Image Modified

    Step 12

    1. Select the 2nd Tab from the Navigation menu.

    2. Enter the Webhook URL details in the Notifications TAB.

    Image Modified

    Step 13

    1. Congratulations, you have completed all the steps required.

    2. Once you run any job via Jenkins on your end, Analytics data will be available at Opsera Portal.

      1. For SonarQube installation, please proceed to next section.

    SonarQube Configuration

    To integrate SonarQube, follow the below steps.

    Step 1

    Objective is to create Auth token to authorize Opsera to SonarQube.

    1. Login to SonarQube portal

    2. Click + Icon located on the top right menu.

    Image Modified

    Step 2

    1. Enter an unique Project key name

    2. Provide a Display name.

    3. Click the Setup button.

    Step 3

    1. Note the Project Key you just created.

    Image Modified

    Step 4

    1. Now we have to create a Token that you can use with Opsera.

    2. Click Administrator link from Top right menu.

    Image Modified

    Step 5

    1. In the Administrator screen, click the Security TAB to create the Security Token.

    Image Modified

    Step 6

    1. Once you have created, you should see a success message as shown below.

    2. Click Copy to copy the key to clipboard.

    Image Modified

    Step 7

    Now that you have created the Token, let’s update Opsera settings.

    1. Log into Opsera Portal

    2. Select Tool Registry from left navigation.

    Image Modified

    Step 8

    1. Click + New Tool Button to add a tool.

    2. A popup dialogbox will be displayed.

    Image Modified

    Step 9

    In the Popup dialogbox,

    1. Type a tool name.

    2. Choose SonarQube as your Tool.

    3. Select Code Scan as Tool Type from the Dropdown

    4. Click Save Changes

    Image Modified

    Step 10

    Once you click Save Changes, Choose your Tool Name you just created. In this case, choose Sonarqube-demo from the list.

    1. Choose your Tool Name from the main screen.

    2. In the Pop-up, Click Connections TAB

    3. Enter Sonar URL

    4. Sonar Port

    5. Sonar User ID

    6. Sonar Auth Token you created in SonarQube portal.

    7. Click save.

    Image Modified

    Step 11

    1. Now login to SonarQube portal.

    2. Once you login, click Configuration from top left Menu

    3. Choose Webhooks.

    Image Modified

    Step 12

    1. Click Create Button located on the right side.

    Image Modified

    Step 13

    Type the below information in the popup dialogbox.

    1. Type an unique name

    2. Enter the URL that you received from Opsera.

    3. Finally Click Create button to complete the Webhook configuration.

    Image Modified

    To Unsubscribe, from sonarqube, 

    1. Administration > configuration > webhooks >Delete.

      1. Screenshot : sonar-add-webhook.png

        Image Modified

    For JMeter, Junit and XUnit to work as expected, you must configure filebeat before proceeding.

    ...

    1. Login into gitlab

    2. Select project > Settings(left panel) >  Webhook > 

    3. Add webhook to send all events to logstash

      1. https://customerdomain-logstash.opsera.io/webhook/gitlab

    Screenshot : gitlab-add-webhook.png

    ...

    Codeship

    1. Add webhook and point to 

      1. Login to codeship dashboard > projects > “select your project” >  Project settings (top-right) > Notifications >  

      2. https://customerdomain-logstash.opsera.io/webhook/codeship

      3. Create user with read privileges and share  username and password with opsera via email

      4. Screenshot : Screenshot : codeship-add-webhook.png

    Solution -2: Direct Integration with Opsera

    SonarQube Installation

    Log into Opsera Portal and Select Platform from the Left navigation

    Select Code Security Tool and click Deploy button.

    Click Confirm button in the popup window to confirm the installation.

    Jenkins Installation

    In the Platform page, Select Jenkins tool and click Confirm Button.

    1. Once you submit, Email will be sent with Tool/URL information. This will take approximately 15 mins.

    2. Logstash plugin and Filebeat is automatically configured by java-microservice.

    3. ELK stack and DB details will be sent via email.

    ...