wx-data engine create

Create a new engine.

Syntax

cpd-cli wx-data engine
create \
--display-name=<engine-display-name> \
--origin=<origin> \
--type=<engine-type> \
[--associated-catalog=<associated-catalog>] \
[--bucket-name=<placeholder-text>] \
[--bucket-type=<placeholder-text>] \
[--description=<description>] \
[--engine-api-key=<engine-api-key>] \
[--engine-connection-string=<engine-connection-string>] \
[--engine-coordinator=<engine-coordinator>] \
[--engine-details=<engine-details>] \
[--engine-managed-by=<engine-managed-by>] \
[--engine-size-config=<engine-size-config>] \
[--engine-worker=<engine-worker>] \
[--instance-id=<instance-id>] \
[--other-engine-type=<other-engine-type>] \
[--region=<region>] \
[--root-path=<root-path>] \
[--spark-home-bucket-name=<spark-home-bucket-name>] \
[--spark-home-volume-id=<spark-home-volume-id>] \
[--spark-home-volume-name=e] \
[--spark-home-volume-storage-class=e] \
[--spark-home-volume-storage-size=e] \
[--spark-scale-config=e] \
[--spark-scale-config=e] \
[--spark-version=e] \
[--tags=<tag1,tag2,...>] \
[--version=<version>]

Options

