1. Reference
  2. TimesTen Scaleout Utilities
  3. ttGridAdmin
  4. Grid Operations
  5. Create a Grid (gridCreate)

Create a Grid (gridCreate)

The gridCreate command creates a grid and the initial version of the model. 

ttGridAdmin gridCreate name 
                       -k n
                       -membershipConfig filepath
                       [-membershipUser user]
                       [-address addr]
                       [-internalAddress addr]
                       [-externalAddress addr]
                       [-mgmtPort n]
                       [-host name]
                       [-retainDays numdays]
                       [-retainVersions n]
                       [-warnThresh percent]
                       [-noDataSpaceGroup]
                       [-walletDir path]
                       [-serverEncryption requirement]
                       [-serverCipherSuites suites]

The instance from which the command is run becomes the initial management instance of the new grid. Additional instances (data instances and a second management instance) can then be created and joined to the grid later.

Options

The gridCreate command has the options:

Option Description

name

Specifies the name for the grid in the model.

-k n

Specifies the degree of K-safety that this grid provides. Valid values for n are 1, 2, 3, 4, or 5.

-membershipConfig filepath

Path and name of the membership client configuration file, which contains the host name and port of each membership server.

The contents of this file will be automatically provisioned in every instance in the grid.

Sample contents: 

Servers zk1.example.com!2181,zk2.example.com!2181,
zk3.example.com!2181

Note: Either colons or exclamation marks can be used between host and port. (Always use exclamation marks with IPv6 addresses, which themselves include colons.)

Also see Membership Operations for information about exporting or importing the membership client configuration file and Configure a Grid as a Membership Service Client in Oracle TimesTen In-Memory Database Scaleout User's Guide for additional information.

-membershipUser user

Specifies the user name that instances will use for authenticated access to the membership servers.

If not specified, access to the membership servers requires no authentication.

If specified, the command prompts for a password.

-internalAddress addr

DNS name or IP address of the local system for internal communications, inside the grid. Use this together with -externalAddress.

This option takes one name or address only, and a specified name must resolve to one IP address or to multiple IP addresses on the same network segment.

If host names from /etc/hosts are being used, the /etc/hosts files on all instances in the grid must contain identical entries for all hosts in the grid.

Also see Notes below and Address Formats.

-externalAddress addr

DNS name or IP address of the local system for external communications, outside the grid, for client/server connections. Use this together with -internalAddress.

This option takes one name or address only, but a name may resolve to one or more IP addresses.

If host names from /etc/hosts are being used, the /etc/hosts files on all instances in the grid must contain identical entries for all hosts in the grid.

Also see Notes below and Address Formats.

-address addr

DNS name or IP address of the local system for both external and internal communications, if a single address is used. Setting -address xxx is exactly equivalent to setting -internalAddress xxx and -externalAddress xxx.

This option takes one name or address only, and a specified name must resolve to one IP address or to multiple IP addresses on the same network segment.

If host names from /etc/hosts are being used, the /etc/hosts files on all instances in the grid must contain identical entries for all hosts in the grid.

Note: Using a single address is not recommended for production environments.

Also see Notes below and Address Formats.

-mgmtPort n

Port number used by the initial management instance for replication when management data on the active management instance is replicated. This is required if there will be two management instances. The default is 3754.

-host name

Specifies the name that will be given to the host object in the model for the initial host in the grid. If not specified, the first component of the operating system host name is used (the host name up to but not including the first ".", such as myhost).

-retainDays numdays

Specifies that old versions of the model should be retained for numdays days, then automatically deleted. If numdays is 0, then old versions of the model are not automatically deleted based on their age. The default is 30.

Also see Notes below.

-retainVersions n

Specifies that n old versions of the model should be retained. Anything older than the newest n versions are deleted. If n is 0, then old versions of the model are not automatically deleted based on the number of versions. The default is 10.

Also see Notes below.

-warnThresh percent

Management instances store metadata for the grid and model. If the metadata on the active management instance fills beyond this percentage of capacity, ttGridAdmin commands result in warnings. The default is 90% full.

-noDataSpaceGroup

Specifies that the initial host in the grid is not assigned to a data space group. If this option is not specified, the first host is assigned to data space group 1.

Do not set this option if the first host will contain a data instance as well as the management instance.

-walletDir path

For the first management instance of the grid being created, path to the directory where the Oracle Wallets with cryptographic information will be stored. This cryptographic information includes the cache admin, client/server, and membership service credentials.

The default is timesten_home/info.

Wallets for multiple instances can be stored in the same directory, a directory which can be shared between the instances, such as through NFS.

-serverEncryption requirement

Determines if databases require encryption for client/server connections. Specify one of these settings:

  • accepted: Enable an encrypted session if required or requested by the client; use an unencrypted session otherwise. This is the default.

  • rejected: Demand an unencrypted session. (If the server does not support encryption, TimesTen behaves as if this is the setting on the server.) The connection is rejected if the client requires encryption.

  • requested: Request an encrypted session if the client allows it (if the client has any setting other than rejected); use an unencrypted session otherwise.

  • required: Demand an encrypted session. Reject the connection if the client rejects encryption.

-serverCipherSuites suites

Lists the cipher suite or suites that databases can use for TLS, depending also on the client setting. Specify one or more (separated by a comma and in order of preference) of these suites:

  • SSL_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256

  • SSL_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384

  • SSL_RSA_WITH_AES_128_CBC_SHA256

There is no default setting. For TLS to be used, the server and client settings must include at least one common suite.

Examples

% ttGridAdmin gridCreate grid1 -k 3 -membershipConfig /sw/tten/grid/zkcfg/membership.conf -internalAddress intmysys1.example.com -externalAddress extmysys1.example.com -host mysys1host
Grid grid1 created

Notes

  • You cannot run this command from an instance that is or has ever been part of another grid.

  • You cannot retry gridCreate if it fails. You must remove and recreate the management instance with ttInstanceDestroy and ttInstanceCreate. See Destroying a Grid and Creating the Initial Management Instance in Oracle TimesTen In-Memory Database Scaleout User's GuideOracle TimesTen In-Memory Database Scaleout User's Guide for examples. See ttInstanceDestroy and ttInstanceCreate for reference information.

  • Hosts in the grid may be configured with either one or two network addresses, depending on system topology. If configured with two addresses, one is used for communications with systems inside the grid (internal) and one is used for client/server access to databases inside the grid from systems outside the grid (external). If configured with one address, which is not recommended for production environments, it is used for both internal and external communications. You must either set -address or set -internalAddress and -externalAddress.

  • You can specify both -retainDays and -retainVersions, in which case old versions of the model are automatically deleted if they are older than numdays days old and there are more than n old versions. If one option is specified as zero, then only the other option takes effect. If both are zero, old versions of the model are not automatically deleted.

  • The -membershipUser option overwrites any previously defined user name and password.

  • The password for the -membershipUser option cannot be empty, must have a maximum length of 30 characters, and must consist only of printable characters.

  • Creating a grid creates version 1 of the grid model.