CloudBees Flow Installed Tools

Tool Name Description

Tool Name	Description
eccert	A command-line tool used to manage the CloudBees Flow Certificate Authority (CA) and the certificates configured in CloudBees Flow Server and CloudBees Flow Agent installations.
ecconfigure	A command-line tool that can change configuration values for any locally installed CloudBees Flow server, web, agent, or repository service. `ecconfigure` is a more user-friendly mechanism for configuring aspects of CloudBees Flow that would otherwise require manual configuration file updates. `ecconfigure` actually manipulates relevant service configuration files on your behalf.
ecdaemon	A "wrapper" program that can be used to start another program from a CloudBees Flow job step—the "started" program will run as a daemon process. The CloudBees Flow agent uses the facilities of the underlying operating system to make sure the process runs in a separate process group on a UNIX-based system, or outside of the normal "Windows Job" grouping in a Windows system. In either case, the CloudBees Flow agent does not treat the process as one it should wait for or one it should try to "kill" if CloudBees Flow needs to abort the step.
ecproxy	A driver script with built-in support for SSH. Every major operation can be overridden by defining a Perl function in the Proxy Customization field on the New Proxy Resource panel, available from the Resources page.
ecremotefilecopy	When CloudBees Flow agents (on platforms other than Linux or Windows) run steps that create log files in a workspace the CloudBees Flow web server cannot access (through Linux or Windows agents), use ecremotefilecopy to recreate job logs so they are visible on those CloudBees Flow agents, which then enables the web server to retrieve and render those log files.
ZKConfigTool	A command-line tool that imports your CloudBees Flow database configuration information into your ZooKeeper server.
ClusterInfoTool	A command-line tool that displays information on the running CloudBees Flow server cluster from ZooKeeper.

A command-line tool used to manage the CloudBees Flow Certificate Authority (CA) and the certificates configured in CloudBees Flow Server and CloudBees Flow Agent installations.

ecconfigure

A command-line tool that can change configuration values for any locally installed CloudBees Flow server, web, agent, or repository service. ecconfigure is a more user-friendly mechanism for configuring aspects of CloudBees Flow that would otherwise require manual configuration file updates. ecconfigure actually manipulates relevant service configuration files on your behalf.

ecdaemon

A "wrapper" program that can be used to start another program from a CloudBees Flow job step—the "started" program will run as a daemon process. The CloudBees Flow agent uses the facilities of the underlying operating system to make sure the process runs in a separate process group on a UNIX-based system, or outside of the normal "Windows Job" grouping in a Windows system. In either case, the CloudBees Flow agent does not treat the process as one it should wait for or one it should try to "kill" if CloudBees Flow needs to abort the step.

ecproxy

A driver script with built-in support for SSH. Every major operation can be overridden by defining a Perl function in the Proxy Customization field on the New Proxy Resource panel, available from the Resources page.

ecremotefilecopy

When CloudBees Flow agents (on platforms other than Linux or Windows) run steps that create log files in a workspace the CloudBees Flow web server cannot access (through Linux or Windows agents), use ecremotefilecopy to recreate job logs so they are visible on those CloudBees Flow agents, which then enables the web server to retrieve and render those log files.

ZKConfigTool

A command-line tool that imports your CloudBees Flow database configuration information into your ZooKeeper server.

ClusterInfoTool

A command-line tool that displays information on the running CloudBees Flow server cluster from ZooKeeper.

eccert

A command-line tool used to manage the CloudBees Flow Certificate Authority (CA) and the certificates configured in CloudBees Flow Server and CloudBees Flow Agent installations.

Do not use eccert as sudo, which would change the ownership of the configuration files (such as the keystore file) to the root user. These files must be owned by the user who starts the CloudBees Flow services.

Usage

eccert [ options ] command [ arg … ]

Commands

addTrustedServer crt

Add a server CA certificate to the agent’s keystore.

getCRL

Retrieve the contents of the current certificate revocation list.

initAgent [ --local | --remote ] [ options ]

Initialize the agent keystore with a new public/private key pair. Generates the agent certificate signing request. If run on the server host, the certificate will automatically be signed by the server CA, and the CA certificate and the signed agent certificate are installed in the agent’s keystore. If run on a non-server host, the signing request is left in the agent directory. If CA Cert is provided, the CA certificate is installed in the agent’s keystore.

--local

Use the local server CA to sign the agent certificate.

--remote

Connect to a remote CloudBees Flow server to sign the agent certificate.

--force

Replace any existing keystore.

--cname name

Use the specified name as the common name (CN) in the agent certificate subject. This is normally the fully qualified domain name used by clients to connect to the agent.

--altNames entries

Use the specified list of entries (comma or space separated) as the subjectAlternateNames list in the agent certificate. Simple names are interpreted as dns entries. Entries may begin with "dns:" or "ip:" to indicate the type (for example, ` "ip:192.168.0.1"` or "dns:myHost" ). If no entries are specified, then reverse DNS is used to look up the registered names of the host’s IP addresses.

initCA

Initialize the server CA. Creates a new CA key and certificate.

initServer [ options ]

Initialize the server keystore. Creates and signs the server certificate. Installs the CA certificate and the signed server certificate into the server’s keystore.

--force

Replace any existing keystore.

--cname name

Use the specified name as the common name (CN) in the server certificate subject. This is normally the fully qualified domain name used by clients to connect to the server.

--altNames entries

Use the specified list of entries (comma or space separated) as the subjectAlternateNames list in the server certificate. Simple names are interpreted as dns entries. Entries may begin with "dns:" or "ip:" to indicate the type (for example, "ip:192.168.0.1" or "dns:myHost" ). If no entries are specified, then reverse DNS is used to look up the registered names of the host’s IP addresses.