Table 1: Command options
Option Description
--associated-catalog Bucket catalog object that includes catalog name, catalog tags, and catalog type.
Status
Optional.
Syntax
--associated-catalog=<associated-catalog>
Input
string
Default value
No default.
--bucket-name Bucket name.
Status
Optional.
Syntax
--bucket-name=<placeholder-text>
Input
string
Default value
No default.
--bucket-type Bucket type.
Status
Optional.
Syntax
--bucket-type=<placeholder-text>
Input
string
Default value
No default.
Valid values
amazon_s3, aws_s3, minio, ibm_cos, ibm_ceph, adls_gen1, adls_gen2, google_cs, ibm_storage_scale, ozone
--description Engine description.
Status
Optional.
Syntax
--description=<description>
Input
string
Default value
No default.
--display-name Engine display name.
Status
Optional.
Syntax
--display-name=<engine-display-name>
Input
string
Default value
No default.
Valid values
The maximum length is 10000 characters. The minimum length is 1 character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`.
--engine-api-key API key to work with an IBM Analytics Engine (IAE) instance on SaaS.
Status
Required for IBM Analytics Engine on SaaS.
Syntax
--engine-api-key=<engine-api-key>
Input
string
Default value
No default.
--engine-connection-string External engine connection string.
Status
Optional.
Syntax
--engine-connection-string=<engine-connection-string>
Input
string
Default value
No default.
--engine-coordinator Provide adhoc coordinator details in JSON format.
Status
Optional.
Syntax
--engine-coordinator=<engine-coordinator>
Input
string
Default value
No default.
Valid values
Example:
'{"node_type": "bx2.4x16", "quantity": 1}'
--engine-details Provide adhoc engine details.
Status
Optional.
Syntax
--engine-details=<engine-details>
Input
string
Default value
No default.
Valid values
Example:
{
"api_key":"<api_key>", 
"connection_string":"<connection_string>", 
"coordinator": {"node_type": "<node_type>", "quantity": }, 
"instance_id": "<instance_id>", 
"managed_by": "<managed_by>", 
"size_config": "<size_config>", 
"worker": {"node_type": "<node_type>", "quantity": }
}
--engine-managed-by Engine managed by.
Status
Optional.
Syntax
--engine-managed-by=<engine-managed-by>
Input
string
Default value
No default.
--engine-size-config Size config.
Status
Optional.
Syntax
--engine-size-config=<engine-size-config>
Input
string
Default value
No default.
Valid values
Allowable values include the following examples: starter, small, medium, large, xlarge, xxlarge, and starter, small, medium, large, xlarge, xxlarge, custom.
--engine-worker Provide adhoc worker details in JSON format.
Status
Optional.
Syntax
--engine-worker=<engine-worker>
Input
string
Default value
No default.
Valid values
Example:
'{"node_type": "bx2.4x16", "quantity": 1}'
--instance-id watsonx.data instance ID for IBM Software Hub or CRN for SaaS.
Status
Optional.
Syntax
--instance-id=<instance-id>
Input
string
Default value
No default.
--origin Origin.
Status
Required.
Syntax
--origin=<origin>
Input
string
Default value
No default.
Valid values
Allowable values include native, external, and discover.
--other-engine-type Engine type, when type is other.
Status
Optional.
Syntax
--other-engine-type=<other-engine-type>
Input
string
Default value
No default.
--region Region of the bucket location.
Status
Optional.
Syntax
--region=<region>
Input
string
Default value
No default.
--root-path Root path, applicable for Milvus.
Status
Optional.
Syntax
--root-path=<root-path>
Input
string
Default value
No default.
--spark-home-bucket-name Home bucket name for Spark. Required for SaaS environments.
Status
Optional.
Syntax
--spark-home-bucket-name=<spark-home-bucket-name>
Input
string
Default value
No default.
--spark-home-volume-id Existing home volume ID for Spark. Only for Cloud Pak for Data environments.
Status
Optional.
Syntax
--spark-home-volume-id=<spark-home-volume-id>
Input
string
Default value
No default.
--spark-home-volume-name Name for the new home volume. Only for Cloud Pak for Data environments.
Status
Optional.
Syntax
--spark-home-volume-name=e
Input
string
Default value
No default.
--spark-home-volume-storage-class Storage class of the volume. Only for Cloud Pak for Data environments.
Status
Optional.
Syntax
--spark-home-volume-storage-class=e
Input
string
Default value
No default.
--spark-home-volume-storage-size Storage size of the volume. Only for Cloud Pak for Data environments.
Status
Optional.
Syntax
--spark-home-volume-storage-size=e
Input
string
Default value
No default.
--spark-scale-config Spark engine scale config. Only for SaaS environments.
Status
Optional.
Syntax
--spark-scale-config=e
Input
string
Default value
No default.
Valid values
Example format:
'{"node_type": "<node_type>", "number_of_nodes":<number_of_nodes>}'.
Allowable values for node_type include small , medium, and large. The number_of_nodes must be at least 1.
--spark-version The Spark version for the native engine.
Status
Optional.
Syntax
--spark-version=e
Input
string
Default value
No default.
--tags Specify the data asset tags. Multiple tags can be specified.
Status
Optional.
Syntax
--tags=<tag1,tag2,...>
Input
string
Default value
No default.
--type Engine type.
Status
Required.
Syntax
--type=<engine-type>
Input
string
Default value
No default.
Valid values
Supported types include presto, spark, prestissimo, netezza, db2, milvus, and other.
--version Version like 0.278 for Presto or else.
Status
Optional.
Syntax
--version=<version>
Input
string
Default value
No default.

Examples

Presto or Prestissimo:

cpd-cli wx-data engine
create \
--origin native \
--type presto \
--associated-catalog iceberg-data,hive-data \
--description 'presto engine for running sql queries' \
--display-name sampleEngine \
--region us-south \
--tags tag1,tag2 \
--version v0.286 \
--instance-id 875463829 \
--root-path '{
  "api_key": "<api_key>", 
  "connection_string": "1.2.3.4", 
  "managed_by": "fully/self", 
  "size_config": "starter", 
  "coordinator": {"node_type": "bx2.4x16", "quantity": 1 }, 
  "worker": { "node_type": "bx2.4x16", "quantity": 1 }
	 }'

Spark example 1:

cpd-cli wx-data engine
create \
--type spark  \
--engine-details '{
  "api_key":"<api_key>",
  "connection_string":"https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/2fc8",
  "managed_by":"fully/self"
	 }' \
--display-name sparkEngine \
--origin external \
--instance-id 17378

Spark example 2:

cpd-cli wx-data engine
create \
--type spark  \
--spark-version 3.4  \
--spark-home-volume-name newvolspark2 \
--spark-home-volume-storage-class nfs-client \
--spark-home-volume-storage-size 5Gi \
--display-name sparkNativeEngine \
--origin native \
--instance-id 1737804849506753 \
--spark-home-bucket-name bucketcos \
--spark-scale-config '{"node_type": "small", "number_of_nodes":1}'

Milvus:

cpd-cli wx-data engine
create \
--origin native \
--type milvus \
--display-name sampleEngine \
--bucket-name sampleBucketName \
--instance-id 875463829 \
--root-path /filepath \
--engine-size-config starter

Netezza:

cpd-cli wx-data engine
create \
--origin external \
--description Netezza engine \
--type netezza \
--display-name sampleEngine \
--instance-id 875463829 \
--engine-details '{"connection_string": "connectionStringValue"}'

Db2:

cpd-cli wx-data engine
create \
--origin external \
--description db2 engine \
--type db2 \
--display-name sampleEngine \
--instance-id875463829 \
--engine-details '{"connection_string": "connectionStringValue"}'

Other:

cpd-cli wx-data engine
delete \
--origin external \
--type other \
--display-name sampleOtherEngine \
--instance-id 875463829 \
--other-engine-type 'SampleEngineType' \
--engine-connection-string sampleConnectionString