create-database¶
- subtitle
Create opDb
- version
0.9.123
Description¶
Create a operational database in a environment
Synopsis¶
create-database
--environment-name <value>
--database-name <value>
[--auto-scaling-parameters <value>]
[--disable-external-db | --no-disable-external-db]
[--subnet-id <value>]
[--custom-user-tags <value>]
[--disable-multi-az | --no-disable-multi-az]
[--attached-storage-for-workers <value>]
[--disable-kerberos | --no-disable-kerberos]
[--num-edge-nodes <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>]
[--storage-location <value>]
[--root-volume-size <value>]
[--volume-encryptions <value>]
[--gateway-nodes-count <value>]
[--restworker-nodes-count <value>]
[--compute-cluster-crn <value>]
[--custom-instance-types <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.
maxCpuUtilization -> (integer)
This configuration is effective when compute nodes are enabled. The maximum percentage threshold for the CPU utilization of nodes. The CPU utilization is obtained from the Cloudera Manager metric ‘cpu_percent’ across worker and compute nodes. Set 100 or more to disable the CPU metrics.
maxComputeNodesForDatabase -> (integer)
The maximum number of compute nodes, as per these metrics, that can be scaled up to.
minComputeNodesForDatabase -> (integer)
The minimum number of compute nodes, as per these metrics, that can be scaled down to.
Shorthand Syntax:
targetedValueForMetric=integer,maxWorkersForDatabase=integer,maxWorkersPerBatch=integer,minWorkersForDatabase=integer,evaluationPeriod=integer,minimumBlockCacheGb=integer,maxHdfsUsagePercentage=integer,maxRegionsPerRegionServer=integer,maxCpuUtilization=integer,maxComputeNodesForDatabase=integer,minComputeNodesForDatabase=integer
JSON Syntax:
{
"targetedValueForMetric": integer,
"maxWorkersForDatabase": integer,
"maxWorkersPerBatch": integer,
"minWorkersForDatabase": integer,
"evaluationPeriod": integer,
"minimumBlockCacheGb": integer,
"maxHdfsUsagePercentage": integer,
"maxRegionsPerRegionServer": integer,
"maxCpuUtilization": integer,
"maxComputeNodesForDatabase": integer,
"minComputeNodesForDatabase": integer
}
--disable-external-db
| --no-disable-external-db
(boolean)
Skips external database creation to avoid DB creation time.
--subnet-id
(string)
Override subnet where the database will be deployed. Disables Multi-AZ if set [only for AWS].
--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"
}
...
]
--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.
--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 and gateway instance type. HEAVY - Create a multi-node cluster with heavy master and gateway 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. CLOUD_WITH_EPHEMERAL_DATATIERING - Cloud with Ephemeral Storage and Datatiering.
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.
--storage-location
(string)
Provide an optional external storage location for a non-CDP managed bucket as the HBase root.
--root-volume-size
(integer)
Root volume size in GiB.
--volume-encryptions
(array)
Specifies encryption key to encrypt volume for instance group. It is currently supported for AWS cloud provider only.
Shorthand Syntax:
encryptionKey=string,instanceGroup=string ... (separate items with spaces)
JSON Syntax:
[
{
"encryptionKey": "string",
"instanceGroup": "WORKER"|"LEADER"|"MASTER"|"GATEWAY"|"STRONGMETA"|"EDGE"
}
...
]
--gateway-nodes-count
(integer)
Number of gateway nodes to be created for the database. When multiple gateway nodes are present Knox works in HA mode. A positive, non-zero number is required. The default value is 1. Requires the COD_RESTWORKERS entitlement.
--restworker-nodes-count
(integer)
Number of REST Worker nodes to be created for the database. A positive, non-zero number is required. The default value is 0. Requires the COD_RESTWORKERS entitlement.
--compute-cluster-crn
(string)
Utilizes the existing compute cluster with the provided CRN instead of creating a new one.
--custom-instance-types
(object)
Custom VM Instance Types.
masterType -> (string)
Master VM Instance Type.
workerType -> (string)
Worker VM Instance Type.
gatewayType -> (string)
Gateway VM Instance Type.
leaderType -> (string)
Leader VM Instance Type.
edgeType -> (string)
Edge VM Instance Type.
computeType -> (string)
Compute VM Instance Type.
Shorthand Syntax:
masterType=string,workerType=string,gatewayType=string,leaderType=string,edgeType=string,computeType=string
JSON Syntax:
{
"masterType": "string",
"workerType": "string",
"gatewayType": "string",
"leaderType": "string",
"edgeType": "string",
"computeType": "string"
}
--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.
maxHdfsUsagePercentage -> (integer)
The maximum percentage of HDFS utilization for the database before the scaling is triggered.
maxRegionsPerRegionServer -> (integer)
The maximum number of regions per region server.
maxCpuUtilization -> (integer)
The maximum percentage threshold for the CPU utilization of the worker nodes. The CPU utilization is obtained from the Cloudera Manager metric ‘cpu_percent’ across worker nodes. Set 100 or more to disable the CPU metrics.
maxComputeNodesForDatabase -> (integer)
The maximum number of compute nodes, as per these metrics can be scaled up to.
minComputeNodesForDatabase -> (integer)
The minimum number of compute nodes as per these metrics can be scaled down to.
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.
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 and gateway instance type. HEAVY - Create a multi-node cluster with heavy master and gateway instance type.
computeNodesCount -> (integer)
Number of active compute nodes in the database (does not include the stopped nodes).
totalComputeNodesCount -> (integer)
Total number of compute nodes in the database (including stopped nodes).
gatewayNodesCount -> (integer)
Number of gateway nodes for the database.
restworkerNodesCount -> (integer)
Number of REST Worker nodes for the database.
Form Factors¶
public