change-flow-version¶

Description¶

Initiates a deployment change flow version on the control plane, and change the flow version of a running deployment on the workload. This operation is supported for the CLI only.

Synopsis¶

  change-flow-version
--service-crn <value>
--flow-version-crn <value>
--deployment-crn <value>
[--strategy <value>]
[--wait-for-flow-to-stop-in-minutes <value>]
[--parameter-groups <value>]
[--kpis <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--service-crn (string)

CRN for the service.

--flow-version-crn (string)

The intended target flow definition version CRN to change to for the deployment.

--deployment-crn (string)

CRN for the deployment.

--strategy (string)

The strategy to use during change flow version. The default is STOP_AND_PROCESS_DATA.

Possible values:

• STOP_AND_PROCESS_DATA

• STOP_AND_EMPTY_QUEUES

• ONLY_RESTART_AFFECTED_COMPONENTS

--wait-for-flow-to-stop-in-minutes (integer)

The max time in minutes to wait for flow to bleed out. This is only relevant when using the default change flow version strategy (STOP_AND_PROCESS_DATA). The default wait time is 15 minutes.

--parameter-groups (array)

Parameter groups with each requiring a value or assets.

JSON Syntax:

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

--kpis (array)

Key Performance Indicators with associated alerts. If these are specified, the KPIs here will replace all the existing KPIs in the deployment.

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"
        }
      }
    }
  }
  ...
]

--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 deployment where change flow version was performed.

Form Factors¶

public