create-deployment¶

Description¶

Initiate deployment on the control plane, upload referenced when specified, and create the deployment on workload. This operation is supported for the CLI only.’

Synopsis¶

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

Options¶

--service-crn (string)

CRN for the service.

--flow-version-crn (string)

CRN for the flow definition version.

--deployment-name (string)

Unique name for the deployment.

--cluster-size-name (string)

Size for the cluster. The default is EXTRA_SMALL.

Possible values:

• EXTRA_SMALL

• SMALL

• MEDIUM

• LARGE

--static-node-count (integer)

The static number of nodes provisioned. The default is 1.

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

Automatic node scaling. The default is disabled.

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

The minimum number of nodes for automatic scaling.

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

The maximum number of nodes for automatic scaling.

--cfm-nifi-version (string)

The CFM NiFi version. Defaults to the latest version.

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

Automatically start the flow.

--parameter-groups (array)

Parameter groups with each requiring a value or assets.

JSON Syntax:

[
  {
    "name": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "assetReferences": ["string", ...]
      }
      ...
    ]
  }
  ...
]

--kpis (array)

Key Performance Indicators with associated alerts.

JSON Syntax:

[
  {
    "metricId": "string",
    "componentId": "string",
    "alert": {
      "thresholdMoreThan": {
        "unitId": "string",
        "value": double
      },
      "thresholdLessThan": {
        "unitId": "string",
        "value": double
      },
      "frequencyTolerance": {
        "value": double,
        "unit": {
          "id": "SECONDS"|"MINUTES"|"HOURS"|"DAYS"
        }
      }
    }
  }
  ...
]

--custom-nar-configuration (object)

Custom NAR configuration properties

username -> (string)

Username for access to NAR storage location

password -> (string)

Password for access to NAR storage location

storageLocation -> (string)

Storage location containing custom NAR files

configurationVersion -> (integer)

Custom configuration version number

Shorthand Syntax:

username=string,password=string,storageLocation=string,configurationVersion=integer

JSON Syntax:

{
  "username": "string",
  "password": "string",
  "storageLocation": "string",
  "configurationVersion": integer
}

--inbound-hostname (string)

The FQDN of inbound host or just the prefix part of the hostname

--listen-components (array)

Listen components port and protocol data

Shorthand Syntax:

protocol=string,port=string ... (separate items with spaces)

JSON Syntax:

[
  {
    "protocol": "TCP"|"UDP",
    "port": "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¶

crn -> (string)

CRN for the created deployment.

Form Factors¶

public