Obtaining configuration information from a config.ini file rather than a running ndb_mgmd

Creating the cluster' certificate authority (CA) if it does not yet exist

Creating private keys

Saving keys and certificates as pending rather than active

Signing the key for a single node as specified using command-line options described later in this section

Requesting a CA located on a remote host to sign a local key

--bind-host

Create a certificate bound to a hostname list of node types that should have certificate hostname bindings, from the set (mgmd,db,api).

--bound-hostname

Create a certificate bound to the hostname passed to this option.

--CA-cert

Use the name passed to this option for the CA Certificate file.

--CA-key

Use the name passed to this option for the CA private key file.

--CA-ordinal

Set the ordinal CA name; defaults to First for --create-CA and Second for --rotate-CA. The Common Name in the CA certificate is “MySQL NDB Cluster ordinal Certificate”, where ordinal is the ordinal name passed to this option.

--CA-search-path

Specify a list of directories to search for a CA file. On Unix platforms, the directory names are separated by colons (:); on Windows systems, the semicolon character (;) is used as the separator. A directory reference may be relative or absolute; it may contain one or more environment variables, each denoted by a prefixed dollar sign ($), and expanded prior to use.

Searching begins with the leftmost named directory and proceeds from left to right until a file is found. An empty string denotes an empty search path, which causes all searches to fail. A string consisting of a single dot (.) indicates that the search path is limited to the current working directory.

If no search path is supplied, the compiled-in default value is used. This value depends on the platform used: On Windows, this is $HOMEPATH\ndb-tls; on other platforms (including Linux), it is $HOME/ndb-tls. This default can be overridden by compiling NDB Cluster using -DWITH_NDB_TLS_SEARCH_PATH.

--CA-tool

Designate an executable helper tool, including the path.

--check

Check certificate expiry dates.

--config-file

Supply the path to the cluster configuration file (usually config.ini).

--connect-retries

Set the number of times that ndb_sign_keys attempts to connect to the cluster. If you use -1, the program keeps trying to connect until it succeeds or is forced to stop.

--connect-retry-delay

Set the number of seconds after a failed connection attempt which ndb_sign_keys waits before trying again, up to the number of times determined by --connect-retries.

--create-CA

Create the CA key and certificate.

--CA-days

Set the lifetime of the certificate to this many days. The default is equivalent to 4 years plus 1 day. -1 means the certificate never expires.

This option was added in NDB 8.4.1.

--create-key

Create or replace private keys.

--curve

Use the named curve for encrypting node keys.

--defaults-extra-file

Read this option file after the global files are read.

--defaults-file

Read this option file only.

--defaults-group-suffix

Read not only the usual option groups, but also groups with the usual names and a suffix of string.

--duration

Set the lifetime of certificates or signing requests, in seconds.

--help

Print help text and exit.

--keys-to-dir

Specify output directory for private keys (only); for this purpose, it overrides any value set for --to-dir.

--login-path

Read this path from the login file.

--ndb-connectstring

Set the connection string to use for connecting to ndb_mgmd, using the syntax [nodeid=id;][host=]hostname[:port]. If this option is set, it overrides the value set for NDB_CONNECTSTRING (if any), as well as any value set in a my.cnf. file.

--ndb-mgm-tls

Sets the level of TLS support required for the ndb_mgm client; one of relaxed or strict. relaxed (the default) means that a TLS connection is attempted, but success is not required; strict means that TLS is required to connect.

--ndb-tls-search-path

Specify a list of directories containing TLS keys and certificates.

For syntax, see the description of the --CA-search-path option.

--no-config

Do not obtain the cluster configuration; create a single certificate based on the options supplied (including defaults for those not specified).

--no-defaults

Do not read default options from any option file other than the login file.

--no-login-paths

Do not read login paths from the login path file.

--passphrase

Specify a CA key pass phrase.

--node-id

Create or sign a key for the node having the specified node ID.

--node-type

Create or sign keys for the specified type or types from the set (mgmd,db,api).

--pending

Save keys and certificates as pending, rather than active.

--print-defaults

Print the program argument list, then exit.

--promote

Promote pending files to active, then exit.

--remote-CA-host

Specify the address or hostname of a remote CA host.

--remote-exec-path

Provide the full path to an executable on the remote CA host specified with --remote-CA-host.

--remote-openssl

Use OpenSSL for signing of keys on the remote CA host specified with --remote-CA-host.

--replace-by

Suggest a certificate replacement date for periodic checks, as a number of days after the CA expiration date. Use a negative number to indicate days before expiration.

--rotate-CA

Replace an older CA with a newer one. The new CA can be created using OpenSSL, or you can allow ndb_sign_keys to create the new one, in which case the new CA is created with an intermediate CA certificate, signed by the old CA.

--schedule

Assign a schedule of expiration dates to certificates. The schedule is defined as a comma-delimited list of six integers, in the format shown here:

api_valid,api_extra,dn_valid,dn_extra,mgm_valid,mgm_extra

These values are defined as follows:

In other words, for each node type (API node, data node, management node), certificates are created with a lifetime equal to a whole fixed number of days, plus some random amount of time less than or equal to the number of extra days. The default schedule is shown here:

--schedule=120,10,130,10,150,0

Following the default schedule, client certificates begin expiring on the 120^th day, and expire at random intervals over the next 10 days; data node certificates expire at random times between the 130^th and 140^th days; and management node certificates expire on the 150^th day (with no random interval following).

--sign

Create signed certificates; enabled by default. Use --skip-sign to create certificate signing requests instead.

--skip-sign

Create certificate signing requests instead of signed certificates.

--stdio

Read certificate signing requests from stdin, and write X.509 to stdout.

--to-dir

Specify the output directory for created files. For private key files, this can be overriden using --keys-to-dir.

--usage

Print help text, then exit (alias for --help).

--version

Print version information, then exit.