create-database¶
- subtitle
Create opDb
- version
0.9.98
Description¶
Create a operational database in a environment
Synopsis¶
create-database
--environment-name <value>
--database-name <value>
[--auto-scaling-parameters <value>]
[--subnet-id <value>]
[--custom-user-tags <value>]
[--use-hdfs | --no-use-hdfs]
[--disable-ephemeral-storage | --no-disable-ephemeral-storage]
[--disable-multi-az | --no-disable-multi-az]
[--attached-storage-for-workers <value>]
[--disable-kerberos | --no-disable-kerberos]
[--num-edge-nodes <value>]
[--gateway-node-type <value>]
[--image <value>]
[--disable-jwt-auth | --no-disable-jwt-auth]
[--enable-region-canary | --no-enable-region-canary]
[--scale-type <value>]
[--storage-type <value>]
[--recipes <value>]
[--enable-grafana | --no-enable-grafana]
[--java-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--environment-name
(string)
environment name
--database-name
(string)
database name
--auto-scaling-parameters
(object)
A Parameters to configure AutoScaling
targetedValueForMetric -> (integer)
The target value of the metric a user expect to maintain for the cluster
maxWorkersForDatabase -> (integer)
Maximum number of worker nodes as per this metrics can be scaled up to.
maxWorkersPerBatch -> (integer)
Maximum number of worker nodes as per this metrics can be scaled up to in one batch.
minWorkersForDatabase -> (integer)
Minimum number of worker nodes as per this metrics can be scaled down to.
evaluationPeriod -> (integer)
Period of metrics(in seconds) needs to be considered.
minimumBlockCacheGb -> (integer)
The amount of block cache, in Gigabytes, which the database should have.
maxHdfsUsagePercentage -> (integer)
The maximum percentage of HDFS utilization for the database before we trigger the scaling.
maxRegionsPerRegionServer -> (integer)
The maximum number of regions per region server.
Shorthand Syntax:
targetedValueForMetric=integer,maxWorkersForDatabase=integer,maxWorkersPerBatch=integer,minWorkersForDatabase=integer,evaluationPeriod=integer,minimumBlockCacheGb=integer,maxHdfsUsagePercentage=integer,maxRegionsPerRegionServer=integer
JSON Syntax:
{
"targetedValueForMetric": integer,
"maxWorkersForDatabase": integer,
"maxWorkersPerBatch": integer,
"minWorkersForDatabase": integer,
"evaluationPeriod": integer,
"minimumBlockCacheGb": integer,
"maxHdfsUsagePercentage": integer,
"maxRegionsPerRegionServer": integer
}
--subnet-id
(string)
Override subnet where the database will be deployed. Disables Multi-AZ if set.
--custom-user-tags
(array)
Optional tags to apply to launched infrastructure resources
Shorthand Syntax:
key=string,value=string ... (separate items with spaces)
JSON Syntax:
[
{
"key": "string",
"value": "string"
}
...
]
--use-hdfs
| --no-use-hdfs
(boolean)
Controls whether hbase root be deployed on hdfs
--disable-ephemeral-storage
| --no-disable-ephemeral-storage
(boolean)
Disable large block cache on ephemeral storage.
--disable-multi-az
| --no-disable-multi-az
(boolean)
Disable deployment into multiple availability-zones (the database will be deployed into one subnet).
--attached-storage-for-workers
(object)
Attached storage for the worker nodes for AWS, Azure, and GCP cloud providers.
volumeCount -> (integer)
The number of Volumes. Default is 4. Valid Range: Minimum value of 1, maximum value 8.
volumeSize -> (integer)
The target size of the volume, in GiB. Default is 2048.
volumeType -> (string)
Volume Type. HDD - Hard disk drives (HDD) volume type. Default is HDD. SSD - Solid disk drives (SSD) volume type. LOCAL_SSD - Local SSD volume type.
Shorthand Syntax:
volumeCount=integer,volumeSize=integer,volumeType=string
JSON Syntax:
{
"volumeCount": integer,
"volumeSize": integer,
"volumeType": "HDD"|"SSD"|"LOCAL_SSD"
}
--disable-kerberos
| --no-disable-kerberos
(boolean)
Disable Kerberos authentication.
--num-edge-nodes
(integer)
Number of edge nodes to be created for the database. A positive, non-zero number is required. The default value is 0. Requires the COD_EDGE_NODE entitlement.
--gateway-node-type
(string)
Gateway node type. LITE - Use a small gateway instance type to handle less load for gateway services. HEAVY - Use a large gateway instance type to handle more load for gateway services.
Possible values:
LITE
HEAVY
--image
(object)
Details of an Image.
id -> (string)
Image ID for the database.
catalog -> (string)
Catalog name for the image.
Shorthand Syntax:
id=string,catalog=string
JSON Syntax:
{
"id": "string",
"catalog": "string"
}
--disable-jwt-auth
| --no-disable-jwt-auth
(boolean)
Disable OAuth Bearer (JWT) authentication scheme.
--enable-region-canary
| --no-enable-region-canary
(boolean)
To enable the region canary for the database.
--scale-type
(string)
Scale type. MICRO - Create a 2-node cluster (1 gateway and 1 worker) with high availability disabled. LIGHT - Create a multi-node cluster with a light master instance type. HEAVY - Create a multi-node cluster with heavy master instance type.
Possible values:
MICRO
LIGHT
HEAVY
--storage-type
(string)
Storage type for clusters. CLOUD_WITH_EPHEMERAL - Cloud with ephemeral storage. CLOUD - Cloud storage without ephemeral storage. HDFS - HDFS storage.
Possible values:
CLOUD_WITH_EPHEMERAL
CLOUD
HDFS
--recipes
(array)
Custom recipes for the database.
Shorthand Syntax:
names=string,string,instanceGroup=string ... (separate items with spaces)
JSON Syntax:
[
{
"names": ["string", ...],
"instanceGroup": "WORKER"|"LEADER"|"MASTER"|"GATEWAY"|"STRONGMETA"|"EDGE"
}
...
]
--enable-grafana
| --no-enable-grafana
(boolean)
To enable grafana server for the database.
--java-version
(integer)
Optional tag to configure the major version of Java on the cluster.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.
--generate-cli-skeleton
(boolean)
Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for
--cli-input-json
.
Output¶
databaseDetails -> (object)
Details of the databases.
databaseName -> (string)
The name of the database.
environmentCrn -> (string)
environment crn
crn -> (string)
database crn
creationDate -> (datetime)
The creation time of the database
status -> (string)
status of the database
creatorCrn -> (string)
Crn of the creator
dbVersion -> (string)
Database version
hueEndpoint -> (string)
Hue endpoint
environmentName -> (string)
Environment name
storageLocation -> (string)
HBase cloud storage location
internalName -> (string)
Internal cluster name for this database
autoScalingConfig -> (object)
A config for Autoscaling
targetedValueForMetric -> (integer)
The target value of the metric a user expect to maintain for the cluster
maxWorkersForDatabase -> (integer)
Maximum number of worker nodes as per this metrics can be scaled up to.
maxWorkersPerBatch -> (integer)
Maximum number of worker nodes as per this metrics can be scaled up to in one batch.
minWorkersForDatabase -> (integer)
Minimum number of worker nodes as per this metrics can be scaled down to.
evaluationPeriod -> (integer)
Period of metrics(in seconds) needs to be considered.
minimumBlockCacheGb -> (integer)
The amount of block cache, in Gigabytes, which the database should have.
numStrongMetaServers -> (integer)
The number of strong meta servers for this database. Requires the COD_STRONG_META_SERVERS entitlement.
storageDetailsForWorkers -> (array)
The list of storage details for the worker nodes for AWS, Azure, and GCP cloud providers.
item -> (object)
Storage details for the worker node for AWS, Azure, and GCP cloud providers.
volumeCount -> (integer)
The number of volumes.
volumeSize -> (integer)
The target size of the volume, in GiB.
volumeType -> (string)
Volume Type. HDD - Hard disk drives (HDD) volume type. Default is HDD. SSD - Solid disk drives (SSD) volume type. LOCAL_SSD - Local SSD volume type.
dbEdgeNodeCount -> (integer)
The number of edge nodes for this database. Requires the COD_EDGE_NODES entitlement.
scaleType -> (string)
Scale type. MICRO - Create a 2-node cluster (1 gateway and 1 worker) with high availability disabled. LIGHT - Create a multi-node cluster with a light master instance type. HEAVY - Create a multi-node cluster with heavy master instance type.
Form Factors¶
public