create-deployment

subtitle

Creates a deployment.

version

0.9.61 (BETA)

Description

Creates a deployment.

Synopsis

  create-deployment
--environment-crn <value>
--configuration-version <value>
--name <value>
--cluster-size-name <value>
--deployment-request-crn <value>
[--parameter-groups <value>]
[--auto-scaling-enabled | --no-auto-scaling-enabled]
[--auto-scale-min-nodes <value>]
[--auto-scale-max-nodes <value>]
[--static-node-count <value>]
[--kpis <value>]
[--cfm-nifi-version <value>]
[--auto-start-flow | --no-auto-start-flow]
[--custom-nar-configuration-crn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--environment-crn (string)

The CRN of an environment to execute the command.

--configuration-version (integer)

The version of this configuration

--name (string)

The name of the deployment

--cluster-size-name (string)

The size of the cluster to deploy

Possible values:

  • EXTRA_SMALL

  • SMALL

  • MEDIUM

  • LARGE

--deployment-request-crn (string)

The CRN of the deployment request.

--parameter-groups (array)

The list of flow parameter groups

JSON Syntax:

[
  {
    "name": "string",
    "parameters": [
      {
        "name": "string",
        "description": "string",
        "value": "string",
        "sensitive": true|false,
        "type": "TEXT"|"FILE"|"FILES",
        "assetReferences": [
          { ... recursive ... }
          ...
        ]
      }
      ...
    ]
  }
  ...
]

--auto-scaling-enabled | --no-auto-scaling-enabled (boolean)

Specifies that auto-scaling should be enabled.

--auto-scale-min-nodes (integer)

The minimum number of nodes that the cluster should allocate. May only be specified when auto-scaling-enabled is true.

--auto-scale-max-nodes (integer)

The maximum number of nodes that the cluster should scale to. May only be specified when auto-scaling-enabled is true.

--static-node-count (integer)

The static number of nodes that the cluster should allocate. May only be specified when auto-scaling-enabled is false.

--kpis (array)

The list of configured KPIs

JSON Syntax:

[
  {
    "metricId": "string",
    "id": "string",
    "metricComponentType": "SYSTEM"|"NIFI_FLOW"|"NIFI_PROCESSOR"|"NIFI_PROCESS_GROUP"|"NIFI_CONNECTION",
    "alert": {
      "thresholdMoreThan": {
        "unitId": "string",
        "value": double
      },
      "thresholdLessThan": {
        "unitId": "string",
        "value": double
      },
      "frequencyTolerance": {
        "unit": {
          "id": "SECONDS"|"MINUTES"|"HOURS"|"DAYS",
          "label": "string",
          "abbreviation": "string"
        },
        "value": double
      }
    },
    "componentId": "string"
  }
  ...
]

--cfm-nifi-version (string)

The CFM NiFi version associated with the deployment

--auto-start-flow | --no-auto-start-flow (boolean)

Indicates whether or not the flow should be started during deployment creation

--custom-nar-configuration-crn (string)

The CRN of the custom NAR configuration.

--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

deployment -> (object)

Provides details about a deployment.

name -> (string)

The name of the deployment

status -> (object)

The state and state message associated with a deployment

detailedState -> (string)

The detailed state that the deployment is currently in

state -> (string)

The state that the deployment is currently in

message -> (string)

Detail message relating to the current status of the deployment

service -> (object)

The meta information about a DataFlow service.

crn -> (string)

The CRN of the DataFlow service

name -> (string)

The name of the DataFlow service

cloudPlatform -> (string)

The cloudPlatform flag of the DataFlow service

region -> (object)

A cloud region

name -> (string)

Name of the cloud region

displayName -> (string)

Display-friendly name of the cloud region

environmentCrn -> (string)

Crn of associated CDP environment

crn -> (string)

The CRN of the deployment

activeWarningAlertCount -> (integer)

Current count of active alerts classified as a warning

activeErrorAlertCount -> (integer)

Current count of active alerts classified as an error

created -> (integer)

Timestamp of the creation of the deployment

updated -> (integer)

Timestamp of the last time the deployment was modified

validActions -> (array)

Valid actions that can be applied to the deployment in its current state

item -> (string)

nifiUrl -> (string)

The url to open the deployed flow in NiFi

clusterSize -> (string)

The initial size of the deployment

coresPerNode -> (integer)

The number of cores per node for the deployment

heapSize -> (double)

The heap size for the deployment

autoscalingEnabled -> (boolean)

Whether or not autoscaling is enabled for this deployment

autoscaleMinNodes -> (integer)

The minimum number of nodes that the deployment will allocate; can only be used when autoscalingEnabled is true

autoscaleMaxNodes -> (integer)

The maximum number of nodes that the deployment can scale up to; can only be used when autoscalingEnabled is true

staticNodeCount -> (integer)

The static number of nodes of the deployment; can only be used when autoscalingEnabled is false

flowName -> (string)

The name of the flow

flowVersion -> (integer)

The version of the flow

flowVersionCrn -> (string)

The deployment’s current flow version CRN

flowCrn -> (string)

The deployment’s current flow CRN

artifactTypeName -> (string)

The type of artifact of the flow

currentNodeCount -> (integer)

The current node count

deployedByUsername -> (string)

The username of the person who deployed the flow

deployedByName -> (string)

The name of the person who deployed the flow

dfxLocalUrl -> (string)

Base URL to the CDF Local instance running this deployment

configurationVersion -> (integer)

The current version of the deployment’s configuration

lastUpdatedByUsername -> (string)

The username of the last person to update the deployment

cfmNifiVersion -> (string)

The CFM NiFi version associated with the deployment

memoryLimit -> (double)

The memory limit of the deployment

Form Factors

public