An Endpoint is an object representing a single container, 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. DeployHub can deploy your Application to Environments with a mixture of Endpoints such as containers, database servers or images, cloud images, request routers, or application servers or images. There is a many-to-many relationship between Environments and Endpoints, so that an Endpoint can be assigned more than one Environment, and an Environment can contain many Endpoints.


Creating and Deleting Endpoints

Select the Data Center Menu item, clicking on the Endpoints tab, and right clicking on the Domain in the tree structure to create where the Endpoint is to reside. The “New Endpoint in this Domain” option displays a dialog box. Once created, the Endpoint details can be edited by selecting the Endpoint’s General tab and clicking on the pencil icon on the far right.


Right click on the Endpoint in the tree view for the ‘Delete this Endpoint’ option. Once deleted, this action cannot be undone. Or select the ‘Copy Endpoint’ option from the list and then paste into another Domain by right clicking on it in the tree structure.


Editing Endpoints

When you select the Endpoint from the tree structure, you can see the details of the Endpoint in the General tab. Clicking the pencil icon in the right corner of the window to edit. In addition, Endpoints have associated Attributes, Components, and Access which can be modified by selecting each of these tabs.  In addition, you can view Endpoint History, and Reports, which shows the usage for the Endpoint.


Timeline Tab

This tab displays log file entries for the deployment of Applications to the selected Endpoint.  It includes information concerning how many days ago the deployment took place, the deployment number, which User deployed the Application, and the Environment it was deployed to. Click on the deployment number within each line of the list in order to view information about each deployment to the Endpoint. A window appears with five tabs:


Tab

Description

Files

A list of files that were deployed to the Endpoint, which includes the Repository’s path of the source file, and the target path where it was placed.

Log

This includes step by step details of the deployment, which includes error messages in red font.

Activities

A list of any Actions, Procedures, and Functions that were used during the Deployment. Clicking on the link navigates to the Action/Procedure/Function.

General

A synopsis of the deployment, which includes the name of the Application, the date and time of the deployment, and the amount of time the deployment took.

Reports

The Reports tab contains two graphs. One displays the time taken for each deployment. Mouse over the dots to see a small translucent box which shows the deployment number and the time taken to deploy in seconds. The second graph is a pie chart which displays the number of successful and failed deployments for each Application onto the selected End Point.


Adding Comments

‘Click to see earlier items’ link shows all of the entries where you can add comments in a text entry field just below the deployment information. Users can also click on the Subscribe link in each entry of the list, which allows the User to receive information about the selected deployment. Any comments appear in the History column of the subscriber’s home page.


“Say something about this End Point” can also have comments placed into it, and files can be attached there. Entering text into this field activates the Add Message button. Click on this button to save the comment as a line in the list.


Clicking on the fingerprint button next to the Add Message button brings up a file explorer that allows files to be selected and attached. These can be retrieved by clicking on the fingerprint icon, which opens a list that displays the file name. Click on it to be downloaded into the default Downloads folder of the PC that hosts the browser used to run DeployHub (not on the server hosting DeployHub). A dropdown list appears at the bottom of the browser with the file name. The options shown are standard in every Windows file download interface, including Open, Always Open this Type of File, and Show in folder. Several drop-down lists can appear along the bottom of the browser. A small ‘x’ on the far-right side at the bottom can be clicked to make all the lists disappear.


Deployed Components Tab

This tab contains a table that displays two different kinds of rows, each of which can be added or deleted by using the group of buttons on the upper right side, which consists of a plus sign and an ‘x’: The plus sign (+) is used to assign Component Versions that have been deployed to the Endpoint outside of DeployHub. Clicking this button on the right side displays a list of Component Base Versions and Component Versions in a pop-up window titled “Manually Add Component Version(s)” that can be selected and placed into the list, along with the current date and time, indicating that this Component has been deployed to the Endpoint outside of DeployHub. This allows DeployHub’s database to keep track of which versions have been deployed, which will affect how deployments are executed in the future.


Any Components that have been deployed through DeployHub’s deployment process appear in this list along with the deployment number under the Details column. Clicking on the ‘Deploy #’ link in the field brings up the Results window seen in various places throughout DeployHub, which includes the Files, Log, General, and Reports tabs. The ‘x’ button is used to delete a line from the list.


Trends Tab

The uppermost section of the Trends tab shows the Change History for the Endpoint's Components. There are horizontal areas across the top and bottom containing a calendar. Components are represented by horizontal areas with a thick blue line. A thin blue vertical line can be clicked on and dragged back and forth across these areas to see what Components were on the Endpoint at the selected date and time.


Using the scrolling device on the User's mouse or trackpad causes the entire area to expand and contract which, along with the ability to scroll back and forth via clicking and dragging, allows the User to easily view the entire Change History from beginning to end, in detail, while using the Calendar as a reference.


