Define Your Endpoints

Introduction to Endpoints

An Endpoint is an object representing a container deployment host, virtual image, or physical server in an enterprise’s data center. Endpoints are where your Components are deployed and used to map where a package vulnerability is running without the need for an EndPoint agent installed into production Environments.

A DeployHub Environment is a collection of Endpoints. Therefore, 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.

This data establishes relationships that allow for mapping a vulnerability found at the Component level to the specific Endpoints where it is running.

Adding Endpoints Via Your CI/CD Workflow

The Ortelius open-source project Command Line Integration (CLI) automates the creation of Endpoints. When a deployment is logged, the CLI is passed the Application Version, Environment, and Endpoints. The CLI will automatically create Endpoints and Environments if they do not already exist. If no Endpoint is provided to the CLI, the name of the Endpoint will default to the Environment name. At least one Environment name must be passed to the CLI. For more information, read the CI/CD and DeployHub.

Use the List View to Add or Delete Endpoints

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. This is a required field.
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. This is a required field.
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.
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	The directory where the artifacts were deployed.
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 pairs are stored for any configuration setting that needs to be persisted with the version of the Object. For example, pairs can be used to store issue numbers from Jira or GitHub issues with the Component Version and/or Applications Version.

For users of the DeployHub internal deployment engine, Key Value pairs can be stored by DeployHub and referenced during a deployment.

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 Pairs during 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.

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.

Audit Trail

The Audit Trail displays audit entries for any changes that impact this Object.

• Comment: Click on ‘Comment’ to add information. There is a field above the list labeled “Say something about this Object” that can have written comments placed into it, or files can be attached to the comment. Entering text into this field activates the Add Message button. Click to save the comment as a line in the list.

• Add Files to Comments: Click on the paperclip icon to add a file to the message. Once done, click on the “Add Message” button. These attachments can later be retrieved by clicking on the paperclip icon which then displays the name of the file within a list. Choose the file to download it into the your default Download directory on your local computer.

Deployment Audits

For deployment audits, select a deployment number to see the details including:

Access	Description
Log	The output of the deployment.
Files	Any files or objects deployed.
Step Duration	Deployment Steps with time required to execute.
Feedback Loop	Shows what was updated starting from Component.

When using the internal DeployHub deployment engine, all log output is automatically persisted with the Application Version and Component Version.

If you are using another deployment solution, you can persist the log via the CI/CD workflow. The output from the deployment can be passed to the CLI to be persisted with the Application Version and Component Versions. Learn more about the CI/CD CLI Integration