Creating a LocalHost Endpoint
- Karl Henselin
The localhost endpoint can be useful to run executions on the FlexDeploy server efficiently without any SSH communication, or need to manage an HTTPS Agent. This endpoint can be utilized for SaaS applications, or with any plugins which manage connectivity using remote interfaces (e.g. REST, JDBC). If build/deploy operations require execution a particular host, an SSH or HTTPS endpoint is required.
A localhost endpoint is included with FlexDeploy, and it is very unlikely that you will need to create another localhost endpoint. The predefined localhost Endpoint uses variables for Base Directory and JDK Home to take advantage of FlexDeploy server's working directory setup and use of same Java Home.
If necessary to create additional localhost Endpoint, then click the Create button to create a new Endpoint. You can edit an existing localhost Endpoint by clicking on the desired row. Update the required fields as defined in the table below.
Field Name | Required | Description |
|---|---|---|
Endpoint Name | Yes | The name of the Endpoint. |
Description | No | An optional description for the Endpoint. |
Active | Yes | Whether or not the endpoint is active in the system. Defaults to "Yes". |
Connection Type | Localhost | Plugin process will run on FlexDeploy application host and as FlexDeploy application process user. When plugin process is invoked, it will not source .bashrc, .bash_profile, .profile. If needed use Source Script to adjust execution environment. |
Base Directory | Yes | A working directory on the Endpoint used by FlexDeploy. ~ is not supported here. Working directory under /var/tmp or /tmp folder is not recommended as administrators generally have cron jobs to purge files based on age and that will cause issues when plugin files are deleted. For example, Error: Could not find or load main class flexagon.fd.core.plugin.ExternalPluginServer will be encountered when plugin lib files are deleted. |
JDK Home | Yes | The JDK Home directory on the Endpoint. |
Source Script | No | An optional script executed right before plugins are executed on the endpoint. Some usages of this script include sourcing an environment file (ie: . $HOME/mfile.env) or exporting a variable (ie: export FLEXAGON_FD_PLUGIN_JAVA_ARGS=”-Xmx1024m -Djava.io.tmpdir=/var/tmp”). Variables exported here will become available to plugin executions on this endpoint. |
Max Concurrent Executions | No | Sets a limit on the number of concurrent executions on this endpoint. If not specified, the default of 5 will be used. |
Optionally, click the Test Connection button to validate that the FlexDeploy server can connect to itself properly. This will verify the Base Directory and JDK Home settings.
Click the Save button to save the changes to the Endpoint. To discard the changes Cancel button.
Related content
- style