Managing Data Sources

Managing Data Sources such as ODBC connections.

Intro to Data Sources

Data Sources are used to connect to Jira, Bugzilla, and GitHub to track change request and LDAP and Active Directory for single sign-on. You will need to define a Credential for these Data Sources in order to login. See Create Your Credentials for more information on defining a Credential for your Data Source.

The Data Sources List View for Adding or Deleting

You will find Data Sources under the Setup menu. Selecting Data Sources will take you to a list of all DataSources which you have access to. You can also use the Filter bar, represented by a funnel icon, to reorder your Data Sources List View. You can filter the list view on Data Sources and Domains. Data Sources are defined to a Domain and will be displayed based on your access to the Domain.

The Data Sources List View has the following Tabs.

Tab Description
Refresh Refreshes the browser.
Add Allows you to Add a new Data Sources of the following types:
  • Jira
  • Bugzilla
  • GitHub Issues
  • LDAP
  • Active Directory
Delete Deletes the selected item.

From the Data Source List View, double click on the Data Source which you would like to view to see all Details.

Using the Data Sources Dashboard for Viewing and Editing

The Dashboard view displays all information related to a specific Data Source.

Common Details of all Data Sources

The following details are common to all Data Sources types:

Field Description
Full Domain The fully qualified name of the Domain to which the Data Source was defined.
Name The Name of the Data Source.
Type The Data Sources Type chosen when you performed the Add.
Owner Type User or Group.
Owner Name of the Owner.
Summary A description of the Data Source.
Created Auto generated date when the Data Source was added.
Modified Auto generated date when the Data Source was updated.
Credential The Credential used to access the Repository if required.

Change Request Data Sources

DeployHub supports GitHub, Jira and Bugzilla for tracking change request to Applications and Components. For a complete description of the integration see Tracking Jira, Bugzilla and GitHub Issues.

GitHub Data Source Details

This Data Source allows you to connect to GitHub to retrieve GitHub issues associated to your Components or Applications. You will need to define a unique Data Source for each repository that needs to be connected to your Components or Applications.

Field Description
Poll Interval The time frequency of how often DeployHub should look for Git issues in seconds, i.e. 60.
Poll Interval Encrypted Select the box to indicate the Poll Interval should be hidden in the database.
Poll Interval Override Select the box if the Poll Interval can be changed.
Organization The full URL to the Git Organization.
Organization Encrypted Select the box to indicate the Organization name should be hidden in the database.
Organization Override Select the box if the Organization can be changed.
Repository The name of the Git Repository underneath the Git Organization.
Repository Encrypted Select the box to indicate the Git Repository should be hidden in the database.
Repository Override Select the box if the Git Repository can be changed.

Jira Data Source Details

This Data Source allows you to connect to Jira to retrieve Jira issues associated to your Components or Applications. You will need to define a unique Data Source for each Project Key that needs to be connected to your Components or Applications.

Field Description
Filter Enter the Jira Status you want to use as your filter.
Filter Encrypted Select the box to indicate the Filter name should be hidden in the database.
Filter Override Select the box to indicate the Filter name can be changed.
Poll Interval The time frequency of how often DeployHub should look for Jira issues in seconds, i.e. 60.
Poll Interval Encrypted Select the box to indicate the Poll Interval should be hidden in the database.
Poll Interval Override Select the box if the Poll Interval can be changed.
Project Key The The Jira Project Key within the Jira Server.
Project Key Encrypted Select the box to indicate the Project name should be hidden in the database.
Project Key Override Select the box if the Project can be changed.
Server The fully qualified URL to the Jira Server so DeployHub can get access.
Server Encrypted Select the box to indicate the Jira Server should be hidden in the database.
Server Override Select the box if the Jira Server can be changed.

Bugzilla Data Source Details

This Data Source allows you to connect to Bugzilla to retrieve Bugzilla issues associated to your Components or Applications. You will need to define a unique Data Source for each Product that needs to be connected to your Components or Applications.

