Define Your Endpoints

How to Define Endpoints for Environments

Introduction to Endpoints

An Endpoint is an object representing a container deployment host, virtual image, or physical server in an enterprise’s data center. A DeployHub Environment is a collection of Endpoints to which your Application will be deployed or from where your container will be deployed (container deployment host).

Endpoints can be the location where you will run your Helm Chart for a Kubernetes deployment, a database server, cloud images, request routers, or WebSphere server. There is a many-to-many relationship between Environments and Endpoints, so that an Endpoint can be assigned to more than one Environment, and an Environment can contain many Endpoints.

Use the Endpoint List View to Add or Delete

The Endpoint menu is on the left of the main panel. Select the Endpoint menu to view a list of all Endpoints to which you have access. Or use the Search bar, represented by a funnel icon, to reorder Endpoints based on Name or Domain.

The Endpoints List View has the following Tabs.

Tab Description
Refresh Refreshes the browser.
Add Allows you to Add a new Endpoint.
Delete Deletes the selected item.

Double click on an item in the list to see the Dashboard.

Use the Endpoint Dashboard to View and Edit

The Dashboard view displays all information related to a specific Endpoint.

Endpoint Details

Field Description
Full Domain The fully qualified name of the Domain to which the Endpoint is defined.
Name The name of the Endpoint object. For managing Kubernetes clusters, you should name your Endpoint to match the cluster name that the Endpoint is deploying to. This will allow DeployHub to track what has been deployed to each cluster.
Owner Type Group or User
Owner The owner defaults to the User or Group who created it.
Summary A short text description of the Endpoint.
Created The date and time the Endpoint was created.
Modified The date and time the Endpoint was last modified.
Endpoint Operating System Type The platform type of the physical or virtual server that the Endpoints resides on, the list currently includes Unix, Windows, Tandem, Stratus, and OpenVMS. For containers you should select Unix.
Endpoint Types Used to indicate what types of Components will be deployed to this Endpoint. Used to route specific types of Components to the matching EndPoint across Environments.
Hostname The unique name of a server that is used to identify it on the network.
Protocol The protocol used to communicate with the Endpoint. Options are ssh and winrm.
ssh Port Number The ssh Port used to connect to the Endpoint if the selected Protocol is ssh.
Base Directory If you would like to force all deployments to occur in a specific high level directory, enter it into this field. The Endpoint Base Directory will override the Component Base Directory. For more information see Formatting Directories on the order of how the deployment directory is formatted.
Credential The Username and Password pair needed to login to the Endpoint.
Test Connection Result The following fields display the result of the last “Test Connection” executed, performed by using the “Test Connection” option from the Endpoint Dashboard.
  • Name Resolution - Checks to see if the DNS name can be resolved. Returns “OK” on success or “Failed” if not.
  • Ping - Checks to see if the Endpoint responds to ping. Returns “OK” on success or “Failed” if not.
  • Base Directory Check -Checks to ensure the Base Directory is available on the EndPoint
  • Ping Time - Time in milliseconds (ms) for the Ping to respond.
  • IPV4 Address - The IP address of the Hostname.
  • Last Checked - Timestamp of when the last “Test Connection” was performed.
  • Test Results - Success or Failed message for the last “Test Connection” executed.

Key Value Configurations

Key Value Configurations are Value Pairs for managing associative arrays assigned to the Object.

Key Value Pairs can be assigned at multiple levels, from the Global Domain down to an individual Component and have a “scope.” Lower level Objects can override a higher level Object. Below is the order in which Key Value Pairs can be overridden:

Object Description
Global Contains all Environment variables and any “additional Key Value Pairs” set by the user when running that task.
Environment Overrides any Global Key Value Pairs during a deployment.
Application Overrides the Environment Key Value Pairsduring a deployment.
Endpoint Overrides the Application Key Value Pairs during a deployment.
Component Overrides the Application Key Value Pairs during a deployed.

Key Value Pairs can be given any Name and a Value. Use +Add to add Key Value Pairs to the table. Use Save to confirm. Use the checkbox to Delete or Edit a Key Value Pair.

Endpoint Access Control

The Access Section allows Users within designated Groups to update the Endpoint. 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 within one of the Access lists will be granted access to the Endpoint in the following ways:

Access Description
View Any User in any Group in this list can see the selected EndPoint.
Change Any User in any Group in this list can make changes to the Endpoint.
Available Groups This list contains all the Groups within the DeployHub installation. Dragging and dropping back and forth between this list and the other two lists allows or prevents access to viewing and changing the selected EndPoint.

Audit Trail

The Audit Trail displays audit entries for any changes or deployments that impact this object. It includes any changes in the object including User date and time, and deployments with unique numbers.

You can Subscribe to or Comment on an Audit Entry.

  • Subscribe: Allows you to receive information about the selected deployment.

  • Comment: Add information by clicking on the ‘Comment’ link within a text entry field. There is a field above the list labeled “Say something about this Application” that can have comments placed into it, and files can be attached to the comment as well. Enter text into this field to activate the Add Message button. Click to save the comment.

  • Add Files to Comments: Click on the paperclip icon to add a file to the message. Once added and you made a comment, click “Add Message”. Click on the paperclip icon to retrieve these attachments. The icon opens the line in the list to display the name of the file. Choose the file to download it into the your default Download directory on your local computer.

The Trends graph shows you your success or failure rates overtime as well at the time required for the last 10 deployments. If an Application deployment is taking longer than previous deployments, this might indicate an issue with your deployment logic.

Deployed Components

This section provides a list of all current versions of Components that have been installed on the Endpoint with the Deployment Number. The Deployment Number is generated by DeployHub for each unique deployment.

Last modified July 9, 2020: small cleanup (b45ee8f)