list [ --agent | --server | --index [ --verbose ]

Display certificate information for agent and/or server keystores or the CA certificate index. If no options are specified, both the agent and server keystores are listed.

--agent

List the contents of the agent keystore.

--server

List the contents of the server keystore.

--index

List the contents of the CA issued certificates index.

--verbose

Display additional details.

refreshCRL

Refresh the certificate revocation list from the CloudBees Flow server.

revoke index

Revoke a previously issued certificate by index.

signCertificate csr crt

Sign the certificate signing request provided in file csr and write the signed result to the file crt. The request is rejected by the CA if there is a matching certificate already in the CA database.

updateAgentCertificate crt

Install a previously signed certificate crt into the agent’s keystore.

Server Communication Options

--server host

Address of the CloudBees Flow server. Defaults to the value of the COMMANDER_SERVER environment variable. If that does not exist,it defaults to localhost.

--securePort port

HTTPS listener port on the server. Defaults to 8443.

Global Options

--help

Print the Help message.

--version

Print the version message.

Examples

Example 1: Configure an agent to talk to any server (untrusted mode)

This example generates a new self-signed certificate for the agent and recreates the keystore with no trusted authorities.

    $ eccert initAgent -force

    Generating keys
    Generating certificate request
        cname=<myAgent.example.com
        san=<dns:myAgent.example.com

Example 2: Configure an agent to accept connections only from a single remote CloudBees Flow server

This example generates a new certificate for the agent that is signed by the remove server’s certificate authority and installs the signed certificate and its associated trust chain in the agent’s keystore. After this point, the agent will only accept requests from the specified server and will be used as a trusted resource by the server.

    $ ectool --server myserver login admin pw
    $ eccert --server myserver initAgent -remote

    Generating certificate request
        cname=<myAgent.example.com
        san=<dns:myAgent.example.com
    Asking server 'myserver' to sign certificate
    Importing 'CA:myserver.example.com' certificate
    Importing 'jetty' certificate

Example 3: Configure a CloudBees Flow server with additional host names in the certificate

This example regenerates the CloudBees Flow Server Certificate, the specified common name, and alternate subject names to allow trusted connections with multiple external dns names.

    $ eccert initServer --force --cname "myServer.example.com" --altNames "myServer,server2.example.com"

    Generating keys
    Generating certificate request
        cname=<myserver.example.com
        san=<dns:myserver,dns:server2.example.com
    Signing server certificate
    Importing 'CA:myserver.example.com' certificate
    Importing 'jetty' certificate

ecconfigure

A command-line tool for changing values in configuration files for any locally-installed CloudBees Flow server, web server, repository server, or agent. ecconfigure is an easier way to configure CloudBees Flow settings than manually editing configuration files.

ecconfigure Command Syntax

ecconfigure [<options>]

Agent Configuration Options

Option	Description
--agentAcceptQueueSize=max	The maximum number of pending connections the agent will queue up.
--agentArtifactCache=path	The directory containing cached artifactVersions.
--agentCaFile=path	A single file containing multiple CA certificates.
--agentCaPath=path	A directory containing a file for every CA, where each file’s name is the CA subject name hash value.
--agentCertFile=path	Location of the certificate file used by the agent to support SSL connections from the server.
--agentCrlFile=relativepath	Relative path of the file containing the agent’s certificate revocation list for SSL.
--agentDomainName=domain	The domain name that the agent uses for fully-qualified names.
--agentDuplicateDetectionListSize=size	The size of the list of recently seen requests used in duplicate request detection.
--agentEnableProxySettings=<1\|0>	Enable (1) or disable (0) the proxy server configuration. If enabling for the first time, --agentProxyHost and --agentProxyPort must be specified.
--agentIdleConnectionTimeout=milliseconds	Idle connection timeout, in milliseconds.
--agentIdleOutboundConnectionTimeout=seconds	Idle time after which an outbound connection is closed, in seconds.
--agentIdlePostRunnerTimeout=seconds	Idle time after which a PostRunner thread is terminated, in seconds.
--agentIdleServerRequestWorkerTimeout=seconds	Idle time after which a ServerRequestWorker thread is terminated, in seconds
--agentIdleWorkerTimeout=seconds	Idle time after which a Worker thread is terminated, in seconds.
--agentInitMemory=percent

Option

Description

--agentAcceptQueueSize=max

The maximum number of pending connections the agent will queue up.

--agentArtifactCache=path

The directory containing cached artifactVersions.

--agentCaFile=path

A single file containing multiple CA certificates.

--agentCaPath=path

A directory containing a file for every CA, where each file’s name is the CA subject name hash value.

--agentCertFile=path

Location of the certificate file used by the agent to support SSL connections from the server.

--agentCrlFile=relativepath

Relative path of the file containing the agent’s certificate revocation list for SSL.

--agentDomainName=domain

The domain name that the agent uses for fully-qualified names.

--agentDuplicateDetectionListSize=size

The size of the list of recently seen requests used in duplicate request detection.

--agentEnableProxySettings=<1|0>

Enable (1) or disable (0) the proxy server configuration. If enabling for the first time, --agentProxyHost and --agentProxyPort must be specified.

--agentIdleConnectionTimeout=milliseconds

Idle connection timeout, in milliseconds.

--agentIdleOutboundConnectionTimeout=seconds

Idle time after which an outbound connection is closed, in seconds.

--agentIdlePostRunnerTimeout=seconds

Idle time after which a PostRunner thread is terminated, in seconds.

--agentIdleServerRequestWorkerTimeout=seconds

Idle time after which a ServerRequestWorker thread is terminated, in seconds

--agentIdleWorkerTimeout=seconds

Idle time after which a Worker thread is terminated, in seconds.

--agentInitMemory=percent