The bottom section of the Trends tab contains information about deployments to the Endpoint. The horizontal numbers across the bottom of the chart indicate the Deployment Number. The vertical numbers on the left side represent the time taken to deploy. Hovering the mouse pointer over any one of the dots on the chart where these intersect shows both values.


The pie chart in the bottom right side shows the number of failed and successful deployments. Hovering the mouse pointer over the chart shows the number of failures (red) and successes (green).

Status Tab

The Status tab is used to check the status of the physical or virtual server that the Endpoint object represents. Clicking on the “Test Now” button causes DeployHub to connect to the server on the network, and returns the following information:

  • Name Resolution: Determines if the server hostname could be resolved to an IP address.
  • Ping: Determines if the “ping” to the IP addressed derived from the name resolution step worked.
  • Connection: If the “ping” succeeded, whether the connection using the specified attributes to the server was successful.
  • Base Directory Check: If the connection succeeded, whether the engine could switch to the server’s “target directory”.
  • Ping Time (ms): Time taken for the ping to respond (in milliseconds).
  • IPv4 Address: The IP address returned by the “Name Resolution” step.
  • Last Checked: The date and time of the last test. If “auto ping” is set to true on the End Point General tab, then this will update automatically to the last automatic connection test.
  • Last Error: If any of the above steps failed, this displays the detected error.


Attributes Tab

Values that are stored against an Endpoints can be used to control deployments. The Name field holds the name of the Value, while the Value field holds the data as either a numeric or text. It can also be an array of Name/Value pairs associated with a Name. Clicking on the plus sign (+) allows the User to enter a new Name and its associated Value. Selecting the Attribute in the table and clicking on the “X” in the upper right-hand corner deletes the line from the table of Name/Value pairs, while selecting the pencil icon displays a window for editing the selected Name and Value.

Access Tab

You can define Groups which contain Users to View and Change access to Endpoints.  This access allows you to define who can manage the Endpoints. There are three Access options:


Access

Description

View

This allows any User that belongs to any Group in this list to see the selected End Point in the tree structure on the right side.

Change

This allows any User that belongs to any Group in this list to make changes to the End Point.

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 End Point.


General Tab

The General Tab displays the basic information that defines an Endpoint. The Endpoint can be edited by clicking on the pencil icon from the right-hand corner of the window. The basic Endpoint information includes:


Field

Description

Name

The name of the Endpoint object.

Owner

The owner of the Endpoint, it defaults to the User who created it. When editing this field, the Owner Type field is available which includes Owner and Group as choices. Selecting one of these causes the Owner field to display either Users or Groups to choose from.

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 Type

The platform type of the physical or virtual server that the Endpoints resides on, the list currently includes AS400, Mac, Unix, Windows, Tandem, Stratus, and OpenVMS. For Docker, you should select Unix or Windows.

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. Currently this includes win, ftp, sftp, and ftps.

SSH Port Number

The SSH Port used to connect to the Endpoint if the selected Protocol is sftp.

Base Directory

The Base Directory for a Component can either be absolute, i.e. 'c:\main' for Windows or '/main' for Linux/Unix, etc., in which case it replaces the Base Directory for the End Point. If the Component's Base Directory is relative, i.e. 'SomeFiles\SomeMoreFiles', then it is appended to the End Point's Base Directory, i.e. 'c:\main\SomeFiles\SomeMoreFiles'.

If the Component Item's Target Directory has a value, it is always appended to the end of whatever value has been created from the Base Directories of the Endpoint and Component.

Credential

The Username and Password pair needed to login to the Endpoint.

Auto Ping

A checkbox that indicates if the DeployHub system will ping the Endpoint periodically. If checked, it causes the Ping Interval, Ping Start, and Ping End fields to be available.

Auto MD5 Check

Each Endpoint has a number stored in the DeployHub database that is derived from an MD5 check of all files deployed to the Endpoint. If Auto Ping is checked, this field is made available. If the Auto MD5 Check field is selected, an MD5 check is run every time the Endpoint is pinged, and the resulting value is compared against the number stored in the database to see if there have been any changes made outside of DeployHub. If there is a difference, it will be reported via the Endpoint Owner’s Home Page.

Ping Interval

Indicates how often the Endpoint will be pinged, using 15 minute increments. Value can between 15 and 240 minutes.

Ping Start

Indicates what time pinging will start each day, in military time.

Ping End

Indicates what time pinging will stop each day, in military time.

Ping Failure Template

The name of the Email Template that is used to notify Users if Auto Ping is set to Yes and the Endpoint cannot be reached over the network.

MD5 Mismatch Template

The name of the Email Template that is used to notify Users if any of the deployed files change, causing the result of the MD5 calculation to change.

Endpoint Component Types

Used to match Components to Endpoints using a many-to-one relationship, with each Endpoint having one or more Types and each Component Version having only one Type. When an Application Version is deployed into an Environment, each Component in the Application will be deployed against each Endpoint that matches its Component Type.