Tools configuration

learn how can be configured to integrate with individual tools extending the value of your investment in your resources the tools configuration page displays the configuration of all tools that have been configured for integration with use it to configure supported tools in your it estate header the tools configuration landing page presents a universal header at the top of the page the header contains the following elements breadcrumbs (selectable for ease of navigation) the title tools configuration two tabs that govern the type of tool you want to configure out of the box tools bring your own tools out of the box tools tab the service presents a tools configuration table, which serves as a platform for knowing what tools are currently supported, managing connections with them and setting configurations necessary to make those connections subsequent sections describe the table, setting connections and setting configurations configured tools table a date and time stamp (this date shows the last updated date) a search box to filter the configured tools an add new + configuration button the configured tools table provides data in a tabular form, separated by columns and sorted as follows tool engine the tool configured i e ansible, bitbucket, jira, etc status the current status of the configured tool success green check icon for fully configured tools partial success yellow ellipsis icon for partially configured tools failure red x icon for failed tool configurations connections configured the number of connections configured to each tool the table view provides a clickable arrow below the bottom right corner of the table that enables navigation across pages of data (page 1 of 3, page 2 of 3, etc ) and a drop down menu to the left to select how many items per page are displayed when accessing this screen all tools that are configured will be displayed, conversely a "no data found" message will be displayed with customized instructions based on access level role as follows privilege user no tools configured yet, add your first tool no tools available no configurable tools available at this moment, contact the platform admin restricted user contact your admin/editor to enable the tools configuration for you adding connections as a privileged user with and admin or editor role, tools can be added as needed from this configuration screen, to configure tools complete the following steps from the main menu , go to → connections management select the add new + button for a list of tools and configurations, see tools connections configurations docid 0jyjumk43ordxdmjn lvh once the connections are configured, select the test connection button and a success or failure message displays for a list of tools and configurations please visit supported tools docid\ crutgj1f0ko53nyzheixu and bring your own tools docid\ j2wcdgqowtc5mnoocztya adding configuration select add configuration a screen will display configuration settings about tool engine to configure the tool engine, complete these steps select the tool engine from the tool engine drop down box complete the appropriate configuration for the tool engine each tool engine requires different parameters for configuration additional actions and notifications by navigating to the vertical ellipsis of each tool located to the right of the table and selecting view details , will open the configuration screen for that specific tool here the information will be grouped into two tabs configuration and sync configuration presents the parameters of the tool engine in the form of a table that includes the following columns host host url connection name of the tool engine connection projects name of the project for the connection archive shows the connection is live or has been archived each connection about the specific tool will display configuration settings, by selecting the vertical ellipsis menu more actions will be available for each tool configured as follows for live configured tools archive delete for archived configured tools unarchive delete notifications by performing any given action mentioned, an alert will be triggered as follows all actions performed need to be confirmed once an alert is triggered archive by archiving this configuration, sync will be paused; you can restart the process again by unarchiving it unarchive by unarchiving this configuration, sync will be restarted delete all data and references associated with it will be deleted, after the data retention period this action cannot be reversed after the data retention period has expired a data retention period for tool configuration and technical service association data has been established once the tool connection is requested to be deleted/not available, the configuration data will remain available in for 24 hours after this retention period expires, the configuration data will be permanently removed sync the sync feature scans current data for visibility after configuring credentials and provides a time estimation of the sync, delete and pulled intervals the sync is performed based on the current environment priority sync status the sync status section will display the status of the data retrieved after the tool engine is configured it presents the parameters of the tool engine sync in the form of a table that includes the following columns connection displays the local connected tool name for the sync active sync shows the active status of a sync records processed displays the number of records processed duration shows the amount of time taken to perform a sync last run displays the last sync run status current sync status information sync details the sync details section displays the record details of each account selected it presents the parameters of the tool engine sync in the form of a table that includes the following columns record name displays the name of the record selected active sync shows the active status of a sync records processed displays the number of records processed duration shows the amount of time taken to perform a sync last run displays the last sync run status current sync status information each tool has configuration and sync tabs, which is how a sync tab would look for a user with the editor role, the status column value for the unconfigured connection in the sync status and sync details table will be configuration waiting when you click, a tooltip appears with the message no configuration was found for this connection add all the necessary data to complete the configuration along with add configuration button after pressing the add configuration button, the user will be sent to the configuration tab, where the add tool configuration side panel for the selected tool will be shown for a user with viewer role, the tooltip message will be no configuration found for this connection contact the admin to complete the configuration along with the learn more button after clicking on learn more button user will be navigated to the documentation page bring your own tools tab you must be assigned the admin role to set the configuration for private tools the bring your own tools tab enables the creation of tokens and adding tool mappers these two features are enabled by two radio buttons create token create tool mapper create token a service token is necessary for connecting private tools to di and for creating tool mapper if a service token already exists for a private tool, you can use that token to create an additional mapper for that tool if a token does not exist, you must create one, before creating a new mapper you must create a token before a tool can make a connection to use the following procedure click create token the service displays the tokens panel in the name field enter a name for the token click the dropdown menu in the token type field click create to create the token or cancel to abort the operation the service returns to the bring your own tools tab if you created a token, the service displays a success message and a field indicating the existence of a token you can show or hide the token string by clicking the eye shaped icon next to the show/hide icon is a copy icon to enable copying the token to the os clipboard you can also regenerate the token by clicking the re generate token button click the view token list button to view a list of existing tokens a list of existing tokens is also available on the tokens panel, enabling you to review existing tokens before creating a new one create tool mapper the create mapper feature enables administrators to add data mapping files to their pipeline through the user interface, giving users sample generated commands such as curl, github actions and jenkins this capability enables an efficient method of posting mapped data to create a tool mapper, you must have a mapping file containing mapping instructions such as the following example { "tool" "trivy", "mapper" { "imagescanmapping" { "analysisdate" "", "cves" "", "cvssscore" "cvss nvd v3score", "datasource" "primaryurl", "description" "description", "fixedversions" "", "imagedigest" "layer digest", "packagename" "pkgname", "packagepath" "pkgid", "packagetype" "pkgpath", "packageversion" "installedversion", "published" "", "severity" "severity", "severitysource" "", "vulnerabilityid" "" }, "root" "results # vulnerabilities" }, "parentmapper" { "imagescanmapping" { "analysisdate" "", "imagedigest" "layer digest" }, "root" "results # vulnerabilities" } } a tool mapper for trivy is being added, which is mapped with container vulnerability scan before creating the mapper, review the requirements for each devops phase presented in mapper configuration docid\ hj67ymcvbwmi9oe5akujg then use the following procedure, borrowing from the example mapper file as necessary click create tool mapper the service displays the create mapper wizard select a tool category from the tool category dropdown select use existing token if a current token for the tool exists or create new token to create one if one does not exist select an existing token from the token dropdown or create a new token using the procedure in the previous section create token click next the wizard progresses to tool manager select existing mapper to specify an existing (previously added) mapping file or create mapper to add a new mapping file in the case of existing mapper , select a tool from the select tool dropdown or, in the case of create mapper , click add file and select your mapping file if you add a mapping file, the service displays the file content on an edit canvas edit the file if necessary click next the wizard progresses to command generation and displays all parameters select values for the parameters click generate command the wizard progresses to view generated command the command is presented as a curl, githubaction and jenkins copy the generated command in the form of your choice and add it to your pipeline