| Table of Contents |
|---|
...
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. Supports:
| ||
| Endpoint Details | ||||
Endpoint Address | Yes | The DNS name or IP address of the Endpoint. | ||
Port | Yes | The SSH port of the Endpoint (typically port 22). | ||
| 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
| ||
| JDK Home | Yes | The JDK Home directory on the Endpoint. For example, /usr. FlexDeploy will look for /bin/java under specified JDK Home folder. Not required if the Endpoint is a Docker Host. | ||
| 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. | ||
| Transfer Protocol | Yes | Protocol/Tool to use to transfer files from FlexDeploy host to endpoint and vice-versa. Options available are:
To use the rsync option, FlexDeploy should be running on a UNIX machine, the endpoint can be UNIX or Windows (Cygwin) and rsync needs to be installed on BOTH, FlexDeploy host and endpoint | ||
| Authentication | ||||
| Authentication Type | Yes | Mechanism to use for authentication. The Password, Private Key File, and Passphrase are displayed based on selected type. Supports:
| ||
User Name | Yes | The user account on the Endpoint to connect with. All executions via this endpoint will run as this user. | ||
Password | No | The password for the User Name. Either password or Private Key File is required. | ||
Private Key File | No | Fully-qualified path of the SSH private key file on FlexDeploy server. Either Private Key File or Password is required. ~ is not supported here. | ||
Passphrase | No | An optional passphrase used when the private key was generated. Only valid if a Private Key File is specified. | ||
| Run As (sudo) | No | An optional user to run as (using sudo) after establishing connection to the endpoint when working with Unix OS.
If there is a need to adjust sudo commands, then it can be done by setting up description value like shown below. Please consult with Flexagon support if questions on this topic.
Note that there is space at the end of each line. Both prefix and suffix should be on it's own line in Description input. In this example, FlexDeploy will run sudo as per this example command: “ | ||
Container Details | ||||
| Docker Host | Yes | Whether or not the endpoint is capable of running Docker containers | ||
| K8s Cluster | No | Whether or not the endpoint can run Docker containers on a K8s cluster | ||
| K8s Context | No | Name of the configured K8s context | ||
| Group | No | An optional group identifier which can be useful when searching for Endpoints. | ||
| Subgroup | No | An optional subgroup identifier which can be useful when searching for 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 Enpoint, click the Inactive link and it will toggle back to Active. This endpoint is now active in the system again and ready for use.
...
It is typical to use the default file name and location to store the private key (which is in the .ssh subfolder of the user's home directory). You can optionally secure the private key file with a passphrase. It is an SSH requirement that the private key be readable only by its owner (e.g. oracle in the example above). So you must change the permissions accordingly (e.g. chmod 600 /home/oracle/.ssh/id_rsa). You will receive an error at connection time similar to the following if you omit this step.
Permissions 0777 for '/home/oracle/.ssh/id_rsa' are too open.
It is recommended that your private key files are NOT accessible by others otherwise private key will be ignored.
| Tip |
|---|
The /home/oracle/.ssh folder on the endpoint must have drw------- permissions. For example,
|
...