seedEnvironmentInventory

Back to index

Summary

Seeds the environment with a new inventory to mimic an actual application or release-scoped deployment.

projectName

Stringrequired

The name for the project that must be unique among all projects.

environmentName

Stringrequired

The name of the environment.

applicationName

Stringrequired

Applications that owns the inventory item.

applicationProcessName

Stringrequired

Application process used to deploy to the environment.

status

Stringrequired

Inventory deployment status.

Possible values: "success", "warning", "error", "skipped", "notRun"

applicationTierName

Stringoptional

The name of the application tier.

applicationVersion

Stringoptional

Application version for the application that was deployed.

artifactName

Stringoptional

Artifact name for the inventory item.

artifactProviderSource

Stringoptional

Source of the provider that indirectly owns this artifact.

artifactSource

Stringoptional

Source of the artifact.

artifactUrl

Stringoptional

Url of the artifact. Enclose the IPV6 address in square brackets. Example: [<IPv6-ADDRESS>].

artifactVersion

Stringoptional

Artifact version for the inventory item.

clusterName

Stringoptional

Cluster where the item is installed.

clusterNamespace

Stringoptional

Cluster namespace where the item is installed.

componentName

Stringoptional

Component that owns the inventory item.

deploymentDetails

Stringoptional

Additional information about the deployment in JSON format.

deploymentStrategy

Stringoptional

Deployment strategy used for the deployment of the microservice artifact being added to the environment inventory. (Used exclusively in the context of an advanced deployment strategy for a microservice application).

Possible values: "canary", "bluegreen"

deploymentStrategyInProgress

Booleanoptional

Whether deployment strategy is in progress. (Used exclusively in the context of an advanced deployment strategy for a microservice application).

deploymentStrategyLabel

Stringoptional

Label used by microservice plugins EC-Helm and EC-Kubectl to identify deployments depending on the deployment strategy in progress. For example, canary and stable will be used with canary strategy-based deployments while preview and active will be used with bluegreen strategy-based deployments. (Used exclusively in the context of an advanced deployment strategy for a microservice application).

environmentProjectName

Stringoptional

Name for the project to which the environment or environment template belongs to.

jobId

UUIDoptional

The ID of the job.

microserviceDeploymentData

Stringoptional

The deployment details related to a microservice deployment.

microserviceDeploymentSummary

Stringoptional

The summary of microservice deployment.

microserviceName

Stringoptional

Microservice that owns the inventory item.

releaseName

Stringoptional

Name of the release.

releaseProjectName

Stringoptional

Name of the release project.

resourceNames

Collectionoptional

An array of resource names

seeded

Booleanoptional

Seeded status.

snapshotName

Stringoptional

Name of a snapshot.

stageName

Stringoptional

Name of the stage.

Usage

Perl

$cmdr->seedEnvironmentInventory(
  "test-projectName", # projectName
  "test-environmentName", # environmentName
  "test-applicationName", # applicationName
  "test-applicationProcessName", # applicationProcessName
  "test-status" # status
  # optionals
);▼

ectool

ectool seedEnvironmentInventory \
  "test-projectName" `# projectName` \
  "test-environmentName" `# environmentName` \
  "test-applicationName" `# applicationName` \
  "test-applicationProcessName" `# applicationProcessName` \
  "test-status" `# status` \
  # optionals▼

Examples

Perl

$cmdr->seedEnvironmentInventory("Default", "PROD", "Deploy", "Clean up DB", "success", {artifactVersion => "3.0"});▼

ectool

ectool seedEnvironmentInventory "Default" "PROD" "Deploy" "Clean up DB" "success" --artifactVersion "3.0"▼