Type Alias EnvPromotion

type EnvPromotion = {
    lockEnvironment(): Promise<LockResponse>;
    promoteConfiguration(
        config: PromotionRequestConfig,
    ): Promise<PromotionResponse>;
    readLastPromotionReport(): Promise<PromotionReport>;
    readLockStatus(): Promise<LockStatus>;
    readPromotionReport(reportId: string): Promise<PromotionReport>;
    readPromotionReports(): Promise<PromotionReportStub[]>;
    readPromotionStatus(): Promise<PromotionStatus>;
    rollbackPromotion(config: RollbackConfig): Promise<RollbackResponse>;
    runProvisionalPromotionReport(): Promise<PromotionReport>;
    runProvisionalRollbackReport(): Promise<PromotionReport>;
    unlockEnvironment(promotionId: string): Promise<LockResponse>;
}

Index

Methods

lockEnvironment promoteConfiguration readLastPromotionReport readLockStatus readPromotionReport readPromotionReports readPromotionStatus rollbackPromotion runProvisionalPromotionReport runProvisionalRollbackReport unlockEnvironment

Methods

lockEnvironment

lockEnvironment(): Promise<LockResponse>
Lock environment

Returns Promise<LockResponse>
a promise that resolves to a LockResponse object.
- Defined in ops/cloud/EnvPromotionOps.ts:31

promoteConfiguration

promoteConfiguration(config: PromotionRequestConfig): Promise<PromotionResponse>
Promote configuration
Parameters
- config: PromotionRequestConfig
  Promotion request config
Returns Promise<PromotionResponse>
a promise that resolves to a PromotionResponse object.
- Defined in ops/cloud/EnvPromotionOps.ts:48

readLastPromotionReport

readLastPromotionReport(): Promise<PromotionReport>
Read last promotion report

Returns Promise<PromotionReport>
a promise that resolves to a PromotionReport object
- Defined in ops/cloud/EnvPromotionOps.ts:60

readLockStatus

readLockStatus(): Promise<LockStatus>
Read lock status

Returns Promise<LockStatus>
a promise that resolves to a LockStatus object
- Defined in ops/cloud/EnvPromotionOps.ts:42

readPromotionReport

readPromotionReport(reportId: string): Promise<PromotionReport>
Read promotion report
Parameters
- reportId: string
  Promotion id
Returns Promise<PromotionReport>
a promise that resolves to a PromotionReport object
- Defined in ops/cloud/EnvPromotionOps.ts:66

readPromotionReports

readPromotionReports(): Promise<PromotionReportStub[]>
Read a list of promotion reports in date order.

Returns Promise<PromotionReportStub[]>
a promise that resolves to an array of PromotionReportStub objects
- Defined in ops/cloud/EnvPromotionOps.ts:83

readPromotionStatus

readPromotionStatus(): Promise<PromotionStatus>
Read promotion status

Returns Promise<PromotionStatus>
a promise that resolves to a PromotionStatus object
- Defined in ops/cloud/EnvPromotionOps.ts:55

rollbackPromotion

rollbackPromotion(config: RollbackConfig): Promise<RollbackResponse>
Rollback a promotion
Parameters
- config: RollbackConfig
  Rollback config
Returns Promise<RollbackResponse>
a promise that resolves to a RollbackResponse object.
- Defined in ops/cloud/EnvPromotionOps.ts:89

runProvisionalPromotionReport

runProvisionalPromotionReport(): Promise<PromotionReport>
Run a provisional report of changes since the last time the lower environment was promoted to the upper environment. The report generated is for informational purposes only and may not reflect all the changes in a full promotion. A dry-run promotion is always recommended prior to a full promotion between environments.

Returns Promise<PromotionReport>
a promise that resolves to a PromotionReport object
- Defined in ops/cloud/EnvPromotionOps.ts:73

runProvisionalRollbackReport

runProvisionalRollbackReport(): Promise<PromotionReport>
Run a provisional rollback report of changes when we rollback the configuration to the previous promotion.

Returns Promise<PromotionReport>
a promise that resolves to a PromotionReport object
- Defined in ops/cloud/EnvPromotionOps.ts:78

unlockEnvironment

unlockEnvironment(promotionId: string): Promise<LockResponse>
Unlock environment
Parameters
- promotionId: string
  Promotion id.
Returns Promise<LockResponse>
a promise that resolves to a LockResponse object
- Defined in ops/cloud/EnvPromotionOps.ts:37