Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.DevOps.getDeployStage
Explore with Pulumi AI
This data source provides details about a specific Deploy Stage resource in Oracle Cloud Infrastructure Devops service.
Retrieves a deployment stage by identifier.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDeployStage = oci.DevOps.getDeployStage({
    deployStageId: testDeployStageOciDevopsDeployStage.id,
});
import pulumi
import pulumi_oci as oci
test_deploy_stage = oci.DevOps.get_deploy_stage(deploy_stage_id=test_deploy_stage_oci_devops_deploy_stage["id"])
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/devops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := devops.GetDeployStage(ctx, &devops.GetDeployStageArgs{
			DeployStageId: testDeployStageOciDevopsDeployStage.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testDeployStage = Oci.DevOps.GetDeployStage.Invoke(new()
    {
        DeployStageId = testDeployStageOciDevopsDeployStage.Id,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DevOps.DevOpsFunctions;
import com.pulumi.oci.DevOps.inputs.GetDeployStageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var testDeployStage = DevOpsFunctions.getDeployStage(GetDeployStageArgs.builder()
            .deployStageId(testDeployStageOciDevopsDeployStage.id())
            .build());
    }
}
variables:
  testDeployStage:
    fn::invoke:
      function: oci:DevOps:getDeployStage
      arguments:
        deployStageId: ${testDeployStageOciDevopsDeployStage.id}
Using getDeployStage
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDeployStage(args: GetDeployStageArgs, opts?: InvokeOptions): Promise<GetDeployStageResult>
function getDeployStageOutput(args: GetDeployStageOutputArgs, opts?: InvokeOptions): Output<GetDeployStageResult>def get_deploy_stage(deploy_stage_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetDeployStageResult
def get_deploy_stage_output(deploy_stage_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetDeployStageResult]func LookupDeployStage(ctx *Context, args *LookupDeployStageArgs, opts ...InvokeOption) (*LookupDeployStageResult, error)
func LookupDeployStageOutput(ctx *Context, args *LookupDeployStageOutputArgs, opts ...InvokeOption) LookupDeployStageResultOutput> Note: This function is named LookupDeployStage in the Go SDK.
public static class GetDeployStage 
{
    public static Task<GetDeployStageResult> InvokeAsync(GetDeployStageArgs args, InvokeOptions? opts = null)
    public static Output<GetDeployStageResult> Invoke(GetDeployStageInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDeployStageResult> getDeployStage(GetDeployStageArgs args, InvokeOptions options)
public static Output<GetDeployStageResult> getDeployStage(GetDeployStageArgs args, InvokeOptions options)
fn::invoke:
  function: oci:DevOps/getDeployStage:getDeployStage
  arguments:
    # arguments dictionaryThe following arguments are supported:
- DeployStage stringId 
- Unique stage identifier.
- DeployStage stringId 
- Unique stage identifier.
- deployStage StringId 
- Unique stage identifier.
- deployStage stringId 
- Unique stage identifier.
- deploy_stage_ strid 
- Unique stage identifier.
- deployStage StringId 
- Unique stage identifier.
getDeployStage Result
The following output properties are available:
- ApprovalPolicies List<GetDeploy Stage Approval Policy> 
- Specifies the approval policy.
- AreHooks boolEnabled 
- Disable pre/post upgrade hooks. Set to false by default.
- BlueBackend List<GetIps Deploy Stage Blue Backend Ip> 
- Collection of backend environment IP addresses.
- BlueGreen List<GetStrategies Deploy Stage Blue Green Strategy> 
- Specifies the required blue green release strategy for OKE deployment.
- CanaryStrategies List<GetDeploy Stage Canary Strategy> 
- Specifies the required canary release strategy for OKE deployment.
- CommandSpec stringDeploy Artifact Id 
- The OCID of the artifact that contains the command specification.
- CompartmentId string
- The OCID of the compartment where the ContainerInstance will be created.
- ComputeInstance stringGroup Blue Green Deployment Deploy Stage Id 
- The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- ComputeInstance stringGroup Canary Deploy Stage Id 
- The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.
- ComputeInstance stringGroup Canary Traffic Shift Deploy Stage Id 
- A compute instance group canary traffic shift stage OCID for load balancer.
- ComputeInstance stringGroup Deploy Environment Id 
- A compute instance group environment OCID for rolling deployment.
- Config Dictionary<string, string>
- User provided key and value pair configuration, which is assigned through constants or parameter.
- ContainerConfigs List<GetDeploy Stage Container Config> 
- Specifies the container configuration.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
- DeployArtifact stringId 
- Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.
- DeployArtifact List<string>Ids 
- The list of file artifact OCIDs to deploy.
- DeployEnvironment stringId A 
- First compute instance group environment OCID for deployment.
- DeployEnvironment stringId B 
- Second compute instance group environment OCID for deployment.
- DeployPipeline stringId 
- The OCID of a pipeline.
- DeployStage stringId 
- DeployStage List<GetPredecessor Collections Deploy Stage Deploy Stage Predecessor Collection> 
- Collection containing the predecessors of a stage.
- DeployStage stringType 
- Deployment stage type.
- DeploymentSpec stringDeploy Artifact Id 
- The OCID of the artifact that contains the deployment specification.
- Description string
- Optional description about the deployment stage.
- DisplayName string
- Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- DockerImage stringDeploy Artifact Id 
- A Docker image artifact OCID.
- FailurePolicies List<GetDeploy Stage Failure Policy> 
- Specifies a failure policy for a compute instance group rolling deployment stage.
- Dictionary<string, string>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
- FunctionDeploy stringEnvironment Id 
- Function environment OCID.
- FunctionTimeout intIn Seconds 
- Timeout for execution of the Function. Value in seconds.
- GreenBackend List<GetIps Deploy Stage Green Backend Ip> 
- Collection of backend environment IP addresses.
- HelmChart stringDeploy Artifact Id 
- Helm chart artifact OCID.
- HelmCommand List<string>Artifact Ids 
- List of Helm command artifact OCIDs.
- Id string
- Unique identifier that is immutable on creation.
- IsAsync bool
- A boolean flag specifies whether this stage executes asynchronously.
- IsDebug boolEnabled 
- Enables helm --debug option to stream output to tf stdout. Set to false by default.
- IsForce boolEnabled 
- Force resource update through delete; or if required, recreate. Set to false by default.
- IsUninstall boolOn Stage Delete 
- Uninstall the Helm chart release on deleting the stage.
- IsValidation boolEnabled 
- A boolean flag specifies whether the invoked function must be validated.
- KubernetesManifest List<string>Deploy Artifact Ids 
- List of Kubernetes manifest artifact OCIDs.
- LifecycleDetails string
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- LoadBalancer List<GetConfigs Deploy Stage Load Balancer Config> 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- MaxHistory int
- Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- MaxMemory stringIn Mbs 
- Maximum usable memory for the Function (in MB).
- Namespace string
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- OkeBlue stringGreen Deploy Stage Id 
- The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- OkeCanary stringDeploy Stage Id 
- The OCID of an upstream OKE canary deployment stage in this pipeline.
- OkeCanary stringTraffic Shift Deploy Stage Id 
- The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- OkeCluster stringDeploy Environment Id 
- Kubernetes cluster environment OCID for deployment.
- ProductionLoad List<GetBalancer Configs Deploy Stage Production Load Balancer Config> 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- ProjectId string
- The OCID of a project.
- Purpose string
- The purpose of running this Helm stage
- ReleaseName string
- Release name of the Helm chart.
- RollbackPolicies List<GetDeploy Stage Rollback Policy> 
- Specifies the rollback policy. This is initiated on the failure of certain stage types.
- RolloutPolicies List<GetDeploy Stage Rollout Policy> 
- Description of rollout policy for load balancer traffic shift stage.
- SetStrings List<GetDeploy Stage Set String> 
- Specifies the name and value pairs to set helm values.
- SetValues List<GetDeploy Stage Set Value> 
- Specifies the name and value pairs to set helm values.
- ShouldCleanup boolOn Fail 
- Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- ShouldNot boolWait 
- Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.
- ShouldReset boolValues 
- During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- ShouldReuse boolValues 
- During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- ShouldSkip boolCrds 
- If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
- ShouldSkip boolRender Subchart Notes 
- If set, renders subchart notes along with the parent. Set to false by default.
- State string
- The current state of the deployment stage.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
- TestLoad List<GetBalancer Configs Deploy Stage Test Load Balancer Config> 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- TimeCreated string
- Time the deployment stage was created. Format defined by RFC3339.
- TimeUpdated string
- Time the deployment stage was updated. Format defined by RFC3339.
- TimeoutIn intSeconds 
- Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
- TrafficShift stringTarget 
- Specifies the target or destination backend set.
- ValuesArtifact List<string>Ids 
- List of values.yaml file artifact OCIDs.
- WaitCriterias List<GetDeploy Stage Wait Criteria> 
- Specifies wait criteria for the Wait stage.
- ApprovalPolicies []GetDeploy Stage Approval Policy 
- Specifies the approval policy.
- AreHooks boolEnabled 
- Disable pre/post upgrade hooks. Set to false by default.
- BlueBackend []GetIps Deploy Stage Blue Backend Ip 
- Collection of backend environment IP addresses.
- BlueGreen []GetStrategies Deploy Stage Blue Green Strategy 
- Specifies the required blue green release strategy for OKE deployment.
- CanaryStrategies []GetDeploy Stage Canary Strategy 
- Specifies the required canary release strategy for OKE deployment.
- CommandSpec stringDeploy Artifact Id 
- The OCID of the artifact that contains the command specification.
- CompartmentId string
- The OCID of the compartment where the ContainerInstance will be created.
- ComputeInstance stringGroup Blue Green Deployment Deploy Stage Id 
- The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- ComputeInstance stringGroup Canary Deploy Stage Id 
- The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.
- ComputeInstance stringGroup Canary Traffic Shift Deploy Stage Id 
- A compute instance group canary traffic shift stage OCID for load balancer.
- ComputeInstance stringGroup Deploy Environment Id 
- A compute instance group environment OCID for rolling deployment.
- Config map[string]string
- User provided key and value pair configuration, which is assigned through constants or parameter.
- ContainerConfigs []GetDeploy Stage Container Config 
- Specifies the container configuration.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
- DeployArtifact stringId 
- Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.
- DeployArtifact []stringIds 
- The list of file artifact OCIDs to deploy.
- DeployEnvironment stringId A 
- First compute instance group environment OCID for deployment.
- DeployEnvironment stringId B 
- Second compute instance group environment OCID for deployment.
- DeployPipeline stringId 
- The OCID of a pipeline.
- DeployStage stringId 
- DeployStage []GetPredecessor Collections Deploy Stage Deploy Stage Predecessor Collection 
- Collection containing the predecessors of a stage.
- DeployStage stringType 
- Deployment stage type.
- DeploymentSpec stringDeploy Artifact Id 
- The OCID of the artifact that contains the deployment specification.
- Description string
- Optional description about the deployment stage.
- DisplayName string
- Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- DockerImage stringDeploy Artifact Id 
- A Docker image artifact OCID.
- FailurePolicies []GetDeploy Stage Failure Policy 
- Specifies a failure policy for a compute instance group rolling deployment stage.
- map[string]string
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
- FunctionDeploy stringEnvironment Id 
- Function environment OCID.
- FunctionTimeout intIn Seconds 
- Timeout for execution of the Function. Value in seconds.
- GreenBackend []GetIps Deploy Stage Green Backend Ip 
- Collection of backend environment IP addresses.
- HelmChart stringDeploy Artifact Id 
- Helm chart artifact OCID.
- HelmCommand []stringArtifact Ids 
- List of Helm command artifact OCIDs.
- Id string
- Unique identifier that is immutable on creation.
- IsAsync bool
- A boolean flag specifies whether this stage executes asynchronously.
- IsDebug boolEnabled 
- Enables helm --debug option to stream output to tf stdout. Set to false by default.
- IsForce boolEnabled 
- Force resource update through delete; or if required, recreate. Set to false by default.
- IsUninstall boolOn Stage Delete 
- Uninstall the Helm chart release on deleting the stage.
- IsValidation boolEnabled 
- A boolean flag specifies whether the invoked function must be validated.
- KubernetesManifest []stringDeploy Artifact Ids 
- List of Kubernetes manifest artifact OCIDs.
- LifecycleDetails string
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- LoadBalancer []GetConfigs Deploy Stage Load Balancer Config 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- MaxHistory int
- Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- MaxMemory stringIn Mbs 
- Maximum usable memory for the Function (in MB).
- Namespace string
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- OkeBlue stringGreen Deploy Stage Id 
- The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- OkeCanary stringDeploy Stage Id 
- The OCID of an upstream OKE canary deployment stage in this pipeline.
- OkeCanary stringTraffic Shift Deploy Stage Id 
- The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- OkeCluster stringDeploy Environment Id 
- Kubernetes cluster environment OCID for deployment.
- ProductionLoad []GetBalancer Configs Deploy Stage Production Load Balancer Config 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- ProjectId string
- The OCID of a project.
- Purpose string
- The purpose of running this Helm stage
- ReleaseName string
- Release name of the Helm chart.
- RollbackPolicies []GetDeploy Stage Rollback Policy 
- Specifies the rollback policy. This is initiated on the failure of certain stage types.
- RolloutPolicies []GetDeploy Stage Rollout Policy 
- Description of rollout policy for load balancer traffic shift stage.
- SetStrings []GetDeploy Stage Set String 
- Specifies the name and value pairs to set helm values.
- SetValues []GetDeploy Stage Set Value 
- Specifies the name and value pairs to set helm values.
- ShouldCleanup boolOn Fail 
- Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- ShouldNot boolWait 
- Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.
- ShouldReset boolValues 
- During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- ShouldReuse boolValues 
- During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- ShouldSkip boolCrds 
- If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
- ShouldSkip boolRender Subchart Notes 
- If set, renders subchart notes along with the parent. Set to false by default.
- State string
- The current state of the deployment stage.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
- TestLoad []GetBalancer Configs Deploy Stage Test Load Balancer Config 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- TimeCreated string
- Time the deployment stage was created. Format defined by RFC3339.
- TimeUpdated string
- Time the deployment stage was updated. Format defined by RFC3339.
- TimeoutIn intSeconds 
- Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
- TrafficShift stringTarget 
- Specifies the target or destination backend set.
- ValuesArtifact []stringIds 
- List of values.yaml file artifact OCIDs.
- WaitCriterias []GetDeploy Stage Wait Criteria 
- Specifies wait criteria for the Wait stage.
- approvalPolicies List<GetDeploy Stage Approval Policy> 
- Specifies the approval policy.
- areHooks BooleanEnabled 
- Disable pre/post upgrade hooks. Set to false by default.
- blueBackend List<GetIps Deploy Stage Blue Backend Ip> 
- Collection of backend environment IP addresses.
- blueGreen List<GetStrategies Deploy Stage Blue Green Strategy> 
- Specifies the required blue green release strategy for OKE deployment.
- canaryStrategies List<GetDeploy Stage Canary Strategy> 
- Specifies the required canary release strategy for OKE deployment.
- commandSpec StringDeploy Artifact Id 
- The OCID of the artifact that contains the command specification.
- compartmentId String
- The OCID of the compartment where the ContainerInstance will be created.
- computeInstance StringGroup Blue Green Deployment Deploy Stage Id 
- The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- computeInstance StringGroup Canary Deploy Stage Id 
- The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.
- computeInstance StringGroup Canary Traffic Shift Deploy Stage Id 
- A compute instance group canary traffic shift stage OCID for load balancer.
- computeInstance StringGroup Deploy Environment Id 
- A compute instance group environment OCID for rolling deployment.
- config Map<String,String>
- User provided key and value pair configuration, which is assigned through constants or parameter.
- containerConfigs List<GetDeploy Stage Container Config> 
- Specifies the container configuration.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
- deployArtifact StringId 
- Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.
- deployArtifact List<String>Ids 
- The list of file artifact OCIDs to deploy.
- deployEnvironment StringId A 
- First compute instance group environment OCID for deployment.
- deployEnvironment StringId B 
- Second compute instance group environment OCID for deployment.
- deployPipeline StringId 
- The OCID of a pipeline.
- deployStage StringId 
- deployStage List<GetPredecessor Collections Deploy Stage Deploy Stage Predecessor Collection> 
- Collection containing the predecessors of a stage.
- deployStage StringType 
- Deployment stage type.
- deploymentSpec StringDeploy Artifact Id 
- The OCID of the artifact that contains the deployment specification.
- description String
- Optional description about the deployment stage.
- displayName String
- Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- dockerImage StringDeploy Artifact Id 
- A Docker image artifact OCID.
- failurePolicies List<GetDeploy Stage Failure Policy> 
- Specifies a failure policy for a compute instance group rolling deployment stage.
- Map<String,String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
- functionDeploy StringEnvironment Id 
- Function environment OCID.
- functionTimeout IntegerIn Seconds 
- Timeout for execution of the Function. Value in seconds.
- greenBackend List<GetIps Deploy Stage Green Backend Ip> 
- Collection of backend environment IP addresses.
- helmChart StringDeploy Artifact Id 
- Helm chart artifact OCID.
- helmCommand List<String>Artifact Ids 
- List of Helm command artifact OCIDs.
- id String
- Unique identifier that is immutable on creation.
- isAsync Boolean
- A boolean flag specifies whether this stage executes asynchronously.
- isDebug BooleanEnabled 
- Enables helm --debug option to stream output to tf stdout. Set to false by default.
- isForce BooleanEnabled 
- Force resource update through delete; or if required, recreate. Set to false by default.
- isUninstall BooleanOn Stage Delete 
- Uninstall the Helm chart release on deleting the stage.
- isValidation BooleanEnabled 
- A boolean flag specifies whether the invoked function must be validated.
- kubernetesManifest List<String>Deploy Artifact Ids 
- List of Kubernetes manifest artifact OCIDs.
- lifecycleDetails String
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- loadBalancer List<GetConfigs Deploy Stage Load Balancer Config> 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- maxHistory Integer
- Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- maxMemory StringIn Mbs 
- Maximum usable memory for the Function (in MB).
- namespace String
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- okeBlue StringGreen Deploy Stage Id 
- The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- okeCanary StringDeploy Stage Id 
- The OCID of an upstream OKE canary deployment stage in this pipeline.
- okeCanary StringTraffic Shift Deploy Stage Id 
- The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- okeCluster StringDeploy Environment Id 
- Kubernetes cluster environment OCID for deployment.
- productionLoad List<GetBalancer Configs Deploy Stage Production Load Balancer Config> 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- projectId String
- The OCID of a project.
- purpose String
- The purpose of running this Helm stage
- releaseName String
- Release name of the Helm chart.
- rollbackPolicies List<GetDeploy Stage Rollback Policy> 
- Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rolloutPolicies List<GetDeploy Stage Rollout Policy> 
- Description of rollout policy for load balancer traffic shift stage.
- setStrings List<GetDeploy Stage Set String> 
- Specifies the name and value pairs to set helm values.
- setValues List<GetDeploy Stage Set Value> 
- Specifies the name and value pairs to set helm values.
- shouldCleanup BooleanOn Fail 
- Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- shouldNot BooleanWait 
- Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.
- shouldReset BooleanValues 
- During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- shouldReuse BooleanValues 
- During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- shouldSkip BooleanCrds 
- If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
- shouldSkip BooleanRender Subchart Notes 
- If set, renders subchart notes along with the parent. Set to false by default.
- state String
- The current state of the deployment stage.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
- testLoad List<GetBalancer Configs Deploy Stage Test Load Balancer Config> 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- timeCreated String
- Time the deployment stage was created. Format defined by RFC3339.
- timeUpdated String
- Time the deployment stage was updated. Format defined by RFC3339.
- timeoutIn IntegerSeconds 
- Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
- trafficShift StringTarget 
- Specifies the target or destination backend set.
- valuesArtifact List<String>Ids 
- List of values.yaml file artifact OCIDs.
- waitCriterias List<GetDeploy Stage Wait Criteria> 
- Specifies wait criteria for the Wait stage.
- approvalPolicies GetDeploy Stage Approval Policy[] 
- Specifies the approval policy.
- areHooks booleanEnabled 
- Disable pre/post upgrade hooks. Set to false by default.
- blueBackend GetIps Deploy Stage Blue Backend Ip[] 
- Collection of backend environment IP addresses.
- blueGreen GetStrategies Deploy Stage Blue Green Strategy[] 
- Specifies the required blue green release strategy for OKE deployment.
- canaryStrategies GetDeploy Stage Canary Strategy[] 
- Specifies the required canary release strategy for OKE deployment.
- commandSpec stringDeploy Artifact Id 
- The OCID of the artifact that contains the command specification.
- compartmentId string
- The OCID of the compartment where the ContainerInstance will be created.
- computeInstance stringGroup Blue Green Deployment Deploy Stage Id 
- The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- computeInstance stringGroup Canary Deploy Stage Id 
- The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.
- computeInstance stringGroup Canary Traffic Shift Deploy Stage Id 
- A compute instance group canary traffic shift stage OCID for load balancer.
- computeInstance stringGroup Deploy Environment Id 
- A compute instance group environment OCID for rolling deployment.
- config {[key: string]: string}
- User provided key and value pair configuration, which is assigned through constants or parameter.
- containerConfigs GetDeploy Stage Container Config[] 
- Specifies the container configuration.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
- deployArtifact stringId 
- Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.
- deployArtifact string[]Ids 
- The list of file artifact OCIDs to deploy.
- deployEnvironment stringId A 
- First compute instance group environment OCID for deployment.
- deployEnvironment stringId B 
- Second compute instance group environment OCID for deployment.
- deployPipeline stringId 
- The OCID of a pipeline.
- deployStage stringId 
- deployStage GetPredecessor Collections Deploy Stage Deploy Stage Predecessor Collection[] 
- Collection containing the predecessors of a stage.
- deployStage stringType 
- Deployment stage type.
- deploymentSpec stringDeploy Artifact Id 
- The OCID of the artifact that contains the deployment specification.
- description string
- Optional description about the deployment stage.
- displayName string
- Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- dockerImage stringDeploy Artifact Id 
- A Docker image artifact OCID.
- failurePolicies GetDeploy Stage Failure Policy[] 
- Specifies a failure policy for a compute instance group rolling deployment stage.
- {[key: string]: string}
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
- functionDeploy stringEnvironment Id 
- Function environment OCID.
- functionTimeout numberIn Seconds 
- Timeout for execution of the Function. Value in seconds.
- greenBackend GetIps Deploy Stage Green Backend Ip[] 
- Collection of backend environment IP addresses.
- helmChart stringDeploy Artifact Id 
- Helm chart artifact OCID.
- helmCommand string[]Artifact Ids 
- List of Helm command artifact OCIDs.
- id string
- Unique identifier that is immutable on creation.
- isAsync boolean
- A boolean flag specifies whether this stage executes asynchronously.
- isDebug booleanEnabled 
- Enables helm --debug option to stream output to tf stdout. Set to false by default.
- isForce booleanEnabled 
- Force resource update through delete; or if required, recreate. Set to false by default.
- isUninstall booleanOn Stage Delete 
- Uninstall the Helm chart release on deleting the stage.
- isValidation booleanEnabled 
- A boolean flag specifies whether the invoked function must be validated.
- kubernetesManifest string[]Deploy Artifact Ids 
- List of Kubernetes manifest artifact OCIDs.
- lifecycleDetails string
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- loadBalancer GetConfigs Deploy Stage Load Balancer Config[] 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- maxHistory number
- Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- maxMemory stringIn Mbs 
- Maximum usable memory for the Function (in MB).
- namespace string
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- okeBlue stringGreen Deploy Stage Id 
- The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- okeCanary stringDeploy Stage Id 
- The OCID of an upstream OKE canary deployment stage in this pipeline.
- okeCanary stringTraffic Shift Deploy Stage Id 
- The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- okeCluster stringDeploy Environment Id 
- Kubernetes cluster environment OCID for deployment.
- productionLoad GetBalancer Configs Deploy Stage Production Load Balancer Config[] 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- projectId string
- The OCID of a project.
- purpose string
- The purpose of running this Helm stage
- releaseName string
- Release name of the Helm chart.
- rollbackPolicies GetDeploy Stage Rollback Policy[] 
- Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rolloutPolicies GetDeploy Stage Rollout Policy[] 
- Description of rollout policy for load balancer traffic shift stage.
- setStrings GetDeploy Stage Set String[] 
- Specifies the name and value pairs to set helm values.
- setValues GetDeploy Stage Set Value[] 
- Specifies the name and value pairs to set helm values.
- shouldCleanup booleanOn Fail 
- Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- shouldNot booleanWait 
- Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.
- shouldReset booleanValues 
- During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- shouldReuse booleanValues 
- During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- shouldSkip booleanCrds 
- If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
- shouldSkip booleanRender Subchart Notes 
- If set, renders subchart notes along with the parent. Set to false by default.
- state string
- The current state of the deployment stage.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
- testLoad GetBalancer Configs Deploy Stage Test Load Balancer Config[] 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- timeCreated string
- Time the deployment stage was created. Format defined by RFC3339.
- timeUpdated string
- Time the deployment stage was updated. Format defined by RFC3339.
- timeoutIn numberSeconds 
- Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
- trafficShift stringTarget 
- Specifies the target or destination backend set.
- valuesArtifact string[]Ids 
- List of values.yaml file artifact OCIDs.
- waitCriterias GetDeploy Stage Wait Criteria[] 
- Specifies wait criteria for the Wait stage.
- approval_policies Sequence[GetDeploy Stage Approval Policy] 
- Specifies the approval policy.
- are_hooks_ boolenabled 
- Disable pre/post upgrade hooks. Set to false by default.
- blue_backend_ Sequence[Getips Deploy Stage Blue Backend Ip] 
- Collection of backend environment IP addresses.
- blue_green_ Sequence[Getstrategies Deploy Stage Blue Green Strategy] 
- Specifies the required blue green release strategy for OKE deployment.
- canary_strategies Sequence[GetDeploy Stage Canary Strategy] 
- Specifies the required canary release strategy for OKE deployment.
- command_spec_ strdeploy_ artifact_ id 
- The OCID of the artifact that contains the command specification.
- compartment_id str
- The OCID of the compartment where the ContainerInstance will be created.
- compute_instance_ strgroup_ blue_ green_ deployment_ deploy_ stage_ id 
- The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- compute_instance_ strgroup_ canary_ deploy_ stage_ id 
- The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.
- compute_instance_ strgroup_ canary_ traffic_ shift_ deploy_ stage_ id 
- A compute instance group canary traffic shift stage OCID for load balancer.
- compute_instance_ strgroup_ deploy_ environment_ id 
- A compute instance group environment OCID for rolling deployment.
- config Mapping[str, str]
- User provided key and value pair configuration, which is assigned through constants or parameter.
- container_configs Sequence[GetDeploy Stage Container Config] 
- Specifies the container configuration.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
- deploy_artifact_ strid 
- Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.
- deploy_artifact_ Sequence[str]ids 
- The list of file artifact OCIDs to deploy.
- deploy_environment_ strid_ a 
- First compute instance group environment OCID for deployment.
- deploy_environment_ strid_ b 
- Second compute instance group environment OCID for deployment.
- deploy_pipeline_ strid 
- The OCID of a pipeline.
- deploy_stage_ strid 
- deploy_stage_ Sequence[Getpredecessor_ collections Deploy Stage Deploy Stage Predecessor Collection] 
- Collection containing the predecessors of a stage.
- deploy_stage_ strtype 
- Deployment stage type.
- deployment_spec_ strdeploy_ artifact_ id 
- The OCID of the artifact that contains the deployment specification.
- description str
- Optional description about the deployment stage.
- display_name str
- Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- docker_image_ strdeploy_ artifact_ id 
- A Docker image artifact OCID.
- failure_policies Sequence[GetDeploy Stage Failure Policy] 
- Specifies a failure policy for a compute instance group rolling deployment stage.
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
- function_deploy_ strenvironment_ id 
- Function environment OCID.
- function_timeout_ intin_ seconds 
- Timeout for execution of the Function. Value in seconds.
- green_backend_ Sequence[Getips Deploy Stage Green Backend Ip] 
- Collection of backend environment IP addresses.
- helm_chart_ strdeploy_ artifact_ id 
- Helm chart artifact OCID.
- helm_command_ Sequence[str]artifact_ ids 
- List of Helm command artifact OCIDs.
- id str
- Unique identifier that is immutable on creation.
- is_async bool
- A boolean flag specifies whether this stage executes asynchronously.
- is_debug_ boolenabled 
- Enables helm --debug option to stream output to tf stdout. Set to false by default.
- is_force_ boolenabled 
- Force resource update through delete; or if required, recreate. Set to false by default.
- is_uninstall_ boolon_ stage_ delete 
- Uninstall the Helm chart release on deleting the stage.
- is_validation_ boolenabled 
- A boolean flag specifies whether the invoked function must be validated.
- kubernetes_manifest_ Sequence[str]deploy_ artifact_ ids 
- List of Kubernetes manifest artifact OCIDs.
- lifecycle_details str
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- load_balancer_ Sequence[Getconfigs Deploy Stage Load Balancer Config] 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- max_history int
- Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- max_memory_ strin_ mbs 
- Maximum usable memory for the Function (in MB).
- namespace str
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- oke_blue_ strgreen_ deploy_ stage_ id 
- The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- oke_canary_ strdeploy_ stage_ id 
- The OCID of an upstream OKE canary deployment stage in this pipeline.
- oke_canary_ strtraffic_ shift_ deploy_ stage_ id 
- The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- oke_cluster_ strdeploy_ environment_ id 
- Kubernetes cluster environment OCID for deployment.
- production_load_ Sequence[Getbalancer_ configs Deploy Stage Production Load Balancer Config] 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- project_id str
- The OCID of a project.
- purpose str
- The purpose of running this Helm stage
- release_name str
- Release name of the Helm chart.
- rollback_policies Sequence[GetDeploy Stage Rollback Policy] 
- Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rollout_policies Sequence[GetDeploy Stage Rollout Policy] 
- Description of rollout policy for load balancer traffic shift stage.
- set_strings Sequence[GetDeploy Stage Set String] 
- Specifies the name and value pairs to set helm values.
- set_values Sequence[GetDeploy Stage Set Value] 
- Specifies the name and value pairs to set helm values.
- should_cleanup_ boolon_ fail 
- Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- should_not_ boolwait 
- Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.
- should_reset_ boolvalues 
- During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- should_reuse_ boolvalues 
- During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- should_skip_ boolcrds 
- If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
- should_skip_ boolrender_ subchart_ notes 
- If set, renders subchart notes along with the parent. Set to false by default.
- state str
- The current state of the deployment stage.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
- test_load_ Sequence[Getbalancer_ configs Deploy Stage Test Load Balancer Config] 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- time_created str
- Time the deployment stage was created. Format defined by RFC3339.
- time_updated str
- Time the deployment stage was updated. Format defined by RFC3339.
- timeout_in_ intseconds 
- Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
- traffic_shift_ strtarget 
- Specifies the target or destination backend set.
- values_artifact_ Sequence[str]ids 
- List of values.yaml file artifact OCIDs.
- wait_criterias Sequence[GetDeploy Stage Wait Criteria] 
- Specifies wait criteria for the Wait stage.
- approvalPolicies List<Property Map>
- Specifies the approval policy.
- areHooks BooleanEnabled 
- Disable pre/post upgrade hooks. Set to false by default.
- blueBackend List<Property Map>Ips 
- Collection of backend environment IP addresses.
- blueGreen List<Property Map>Strategies 
- Specifies the required blue green release strategy for OKE deployment.
- canaryStrategies List<Property Map>
- Specifies the required canary release strategy for OKE deployment.
- commandSpec StringDeploy Artifact Id 
- The OCID of the artifact that contains the command specification.
- compartmentId String
- The OCID of the compartment where the ContainerInstance will be created.
- computeInstance StringGroup Blue Green Deployment Deploy Stage Id 
- The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- computeInstance StringGroup Canary Deploy Stage Id 
- The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.
- computeInstance StringGroup Canary Traffic Shift Deploy Stage Id 
- A compute instance group canary traffic shift stage OCID for load balancer.
- computeInstance StringGroup Deploy Environment Id 
- A compute instance group environment OCID for rolling deployment.
- config Map<String>
- User provided key and value pair configuration, which is assigned through constants or parameter.
- containerConfigs List<Property Map>
- Specifies the container configuration.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
- deployArtifact StringId 
- Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.
- deployArtifact List<String>Ids 
- The list of file artifact OCIDs to deploy.
- deployEnvironment StringId A 
- First compute instance group environment OCID for deployment.
- deployEnvironment StringId B 
- Second compute instance group environment OCID for deployment.
- deployPipeline StringId 
- The OCID of a pipeline.
- deployStage StringId 
- deployStage List<Property Map>Predecessor Collections 
- Collection containing the predecessors of a stage.
- deployStage StringType 
- Deployment stage type.
- deploymentSpec StringDeploy Artifact Id 
- The OCID of the artifact that contains the deployment specification.
- description String
- Optional description about the deployment stage.
- displayName String
- Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- dockerImage StringDeploy Artifact Id 
- A Docker image artifact OCID.
- failurePolicies List<Property Map>
- Specifies a failure policy for a compute instance group rolling deployment stage.
- Map<String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
- functionDeploy StringEnvironment Id 
- Function environment OCID.
- functionTimeout NumberIn Seconds 
- Timeout for execution of the Function. Value in seconds.
- greenBackend List<Property Map>Ips 
- Collection of backend environment IP addresses.
- helmChart StringDeploy Artifact Id 
- Helm chart artifact OCID.
- helmCommand List<String>Artifact Ids 
- List of Helm command artifact OCIDs.
- id String
- Unique identifier that is immutable on creation.
- isAsync Boolean
- A boolean flag specifies whether this stage executes asynchronously.
- isDebug BooleanEnabled 
- Enables helm --debug option to stream output to tf stdout. Set to false by default.
- isForce BooleanEnabled 
- Force resource update through delete; or if required, recreate. Set to false by default.
- isUninstall BooleanOn Stage Delete 
- Uninstall the Helm chart release on deleting the stage.
- isValidation BooleanEnabled 
- A boolean flag specifies whether the invoked function must be validated.
- kubernetesManifest List<String>Deploy Artifact Ids 
- List of Kubernetes manifest artifact OCIDs.
- lifecycleDetails String
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- loadBalancer List<Property Map>Configs 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- maxHistory Number
- Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- maxMemory StringIn Mbs 
- Maximum usable memory for the Function (in MB).
- namespace String
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- okeBlue StringGreen Deploy Stage Id 
- The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- okeCanary StringDeploy Stage Id 
- The OCID of an upstream OKE canary deployment stage in this pipeline.
- okeCanary StringTraffic Shift Deploy Stage Id 
- The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- okeCluster StringDeploy Environment Id 
- Kubernetes cluster environment OCID for deployment.
- productionLoad List<Property Map>Balancer Configs 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- projectId String
- The OCID of a project.
- purpose String
- The purpose of running this Helm stage
- releaseName String
- Release name of the Helm chart.
- rollbackPolicies List<Property Map>
- Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rolloutPolicies List<Property Map>
- Description of rollout policy for load balancer traffic shift stage.
- setStrings List<Property Map>
- Specifies the name and value pairs to set helm values.
- setValues List<Property Map>
- Specifies the name and value pairs to set helm values.
- shouldCleanup BooleanOn Fail 
- Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- shouldNot BooleanWait 
- Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.
- shouldReset BooleanValues 
- During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- shouldReuse BooleanValues 
- During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- shouldSkip BooleanCrds 
- If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
- shouldSkip BooleanRender Subchart Notes 
- If set, renders subchart notes along with the parent. Set to false by default.
- state String
- The current state of the deployment stage.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
- testLoad List<Property Map>Balancer Configs 
- Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.
- timeCreated String
- Time the deployment stage was created. Format defined by RFC3339.
- timeUpdated String
- Time the deployment stage was updated. Format defined by RFC3339.
- timeoutIn NumberSeconds 
- Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
- trafficShift StringTarget 
- Specifies the target or destination backend set.
- valuesArtifact List<String>Ids 
- List of values.yaml file artifact OCIDs.
- waitCriterias List<Property Map>
- Specifies wait criteria for the Wait stage.
Supporting Types
GetDeployStageApprovalPolicy    
- ApprovalPolicy stringType 
- Approval policy type.
- NumberOf intApprovals Required 
- A minimum number of approvals required for stage to proceed.
- ApprovalPolicy stringType 
- Approval policy type.
- NumberOf intApprovals Required 
- A minimum number of approvals required for stage to proceed.
- approvalPolicy StringType 
- Approval policy type.
- numberOf IntegerApprovals Required 
- A minimum number of approvals required for stage to proceed.
- approvalPolicy stringType 
- Approval policy type.
- numberOf numberApprovals Required 
- A minimum number of approvals required for stage to proceed.
- approval_policy_ strtype 
- Approval policy type.
- number_of_ intapprovals_ required 
- A minimum number of approvals required for stage to proceed.
- approvalPolicy StringType 
- Approval policy type.
- numberOf NumberApprovals Required 
- A minimum number of approvals required for stage to proceed.
GetDeployStageBlueBackendIp     
- Items List<string>
- List of parameters defined to set helm value.
- Items []string
- List of parameters defined to set helm value.
- items List<String>
- List of parameters defined to set helm value.
- items string[]
- List of parameters defined to set helm value.
- items Sequence[str]
- List of parameters defined to set helm value.
- items List<String>
- List of parameters defined to set helm value.
GetDeployStageBlueGreenStrategy     
- IngressName string
- Name of the Ingress resource.
- NamespaceA string
- First Namespace for deployment.
- NamespaceB string
- Second Namespace for deployment.
- StrategyType string
- Canary strategy type.
- IngressName string
- Name of the Ingress resource.
- NamespaceA string
- First Namespace for deployment.
- NamespaceB string
- Second Namespace for deployment.
- StrategyType string
- Canary strategy type.
- ingressName String
- Name of the Ingress resource.
- namespaceA String
- First Namespace for deployment.
- namespaceB String
- Second Namespace for deployment.
- strategyType String
- Canary strategy type.
- ingressName string
- Name of the Ingress resource.
- namespaceA string
- First Namespace for deployment.
- namespaceB string
- Second Namespace for deployment.
- strategyType string
- Canary strategy type.
- ingress_name str
- Name of the Ingress resource.
- namespace_a str
- First Namespace for deployment.
- namespace_b str
- Second Namespace for deployment.
- strategy_type str
- Canary strategy type.
- ingressName String
- Name of the Ingress resource.
- namespaceA String
- First Namespace for deployment.
- namespaceB String
- Second Namespace for deployment.
- strategyType String
- Canary strategy type.
GetDeployStageCanaryStrategy    
- IngressName string
- Name of the Ingress resource.
- Namespace string
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- StrategyType string
- Canary strategy type.
- IngressName string
- Name of the Ingress resource.
- Namespace string
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- StrategyType string
- Canary strategy type.
- ingressName String
- Name of the Ingress resource.
- namespace String
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- strategyType String
- Canary strategy type.
- ingressName string
- Name of the Ingress resource.
- namespace string
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- strategyType string
- Canary strategy type.
- ingress_name str
- Name of the Ingress resource.
- namespace str
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- strategy_type str
- Canary strategy type.
- ingressName String
- Name of the Ingress resource.
- namespace String
- Default Namespace to be used for Kubernetes deployment when not specified in the manifest.
- strategyType String
- Canary strategy type.
GetDeployStageContainerConfig    
- AvailabilityDomain string
- Availability domain where the ContainerInstance will be created.
- CompartmentId string
- The OCID of the compartment where the ContainerInstance will be created.
- ContainerConfig stringType 
- Container configuration type.
- NetworkChannels List<GetDeploy Stage Container Config Network Channel> 
- Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- ShapeConfigs List<GetDeploy Stage Container Config Shape Config> 
- Determines the size and amount of resources available to the instance.
- ShapeName string
- The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- AvailabilityDomain string
- Availability domain where the ContainerInstance will be created.
- CompartmentId string
- The OCID of the compartment where the ContainerInstance will be created.
- ContainerConfig stringType 
- Container configuration type.
- NetworkChannels []GetDeploy Stage Container Config Network Channel 
- Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- ShapeConfigs []GetDeploy Stage Container Config Shape Config 
- Determines the size and amount of resources available to the instance.
- ShapeName string
- The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- availabilityDomain String
- Availability domain where the ContainerInstance will be created.
- compartmentId String
- The OCID of the compartment where the ContainerInstance will be created.
- containerConfig StringType 
- Container configuration type.
- networkChannels List<GetDeploy Stage Container Config Network Channel> 
- Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- shapeConfigs List<GetDeploy Stage Container Config Shape Config> 
- Determines the size and amount of resources available to the instance.
- shapeName String
- The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- availabilityDomain string
- Availability domain where the ContainerInstance will be created.
- compartmentId string
- The OCID of the compartment where the ContainerInstance will be created.
- containerConfig stringType 
- Container configuration type.
- networkChannels GetDeploy Stage Container Config Network Channel[] 
- Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- shapeConfigs GetDeploy Stage Container Config Shape Config[] 
- Determines the size and amount of resources available to the instance.
- shapeName string
- The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- availability_domain str
- Availability domain where the ContainerInstance will be created.
- compartment_id str
- The OCID of the compartment where the ContainerInstance will be created.
- container_config_ strtype 
- Container configuration type.
- network_channels Sequence[GetDeploy Stage Container Config Network Channel] 
- Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- shape_configs Sequence[GetDeploy Stage Container Config Shape Config] 
- Determines the size and amount of resources available to the instance.
- shape_name str
- The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- availabilityDomain String
- Availability domain where the ContainerInstance will be created.
- compartmentId String
- The OCID of the compartment where the ContainerInstance will be created.
- containerConfig StringType 
- Container configuration type.
- networkChannels List<Property Map>
- Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- shapeConfigs List<Property Map>
- Determines the size and amount of resources available to the instance.
- shapeName String
- The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
GetDeployStageContainerConfigNetworkChannel      
- NetworkChannel stringType 
- Network channel type.
- NsgIds List<string>
- An array of network security group OCIDs.
- SubnetId string
- The OCID of the subnet where VNIC resources will be created for private endpoint.
- NetworkChannel stringType 
- Network channel type.
- NsgIds []string
- An array of network security group OCIDs.
- SubnetId string
- The OCID of the subnet where VNIC resources will be created for private endpoint.
- networkChannel StringType 
- Network channel type.
- nsgIds List<String>
- An array of network security group OCIDs.
- subnetId String
- The OCID of the subnet where VNIC resources will be created for private endpoint.
- networkChannel stringType 
- Network channel type.
- nsgIds string[]
- An array of network security group OCIDs.
- subnetId string
- The OCID of the subnet where VNIC resources will be created for private endpoint.
- network_channel_ strtype 
- Network channel type.
- nsg_ids Sequence[str]
- An array of network security group OCIDs.
- subnet_id str
- The OCID of the subnet where VNIC resources will be created for private endpoint.
- networkChannel StringType 
- Network channel type.
- nsgIds List<String>
- An array of network security group OCIDs.
- subnetId String
- The OCID of the subnet where VNIC resources will be created for private endpoint.
GetDeployStageContainerConfigShapeConfig      
- MemoryIn doubleGbs 
- The total amount of memory available to the instance, in gigabytes.
- Ocpus double
- The total number of OCPUs available to the instance.
- MemoryIn float64Gbs 
- The total amount of memory available to the instance, in gigabytes.
- Ocpus float64
- The total number of OCPUs available to the instance.
- memoryIn DoubleGbs 
- The total amount of memory available to the instance, in gigabytes.
- ocpus Double
- The total number of OCPUs available to the instance.
- memoryIn numberGbs 
- The total amount of memory available to the instance, in gigabytes.
- ocpus number
- The total number of OCPUs available to the instance.
- memory_in_ floatgbs 
- The total amount of memory available to the instance, in gigabytes.
- ocpus float
- The total number of OCPUs available to the instance.
- memoryIn NumberGbs 
- The total amount of memory available to the instance, in gigabytes.
- ocpus Number
- The total number of OCPUs available to the instance.
GetDeployStageDeployStagePredecessorCollection      
- Items
List<GetDeploy Stage Deploy Stage Predecessor Collection Item> 
- List of parameters defined to set helm value.
- Items
[]GetDeploy Stage Deploy Stage Predecessor Collection Item 
- List of parameters defined to set helm value.
- items
List<GetDeploy Stage Deploy Stage Predecessor Collection Item> 
- List of parameters defined to set helm value.
- items
GetDeploy Stage Deploy Stage Predecessor Collection Item[] 
- List of parameters defined to set helm value.
- items
Sequence[GetDeploy Stage Deploy Stage Predecessor Collection Item] 
- List of parameters defined to set helm value.
- items List<Property Map>
- List of parameters defined to set helm value.
GetDeployStageDeployStagePredecessorCollectionItem       
- Id string
- Unique identifier that is immutable on creation.
- Id string
- Unique identifier that is immutable on creation.
- id String
- Unique identifier that is immutable on creation.
- id string
- Unique identifier that is immutable on creation.
- id str
- Unique identifier that is immutable on creation.
- id String
- Unique identifier that is immutable on creation.
GetDeployStageFailurePolicy    
- FailureCount int
- The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
- FailurePercentage int
- The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.
- PolicyType string
- The type of policy used for rolling out a deployment stage.
- FailureCount int
- The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
- FailurePercentage int
- The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.
- PolicyType string
- The type of policy used for rolling out a deployment stage.
- failureCount Integer
- The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
- failurePercentage Integer
- The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.
- policyType String
- The type of policy used for rolling out a deployment stage.
- failureCount number
- The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
- failurePercentage number
- The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.
- policyType string
- The type of policy used for rolling out a deployment stage.
- failure_count int
- The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
- failure_percentage int
- The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.
- policy_type str
- The type of policy used for rolling out a deployment stage.
- failureCount Number
- The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
- failurePercentage Number
- The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.
- policyType String
- The type of policy used for rolling out a deployment stage.
GetDeployStageGreenBackendIp     
- Items List<string>
- List of parameters defined to set helm value.
- Items []string
- List of parameters defined to set helm value.
- items List<String>
- List of parameters defined to set helm value.
- items string[]
- List of parameters defined to set helm value.
- items Sequence[str]
- List of parameters defined to set helm value.
- items List<String>
- List of parameters defined to set helm value.
GetDeployStageLoadBalancerConfig     
- BackendPort int
- Listen port for the backend server.
- ListenerName string
- Name of the load balancer listener.
- LoadBalancer stringId 
- The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- BackendPort int
- Listen port for the backend server.
- ListenerName string
- Name of the load balancer listener.
- LoadBalancer stringId 
- The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- backendPort Integer
- Listen port for the backend server.
- listenerName String
- Name of the load balancer listener.
- loadBalancer StringId 
- The OCID of the load balancer.
- state String
- The current state of the deployment stage.
- backendPort number
- Listen port for the backend server.
- listenerName string
- Name of the load balancer listener.
- loadBalancer stringId 
- The OCID of the load balancer.
- state string
- The current state of the deployment stage.
- backend_port int
- Listen port for the backend server.
- listener_name str
- Name of the load balancer listener.
- load_balancer_ strid 
- The OCID of the load balancer.
- state str
- The current state of the deployment stage.
- backendPort Number
- Listen port for the backend server.
- listenerName String
- Name of the load balancer listener.
- loadBalancer StringId 
- The OCID of the load balancer.
- state String
- The current state of the deployment stage.
GetDeployStageProductionLoadBalancerConfig      
- BackendPort int
- Listen port for the backend server.
- ListenerName string
- Name of the load balancer listener.
- LoadBalancer stringId 
- The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- BackendPort int
- Listen port for the backend server.
- ListenerName string
- Name of the load balancer listener.
- LoadBalancer stringId 
- The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- backendPort Integer
- Listen port for the backend server.
- listenerName String
- Name of the load balancer listener.
- loadBalancer StringId 
- The OCID of the load balancer.
- state String
- The current state of the deployment stage.
- backendPort number
- Listen port for the backend server.
- listenerName string
- Name of the load balancer listener.
- loadBalancer stringId 
- The OCID of the load balancer.
- state string
- The current state of the deployment stage.
- backend_port int
- Listen port for the backend server.
- listener_name str
- Name of the load balancer listener.
- load_balancer_ strid 
- The OCID of the load balancer.
- state str
- The current state of the deployment stage.
- backendPort Number
- Listen port for the backend server.
- listenerName String
- Name of the load balancer listener.
- loadBalancer StringId 
- The OCID of the load balancer.
- state String
- The current state of the deployment stage.
GetDeployStageRollbackPolicy    
- PolicyType string
- The type of policy used for rolling out a deployment stage.
- PolicyType string
- The type of policy used for rolling out a deployment stage.
- policyType String
- The type of policy used for rolling out a deployment stage.
- policyType string
- The type of policy used for rolling out a deployment stage.
- policy_type str
- The type of policy used for rolling out a deployment stage.
- policyType String
- The type of policy used for rolling out a deployment stage.
GetDeployStageRolloutPolicy    
- BatchCount int
- The number that will be used to determine how many instances will be deployed concurrently.
- BatchDelay intIn Seconds 
- The duration of delay between batch rollout. The default delay is 1 minute.
- BatchPercentage int
- The percentage that will be used to determine how many instances will be deployed concurrently.
- PolicyType string
- The type of policy used for rolling out a deployment stage.
- RampLimit doublePercent 
- Indicates the criteria to stop.
- BatchCount int
- The number that will be used to determine how many instances will be deployed concurrently.
- BatchDelay intIn Seconds 
- The duration of delay between batch rollout. The default delay is 1 minute.
- BatchPercentage int
- The percentage that will be used to determine how many instances will be deployed concurrently.
- PolicyType string
- The type of policy used for rolling out a deployment stage.
- RampLimit float64Percent 
- Indicates the criteria to stop.
- batchCount Integer
- The number that will be used to determine how many instances will be deployed concurrently.
- batchDelay IntegerIn Seconds 
- The duration of delay between batch rollout. The default delay is 1 minute.
- batchPercentage Integer
- The percentage that will be used to determine how many instances will be deployed concurrently.
- policyType String
- The type of policy used for rolling out a deployment stage.
- rampLimit DoublePercent 
- Indicates the criteria to stop.
- batchCount number
- The number that will be used to determine how many instances will be deployed concurrently.
- batchDelay numberIn Seconds 
- The duration of delay between batch rollout. The default delay is 1 minute.
- batchPercentage number
- The percentage that will be used to determine how many instances will be deployed concurrently.
- policyType string
- The type of policy used for rolling out a deployment stage.
- rampLimit numberPercent 
- Indicates the criteria to stop.
- batch_count int
- The number that will be used to determine how many instances will be deployed concurrently.
- batch_delay_ intin_ seconds 
- The duration of delay between batch rollout. The default delay is 1 minute.
- batch_percentage int
- The percentage that will be used to determine how many instances will be deployed concurrently.
- policy_type str
- The type of policy used for rolling out a deployment stage.
- ramp_limit_ floatpercent 
- Indicates the criteria to stop.
- batchCount Number
- The number that will be used to determine how many instances will be deployed concurrently.
- batchDelay NumberIn Seconds 
- The duration of delay between batch rollout. The default delay is 1 minute.
- batchPercentage Number
- The percentage that will be used to determine how many instances will be deployed concurrently.
- policyType String
- The type of policy used for rolling out a deployment stage.
- rampLimit NumberPercent 
- Indicates the criteria to stop.
GetDeployStageSetString    
- Items
List<GetDeploy Stage Set String Item> 
- List of parameters defined to set helm value.
- Items
[]GetDeploy Stage Set String Item 
- List of parameters defined to set helm value.
- items
List<GetDeploy Stage Set String Item> 
- List of parameters defined to set helm value.
- items
GetDeploy Stage Set String Item[] 
- List of parameters defined to set helm value.
- items
Sequence[GetDeploy Stage Set String Item] 
- List of parameters defined to set helm value.
- items List<Property Map>
- List of parameters defined to set helm value.
GetDeployStageSetStringItem     
GetDeployStageSetValue    
- Items
List<GetDeploy Stage Set Value Item> 
- List of parameters defined to set helm value.
- Items
[]GetDeploy Stage Set Value Item 
- List of parameters defined to set helm value.
- items
List<GetDeploy Stage Set Value Item> 
- List of parameters defined to set helm value.
- items
GetDeploy Stage Set Value Item[] 
- List of parameters defined to set helm value.
- items
Sequence[GetDeploy Stage Set Value Item] 
- List of parameters defined to set helm value.
- items List<Property Map>
- List of parameters defined to set helm value.
GetDeployStageSetValueItem     
GetDeployStageTestLoadBalancerConfig      
- BackendPort int
- Listen port for the backend server.
- ListenerName string
- Name of the load balancer listener.
- LoadBalancer stringId 
- The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- BackendPort int
- Listen port for the backend server.
- ListenerName string
- Name of the load balancer listener.
- LoadBalancer stringId 
- The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- backendPort Integer
- Listen port for the backend server.
- listenerName String
- Name of the load balancer listener.
- loadBalancer StringId 
- The OCID of the load balancer.
- state String
- The current state of the deployment stage.
- backendPort number
- Listen port for the backend server.
- listenerName string
- Name of the load balancer listener.
- loadBalancer stringId 
- The OCID of the load balancer.
- state string
- The current state of the deployment stage.
- backend_port int
- Listen port for the backend server.
- listener_name str
- Name of the load balancer listener.
- load_balancer_ strid 
- The OCID of the load balancer.
- state str
- The current state of the deployment stage.
- backendPort Number
- Listen port for the backend server.
- listenerName String
- Name of the load balancer listener.
- loadBalancer StringId 
- The OCID of the load balancer.
- state String
- The current state of the deployment stage.
GetDeployStageWaitCriteria    
- WaitDuration string
- The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.
- WaitType string
- Wait criteria type.
- WaitDuration string
- The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.
- WaitType string
- Wait criteria type.
- waitDuration String
- The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.
- waitType String
- Wait criteria type.
- waitDuration string
- The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.
- waitType string
- Wait criteria type.
- wait_duration str
- The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.
- wait_type str
- Wait criteria type.
- waitDuration String
- The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.
- waitType String
- Wait criteria type.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.