Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Yes

The connection type used for connection to the Endpoint. Select HTTPS for connectivity over https protocol.

Supports:Operating System

localhost

Yes

Unix

- SSH
  • Windows - SSH     Supported on Windows Server 2019+ where native OpenSSH is available.

  • Windows - SSH (Cygwin)     See the Cygwin Installation Guide for more information.

  • HTTPS

    or Windows

    Address

    Yes

    The DNS name or IP address of the Endpoint.

    Port

    Yes

    The HTTPS port of the Endpoint (typically port 8444), and will depend on how you installed https agent, see FlexDeploy HTTPS Agent for more details.

    Default port for HTTPS Agent process is 8444, which you can configure to 443 also.

    Base Directory

    Yes

    A working directory on the Endpoint used by FlexDeploy. ~ is not supported here. See Permissions information below for details on how to create this folder automatically (Recommended).

    For example, /app/flexdeploy.

    If you have two FlexDeploy installations that may connect to same Endpoint, you must use unique folders for both FlexDeploy Servers. In most cases, separate FlexDeploy is installed to perform testing of FlexDeploy patches, which may connect to same Endpoint, in which case you can use different folder like /app/flexdeploytest and /app/flexdeploy.

    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.

    Permissions

    • Base directory must be owned by user that the HTTPS agent is running as and it's group.

    • Ideal option is to point base directory where the user that the HTTPS agent is running as has access to create sub-folder. In such case, FlexDeploy will automatically create folder with necessary permissions.

    • Permissions required are 755. Keep in mind that FlexDeploy may temporarily change permissions specifically when using Run as option.

    JDK Home

    Yes

    The JDK Home directory on the Endpoint. For example, /usr. FlexDeploy will look for /bin/java under specified JDK Home folder.

    Source Script 

    No

    An optional script executed right before plugins are executed on the endpoint. Script can source some other environment script as well. Script should be Unix shell or Windows bat commands depending on type of Endpoint. If using Windows Cygwin SSH then script should be written as Unix shell.

    Some usages of this script include sourcing an environment file (. $HOME/mfile.env)  or exporting a variable (export FLEXAGON_FD_PLUGIN_JAVA_ARGS="-Xmx1024m -Djava.io.tmpdir=/var/tmp"). Variables exported here will become available to plugin executions on this endpoint.

    Username

    Yes

    The user account on the Endpoint to connect with.

    Password

    No

    The password for the Username.

    ...