Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Endpoints are the FlexDeploy representation of a device or virtual machine where plugins can be runexecuted. They hold connection and host details that allow FlexDeploy to connect to and perform commands on the server.

FlexDeploy utilizes an agent-less as well as agent-based (available since 6.5.0.3) architecture to connect to computers across private or public networks/clouds to execute build and deploy operations. This architecture uses a secured communication protocol (SSH) and or HTTPS. If HTTPS protocol is desired then agent installation is necessary. SSH connectivity eliminates the need for installing and managing software(agent) on every build and deployment target. In many cases no setup is required on an Endpoint prior to configuring it within FlexDeploy.

Endpoint Requirements

Viewing Endpoints

To view the configured Endpoints, select Topology from the menu, and then choose the Endpoints tab.

...

If you want to search the Endpoint , by clicking on filter symbol on different columns like Active, Name, Address, Description, Updated By, Updated On .

...

Creating/Editing Endpoints

See the following links for information on creating Endpoints.

...

Endpoint Tags

To add a Tag to the Endpoint , click on the three dots that we are seeing on right side of the particular endpoint row.

...

To Manage the Tags you can navigate to Tags from the menu and manage the Tags Tags | Managing Tags .

Activating and Inactivating Endpoints

To inactivate an Endpoint click the Active link on the desired endpoint, and it will toggle to Inactive. This will hide that Endpoint after leaving the screen, until the Active checkbox is unchecked. To reactivate an Endpoint, click the Inactive link and it will toggle back to Active

Endpoint Directory Structure

FlexDeploy creates and manages the following directory structure on the endpoints. 

...

Info

The scratch folder is only created when using "Run as User" for the endpoint. This folder is created and owned Endpoint user, whereby all other directories are owned by the Run As User.  This is required to facilitate the upload/download of files which are performed using the endpoint user.

security
The security directory holds information related to the SSH connection between the FlexDeploy server and the Endpoint server and is used for secure communications.

work
The work directory contains every invocation of a plugin operation that has occurred on the Endpoint. There is additional file structure under the work directory based on the execution project id and the current execution id of the given project.

...

work/<projectId>/<executionId>/scan-results
Directory for security scanning plugins (e.g. OWSAP, SonarQube) to place the scan results to be returned to the FlexDeploy server and processed.

work/<projectId>/<executionId>/temp
Directory for plugin execution to checkout and manipulate data or files until moved to the artifacts directory for storage.

work/<projectId>/<executionId>/test-results
Directory for test plugins like Junit (e.g. Junit, Postman) to place the test results to be returned to the FlexDeploy server and processed.

...