Field Description
Component The name of the Bugzilla Component.
Component Encrypted Select the box to indicate the Bugzilla Component should be hidden in the database.
Component Override Select the box if the Bugzilla Component can be changed.
Poll Interval The time frequency of how often DeployHub should look for Bugzilla issues in seconds, i.e. 60.
Poll Interval Encrypted Select the box to indicate the Poll Interval should be hidden in the database.
Poll Interval Override Select the box if the Poll Interval can be changed.
Product The full URL to the Bugzilla Product.
Product Encrypted Select the box to indicate the Product name should be hidden in the database.
Product Override Select the box if the Product can be changed.
Server The fully qualified URL to the Bugzilla Server so DeployHub can get access.
Server Encrypted Select the box to indicate the Server should be hidden in the database.
Server Override Select the box if the Server can be changed.
Status The Bugzilla Status you want to use as your Filter.
Status Encrypted Select the box to indicate the Status should be hidden in the database.
Status Override Select the box if the Status can be changed.

Using a LDAP or Active Directory Data Source for Single Sign-on

DeployHub allows you to use LDAP or Active Directory to manage your User logins. Create an LDAP Data Source to access an LDAP database and use the information stored to gain access to DeployHub. It also populates the Users General tab with Real Name and Email, which it gets from the LDAP database. When you define a User, you associate the LDAP authentication method. At login, DeployHub checks the User’s authentication method to determine if LDAP or Active Directory should be used.

Creating a LDAP or Active Directory Data Source

To support LDAP integration, you must create an LDAP Credential whose Username value is a user id (uid) followed by the necessary Ldap domain components (dc), all comma delimited (i.e., uid=mycompany,dc=example,dc=com). The Credential’s Password field contains the password for the user in the LDAP directory. For more on creating Credentials see Create Your Credentials.

The Data Source has specific parameters used to validate a User:

Field Description
LDAP Server I.P. address or hostname of the LDAP Server. The address of the LDAP server, which can include the port (i.e., ldap://ldap.forumsys.com:389). If the port isn’t included, it can be put separately into the Port Number parameter.
LDAP Server Encrypted Select the box to indicate if the LDAP Server should be hidden in the database.
LDAP Server Override Select the box if the LDAP Server can be changed.
Active Directory Domain Enter the name of the Active Directory Domain within the LDAP Server.
Active Directory Encrypted Select the box to indicate if the Active Directory Domain Name should be hidden in the database.
Active Directory Override Select the box if the Active Directory Domain Name can be changed.
Port Number The port on which the LDAP server is listening.
Port Number Encrypted Select the box to indicate if the Port Number should be hidden in the database.
Port Number Override Select the box if the Port Number can be changed.
Search Base The search base defines the starting point for the search in the LDAP directory tree.Enter the search base (the distinguished name of the search base object) that defines the location in the directory from which the LDAP search begins (i.e., dc=example,dc=com).
Search Base Encrypted Select the box to indicate if the Search Base should be hidden in the database.
Search Base Override Select the box if the Search Base can be changed.
Search Filter Always (uid=$USERNAME) (include parenthesis), as this locates the user within the LDAP database using the Username that was entered into the DeployHub Credential. These filters are used for selecting which objects are returned when browsing for the search base. They identify which objects in your directory are examined, for example email address attributes or user attributes.
Search Filter Encrypted Select the box to indicate if the Search Filter should be hidden in the database.
Search Filter Override Select the box if the Search Filter can be changed.

Data Source Access Controls

The Access Section allows Users within designated Groups to update the Data Source in various ways. To add a Group to one of the access lists, drag and drop the Group from the Available Groups list onto desired access list. All Users who belong to a Group that appear in one of the Access lists will be granted access to the Data Source in the following ways:

Access Description
View Allows Users to see the Data Source. If the User does not belong to a Group in the View Access list, the Data Source will not appear in the List View.
Change This allows a User who belongs to any User Group in the list to change the attributes of the Data Source.
Select Allows Users to use the Data Source to access external data.
Delete Allows the User to remove the Data Source.

NOTE: DeployHub Team has only two Groups, Administrators and Users. If you need more granularity in your UserGroups, you will need to upgrade to DeployHub Pro.

Last modified June 28, 2020: run markdownlint tidy (1259dc6)