Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DevOps
  5. DeployStage
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.DevOps.DeployStage

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Deploy Stage resource in Oracle Cloud Infrastructure Devops service.

Creates a new deployment stage.

Create DeployStage Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DeployStage(name: string, args: DeployStageArgs, opts?: CustomResourceOptions);
@overload
def DeployStage(resource_name: str,
                args: DeployStageArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def DeployStage(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                deploy_pipeline_id: Optional[str] = None,
                deploy_stage_predecessor_collection: Optional[_devops.DeployStageDeployStagePredecessorCollectionArgs] = None,
                deploy_stage_type: Optional[str] = None,
                approval_policy: Optional[_devops.DeployStageApprovalPolicyArgs] = None,
                are_hooks_enabled: Optional[bool] = None,
                blue_backend_ips: Optional[_devops.DeployStageBlueBackendIpsArgs] = None,
                blue_green_strategy: Optional[_devops.DeployStageBlueGreenStrategyArgs] = None,
                canary_strategy: Optional[_devops.DeployStageCanaryStrategyArgs] = None,
                command_spec_deploy_artifact_id: Optional[str] = None,
                compute_instance_group_blue_green_deployment_deploy_stage_id: Optional[str] = None,
                compute_instance_group_canary_deploy_stage_id: Optional[str] = None,
                compute_instance_group_canary_traffic_shift_deploy_stage_id: Optional[str] = None,
                compute_instance_group_deploy_environment_id: Optional[str] = None,
                config: Optional[Mapping[str, str]] = None,
                container_config: Optional[_devops.DeployStageContainerConfigArgs] = None,
                defined_tags: Optional[Mapping[str, str]] = None,
                deploy_artifact_id: Optional[str] = None,
                deploy_artifact_ids: Optional[Sequence[str]] = None,
                deploy_environment_id_a: Optional[str] = None,
                deploy_environment_id_b: Optional[str] = None,
                deployment_spec_deploy_artifact_id: Optional[str] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                docker_image_deploy_artifact_id: Optional[str] = None,
                failure_policy: Optional[_devops.DeployStageFailurePolicyArgs] = None,
                freeform_tags: Optional[Mapping[str, str]] = None,
                function_deploy_environment_id: Optional[str] = None,
                function_timeout_in_seconds: Optional[int] = None,
                green_backend_ips: Optional[_devops.DeployStageGreenBackendIpsArgs] = None,
                helm_chart_deploy_artifact_id: Optional[str] = None,
                helm_command_artifact_ids: Optional[Sequence[str]] = None,
                is_async: Optional[bool] = None,
                is_debug_enabled: Optional[bool] = None,
                is_force_enabled: Optional[bool] = None,
                is_uninstall_on_stage_delete: Optional[bool] = None,
                is_validation_enabled: Optional[bool] = None,
                kubernetes_manifest_deploy_artifact_ids: Optional[Sequence[str]] = None,
                load_balancer_config: Optional[_devops.DeployStageLoadBalancerConfigArgs] = None,
                max_history: Optional[int] = None,
                max_memory_in_mbs: Optional[str] = None,
                namespace: Optional[str] = None,
                oke_blue_green_deploy_stage_id: Optional[str] = None,
                oke_canary_deploy_stage_id: Optional[str] = None,
                oke_canary_traffic_shift_deploy_stage_id: Optional[str] = None,
                oke_cluster_deploy_environment_id: Optional[str] = None,
                production_load_balancer_config: Optional[_devops.DeployStageProductionLoadBalancerConfigArgs] = None,
                purpose: Optional[str] = None,
                release_name: Optional[str] = None,
                rollback_policy: Optional[_devops.DeployStageRollbackPolicyArgs] = None,
                rollout_policy: Optional[_devops.DeployStageRolloutPolicyArgs] = None,
                set_string: Optional[_devops.DeployStageSetStringArgs] = None,
                set_values: Optional[_devops.DeployStageSetValuesArgs] = None,
                should_cleanup_on_fail: Optional[bool] = None,
                should_not_wait: Optional[bool] = None,
                should_reset_values: Optional[bool] = None,
                should_reuse_values: Optional[bool] = None,
                should_skip_crds: Optional[bool] = None,
                should_skip_render_subchart_notes: Optional[bool] = None,
                test_load_balancer_config: Optional[_devops.DeployStageTestLoadBalancerConfigArgs] = None,
                timeout_in_seconds: Optional[int] = None,
                traffic_shift_target: Optional[str] = None,
                values_artifact_ids: Optional[Sequence[str]] = None,
                wait_criteria: Optional[_devops.DeployStageWaitCriteriaArgs] = None)
func NewDeployStage(ctx *Context, name string, args DeployStageArgs, opts ...ResourceOption) (*DeployStage, error)
public DeployStage(string name, DeployStageArgs args, CustomResourceOptions? opts = null)
public DeployStage(String name, DeployStageArgs args)
public DeployStage(String name, DeployStageArgs args, CustomResourceOptions options)

type: oci:DevOps:DeployStage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DeployStageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DeployStageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DeployStageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DeployStageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DeployStageArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var deployStageResource = new Oci.DevOps.DeployStage("deployStageResource", new()
{
    DeployPipelineId = "string",
    DeployStagePredecessorCollection = new Oci.DevOps.Inputs.DeployStageDeployStagePredecessorCollectionArgs
    {
        Items = new[]
        {
            new Oci.DevOps.Inputs.DeployStageDeployStagePredecessorCollectionItemArgs
            {
                Id = "string",
            },
        },
    },
    DeployStageType = "string",
    ApprovalPolicy = new Oci.DevOps.Inputs.DeployStageApprovalPolicyArgs
    {
        ApprovalPolicyType = "string",
        NumberOfApprovalsRequired = 0,
    },
    AreHooksEnabled = false,
    BlueBackendIps = new Oci.DevOps.Inputs.DeployStageBlueBackendIpsArgs
    {
        Items = new[]
        {
            "string",
        },
    },
    BlueGreenStrategy = new Oci.DevOps.Inputs.DeployStageBlueGreenStrategyArgs
    {
        IngressName = "string",
        NamespaceA = "string",
        NamespaceB = "string",
        StrategyType = "string",
    },
    CanaryStrategy = new Oci.DevOps.Inputs.DeployStageCanaryStrategyArgs
    {
        IngressName = "string",
        Namespace = "string",
        StrategyType = "string",
    },
    CommandSpecDeployArtifactId = "string",
    ComputeInstanceGroupBlueGreenDeploymentDeployStageId = "string",
    ComputeInstanceGroupCanaryDeployStageId = "string",
    ComputeInstanceGroupCanaryTrafficShiftDeployStageId = "string",
    ComputeInstanceGroupDeployEnvironmentId = "string",
    Config = 
    {
        { "string", "string" },
    },
    ContainerConfig = new Oci.DevOps.Inputs.DeployStageContainerConfigArgs
    {
        ContainerConfigType = "string",
        NetworkChannel = new Oci.DevOps.Inputs.DeployStageContainerConfigNetworkChannelArgs
        {
            NetworkChannelType = "string",
            SubnetId = "string",
            NsgIds = new[]
            {
                "string",
            },
        },
        ShapeConfig = new Oci.DevOps.Inputs.DeployStageContainerConfigShapeConfigArgs
        {
            Ocpus = 0,
            MemoryInGbs = 0,
        },
        ShapeName = "string",
        AvailabilityDomain = "string",
        CompartmentId = "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    DeployArtifactId = "string",
    DeployArtifactIds = new[]
    {
        "string",
    },
    DeployEnvironmentIdA = "string",
    DeployEnvironmentIdB = "string",
    DeploymentSpecDeployArtifactId = "string",
    Description = "string",
    DisplayName = "string",
    DockerImageDeployArtifactId = "string",
    FailurePolicy = new Oci.DevOps.Inputs.DeployStageFailurePolicyArgs
    {
        PolicyType = "string",
        FailureCount = 0,
        FailurePercentage = 0,
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    FunctionDeployEnvironmentId = "string",
    FunctionTimeoutInSeconds = 0,
    GreenBackendIps = new Oci.DevOps.Inputs.DeployStageGreenBackendIpsArgs
    {
        Items = new[]
        {
            "string",
        },
    },
    HelmChartDeployArtifactId = "string",
    HelmCommandArtifactIds = new[]
    {
        "string",
    },
    IsAsync = false,
    IsDebugEnabled = false,
    IsForceEnabled = false,
    IsUninstallOnStageDelete = false,
    IsValidationEnabled = false,
    KubernetesManifestDeployArtifactIds = new[]
    {
        "string",
    },
    LoadBalancerConfig = new Oci.DevOps.Inputs.DeployStageLoadBalancerConfigArgs
    {
        BackendPort = 0,
        ListenerName = "string",
        LoadBalancerId = "string",
        State = "string",
    },
    MaxHistory = 0,
    MaxMemoryInMbs = "string",
    Namespace = "string",
    OkeBlueGreenDeployStageId = "string",
    OkeCanaryDeployStageId = "string",
    OkeCanaryTrafficShiftDeployStageId = "string",
    OkeClusterDeployEnvironmentId = "string",
    ProductionLoadBalancerConfig = new Oci.DevOps.Inputs.DeployStageProductionLoadBalancerConfigArgs
    {
        BackendPort = 0,
        ListenerName = "string",
        LoadBalancerId = "string",
        State = "string",
    },
    Purpose = "string",
    ReleaseName = "string",
    RollbackPolicy = new Oci.DevOps.Inputs.DeployStageRollbackPolicyArgs
    {
        PolicyType = "string",
    },
    RolloutPolicy = new Oci.DevOps.Inputs.DeployStageRolloutPolicyArgs
    {
        BatchCount = 0,
        BatchDelayInSeconds = 0,
        BatchPercentage = 0,
        PolicyType = "string",
        RampLimitPercent = 0,
    },
    SetString = new Oci.DevOps.Inputs.DeployStageSetStringArgs
    {
        Items = new[]
        {
            new Oci.DevOps.Inputs.DeployStageSetStringItemArgs
            {
                Name = "string",
                Value = "string",
            },
        },
    },
    SetValues = new Oci.DevOps.Inputs.DeployStageSetValuesArgs
    {
        Items = new[]
        {
            new Oci.DevOps.Inputs.DeployStageSetValuesItemArgs
            {
                Name = "string",
                Value = "string",
            },
        },
    },
    ShouldCleanupOnFail = false,
    ShouldNotWait = false,
    ShouldResetValues = false,
    ShouldReuseValues = false,
    ShouldSkipCrds = false,
    ShouldSkipRenderSubchartNotes = false,
    TestLoadBalancerConfig = new Oci.DevOps.Inputs.DeployStageTestLoadBalancerConfigArgs
    {
        BackendPort = 0,
        ListenerName = "string",
        LoadBalancerId = "string",
        State = "string",
    },
    TimeoutInSeconds = 0,
    TrafficShiftTarget = "string",
    ValuesArtifactIds = new[]
    {
        "string",
    },
    WaitCriteria = new Oci.DevOps.Inputs.DeployStageWaitCriteriaArgs
    {
        WaitDuration = "string",
        WaitType = "string",
    },
});
Copy
example, err := DevOps.NewDeployStage(ctx, "deployStageResource", &DevOps.DeployStageArgs{
	DeployPipelineId: pulumi.String("string"),
	DeployStagePredecessorCollection: &devops.DeployStageDeployStagePredecessorCollectionArgs{
		Items: devops.DeployStageDeployStagePredecessorCollectionItemArray{
			&devops.DeployStageDeployStagePredecessorCollectionItemArgs{
				Id: pulumi.String("string"),
			},
		},
	},
	DeployStageType: pulumi.String("string"),
	ApprovalPolicy: &devops.DeployStageApprovalPolicyArgs{
		ApprovalPolicyType:        pulumi.String("string"),
		NumberOfApprovalsRequired: pulumi.Int(0),
	},
	AreHooksEnabled: pulumi.Bool(false),
	BlueBackendIps: &devops.DeployStageBlueBackendIpsArgs{
		Items: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	BlueGreenStrategy: &devops.DeployStageBlueGreenStrategyArgs{
		IngressName:  pulumi.String("string"),
		NamespaceA:   pulumi.String("string"),
		NamespaceB:   pulumi.String("string"),
		StrategyType: pulumi.String("string"),
	},
	CanaryStrategy: &devops.DeployStageCanaryStrategyArgs{
		IngressName:  pulumi.String("string"),
		Namespace:    pulumi.String("string"),
		StrategyType: pulumi.String("string"),
	},
	CommandSpecDeployArtifactId:                          pulumi.String("string"),
	ComputeInstanceGroupBlueGreenDeploymentDeployStageId: pulumi.String("string"),
	ComputeInstanceGroupCanaryDeployStageId:              pulumi.String("string"),
	ComputeInstanceGroupCanaryTrafficShiftDeployStageId:  pulumi.String("string"),
	ComputeInstanceGroupDeployEnvironmentId:              pulumi.String("string"),
	Config: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ContainerConfig: &devops.DeployStageContainerConfigArgs{
		ContainerConfigType: pulumi.String("string"),
		NetworkChannel: &devops.DeployStageContainerConfigNetworkChannelArgs{
			NetworkChannelType: pulumi.String("string"),
			SubnetId:           pulumi.String("string"),
			NsgIds: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		ShapeConfig: &devops.DeployStageContainerConfigShapeConfigArgs{
			Ocpus:       pulumi.Float64(0),
			MemoryInGbs: pulumi.Float64(0),
		},
		ShapeName:          pulumi.String("string"),
		AvailabilityDomain: pulumi.String("string"),
		CompartmentId:      pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DeployArtifactId: pulumi.String("string"),
	DeployArtifactIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	DeployEnvironmentIdA:           pulumi.String("string"),
	DeployEnvironmentIdB:           pulumi.String("string"),
	DeploymentSpecDeployArtifactId: pulumi.String("string"),
	Description:                    pulumi.String("string"),
	DisplayName:                    pulumi.String("string"),
	DockerImageDeployArtifactId:    pulumi.String("string"),
	FailurePolicy: &devops.DeployStageFailurePolicyArgs{
		PolicyType:        pulumi.String("string"),
		FailureCount:      pulumi.Int(0),
		FailurePercentage: pulumi.Int(0),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FunctionDeployEnvironmentId: pulumi.String("string"),
	FunctionTimeoutInSeconds:    pulumi.Int(0),
	GreenBackendIps: &devops.DeployStageGreenBackendIpsArgs{
		Items: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	HelmChartDeployArtifactId: pulumi.String("string"),
	HelmCommandArtifactIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsAsync:                  pulumi.Bool(false),
	IsDebugEnabled:           pulumi.Bool(false),
	IsForceEnabled:           pulumi.Bool(false),
	IsUninstallOnStageDelete: pulumi.Bool(false),
	IsValidationEnabled:      pulumi.Bool(false),
	KubernetesManifestDeployArtifactIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	LoadBalancerConfig: &devops.DeployStageLoadBalancerConfigArgs{
		BackendPort:    pulumi.Int(0),
		ListenerName:   pulumi.String("string"),
		LoadBalancerId: pulumi.String("string"),
		State:          pulumi.String("string"),
	},
	MaxHistory:                         pulumi.Int(0),
	MaxMemoryInMbs:                     pulumi.String("string"),
	Namespace:                          pulumi.String("string"),
	OkeBlueGreenDeployStageId:          pulumi.String("string"),
	OkeCanaryDeployStageId:             pulumi.String("string"),
	OkeCanaryTrafficShiftDeployStageId: pulumi.String("string"),
	OkeClusterDeployEnvironmentId:      pulumi.String("string"),
	ProductionLoadBalancerConfig: &devops.DeployStageProductionLoadBalancerConfigArgs{
		BackendPort:    pulumi.Int(0),
		ListenerName:   pulumi.String("string"),
		LoadBalancerId: pulumi.String("string"),
		State:          pulumi.String("string"),
	},
	Purpose:     pulumi.String("string"),
	ReleaseName: pulumi.String("string"),
	RollbackPolicy: &devops.DeployStageRollbackPolicyArgs{
		PolicyType: pulumi.String("string"),
	},
	RolloutPolicy: &devops.DeployStageRolloutPolicyArgs{
		BatchCount:          pulumi.Int(0),
		BatchDelayInSeconds: pulumi.Int(0),
		BatchPercentage:     pulumi.Int(0),
		PolicyType:          pulumi.String("string"),
		RampLimitPercent:    pulumi.Float64(0),
	},
	SetString: &devops.DeployStageSetStringArgs{
		Items: devops.DeployStageSetStringItemArray{
			&devops.DeployStageSetStringItemArgs{
				Name:  pulumi.String("string"),
				Value: pulumi.String("string"),
			},
		},
	},
	SetValues: &devops.DeployStageSetValuesArgs{
		Items: devops.DeployStageSetValuesItemArray{
			&devops.DeployStageSetValuesItemArgs{
				Name:  pulumi.String("string"),
				Value: pulumi.String("string"),
			},
		},
	},
	ShouldCleanupOnFail:           pulumi.Bool(false),
	ShouldNotWait:                 pulumi.Bool(false),
	ShouldResetValues:             pulumi.Bool(false),
	ShouldReuseValues:             pulumi.Bool(false),
	ShouldSkipCrds:                pulumi.Bool(false),
	ShouldSkipRenderSubchartNotes: pulumi.Bool(false),
	TestLoadBalancerConfig: &devops.DeployStageTestLoadBalancerConfigArgs{
		BackendPort:    pulumi.Int(0),
		ListenerName:   pulumi.String("string"),
		LoadBalancerId: pulumi.String("string"),
		State:          pulumi.String("string"),
	},
	TimeoutInSeconds:   pulumi.Int(0),
	TrafficShiftTarget: pulumi.String("string"),
	ValuesArtifactIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	WaitCriteria: &devops.DeployStageWaitCriteriaArgs{
		WaitDuration: pulumi.String("string"),
		WaitType:     pulumi.String("string"),
	},
})
Copy
var deployStageResource = new DeployStage("deployStageResource", DeployStageArgs.builder()
    .deployPipelineId("string")
    .deployStagePredecessorCollection(DeployStageDeployStagePredecessorCollectionArgs.builder()
        .items(DeployStageDeployStagePredecessorCollectionItemArgs.builder()
            .id("string")
            .build())
        .build())
    .deployStageType("string")
    .approvalPolicy(DeployStageApprovalPolicyArgs.builder()
        .approvalPolicyType("string")
        .numberOfApprovalsRequired(0)
        .build())
    .areHooksEnabled(false)
    .blueBackendIps(DeployStageBlueBackendIpsArgs.builder()
        .items("string")
        .build())
    .blueGreenStrategy(DeployStageBlueGreenStrategyArgs.builder()
        .ingressName("string")
        .namespaceA("string")
        .namespaceB("string")
        .strategyType("string")
        .build())
    .canaryStrategy(DeployStageCanaryStrategyArgs.builder()
        .ingressName("string")
        .namespace("string")
        .strategyType("string")
        .build())
    .commandSpecDeployArtifactId("string")
    .computeInstanceGroupBlueGreenDeploymentDeployStageId("string")
    .computeInstanceGroupCanaryDeployStageId("string")
    .computeInstanceGroupCanaryTrafficShiftDeployStageId("string")
    .computeInstanceGroupDeployEnvironmentId("string")
    .config(Map.of("string", "string"))
    .containerConfig(DeployStageContainerConfigArgs.builder()
        .containerConfigType("string")
        .networkChannel(DeployStageContainerConfigNetworkChannelArgs.builder()
            .networkChannelType("string")
            .subnetId("string")
            .nsgIds("string")
            .build())
        .shapeConfig(DeployStageContainerConfigShapeConfigArgs.builder()
            .ocpus(0)
            .memoryInGbs(0)
            .build())
        .shapeName("string")
        .availabilityDomain("string")
        .compartmentId("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .deployArtifactId("string")
    .deployArtifactIds("string")
    .deployEnvironmentIdA("string")
    .deployEnvironmentIdB("string")
    .deploymentSpecDeployArtifactId("string")
    .description("string")
    .displayName("string")
    .dockerImageDeployArtifactId("string")
    .failurePolicy(DeployStageFailurePolicyArgs.builder()
        .policyType("string")
        .failureCount(0)
        .failurePercentage(0)
        .build())
    .freeformTags(Map.of("string", "string"))
    .functionDeployEnvironmentId("string")
    .functionTimeoutInSeconds(0)
    .greenBackendIps(DeployStageGreenBackendIpsArgs.builder()
        .items("string")
        .build())
    .helmChartDeployArtifactId("string")
    .helmCommandArtifactIds("string")
    .isAsync(false)
    .isDebugEnabled(false)
    .isForceEnabled(false)
    .isUninstallOnStageDelete(false)
    .isValidationEnabled(false)
    .kubernetesManifestDeployArtifactIds("string")
    .loadBalancerConfig(DeployStageLoadBalancerConfigArgs.builder()
        .backendPort(0)
        .listenerName("string")
        .loadBalancerId("string")
        .state("string")
        .build())
    .maxHistory(0)
    .maxMemoryInMbs("string")
    .namespace("string")
    .okeBlueGreenDeployStageId("string")
    .okeCanaryDeployStageId("string")
    .okeCanaryTrafficShiftDeployStageId("string")
    .okeClusterDeployEnvironmentId("string")
    .productionLoadBalancerConfig(DeployStageProductionLoadBalancerConfigArgs.builder()
        .backendPort(0)
        .listenerName("string")
        .loadBalancerId("string")
        .state("string")
        .build())
    .purpose("string")
    .releaseName("string")
    .rollbackPolicy(DeployStageRollbackPolicyArgs.builder()
        .policyType("string")
        .build())
    .rolloutPolicy(DeployStageRolloutPolicyArgs.builder()
        .batchCount(0)
        .batchDelayInSeconds(0)
        .batchPercentage(0)
        .policyType("string")
        .rampLimitPercent(0)
        .build())
    .setString(DeployStageSetStringArgs.builder()
        .items(DeployStageSetStringItemArgs.builder()
            .name("string")
            .value("string")
            .build())
        .build())
    .setValues(DeployStageSetValuesArgs.builder()
        .items(DeployStageSetValuesItemArgs.builder()
            .name("string")
            .value("string")
            .build())
        .build())
    .shouldCleanupOnFail(false)
    .shouldNotWait(false)
    .shouldResetValues(false)
    .shouldReuseValues(false)
    .shouldSkipCrds(false)
    .shouldSkipRenderSubchartNotes(false)
    .testLoadBalancerConfig(DeployStageTestLoadBalancerConfigArgs.builder()
        .backendPort(0)
        .listenerName("string")
        .loadBalancerId("string")
        .state("string")
        .build())
    .timeoutInSeconds(0)
    .trafficShiftTarget("string")
    .valuesArtifactIds("string")
    .waitCriteria(DeployStageWaitCriteriaArgs.builder()
        .waitDuration("string")
        .waitType("string")
        .build())
    .build());
Copy
deploy_stage_resource = oci.dev_ops.DeployStage("deployStageResource",
    deploy_pipeline_id="string",
    deploy_stage_predecessor_collection={
        "items": [{
            "id": "string",
        }],
    },
    deploy_stage_type="string",
    approval_policy={
        "approval_policy_type": "string",
        "number_of_approvals_required": 0,
    },
    are_hooks_enabled=False,
    blue_backend_ips={
        "items": ["string"],
    },
    blue_green_strategy={
        "ingress_name": "string",
        "namespace_a": "string",
        "namespace_b": "string",
        "strategy_type": "string",
    },
    canary_strategy={
        "ingress_name": "string",
        "namespace": "string",
        "strategy_type": "string",
    },
    command_spec_deploy_artifact_id="string",
    compute_instance_group_blue_green_deployment_deploy_stage_id="string",
    compute_instance_group_canary_deploy_stage_id="string",
    compute_instance_group_canary_traffic_shift_deploy_stage_id="string",
    compute_instance_group_deploy_environment_id="string",
    config={
        "string": "string",
    },
    container_config={
        "container_config_type": "string",
        "network_channel": {
            "network_channel_type": "string",
            "subnet_id": "string",
            "nsg_ids": ["string"],
        },
        "shape_config": {
            "ocpus": 0,
            "memory_in_gbs": 0,
        },
        "shape_name": "string",
        "availability_domain": "string",
        "compartment_id": "string",
    },
    defined_tags={
        "string": "string",
    },
    deploy_artifact_id="string",
    deploy_artifact_ids=["string"],
    deploy_environment_id_a="string",
    deploy_environment_id_b="string",
    deployment_spec_deploy_artifact_id="string",
    description="string",
    display_name="string",
    docker_image_deploy_artifact_id="string",
    failure_policy={
        "policy_type": "string",
        "failure_count": 0,
        "failure_percentage": 0,
    },
    freeform_tags={
        "string": "string",
    },
    function_deploy_environment_id="string",
    function_timeout_in_seconds=0,
    green_backend_ips={
        "items": ["string"],
    },
    helm_chart_deploy_artifact_id="string",
    helm_command_artifact_ids=["string"],
    is_async=False,
    is_debug_enabled=False,
    is_force_enabled=False,
    is_uninstall_on_stage_delete=False,
    is_validation_enabled=False,
    kubernetes_manifest_deploy_artifact_ids=["string"],
    load_balancer_config={
        "backend_port": 0,
        "listener_name": "string",
        "load_balancer_id": "string",
        "state": "string",
    },
    max_history=0,
    max_memory_in_mbs="string",
    namespace="string",
    oke_blue_green_deploy_stage_id="string",
    oke_canary_deploy_stage_id="string",
    oke_canary_traffic_shift_deploy_stage_id="string",
    oke_cluster_deploy_environment_id="string",
    production_load_balancer_config={
        "backend_port": 0,
        "listener_name": "string",
        "load_balancer_id": "string",
        "state": "string",
    },
    purpose="string",
    release_name="string",
    rollback_policy={
        "policy_type": "string",
    },
    rollout_policy={
        "batch_count": 0,
        "batch_delay_in_seconds": 0,
        "batch_percentage": 0,
        "policy_type": "string",
        "ramp_limit_percent": 0,
    },
    set_string={
        "items": [{
            "name": "string",
            "value": "string",
        }],
    },
    set_values={
        "items": [{
            "name": "string",
            "value": "string",
        }],
    },
    should_cleanup_on_fail=False,
    should_not_wait=False,
    should_reset_values=False,
    should_reuse_values=False,
    should_skip_crds=False,
    should_skip_render_subchart_notes=False,
    test_load_balancer_config={
        "backend_port": 0,
        "listener_name": "string",
        "load_balancer_id": "string",
        "state": "string",
    },
    timeout_in_seconds=0,
    traffic_shift_target="string",
    values_artifact_ids=["string"],
    wait_criteria={
        "wait_duration": "string",
        "wait_type": "string",
    })
Copy
const deployStageResource = new oci.devops.DeployStage("deployStageResource", {
    deployPipelineId: "string",
    deployStagePredecessorCollection: {
        items: [{
            id: "string",
        }],
    },
    deployStageType: "string",
    approvalPolicy: {
        approvalPolicyType: "string",
        numberOfApprovalsRequired: 0,
    },
    areHooksEnabled: false,
    blueBackendIps: {
        items: ["string"],
    },
    blueGreenStrategy: {
        ingressName: "string",
        namespaceA: "string",
        namespaceB: "string",
        strategyType: "string",
    },
    canaryStrategy: {
        ingressName: "string",
        namespace: "string",
        strategyType: "string",
    },
    commandSpecDeployArtifactId: "string",
    computeInstanceGroupBlueGreenDeploymentDeployStageId: "string",
    computeInstanceGroupCanaryDeployStageId: "string",
    computeInstanceGroupCanaryTrafficShiftDeployStageId: "string",
    computeInstanceGroupDeployEnvironmentId: "string",
    config: {
        string: "string",
    },
    containerConfig: {
        containerConfigType: "string",
        networkChannel: {
            networkChannelType: "string",
            subnetId: "string",
            nsgIds: ["string"],
        },
        shapeConfig: {
            ocpus: 0,
            memoryInGbs: 0,
        },
        shapeName: "string",
        availabilityDomain: "string",
        compartmentId: "string",
    },
    definedTags: {
        string: "string",
    },
    deployArtifactId: "string",
    deployArtifactIds: ["string"],
    deployEnvironmentIdA: "string",
    deployEnvironmentIdB: "string",
    deploymentSpecDeployArtifactId: "string",
    description: "string",
    displayName: "string",
    dockerImageDeployArtifactId: "string",
    failurePolicy: {
        policyType: "string",
        failureCount: 0,
        failurePercentage: 0,
    },
    freeformTags: {
        string: "string",
    },
    functionDeployEnvironmentId: "string",
    functionTimeoutInSeconds: 0,
    greenBackendIps: {
        items: ["string"],
    },
    helmChartDeployArtifactId: "string",
    helmCommandArtifactIds: ["string"],
    isAsync: false,
    isDebugEnabled: false,
    isForceEnabled: false,
    isUninstallOnStageDelete: false,
    isValidationEnabled: false,
    kubernetesManifestDeployArtifactIds: ["string"],
    loadBalancerConfig: {
        backendPort: 0,
        listenerName: "string",
        loadBalancerId: "string",
        state: "string",
    },
    maxHistory: 0,
    maxMemoryInMbs: "string",
    namespace: "string",
    okeBlueGreenDeployStageId: "string",
    okeCanaryDeployStageId: "string",
    okeCanaryTrafficShiftDeployStageId: "string",
    okeClusterDeployEnvironmentId: "string",
    productionLoadBalancerConfig: {
        backendPort: 0,
        listenerName: "string",
        loadBalancerId: "string",
        state: "string",
    },
    purpose: "string",
    releaseName: "string",
    rollbackPolicy: {
        policyType: "string",
    },
    rolloutPolicy: {
        batchCount: 0,
        batchDelayInSeconds: 0,
        batchPercentage: 0,
        policyType: "string",
        rampLimitPercent: 0,
    },
    setString: {
        items: [{
            name: "string",
            value: "string",
        }],
    },
    setValues: {
        items: [{
            name: "string",
            value: "string",
        }],
    },
    shouldCleanupOnFail: false,
    shouldNotWait: false,
    shouldResetValues: false,
    shouldReuseValues: false,
    shouldSkipCrds: false,
    shouldSkipRenderSubchartNotes: false,
    testLoadBalancerConfig: {
        backendPort: 0,
        listenerName: "string",
        loadBalancerId: "string",
        state: "string",
    },
    timeoutInSeconds: 0,
    trafficShiftTarget: "string",
    valuesArtifactIds: ["string"],
    waitCriteria: {
        waitDuration: "string",
        waitType: "string",
    },
});
Copy
type: oci:DevOps:DeployStage
properties:
    approvalPolicy:
        approvalPolicyType: string
        numberOfApprovalsRequired: 0
    areHooksEnabled: false
    blueBackendIps:
        items:
            - string
    blueGreenStrategy:
        ingressName: string
        namespaceA: string
        namespaceB: string
        strategyType: string
    canaryStrategy:
        ingressName: string
        namespace: string
        strategyType: string
    commandSpecDeployArtifactId: string
    computeInstanceGroupBlueGreenDeploymentDeployStageId: string
    computeInstanceGroupCanaryDeployStageId: string
    computeInstanceGroupCanaryTrafficShiftDeployStageId: string
    computeInstanceGroupDeployEnvironmentId: string
    config:
        string: string
    containerConfig:
        availabilityDomain: string
        compartmentId: string
        containerConfigType: string
        networkChannel:
            networkChannelType: string
            nsgIds:
                - string
            subnetId: string
        shapeConfig:
            memoryInGbs: 0
            ocpus: 0
        shapeName: string
    definedTags:
        string: string
    deployArtifactId: string
    deployArtifactIds:
        - string
    deployEnvironmentIdA: string
    deployEnvironmentIdB: string
    deployPipelineId: string
    deployStagePredecessorCollection:
        items:
            - id: string
    deployStageType: string
    deploymentSpecDeployArtifactId: string
    description: string
    displayName: string
    dockerImageDeployArtifactId: string
    failurePolicy:
        failureCount: 0
        failurePercentage: 0
        policyType: string
    freeformTags:
        string: string
    functionDeployEnvironmentId: string
    functionTimeoutInSeconds: 0
    greenBackendIps:
        items:
            - string
    helmChartDeployArtifactId: string
    helmCommandArtifactIds:
        - string
    isAsync: false
    isDebugEnabled: false
    isForceEnabled: false
    isUninstallOnStageDelete: false
    isValidationEnabled: false
    kubernetesManifestDeployArtifactIds:
        - string
    loadBalancerConfig:
        backendPort: 0
        listenerName: string
        loadBalancerId: string
        state: string
    maxHistory: 0
    maxMemoryInMbs: string
    namespace: string
    okeBlueGreenDeployStageId: string
    okeCanaryDeployStageId: string
    okeCanaryTrafficShiftDeployStageId: string
    okeClusterDeployEnvironmentId: string
    productionLoadBalancerConfig:
        backendPort: 0
        listenerName: string
        loadBalancerId: string
        state: string
    purpose: string
    releaseName: string
    rollbackPolicy:
        policyType: string
    rolloutPolicy:
        batchCount: 0
        batchDelayInSeconds: 0
        batchPercentage: 0
        policyType: string
        rampLimitPercent: 0
    setString:
        items:
            - name: string
              value: string
    setValues:
        items:
            - name: string
              value: string
    shouldCleanupOnFail: false
    shouldNotWait: false
    shouldResetValues: false
    shouldReuseValues: false
    shouldSkipCrds: false
    shouldSkipRenderSubchartNotes: false
    testLoadBalancerConfig:
        backendPort: 0
        listenerName: string
        loadBalancerId: string
        state: string
    timeoutInSeconds: 0
    trafficShiftTarget: string
    valuesArtifactIds:
        - string
    waitCriteria:
        waitDuration: string
        waitType: string
Copy

DeployStage Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DeployStage resource accepts the following input properties:

DeployPipelineId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of a pipeline.
DeployStagePredecessorCollection This property is required. DeployStageDeployStagePredecessorCollection
(Updatable) Collection containing the predecessors of a stage.
DeployStageType This property is required. string
(Updatable) Deployment stage type.
ApprovalPolicy DeployStageApprovalPolicy
(Updatable) Specifies the approval policy.
AreHooksEnabled bool
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
BlueBackendIps DeployStageBlueBackendIps
(Updatable) Collection of backend environment IP addresses.
BlueGreenStrategy Changes to this property will trigger replacement. DeployStageBlueGreenStrategy
Specifies the required blue green release strategy for OKE deployment.
CanaryStrategy Changes to this property will trigger replacement. DeployStageCanaryStrategy
Specifies the required canary release strategy for OKE deployment.
CommandSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the command specification.
ComputeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
ComputeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. string
A compute instance group canary stage OCID for load balancer.
ComputeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
ComputeInstanceGroupDeployEnvironmentId string
(Updatable) A compute instance group environment OCID for rolling deployment.
Config Dictionary<string, string>
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
ContainerConfig DeployStageContainerConfig
(Updatable) Specifies the container configuration.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
DeployArtifactId string
(Updatable) 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.
DeployArtifactIds List<string>
(Updatable) The list of file artifact OCIDs to deploy.
DeployEnvironmentIdA Changes to this property will trigger replacement. string
First compute instance group environment OCID for deployment.
DeployEnvironmentIdB Changes to this property will trigger replacement. string
Second compute instance group environment OCID for deployment.
DeploymentSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the deployment specification.
Description string
(Updatable) Optional description about the deployment stage.
DisplayName string
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
DockerImageDeployArtifactId string
(Updatable) A Docker image artifact OCID.
FailurePolicy DeployStageFailurePolicy
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
FreeformTags Dictionary<string, string>
(Updatable) 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"}
FunctionDeployEnvironmentId string
(Updatable) Function environment OCID.
FunctionTimeoutInSeconds int
(Updatable) Timeout for execution of the Function. Value in seconds.
GreenBackendIps DeployStageGreenBackendIps
(Updatable) Collection of backend environment IP addresses.
HelmChartDeployArtifactId string
(Updatable) Helm chart artifact OCID.
HelmCommandArtifactIds List<string>
(Updatable) List of Helm command artifact OCIDs.
IsAsync bool
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
IsDebugEnabled bool
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
IsForceEnabled bool
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
IsUninstallOnStageDelete bool
(Updatable) Uninstall the Helm chart release on deleting the stage.
IsValidationEnabled bool
(Updatable) A boolean flag specifies whether the invoked function should be validated.
KubernetesManifestDeployArtifactIds List<string>
(Updatable) List of Kubernetes manifest artifact OCIDs.
LoadBalancerConfig DeployStageLoadBalancerConfig
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
MaxMemoryInMbs string
(Updatable) Maximum usable memory for the Function (in MB).
Namespace string
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
OkeBlueGreenDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
OkeCanaryDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment stage in this pipeline.
OkeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
OkeClusterDeployEnvironmentId string
(Updatable) Kubernetes cluster environment OCID for deployment.
ProductionLoadBalancerConfig Changes to this property will trigger replacement. DeployStageProductionLoadBalancerConfig
Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
Purpose string
(Updatable) The purpose of running this Helm stage
ReleaseName string
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
RollbackPolicy DeployStageRollbackPolicy
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
RolloutPolicy DeployStageRolloutPolicy
(Updatable) Description of rollout policy for load balancer traffic shift stage.
SetString DeployStageSetString
(Updatable) Specifies the name and value pairs to set helm values.
SetValues DeployStageSetValues
(Updatable) Specifies the name and value pairs to set helm values.
ShouldCleanupOnFail bool
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
ShouldNotWait bool
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
ShouldResetValues bool
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
ShouldReuseValues bool
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
ShouldSkipCrds bool
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
ShouldSkipRenderSubchartNotes bool
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
TestLoadBalancerConfig DeployStageTestLoadBalancerConfig
(Updatable) Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
TimeoutInSeconds int
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
TrafficShiftTarget string
(Updatable) Specifies the target or destination backend set.
ValuesArtifactIds List<string>
(Updatable) List of values.yaml file artifact OCIDs.
WaitCriteria DeployStageWaitCriteria
(Updatable) Specifies wait criteria for the Wait stage.
DeployPipelineId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of a pipeline.
DeployStagePredecessorCollection This property is required. DeployStageDeployStagePredecessorCollectionArgs
(Updatable) Collection containing the predecessors of a stage.
DeployStageType This property is required. string
(Updatable) Deployment stage type.
ApprovalPolicy DeployStageApprovalPolicyArgs
(Updatable) Specifies the approval policy.
AreHooksEnabled bool
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
BlueBackendIps DeployStageBlueBackendIpsArgs
(Updatable) Collection of backend environment IP addresses.
BlueGreenStrategy Changes to this property will trigger replacement. DeployStageBlueGreenStrategyArgs
Specifies the required blue green release strategy for OKE deployment.
CanaryStrategy Changes to this property will trigger replacement. DeployStageCanaryStrategyArgs
Specifies the required canary release strategy for OKE deployment.
CommandSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the command specification.
ComputeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
ComputeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. string
A compute instance group canary stage OCID for load balancer.
ComputeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
ComputeInstanceGroupDeployEnvironmentId string
(Updatable) A compute instance group environment OCID for rolling deployment.
Config map[string]string
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
ContainerConfig DeployStageContainerConfigArgs
(Updatable) Specifies the container configuration.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
DeployArtifactId string
(Updatable) 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.
DeployArtifactIds []string
(Updatable) The list of file artifact OCIDs to deploy.
DeployEnvironmentIdA Changes to this property will trigger replacement. string
First compute instance group environment OCID for deployment.
DeployEnvironmentIdB Changes to this property will trigger replacement. string
Second compute instance group environment OCID for deployment.
DeploymentSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the deployment specification.
Description string
(Updatable) Optional description about the deployment stage.
DisplayName string
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
DockerImageDeployArtifactId string
(Updatable) A Docker image artifact OCID.
FailurePolicy DeployStageFailurePolicyArgs
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
FreeformTags map[string]string
(Updatable) 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"}
FunctionDeployEnvironmentId string
(Updatable) Function environment OCID.
FunctionTimeoutInSeconds int
(Updatable) Timeout for execution of the Function. Value in seconds.
GreenBackendIps DeployStageGreenBackendIpsArgs
(Updatable) Collection of backend environment IP addresses.
HelmChartDeployArtifactId string
(Updatable) Helm chart artifact OCID.
HelmCommandArtifactIds []string
(Updatable) List of Helm command artifact OCIDs.
IsAsync bool
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
IsDebugEnabled bool
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
IsForceEnabled bool
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
IsUninstallOnStageDelete bool
(Updatable) Uninstall the Helm chart release on deleting the stage.
IsValidationEnabled bool
(Updatable) A boolean flag specifies whether the invoked function should be validated.
KubernetesManifestDeployArtifactIds []string
(Updatable) List of Kubernetes manifest artifact OCIDs.
LoadBalancerConfig DeployStageLoadBalancerConfigArgs
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
MaxMemoryInMbs string
(Updatable) Maximum usable memory for the Function (in MB).
Namespace string
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
OkeBlueGreenDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
OkeCanaryDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment stage in this pipeline.
OkeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
OkeClusterDeployEnvironmentId string
(Updatable) Kubernetes cluster environment OCID for deployment.
ProductionLoadBalancerConfig Changes to this property will trigger replacement. DeployStageProductionLoadBalancerConfigArgs
Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
Purpose string
(Updatable) The purpose of running this Helm stage
ReleaseName string
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
RollbackPolicy DeployStageRollbackPolicyArgs
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
RolloutPolicy DeployStageRolloutPolicyArgs
(Updatable) Description of rollout policy for load balancer traffic shift stage.
SetString DeployStageSetStringArgs
(Updatable) Specifies the name and value pairs to set helm values.
SetValues DeployStageSetValuesArgs
(Updatable) Specifies the name and value pairs to set helm values.
ShouldCleanupOnFail bool
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
ShouldNotWait bool
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
ShouldResetValues bool
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
ShouldReuseValues bool
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
ShouldSkipCrds bool
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
ShouldSkipRenderSubchartNotes bool
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
TestLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs
(Updatable) Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
TimeoutInSeconds int
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
TrafficShiftTarget string
(Updatable) Specifies the target or destination backend set.
ValuesArtifactIds []string
(Updatable) List of values.yaml file artifact OCIDs.
WaitCriteria DeployStageWaitCriteriaArgs
(Updatable) Specifies wait criteria for the Wait stage.
deployPipelineId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of a pipeline.
deployStagePredecessorCollection This property is required. DeployStageDeployStagePredecessorCollection
(Updatable) Collection containing the predecessors of a stage.
deployStageType This property is required. String
(Updatable) Deployment stage type.
approvalPolicy DeployStageApprovalPolicy
(Updatable) Specifies the approval policy.
areHooksEnabled Boolean
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
blueBackendIps DeployStageBlueBackendIps
(Updatable) Collection of backend environment IP addresses.
blueGreenStrategy Changes to this property will trigger replacement. DeployStageBlueGreenStrategy
Specifies the required blue green release strategy for OKE deployment.
canaryStrategy Changes to this property will trigger replacement. DeployStageCanaryStrategy
Specifies the required canary release strategy for OKE deployment.
commandSpecDeployArtifactId String
(Updatable) The OCID of the artifact that contains the command specification.
computeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. String
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
computeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. String
A compute instance group canary stage OCID for load balancer.
computeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. String
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
computeInstanceGroupDeployEnvironmentId String
(Updatable) A compute instance group environment OCID for rolling deployment.
config Map<String,String>
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
containerConfig DeployStageContainerConfig
(Updatable) Specifies the container configuration.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deployArtifactId String
(Updatable) 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.
deployArtifactIds List<String>
(Updatable) The list of file artifact OCIDs to deploy.
deployEnvironmentIdA Changes to this property will trigger replacement. String
First compute instance group environment OCID for deployment.
deployEnvironmentIdB Changes to this property will trigger replacement. String
Second compute instance group environment OCID for deployment.
deploymentSpecDeployArtifactId String
(Updatable) The OCID of the artifact that contains the deployment specification.
description String
(Updatable) Optional description about the deployment stage.
displayName String
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
dockerImageDeployArtifactId String
(Updatable) A Docker image artifact OCID.
failurePolicy DeployStageFailurePolicy
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
freeformTags Map<String,String>
(Updatable) 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"}
functionDeployEnvironmentId String
(Updatable) Function environment OCID.
functionTimeoutInSeconds Integer
(Updatable) Timeout for execution of the Function. Value in seconds.
greenBackendIps DeployStageGreenBackendIps
(Updatable) Collection of backend environment IP addresses.
helmChartDeployArtifactId String
(Updatable) Helm chart artifact OCID.
helmCommandArtifactIds List<String>
(Updatable) List of Helm command artifact OCIDs.
isAsync Boolean
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
isDebugEnabled Boolean
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
isForceEnabled Boolean
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
isUninstallOnStageDelete Boolean
(Updatable) Uninstall the Helm chart release on deleting the stage.
isValidationEnabled Boolean
(Updatable) A boolean flag specifies whether the invoked function should be validated.
kubernetesManifestDeployArtifactIds List<String>
(Updatable) List of Kubernetes manifest artifact OCIDs.
loadBalancerConfig DeployStageLoadBalancerConfig
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
maxMemoryInMbs String
(Updatable) Maximum usable memory for the Function (in MB).
namespace String
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
okeBlueGreenDeployStageId Changes to this property will trigger replacement. String
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
okeCanaryDeployStageId Changes to this property will trigger replacement. String
The OCID of an upstream OKE canary deployment stage in this pipeline.
okeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. String
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
okeClusterDeployEnvironmentId String
(Updatable) Kubernetes cluster environment OCID for deployment.
productionLoadBalancerConfig Changes to this property will trigger replacement. DeployStageProductionLoadBalancerConfig
Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
purpose String
(Updatable) The purpose of running this Helm stage
releaseName String
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
rollbackPolicy DeployStageRollbackPolicy
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
rolloutPolicy DeployStageRolloutPolicy
(Updatable) Description of rollout policy for load balancer traffic shift stage.
setString DeployStageSetString
(Updatable) Specifies the name and value pairs to set helm values.
setValues DeployStageSetValues
(Updatable) Specifies the name and value pairs to set helm values.
shouldCleanupOnFail Boolean
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
shouldNotWait Boolean
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
shouldResetValues Boolean
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
shouldReuseValues Boolean
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
shouldSkipCrds Boolean
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
shouldSkipRenderSubchartNotes Boolean
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
testLoadBalancerConfig DeployStageTestLoadBalancerConfig
(Updatable) Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
timeoutInSeconds Integer
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
trafficShiftTarget String
(Updatable) Specifies the target or destination backend set.
valuesArtifactIds List<String>
(Updatable) List of values.yaml file artifact OCIDs.
waitCriteria DeployStageWaitCriteria
(Updatable) Specifies wait criteria for the Wait stage.
deployPipelineId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of a pipeline.
deployStagePredecessorCollection This property is required. DeployStageDeployStagePredecessorCollection
(Updatable) Collection containing the predecessors of a stage.
deployStageType This property is required. string
(Updatable) Deployment stage type.
approvalPolicy DeployStageApprovalPolicy
(Updatable) Specifies the approval policy.
areHooksEnabled boolean
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
blueBackendIps DeployStageBlueBackendIps
(Updatable) Collection of backend environment IP addresses.
blueGreenStrategy Changes to this property will trigger replacement. DeployStageBlueGreenStrategy
Specifies the required blue green release strategy for OKE deployment.
canaryStrategy Changes to this property will trigger replacement. DeployStageCanaryStrategy
Specifies the required canary release strategy for OKE deployment.
commandSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the command specification.
computeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
computeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. string
A compute instance group canary stage OCID for load balancer.
computeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
computeInstanceGroupDeployEnvironmentId string
(Updatable) A compute instance group environment OCID for rolling deployment.
config {[key: string]: string}
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
containerConfig DeployStageContainerConfig
(Updatable) Specifies the container configuration.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deployArtifactId string
(Updatable) 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.
deployArtifactIds string[]
(Updatable) The list of file artifact OCIDs to deploy.
deployEnvironmentIdA Changes to this property will trigger replacement. string
First compute instance group environment OCID for deployment.
deployEnvironmentIdB Changes to this property will trigger replacement. string
Second compute instance group environment OCID for deployment.
deploymentSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the deployment specification.
description string
(Updatable) Optional description about the deployment stage.
displayName string
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
dockerImageDeployArtifactId string
(Updatable) A Docker image artifact OCID.
failurePolicy DeployStageFailurePolicy
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
freeformTags {[key: string]: string}
(Updatable) 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"}
functionDeployEnvironmentId string
(Updatable) Function environment OCID.
functionTimeoutInSeconds number
(Updatable) Timeout for execution of the Function. Value in seconds.
greenBackendIps DeployStageGreenBackendIps
(Updatable) Collection of backend environment IP addresses.
helmChartDeployArtifactId string
(Updatable) Helm chart artifact OCID.
helmCommandArtifactIds string[]
(Updatable) List of Helm command artifact OCIDs.
isAsync boolean
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
isDebugEnabled boolean
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
isForceEnabled boolean
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
isUninstallOnStageDelete boolean
(Updatable) Uninstall the Helm chart release on deleting the stage.
isValidationEnabled boolean
(Updatable) A boolean flag specifies whether the invoked function should be validated.
kubernetesManifestDeployArtifactIds string[]
(Updatable) List of Kubernetes manifest artifact OCIDs.
loadBalancerConfig DeployStageLoadBalancerConfig
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
maxMemoryInMbs string
(Updatable) Maximum usable memory for the Function (in MB).
namespace string
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
okeBlueGreenDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
okeCanaryDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment stage in this pipeline.
okeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
okeClusterDeployEnvironmentId string
(Updatable) Kubernetes cluster environment OCID for deployment.
productionLoadBalancerConfig Changes to this property will trigger replacement. DeployStageProductionLoadBalancerConfig
Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
purpose string
(Updatable) The purpose of running this Helm stage
releaseName string
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
rollbackPolicy DeployStageRollbackPolicy
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
rolloutPolicy DeployStageRolloutPolicy
(Updatable) Description of rollout policy for load balancer traffic shift stage.
setString DeployStageSetString
(Updatable) Specifies the name and value pairs to set helm values.
setValues DeployStageSetValues
(Updatable) Specifies the name and value pairs to set helm values.
shouldCleanupOnFail boolean
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
shouldNotWait boolean
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
shouldResetValues boolean
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
shouldReuseValues boolean
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
shouldSkipCrds boolean
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
shouldSkipRenderSubchartNotes boolean
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
testLoadBalancerConfig DeployStageTestLoadBalancerConfig
(Updatable) Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
timeoutInSeconds number
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
trafficShiftTarget string
(Updatable) Specifies the target or destination backend set.
valuesArtifactIds string[]
(Updatable) List of values.yaml file artifact OCIDs.
waitCriteria DeployStageWaitCriteria
(Updatable) Specifies wait criteria for the Wait stage.
deploy_pipeline_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of a pipeline.
deploy_stage_predecessor_collection This property is required. devops.DeployStageDeployStagePredecessorCollectionArgs
(Updatable) Collection containing the predecessors of a stage.
deploy_stage_type This property is required. str
(Updatable) Deployment stage type.
approval_policy devops.DeployStageApprovalPolicyArgs
(Updatable) Specifies the approval policy.
are_hooks_enabled bool
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
blue_backend_ips devops.DeployStageBlueBackendIpsArgs
(Updatable) Collection of backend environment IP addresses.
blue_green_strategy Changes to this property will trigger replacement. devops.DeployStageBlueGreenStrategyArgs
Specifies the required blue green release strategy for OKE deployment.
canary_strategy Changes to this property will trigger replacement. devops.DeployStageCanaryStrategyArgs
Specifies the required canary release strategy for OKE deployment.
command_spec_deploy_artifact_id str
(Updatable) The OCID of the artifact that contains the command specification.
compute_instance_group_blue_green_deployment_deploy_stage_id Changes to this property will trigger replacement. str
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
compute_instance_group_canary_deploy_stage_id Changes to this property will trigger replacement. str
A compute instance group canary stage OCID for load balancer.
compute_instance_group_canary_traffic_shift_deploy_stage_id Changes to this property will trigger replacement. str
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
compute_instance_group_deploy_environment_id str
(Updatable) A compute instance group environment OCID for rolling deployment.
config Mapping[str, str]
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
container_config devops.DeployStageContainerConfigArgs
(Updatable) Specifies the container configuration.
defined_tags Mapping[str, str]
(Updatable) 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_id str
(Updatable) 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_ids Sequence[str]
(Updatable) The list of file artifact OCIDs to deploy.
deploy_environment_id_a Changes to this property will trigger replacement. str
First compute instance group environment OCID for deployment.
deploy_environment_id_b Changes to this property will trigger replacement. str
Second compute instance group environment OCID for deployment.
deployment_spec_deploy_artifact_id str
(Updatable) The OCID of the artifact that contains the deployment specification.
description str
(Updatable) Optional description about the deployment stage.
display_name str
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
docker_image_deploy_artifact_id str
(Updatable) A Docker image artifact OCID.
failure_policy devops.DeployStageFailurePolicyArgs
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
freeform_tags Mapping[str, str]
(Updatable) 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_environment_id str
(Updatable) Function environment OCID.
function_timeout_in_seconds int
(Updatable) Timeout for execution of the Function. Value in seconds.
green_backend_ips devops.DeployStageGreenBackendIpsArgs
(Updatable) Collection of backend environment IP addresses.
helm_chart_deploy_artifact_id str
(Updatable) Helm chart artifact OCID.
helm_command_artifact_ids Sequence[str]
(Updatable) List of Helm command artifact OCIDs.
is_async bool
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
is_debug_enabled bool
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
is_force_enabled bool
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
is_uninstall_on_stage_delete bool
(Updatable) Uninstall the Helm chart release on deleting the stage.
is_validation_enabled bool
(Updatable) A boolean flag specifies whether the invoked function should be validated.
kubernetes_manifest_deploy_artifact_ids Sequence[str]
(Updatable) List of Kubernetes manifest artifact OCIDs.
load_balancer_config devops.DeployStageLoadBalancerConfigArgs
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
max_memory_in_mbs str
(Updatable) Maximum usable memory for the Function (in MB).
namespace str
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
oke_blue_green_deploy_stage_id Changes to this property will trigger replacement. str
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
oke_canary_deploy_stage_id Changes to this property will trigger replacement. str
The OCID of an upstream OKE canary deployment stage in this pipeline.
oke_canary_traffic_shift_deploy_stage_id Changes to this property will trigger replacement. str
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
oke_cluster_deploy_environment_id str
(Updatable) Kubernetes cluster environment OCID for deployment.
production_load_balancer_config Changes to this property will trigger replacement. devops.DeployStageProductionLoadBalancerConfigArgs
Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
purpose str
(Updatable) The purpose of running this Helm stage
release_name str
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
rollback_policy devops.DeployStageRollbackPolicyArgs
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
rollout_policy devops.DeployStageRolloutPolicyArgs
(Updatable) Description of rollout policy for load balancer traffic shift stage.
set_string devops.DeployStageSetStringArgs
(Updatable) Specifies the name and value pairs to set helm values.
set_values devops.DeployStageSetValuesArgs
(Updatable) Specifies the name and value pairs to set helm values.
should_cleanup_on_fail bool
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
should_not_wait bool
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
should_reset_values bool
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
should_reuse_values bool
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
should_skip_crds bool
(Updatable) 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_render_subchart_notes bool
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
test_load_balancer_config devops.DeployStageTestLoadBalancerConfigArgs
(Updatable) Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
timeout_in_seconds int
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
traffic_shift_target str
(Updatable) Specifies the target or destination backend set.
values_artifact_ids Sequence[str]
(Updatable) List of values.yaml file artifact OCIDs.
wait_criteria devops.DeployStageWaitCriteriaArgs
(Updatable) Specifies wait criteria for the Wait stage.
deployPipelineId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of a pipeline.
deployStagePredecessorCollection This property is required. Property Map
(Updatable) Collection containing the predecessors of a stage.
deployStageType This property is required. String
(Updatable) Deployment stage type.
approvalPolicy Property Map
(Updatable) Specifies the approval policy.
areHooksEnabled Boolean
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
blueBackendIps Property Map
(Updatable) Collection of backend environment IP addresses.
blueGreenStrategy Changes to this property will trigger replacement. Property Map
Specifies the required blue green release strategy for OKE deployment.
canaryStrategy Changes to this property will trigger replacement. Property Map
Specifies the required canary release strategy for OKE deployment.
commandSpecDeployArtifactId String
(Updatable) The OCID of the artifact that contains the command specification.
computeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. String
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
computeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. String
A compute instance group canary stage OCID for load balancer.
computeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. String
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
computeInstanceGroupDeployEnvironmentId String
(Updatable) A compute instance group environment OCID for rolling deployment.
config Map<String>
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
containerConfig Property Map
(Updatable) Specifies the container configuration.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deployArtifactId String
(Updatable) 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.
deployArtifactIds List<String>
(Updatable) The list of file artifact OCIDs to deploy.
deployEnvironmentIdA Changes to this property will trigger replacement. String
First compute instance group environment OCID for deployment.
deployEnvironmentIdB Changes to this property will trigger replacement. String
Second compute instance group environment OCID for deployment.
deploymentSpecDeployArtifactId String
(Updatable) The OCID of the artifact that contains the deployment specification.
description String
(Updatable) Optional description about the deployment stage.
displayName String
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
dockerImageDeployArtifactId String
(Updatable) A Docker image artifact OCID.
failurePolicy Property Map
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
freeformTags Map<String>
(Updatable) 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"}
functionDeployEnvironmentId String
(Updatable) Function environment OCID.
functionTimeoutInSeconds Number
(Updatable) Timeout for execution of the Function. Value in seconds.
greenBackendIps Property Map
(Updatable) Collection of backend environment IP addresses.
helmChartDeployArtifactId String
(Updatable) Helm chart artifact OCID.
helmCommandArtifactIds List<String>
(Updatable) List of Helm command artifact OCIDs.
isAsync Boolean
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
isDebugEnabled Boolean
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
isForceEnabled Boolean
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
isUninstallOnStageDelete Boolean
(Updatable) Uninstall the Helm chart release on deleting the stage.
isValidationEnabled Boolean
(Updatable) A boolean flag specifies whether the invoked function should be validated.
kubernetesManifestDeployArtifactIds List<String>
(Updatable) List of Kubernetes manifest artifact OCIDs.
loadBalancerConfig Property Map
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
maxMemoryInMbs String
(Updatable) Maximum usable memory for the Function (in MB).
namespace String
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
okeBlueGreenDeployStageId Changes to this property will trigger replacement. String
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
okeCanaryDeployStageId Changes to this property will trigger replacement. String
The OCID of an upstream OKE canary deployment stage in this pipeline.
okeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. String
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
okeClusterDeployEnvironmentId String
(Updatable) Kubernetes cluster environment OCID for deployment.
productionLoadBalancerConfig Changes to this property will trigger replacement. Property Map
Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
purpose String
(Updatable) The purpose of running this Helm stage
releaseName String
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
rollbackPolicy Property Map
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
rolloutPolicy Property Map
(Updatable) Description of rollout policy for load balancer traffic shift stage.
setString Property Map
(Updatable) Specifies the name and value pairs to set helm values.
setValues Property Map
(Updatable) Specifies the name and value pairs to set helm values.
shouldCleanupOnFail Boolean
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
shouldNotWait Boolean
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
shouldResetValues Boolean
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
shouldReuseValues Boolean
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
shouldSkipCrds Boolean
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
shouldSkipRenderSubchartNotes Boolean
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
testLoadBalancerConfig Property Map
(Updatable) Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.
timeoutInSeconds Number
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
trafficShiftTarget String
(Updatable) Specifies the target or destination backend set.
valuesArtifactIds List<String>
(Updatable) List of values.yaml file artifact OCIDs.
waitCriteria Property Map
(Updatable) Specifies wait criteria for the Wait stage.

Outputs

All input properties are implicitly available as output properties. Additionally, the DeployStage resource produces the following output properties:

CompartmentId string
The OCID of the compartment where the ContainerInstance will be created.
Id string
The provider-assigned unique ID for this managed resource.
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.
ProjectId string
The OCID of a project.
State string
The current state of the deployment stage.
SystemTags 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"}
TimeCreated string
Time the deployment stage was created. Format defined by RFC3339.
TimeUpdated string
Time the deployment stage was updated. Format defined by RFC3339.
CompartmentId string
The OCID of the compartment where the ContainerInstance will be created.
Id string
The provider-assigned unique ID for this managed resource.
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.
ProjectId string
The OCID of a project.
State string
The current state of the deployment stage.
SystemTags 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"}
TimeCreated string
Time the deployment stage was created. Format defined by RFC3339.
TimeUpdated string
Time the deployment stage was updated. Format defined by RFC3339.
compartmentId String
The OCID of the compartment where the ContainerInstance will be created.
id String
The provider-assigned unique ID for this managed resource.
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.
projectId String
The OCID of a project.
state String
The current state of the deployment stage.
systemTags 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"}
timeCreated String
Time the deployment stage was created. Format defined by RFC3339.
timeUpdated String
Time the deployment stage was updated. Format defined by RFC3339.
compartmentId string
The OCID of the compartment where the ContainerInstance will be created.
id string
The provider-assigned unique ID for this managed resource.
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.
projectId string
The OCID of a project.
state string
The current state of the deployment stage.
systemTags {[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"}
timeCreated string
Time the deployment stage was created. Format defined by RFC3339.
timeUpdated string
Time the deployment stage was updated. Format defined by RFC3339.
compartment_id str
The OCID of the compartment where the ContainerInstance will be created.
id str
The provider-assigned unique ID for this managed resource.
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.
project_id str
The OCID of a project.
state str
The current state of the deployment stage.
system_tags 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"}
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.
compartmentId String
The OCID of the compartment where the ContainerInstance will be created.
id String
The provider-assigned unique ID for this managed resource.
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.
projectId String
The OCID of a project.
state String
The current state of the deployment stage.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
Time the deployment stage was created. Format defined by RFC3339.
timeUpdated String
Time the deployment stage was updated. Format defined by RFC3339.

Look up Existing DeployStage Resource

Get an existing DeployStage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DeployStageState, opts?: CustomResourceOptions): DeployStage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        approval_policy: Optional[_devops.DeployStageApprovalPolicyArgs] = None,
        are_hooks_enabled: Optional[bool] = None,
        blue_backend_ips: Optional[_devops.DeployStageBlueBackendIpsArgs] = None,
        blue_green_strategy: Optional[_devops.DeployStageBlueGreenStrategyArgs] = None,
        canary_strategy: Optional[_devops.DeployStageCanaryStrategyArgs] = None,
        command_spec_deploy_artifact_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        compute_instance_group_blue_green_deployment_deploy_stage_id: Optional[str] = None,
        compute_instance_group_canary_deploy_stage_id: Optional[str] = None,
        compute_instance_group_canary_traffic_shift_deploy_stage_id: Optional[str] = None,
        compute_instance_group_deploy_environment_id: Optional[str] = None,
        config: Optional[Mapping[str, str]] = None,
        container_config: Optional[_devops.DeployStageContainerConfigArgs] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        deploy_artifact_id: Optional[str] = None,
        deploy_artifact_ids: Optional[Sequence[str]] = None,
        deploy_environment_id_a: Optional[str] = None,
        deploy_environment_id_b: Optional[str] = None,
        deploy_pipeline_id: Optional[str] = None,
        deploy_stage_predecessor_collection: Optional[_devops.DeployStageDeployStagePredecessorCollectionArgs] = None,
        deploy_stage_type: Optional[str] = None,
        deployment_spec_deploy_artifact_id: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        docker_image_deploy_artifact_id: Optional[str] = None,
        failure_policy: Optional[_devops.DeployStageFailurePolicyArgs] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        function_deploy_environment_id: Optional[str] = None,
        function_timeout_in_seconds: Optional[int] = None,
        green_backend_ips: Optional[_devops.DeployStageGreenBackendIpsArgs] = None,
        helm_chart_deploy_artifact_id: Optional[str] = None,
        helm_command_artifact_ids: Optional[Sequence[str]] = None,
        is_async: Optional[bool] = None,
        is_debug_enabled: Optional[bool] = None,
        is_force_enabled: Optional[bool] = None,
        is_uninstall_on_stage_delete: Optional[bool] = None,
        is_validation_enabled: Optional[bool] = None,
        kubernetes_manifest_deploy_artifact_ids: Optional[Sequence[str]] = None,
        lifecycle_details: Optional[str] = None,
        load_balancer_config: Optional[_devops.DeployStageLoadBalancerConfigArgs] = None,
        max_history: Optional[int] = None,
        max_memory_in_mbs: Optional[str] = None,
        namespace: Optional[str] = None,
        oke_blue_green_deploy_stage_id: Optional[str] = None,
        oke_canary_deploy_stage_id: Optional[str] = None,
        oke_canary_traffic_shift_deploy_stage_id: Optional[str] = None,
        oke_cluster_deploy_environment_id: Optional[str] = None,
        production_load_balancer_config: Optional[_devops.DeployStageProductionLoadBalancerConfigArgs] = None,
        project_id: Optional[str] = None,
        purpose: Optional[str] = None,
        release_name: Optional[str] = None,
        rollback_policy: Optional[_devops.DeployStageRollbackPolicyArgs] = None,
        rollout_policy: Optional[_devops.DeployStageRolloutPolicyArgs] = None,
        set_string: Optional[_devops.DeployStageSetStringArgs] = None,
        set_values: Optional[_devops.DeployStageSetValuesArgs] = None,
        should_cleanup_on_fail: Optional[bool] = None,
        should_not_wait: Optional[bool] = None,
        should_reset_values: Optional[bool] = None,
        should_reuse_values: Optional[bool] = None,
        should_skip_crds: Optional[bool] = None,
        should_skip_render_subchart_notes: Optional[bool] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        test_load_balancer_config: Optional[_devops.DeployStageTestLoadBalancerConfigArgs] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        timeout_in_seconds: Optional[int] = None,
        traffic_shift_target: Optional[str] = None,
        values_artifact_ids: Optional[Sequence[str]] = None,
        wait_criteria: Optional[_devops.DeployStageWaitCriteriaArgs] = None) -> DeployStage
func GetDeployStage(ctx *Context, name string, id IDInput, state *DeployStageState, opts ...ResourceOption) (*DeployStage, error)
public static DeployStage Get(string name, Input<string> id, DeployStageState? state, CustomResourceOptions? opts = null)
public static DeployStage get(String name, Output<String> id, DeployStageState state, CustomResourceOptions options)
resources:  _:    type: oci:DevOps:DeployStage    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApprovalPolicy DeployStageApprovalPolicy
(Updatable) Specifies the approval policy.
AreHooksEnabled bool
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
BlueBackendIps DeployStageBlueBackendIps
(Updatable) Collection of backend environment IP addresses.
BlueGreenStrategy Changes to this property will trigger replacement. DeployStageBlueGreenStrategy
Specifies the required blue green release strategy for OKE deployment.
CanaryStrategy Changes to this property will trigger replacement. DeployStageCanaryStrategy
Specifies the required canary release strategy for OKE deployment.
CommandSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the command specification.
CompartmentId string
The OCID of the compartment where the ContainerInstance will be created.
ComputeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
ComputeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. string
A compute instance group canary stage OCID for load balancer.
ComputeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
ComputeInstanceGroupDeployEnvironmentId string
(Updatable) A compute instance group environment OCID for rolling deployment.
Config Dictionary<string, string>
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
ContainerConfig DeployStageContainerConfig
(Updatable) Specifies the container configuration.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
DeployArtifactId string
(Updatable) 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.
DeployArtifactIds List<string>
(Updatable) The list of file artifact OCIDs to deploy.
DeployEnvironmentIdA Changes to this property will trigger replacement. string
First compute instance group environment OCID for deployment.
DeployEnvironmentIdB Changes to this property will trigger replacement. string
Second compute instance group environment OCID for deployment.
DeployPipelineId Changes to this property will trigger replacement. string
The OCID of a pipeline.
DeployStagePredecessorCollection DeployStageDeployStagePredecessorCollection
(Updatable) Collection containing the predecessors of a stage.
DeployStageType string
(Updatable) Deployment stage type.
DeploymentSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the deployment specification.
Description string
(Updatable) Optional description about the deployment stage.
DisplayName string
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
DockerImageDeployArtifactId string
(Updatable) A Docker image artifact OCID.
FailurePolicy DeployStageFailurePolicy
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
FreeformTags Dictionary<string, string>
(Updatable) 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"}
FunctionDeployEnvironmentId string
(Updatable) Function environment OCID.
FunctionTimeoutInSeconds int
(Updatable) Timeout for execution of the Function. Value in seconds.
GreenBackendIps DeployStageGreenBackendIps
(Updatable) Collection of backend environment IP addresses.
HelmChartDeployArtifactId string
(Updatable) Helm chart artifact OCID.
HelmCommandArtifactIds List<string>
(Updatable) List of Helm command artifact OCIDs.
IsAsync bool
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
IsDebugEnabled bool
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
IsForceEnabled bool
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
IsUninstallOnStageDelete bool
(Updatable) Uninstall the Helm chart release on deleting the stage.
IsValidationEnabled bool
(Updatable) A boolean flag specifies whether the invoked function should be validated.
KubernetesManifestDeployArtifactIds List<string>
(Updatable) 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.
LoadBalancerConfig DeployStageLoadBalancerConfig
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
MaxMemoryInMbs string
(Updatable) Maximum usable memory for the Function (in MB).
Namespace string
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
OkeBlueGreenDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
OkeCanaryDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment stage in this pipeline.
OkeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
OkeClusterDeployEnvironmentId string
(Updatable) Kubernetes cluster environment OCID for deployment.
ProductionLoadBalancerConfig Changes to this property will trigger replacement. DeployStageProductionLoadBalancerConfig
Specifies configuration 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
(Updatable) The purpose of running this Helm stage
ReleaseName string
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
RollbackPolicy DeployStageRollbackPolicy
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
RolloutPolicy DeployStageRolloutPolicy
(Updatable) Description of rollout policy for load balancer traffic shift stage.
SetString DeployStageSetString
(Updatable) Specifies the name and value pairs to set helm values.
SetValues DeployStageSetValues
(Updatable) Specifies the name and value pairs to set helm values.
ShouldCleanupOnFail bool
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
ShouldNotWait bool
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
ShouldResetValues bool
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
ShouldReuseValues bool
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
ShouldSkipCrds bool
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
ShouldSkipRenderSubchartNotes bool
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
State string
The current state of the deployment stage.
SystemTags 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"}
TestLoadBalancerConfig DeployStageTestLoadBalancerConfig
(Updatable) Specifies configuration 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.
TimeoutInSeconds int
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
TrafficShiftTarget string
(Updatable) Specifies the target or destination backend set.
ValuesArtifactIds List<string>
(Updatable) List of values.yaml file artifact OCIDs.
WaitCriteria DeployStageWaitCriteria
(Updatable) Specifies wait criteria for the Wait stage.
ApprovalPolicy DeployStageApprovalPolicyArgs
(Updatable) Specifies the approval policy.
AreHooksEnabled bool
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
BlueBackendIps DeployStageBlueBackendIpsArgs
(Updatable) Collection of backend environment IP addresses.
BlueGreenStrategy Changes to this property will trigger replacement. DeployStageBlueGreenStrategyArgs
Specifies the required blue green release strategy for OKE deployment.
CanaryStrategy Changes to this property will trigger replacement. DeployStageCanaryStrategyArgs
Specifies the required canary release strategy for OKE deployment.
CommandSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the command specification.
CompartmentId string
The OCID of the compartment where the ContainerInstance will be created.
ComputeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
ComputeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. string
A compute instance group canary stage OCID for load balancer.
ComputeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
ComputeInstanceGroupDeployEnvironmentId string
(Updatable) A compute instance group environment OCID for rolling deployment.
Config map[string]string
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
ContainerConfig DeployStageContainerConfigArgs
(Updatable) Specifies the container configuration.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
DeployArtifactId string
(Updatable) 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.
DeployArtifactIds []string
(Updatable) The list of file artifact OCIDs to deploy.
DeployEnvironmentIdA Changes to this property will trigger replacement. string
First compute instance group environment OCID for deployment.
DeployEnvironmentIdB Changes to this property will trigger replacement. string
Second compute instance group environment OCID for deployment.
DeployPipelineId Changes to this property will trigger replacement. string
The OCID of a pipeline.
DeployStagePredecessorCollection DeployStageDeployStagePredecessorCollectionArgs
(Updatable) Collection containing the predecessors of a stage.
DeployStageType string
(Updatable) Deployment stage type.
DeploymentSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the deployment specification.
Description string
(Updatable) Optional description about the deployment stage.
DisplayName string
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
DockerImageDeployArtifactId string
(Updatable) A Docker image artifact OCID.
FailurePolicy DeployStageFailurePolicyArgs
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
FreeformTags map[string]string
(Updatable) 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"}
FunctionDeployEnvironmentId string
(Updatable) Function environment OCID.
FunctionTimeoutInSeconds int
(Updatable) Timeout for execution of the Function. Value in seconds.
GreenBackendIps DeployStageGreenBackendIpsArgs
(Updatable) Collection of backend environment IP addresses.
HelmChartDeployArtifactId string
(Updatable) Helm chart artifact OCID.
HelmCommandArtifactIds []string
(Updatable) List of Helm command artifact OCIDs.
IsAsync bool
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
IsDebugEnabled bool
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
IsForceEnabled bool
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
IsUninstallOnStageDelete bool
(Updatable) Uninstall the Helm chart release on deleting the stage.
IsValidationEnabled bool
(Updatable) A boolean flag specifies whether the invoked function should be validated.
KubernetesManifestDeployArtifactIds []string
(Updatable) 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.
LoadBalancerConfig DeployStageLoadBalancerConfigArgs
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
MaxMemoryInMbs string
(Updatable) Maximum usable memory for the Function (in MB).
Namespace string
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
OkeBlueGreenDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
OkeCanaryDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment stage in this pipeline.
OkeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
OkeClusterDeployEnvironmentId string
(Updatable) Kubernetes cluster environment OCID for deployment.
ProductionLoadBalancerConfig Changes to this property will trigger replacement. DeployStageProductionLoadBalancerConfigArgs
Specifies configuration 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
(Updatable) The purpose of running this Helm stage
ReleaseName string
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
RollbackPolicy DeployStageRollbackPolicyArgs
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
RolloutPolicy DeployStageRolloutPolicyArgs
(Updatable) Description of rollout policy for load balancer traffic shift stage.
SetString DeployStageSetStringArgs
(Updatable) Specifies the name and value pairs to set helm values.
SetValues DeployStageSetValuesArgs
(Updatable) Specifies the name and value pairs to set helm values.
ShouldCleanupOnFail bool
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
ShouldNotWait bool
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
ShouldResetValues bool
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
ShouldReuseValues bool
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
ShouldSkipCrds bool
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
ShouldSkipRenderSubchartNotes bool
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
State string
The current state of the deployment stage.
SystemTags 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"}
TestLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs
(Updatable) Specifies configuration 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.
TimeoutInSeconds int
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
TrafficShiftTarget string
(Updatable) Specifies the target or destination backend set.
ValuesArtifactIds []string
(Updatable) List of values.yaml file artifact OCIDs.
WaitCriteria DeployStageWaitCriteriaArgs
(Updatable) Specifies wait criteria for the Wait stage.
approvalPolicy DeployStageApprovalPolicy
(Updatable) Specifies the approval policy.
areHooksEnabled Boolean
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
blueBackendIps DeployStageBlueBackendIps
(Updatable) Collection of backend environment IP addresses.
blueGreenStrategy Changes to this property will trigger replacement. DeployStageBlueGreenStrategy
Specifies the required blue green release strategy for OKE deployment.
canaryStrategy Changes to this property will trigger replacement. DeployStageCanaryStrategy
Specifies the required canary release strategy for OKE deployment.
commandSpecDeployArtifactId String
(Updatable) The OCID of the artifact that contains the command specification.
compartmentId String
The OCID of the compartment where the ContainerInstance will be created.
computeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. String
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
computeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. String
A compute instance group canary stage OCID for load balancer.
computeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. String
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
computeInstanceGroupDeployEnvironmentId String
(Updatable) A compute instance group environment OCID for rolling deployment.
config Map<String,String>
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
containerConfig DeployStageContainerConfig
(Updatable) Specifies the container configuration.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deployArtifactId String
(Updatable) 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.
deployArtifactIds List<String>
(Updatable) The list of file artifact OCIDs to deploy.
deployEnvironmentIdA Changes to this property will trigger replacement. String
First compute instance group environment OCID for deployment.
deployEnvironmentIdB Changes to this property will trigger replacement. String
Second compute instance group environment OCID for deployment.
deployPipelineId Changes to this property will trigger replacement. String
The OCID of a pipeline.
deployStagePredecessorCollection DeployStageDeployStagePredecessorCollection
(Updatable) Collection containing the predecessors of a stage.
deployStageType String
(Updatable) Deployment stage type.
deploymentSpecDeployArtifactId String
(Updatable) The OCID of the artifact that contains the deployment specification.
description String
(Updatable) Optional description about the deployment stage.
displayName String
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
dockerImageDeployArtifactId String
(Updatable) A Docker image artifact OCID.
failurePolicy DeployStageFailurePolicy
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
freeformTags Map<String,String>
(Updatable) 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"}
functionDeployEnvironmentId String
(Updatable) Function environment OCID.
functionTimeoutInSeconds Integer
(Updatable) Timeout for execution of the Function. Value in seconds.
greenBackendIps DeployStageGreenBackendIps
(Updatable) Collection of backend environment IP addresses.
helmChartDeployArtifactId String
(Updatable) Helm chart artifact OCID.
helmCommandArtifactIds List<String>
(Updatable) List of Helm command artifact OCIDs.
isAsync Boolean
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
isDebugEnabled Boolean
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
isForceEnabled Boolean
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
isUninstallOnStageDelete Boolean
(Updatable) Uninstall the Helm chart release on deleting the stage.
isValidationEnabled Boolean
(Updatable) A boolean flag specifies whether the invoked function should be validated.
kubernetesManifestDeployArtifactIds List<String>
(Updatable) 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.
loadBalancerConfig DeployStageLoadBalancerConfig
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
maxMemoryInMbs String
(Updatable) Maximum usable memory for the Function (in MB).
namespace String
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
okeBlueGreenDeployStageId Changes to this property will trigger replacement. String
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
okeCanaryDeployStageId Changes to this property will trigger replacement. String
The OCID of an upstream OKE canary deployment stage in this pipeline.
okeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. String
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
okeClusterDeployEnvironmentId String
(Updatable) Kubernetes cluster environment OCID for deployment.
productionLoadBalancerConfig Changes to this property will trigger replacement. DeployStageProductionLoadBalancerConfig
Specifies configuration 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
(Updatable) The purpose of running this Helm stage
releaseName String
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
rollbackPolicy DeployStageRollbackPolicy
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
rolloutPolicy DeployStageRolloutPolicy
(Updatable) Description of rollout policy for load balancer traffic shift stage.
setString DeployStageSetString
(Updatable) Specifies the name and value pairs to set helm values.
setValues DeployStageSetValues
(Updatable) Specifies the name and value pairs to set helm values.
shouldCleanupOnFail Boolean
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
shouldNotWait Boolean
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
shouldResetValues Boolean
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
shouldReuseValues Boolean
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
shouldSkipCrds Boolean
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
shouldSkipRenderSubchartNotes Boolean
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
state String
The current state of the deployment stage.
systemTags 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"}
testLoadBalancerConfig DeployStageTestLoadBalancerConfig
(Updatable) Specifies configuration 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.
timeoutInSeconds Integer
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
trafficShiftTarget String
(Updatable) Specifies the target or destination backend set.
valuesArtifactIds List<String>
(Updatable) List of values.yaml file artifact OCIDs.
waitCriteria DeployStageWaitCriteria
(Updatable) Specifies wait criteria for the Wait stage.
approvalPolicy DeployStageApprovalPolicy
(Updatable) Specifies the approval policy.
areHooksEnabled boolean
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
blueBackendIps DeployStageBlueBackendIps
(Updatable) Collection of backend environment IP addresses.
blueGreenStrategy Changes to this property will trigger replacement. DeployStageBlueGreenStrategy
Specifies the required blue green release strategy for OKE deployment.
canaryStrategy Changes to this property will trigger replacement. DeployStageCanaryStrategy
Specifies the required canary release strategy for OKE deployment.
commandSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the command specification.
compartmentId string
The OCID of the compartment where the ContainerInstance will be created.
computeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
computeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. string
A compute instance group canary stage OCID for load balancer.
computeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
computeInstanceGroupDeployEnvironmentId string
(Updatable) A compute instance group environment OCID for rolling deployment.
config {[key: string]: string}
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
containerConfig DeployStageContainerConfig
(Updatable) Specifies the container configuration.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deployArtifactId string
(Updatable) 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.
deployArtifactIds string[]
(Updatable) The list of file artifact OCIDs to deploy.
deployEnvironmentIdA Changes to this property will trigger replacement. string
First compute instance group environment OCID for deployment.
deployEnvironmentIdB Changes to this property will trigger replacement. string
Second compute instance group environment OCID for deployment.
deployPipelineId Changes to this property will trigger replacement. string
The OCID of a pipeline.
deployStagePredecessorCollection DeployStageDeployStagePredecessorCollection
(Updatable) Collection containing the predecessors of a stage.
deployStageType string
(Updatable) Deployment stage type.
deploymentSpecDeployArtifactId string
(Updatable) The OCID of the artifact that contains the deployment specification.
description string
(Updatable) Optional description about the deployment stage.
displayName string
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
dockerImageDeployArtifactId string
(Updatable) A Docker image artifact OCID.
failurePolicy DeployStageFailurePolicy
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
freeformTags {[key: string]: string}
(Updatable) 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"}
functionDeployEnvironmentId string
(Updatable) Function environment OCID.
functionTimeoutInSeconds number
(Updatable) Timeout for execution of the Function. Value in seconds.
greenBackendIps DeployStageGreenBackendIps
(Updatable) Collection of backend environment IP addresses.
helmChartDeployArtifactId string
(Updatable) Helm chart artifact OCID.
helmCommandArtifactIds string[]
(Updatable) List of Helm command artifact OCIDs.
isAsync boolean
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
isDebugEnabled boolean
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
isForceEnabled boolean
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
isUninstallOnStageDelete boolean
(Updatable) Uninstall the Helm chart release on deleting the stage.
isValidationEnabled boolean
(Updatable) A boolean flag specifies whether the invoked function should be validated.
kubernetesManifestDeployArtifactIds string[]
(Updatable) 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.
loadBalancerConfig DeployStageLoadBalancerConfig
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
maxMemoryInMbs string
(Updatable) Maximum usable memory for the Function (in MB).
namespace string
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
okeBlueGreenDeployStageId Changes to this property will trigger replacement. string
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
okeCanaryDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment stage in this pipeline.
okeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. string
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
okeClusterDeployEnvironmentId string
(Updatable) Kubernetes cluster environment OCID for deployment.
productionLoadBalancerConfig Changes to this property will trigger replacement. DeployStageProductionLoadBalancerConfig
Specifies configuration 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
(Updatable) The purpose of running this Helm stage
releaseName string
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
rollbackPolicy DeployStageRollbackPolicy
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
rolloutPolicy DeployStageRolloutPolicy
(Updatable) Description of rollout policy for load balancer traffic shift stage.
setString DeployStageSetString
(Updatable) Specifies the name and value pairs to set helm values.
setValues DeployStageSetValues
(Updatable) Specifies the name and value pairs to set helm values.
shouldCleanupOnFail boolean
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
shouldNotWait boolean
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
shouldResetValues boolean
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
shouldReuseValues boolean
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
shouldSkipCrds boolean
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
shouldSkipRenderSubchartNotes boolean
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
state string
The current state of the deployment stage.
systemTags {[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"}
testLoadBalancerConfig DeployStageTestLoadBalancerConfig
(Updatable) Specifies configuration 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.
timeoutInSeconds number
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
trafficShiftTarget string
(Updatable) Specifies the target or destination backend set.
valuesArtifactIds string[]
(Updatable) List of values.yaml file artifact OCIDs.
waitCriteria DeployStageWaitCriteria
(Updatable) Specifies wait criteria for the Wait stage.
approval_policy devops.DeployStageApprovalPolicyArgs
(Updatable) Specifies the approval policy.
are_hooks_enabled bool
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
blue_backend_ips devops.DeployStageBlueBackendIpsArgs
(Updatable) Collection of backend environment IP addresses.
blue_green_strategy Changes to this property will trigger replacement. devops.DeployStageBlueGreenStrategyArgs
Specifies the required blue green release strategy for OKE deployment.
canary_strategy Changes to this property will trigger replacement. devops.DeployStageCanaryStrategyArgs
Specifies the required canary release strategy for OKE deployment.
command_spec_deploy_artifact_id str
(Updatable) 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_group_blue_green_deployment_deploy_stage_id Changes to this property will trigger replacement. str
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
compute_instance_group_canary_deploy_stage_id Changes to this property will trigger replacement. str
A compute instance group canary stage OCID for load balancer.
compute_instance_group_canary_traffic_shift_deploy_stage_id Changes to this property will trigger replacement. str
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
compute_instance_group_deploy_environment_id str
(Updatable) A compute instance group environment OCID for rolling deployment.
config Mapping[str, str]
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
container_config devops.DeployStageContainerConfigArgs
(Updatable) Specifies the container configuration.
defined_tags Mapping[str, str]
(Updatable) 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_id str
(Updatable) 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_ids Sequence[str]
(Updatable) The list of file artifact OCIDs to deploy.
deploy_environment_id_a Changes to this property will trigger replacement. str
First compute instance group environment OCID for deployment.
deploy_environment_id_b Changes to this property will trigger replacement. str
Second compute instance group environment OCID for deployment.
deploy_pipeline_id Changes to this property will trigger replacement. str
The OCID of a pipeline.
deploy_stage_predecessor_collection devops.DeployStageDeployStagePredecessorCollectionArgs
(Updatable) Collection containing the predecessors of a stage.
deploy_stage_type str
(Updatable) Deployment stage type.
deployment_spec_deploy_artifact_id str
(Updatable) The OCID of the artifact that contains the deployment specification.
description str
(Updatable) Optional description about the deployment stage.
display_name str
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
docker_image_deploy_artifact_id str
(Updatable) A Docker image artifact OCID.
failure_policy devops.DeployStageFailurePolicyArgs
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
freeform_tags Mapping[str, str]
(Updatable) 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_environment_id str
(Updatable) Function environment OCID.
function_timeout_in_seconds int
(Updatable) Timeout for execution of the Function. Value in seconds.
green_backend_ips devops.DeployStageGreenBackendIpsArgs
(Updatable) Collection of backend environment IP addresses.
helm_chart_deploy_artifact_id str
(Updatable) Helm chart artifact OCID.
helm_command_artifact_ids Sequence[str]
(Updatable) List of Helm command artifact OCIDs.
is_async bool
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
is_debug_enabled bool
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
is_force_enabled bool
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
is_uninstall_on_stage_delete bool
(Updatable) Uninstall the Helm chart release on deleting the stage.
is_validation_enabled bool
(Updatable) A boolean flag specifies whether the invoked function should be validated.
kubernetes_manifest_deploy_artifact_ids Sequence[str]
(Updatable) 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_config devops.DeployStageLoadBalancerConfigArgs
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
max_memory_in_mbs str
(Updatable) Maximum usable memory for the Function (in MB).
namespace str
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
oke_blue_green_deploy_stage_id Changes to this property will trigger replacement. str
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
oke_canary_deploy_stage_id Changes to this property will trigger replacement. str
The OCID of an upstream OKE canary deployment stage in this pipeline.
oke_canary_traffic_shift_deploy_stage_id Changes to this property will trigger replacement. str
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
oke_cluster_deploy_environment_id str
(Updatable) Kubernetes cluster environment OCID for deployment.
production_load_balancer_config Changes to this property will trigger replacement. devops.DeployStageProductionLoadBalancerConfigArgs
Specifies configuration 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
(Updatable) The purpose of running this Helm stage
release_name str
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
rollback_policy devops.DeployStageRollbackPolicyArgs
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
rollout_policy devops.DeployStageRolloutPolicyArgs
(Updatable) Description of rollout policy for load balancer traffic shift stage.
set_string devops.DeployStageSetStringArgs
(Updatable) Specifies the name and value pairs to set helm values.
set_values devops.DeployStageSetValuesArgs
(Updatable) Specifies the name and value pairs to set helm values.
should_cleanup_on_fail bool
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
should_not_wait bool
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
should_reset_values bool
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
should_reuse_values bool
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
should_skip_crds bool
(Updatable) 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_render_subchart_notes bool
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
state str
The current state of the deployment stage.
system_tags 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_balancer_config devops.DeployStageTestLoadBalancerConfigArgs
(Updatable) Specifies configuration 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_seconds int
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
traffic_shift_target str
(Updatable) Specifies the target or destination backend set.
values_artifact_ids Sequence[str]
(Updatable) List of values.yaml file artifact OCIDs.
wait_criteria devops.DeployStageWaitCriteriaArgs
(Updatable) Specifies wait criteria for the Wait stage.
approvalPolicy Property Map
(Updatable) Specifies the approval policy.
areHooksEnabled Boolean
(Updatable) Disable pre/post upgrade hooks. Set to false by default.
blueBackendIps Property Map
(Updatable) Collection of backend environment IP addresses.
blueGreenStrategy Changes to this property will trigger replacement. Property Map
Specifies the required blue green release strategy for OKE deployment.
canaryStrategy Changes to this property will trigger replacement. Property Map
Specifies the required canary release strategy for OKE deployment.
commandSpecDeployArtifactId String
(Updatable) The OCID of the artifact that contains the command specification.
compartmentId String
The OCID of the compartment where the ContainerInstance will be created.
computeInstanceGroupBlueGreenDeploymentDeployStageId Changes to this property will trigger replacement. String
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
computeInstanceGroupCanaryDeployStageId Changes to this property will trigger replacement. String
A compute instance group canary stage OCID for load balancer.
computeInstanceGroupCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. String
(Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
computeInstanceGroupDeployEnvironmentId String
(Updatable) A compute instance group environment OCID for rolling deployment.
config Map<String>
(Updatable) User provided key and value pair configuration, which is assigned through constants or parameter.
containerConfig Property Map
(Updatable) Specifies the container configuration.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deployArtifactId String
(Updatable) 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.
deployArtifactIds List<String>
(Updatable) The list of file artifact OCIDs to deploy.
deployEnvironmentIdA Changes to this property will trigger replacement. String
First compute instance group environment OCID for deployment.
deployEnvironmentIdB Changes to this property will trigger replacement. String
Second compute instance group environment OCID for deployment.
deployPipelineId Changes to this property will trigger replacement. String
The OCID of a pipeline.
deployStagePredecessorCollection Property Map
(Updatable) Collection containing the predecessors of a stage.
deployStageType String
(Updatable) Deployment stage type.
deploymentSpecDeployArtifactId String
(Updatable) The OCID of the artifact that contains the deployment specification.
description String
(Updatable) Optional description about the deployment stage.
displayName String
(Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
dockerImageDeployArtifactId String
(Updatable) A Docker image artifact OCID.
failurePolicy Property Map
(Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
freeformTags Map<String>
(Updatable) 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"}
functionDeployEnvironmentId String
(Updatable) Function environment OCID.
functionTimeoutInSeconds Number
(Updatable) Timeout for execution of the Function. Value in seconds.
greenBackendIps Property Map
(Updatable) Collection of backend environment IP addresses.
helmChartDeployArtifactId String
(Updatable) Helm chart artifact OCID.
helmCommandArtifactIds List<String>
(Updatable) List of Helm command artifact OCIDs.
isAsync Boolean
(Updatable) A boolean flag specifies whether this stage executes asynchronously.
isDebugEnabled Boolean
(Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
isForceEnabled Boolean
(Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
isUninstallOnStageDelete Boolean
(Updatable) Uninstall the Helm chart release on deleting the stage.
isValidationEnabled Boolean
(Updatable) A boolean flag specifies whether the invoked function should be validated.
kubernetesManifestDeployArtifactIds List<String>
(Updatable) 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.
loadBalancerConfig Property Map
(Updatable) 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
(Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
maxMemoryInMbs String
(Updatable) Maximum usable memory for the Function (in MB).
namespace String
(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.
okeBlueGreenDeployStageId Changes to this property will trigger replacement. String
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
okeCanaryDeployStageId Changes to this property will trigger replacement. String
The OCID of an upstream OKE canary deployment stage in this pipeline.
okeCanaryTrafficShiftDeployStageId Changes to this property will trigger replacement. String
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
okeClusterDeployEnvironmentId String
(Updatable) Kubernetes cluster environment OCID for deployment.
productionLoadBalancerConfig Changes to this property will trigger replacement. Property Map
Specifies configuration 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
(Updatable) The purpose of running this Helm stage
releaseName String
(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
rollbackPolicy Property Map
(Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
rolloutPolicy Property Map
(Updatable) Description of rollout policy for load balancer traffic shift stage.
setString Property Map
(Updatable) Specifies the name and value pairs to set helm values.
setValues Property Map
(Updatable) Specifies the name and value pairs to set helm values.
shouldCleanupOnFail Boolean
(Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
shouldNotWait Boolean
(Updatable) Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.
shouldResetValues Boolean
(Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
shouldReuseValues Boolean
(Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
shouldSkipCrds Boolean
(Updatable) If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
shouldSkipRenderSubchartNotes Boolean
(Updatable) If set, renders subchart notes along with the parent. Set to false by default.
state String
The current state of the deployment stage.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
testLoadBalancerConfig Property Map
(Updatable) Specifies configuration 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.
timeoutInSeconds Number
(Updatable) Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage
trafficShiftTarget String
(Updatable) Specifies the target or destination backend set.
valuesArtifactIds List<String>
(Updatable) List of values.yaml file artifact OCIDs.
waitCriteria Property Map
(Updatable) Specifies wait criteria for the Wait stage.

Supporting Types

DeployStageApprovalPolicy
, DeployStageApprovalPolicyArgs

ApprovalPolicyType This property is required. string
(Updatable) Approval policy type.
NumberOfApprovalsRequired This property is required. int
(Updatable) A minimum number of approvals required for stage to proceed.
ApprovalPolicyType This property is required. string
(Updatable) Approval policy type.
NumberOfApprovalsRequired This property is required. int
(Updatable) A minimum number of approvals required for stage to proceed.
approvalPolicyType This property is required. String
(Updatable) Approval policy type.
numberOfApprovalsRequired This property is required. Integer
(Updatable) A minimum number of approvals required for stage to proceed.
approvalPolicyType This property is required. string
(Updatable) Approval policy type.
numberOfApprovalsRequired This property is required. number
(Updatable) A minimum number of approvals required for stage to proceed.
approval_policy_type This property is required. str
(Updatable) Approval policy type.
number_of_approvals_required This property is required. int
(Updatable) A minimum number of approvals required for stage to proceed.
approvalPolicyType This property is required. String
(Updatable) Approval policy type.
numberOfApprovalsRequired This property is required. Number
(Updatable) A minimum number of approvals required for stage to proceed.

DeployStageBlueBackendIps
, DeployStageBlueBackendIpsArgs

Items List<string>
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
Items []string
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
items List<String>
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
items string[]
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
items Sequence[str]
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
items List<String>
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

DeployStageBlueGreenStrategy
, DeployStageBlueGreenStrategyArgs

IngressName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Ingress resource.
NamespaceA
This property is required.
Changes to this property will trigger replacement.
string
First Namespace for deployment.
NamespaceB
This property is required.
Changes to this property will trigger replacement.
string
Second Namespace for deployment.
StrategyType
This property is required.
Changes to this property will trigger replacement.
string
Blue Green strategy type
IngressName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Ingress resource.
NamespaceA
This property is required.
Changes to this property will trigger replacement.
string
First Namespace for deployment.
NamespaceB
This property is required.
Changes to this property will trigger replacement.
string
Second Namespace for deployment.
StrategyType
This property is required.
Changes to this property will trigger replacement.
string
Blue Green strategy type
ingressName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Ingress resource.
namespaceA
This property is required.
Changes to this property will trigger replacement.
String
First Namespace for deployment.
namespaceB
This property is required.
Changes to this property will trigger replacement.
String
Second Namespace for deployment.
strategyType
This property is required.
Changes to this property will trigger replacement.
String
Blue Green strategy type
ingressName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Ingress resource.
namespaceA
This property is required.
Changes to this property will trigger replacement.
string
First Namespace for deployment.
namespaceB
This property is required.
Changes to this property will trigger replacement.
string
Second Namespace for deployment.
strategyType
This property is required.
Changes to this property will trigger replacement.
string
Blue Green strategy type
ingress_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Ingress resource.
namespace_a
This property is required.
Changes to this property will trigger replacement.
str
First Namespace for deployment.
namespace_b
This property is required.
Changes to this property will trigger replacement.
str
Second Namespace for deployment.
strategy_type
This property is required.
Changes to this property will trigger replacement.
str
Blue Green strategy type
ingressName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Ingress resource.
namespaceA
This property is required.
Changes to this property will trigger replacement.
String
First Namespace for deployment.
namespaceB
This property is required.
Changes to this property will trigger replacement.
String
Second Namespace for deployment.
strategyType
This property is required.
Changes to this property will trigger replacement.
String
Blue Green strategy type

DeployStageCanaryStrategy
, DeployStageCanaryStrategyArgs

IngressName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Ingress resource.
Namespace
This property is required.
Changes to this property will trigger replacement.
string
Canary namespace to be used for Kubernetes canary deployment.
StrategyType
This property is required.
Changes to this property will trigger replacement.
string
Canary strategy type.
IngressName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Ingress resource.
Namespace
This property is required.
Changes to this property will trigger replacement.
string
Canary namespace to be used for Kubernetes canary deployment.
StrategyType
This property is required.
Changes to this property will trigger replacement.
string
Canary strategy type.
ingressName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Ingress resource.
namespace
This property is required.
Changes to this property will trigger replacement.
String
Canary namespace to be used for Kubernetes canary deployment.
strategyType
This property is required.
Changes to this property will trigger replacement.
String
Canary strategy type.
ingressName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Ingress resource.
namespace
This property is required.
Changes to this property will trigger replacement.
string
Canary namespace to be used for Kubernetes canary deployment.
strategyType
This property is required.
Changes to this property will trigger replacement.
string
Canary strategy type.
ingress_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Ingress resource.
namespace
This property is required.
Changes to this property will trigger replacement.
str
Canary namespace to be used for Kubernetes canary deployment.
strategy_type
This property is required.
Changes to this property will trigger replacement.
str
Canary strategy type.
ingressName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Ingress resource.
namespace
This property is required.
Changes to this property will trigger replacement.
String
Canary namespace to be used for Kubernetes canary deployment.
strategyType
This property is required.
Changes to this property will trigger replacement.
String
Canary strategy type.

DeployStageContainerConfig
, DeployStageContainerConfigArgs

ContainerConfigType This property is required. string
(Updatable) Container configuration type.
NetworkChannel This property is required. DeployStageContainerConfigNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
ShapeConfig This property is required. DeployStageContainerConfigShapeConfig
(Updatable) Determines the size and amount of resources available to the instance.
ShapeName This property is required. string
(Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
AvailabilityDomain string
(Updatable) Availability domain where the ContainerInstance will be created.
CompartmentId string
(Updatable) The OCID of the compartment where the ContainerInstance will be created.
ContainerConfigType This property is required. string
(Updatable) Container configuration type.
NetworkChannel This property is required. DeployStageContainerConfigNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
ShapeConfig This property is required. DeployStageContainerConfigShapeConfig
(Updatable) Determines the size and amount of resources available to the instance.
ShapeName This property is required. string
(Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
AvailabilityDomain string
(Updatable) Availability domain where the ContainerInstance will be created.
CompartmentId string
(Updatable) The OCID of the compartment where the ContainerInstance will be created.
containerConfigType This property is required. String
(Updatable) Container configuration type.
networkChannel This property is required. DeployStageContainerConfigNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
shapeConfig This property is required. DeployStageContainerConfigShapeConfig
(Updatable) Determines the size and amount of resources available to the instance.
shapeName This property is required. String
(Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
availabilityDomain String
(Updatable) Availability domain where the ContainerInstance will be created.
compartmentId String
(Updatable) The OCID of the compartment where the ContainerInstance will be created.
containerConfigType This property is required. string
(Updatable) Container configuration type.
networkChannel This property is required. DeployStageContainerConfigNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
shapeConfig This property is required. DeployStageContainerConfigShapeConfig
(Updatable) Determines the size and amount of resources available to the instance.
shapeName This property is required. string
(Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
availabilityDomain string
(Updatable) Availability domain where the ContainerInstance will be created.
compartmentId string
(Updatable) The OCID of the compartment where the ContainerInstance will be created.
container_config_type This property is required. str
(Updatable) Container configuration type.
network_channel This property is required. devops.DeployStageContainerConfigNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
shape_config This property is required. devops.DeployStageContainerConfigShapeConfig
(Updatable) Determines the size and amount of resources available to the instance.
shape_name This property is required. str
(Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
availability_domain str
(Updatable) Availability domain where the ContainerInstance will be created.
compartment_id str
(Updatable) The OCID of the compartment where the ContainerInstance will be created.
containerConfigType This property is required. String
(Updatable) Container configuration type.
networkChannel This property is required. Property Map
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
shapeConfig This property is required. Property Map
(Updatable) Determines the size and amount of resources available to the instance.
shapeName This property is required. String
(Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
availabilityDomain String
(Updatable) Availability domain where the ContainerInstance will be created.
compartmentId String
(Updatable) The OCID of the compartment where the ContainerInstance will be created.

DeployStageContainerConfigNetworkChannel
, DeployStageContainerConfigNetworkChannelArgs

NetworkChannelType This property is required. string
(Updatable) Network channel type.
SubnetId This property is required. string
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
NsgIds List<string>
(Updatable) An array of network security group OCIDs.
NetworkChannelType This property is required. string
(Updatable) Network channel type.
SubnetId This property is required. string
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
NsgIds []string
(Updatable) An array of network security group OCIDs.
networkChannelType This property is required. String
(Updatable) Network channel type.
subnetId This property is required. String
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
nsgIds List<String>
(Updatable) An array of network security group OCIDs.
networkChannelType This property is required. string
(Updatable) Network channel type.
subnetId This property is required. string
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
nsgIds string[]
(Updatable) An array of network security group OCIDs.
network_channel_type This property is required. str
(Updatable) Network channel type.
subnet_id This property is required. str
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
nsg_ids Sequence[str]
(Updatable) An array of network security group OCIDs.
networkChannelType This property is required. String
(Updatable) Network channel type.
subnetId This property is required. String
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
nsgIds List<String>
(Updatable) An array of network security group OCIDs.

DeployStageContainerConfigShapeConfig
, DeployStageContainerConfigShapeConfigArgs

Ocpus This property is required. double
(Updatable) The total number of OCPUs available to the instance.
MemoryInGbs double
(Updatable) The total amount of memory available to the instance, in gigabytes.
Ocpus This property is required. float64
(Updatable) The total number of OCPUs available to the instance.
MemoryInGbs float64
(Updatable) The total amount of memory available to the instance, in gigabytes.
ocpus This property is required. Double
(Updatable) The total number of OCPUs available to the instance.
memoryInGbs Double
(Updatable) The total amount of memory available to the instance, in gigabytes.
ocpus This property is required. number
(Updatable) The total number of OCPUs available to the instance.
memoryInGbs number
(Updatable) The total amount of memory available to the instance, in gigabytes.
ocpus This property is required. float
(Updatable) The total number of OCPUs available to the instance.
memory_in_gbs float
(Updatable) The total amount of memory available to the instance, in gigabytes.
ocpus This property is required. Number
(Updatable) The total number of OCPUs available to the instance.
memoryInGbs Number
(Updatable) The total amount of memory available to the instance, in gigabytes.

DeployStageDeployStagePredecessorCollection
, DeployStageDeployStagePredecessorCollectionArgs

Items This property is required. List<DeployStageDeployStagePredecessorCollectionItem>
(Updatable) A list of stage predecessors for a stage.
Items This property is required. []DeployStageDeployStagePredecessorCollectionItem
(Updatable) A list of stage predecessors for a stage.
items This property is required. List<DeployStageDeployStagePredecessorCollectionItem>
(Updatable) A list of stage predecessors for a stage.
items This property is required. DeployStageDeployStagePredecessorCollectionItem[]
(Updatable) A list of stage predecessors for a stage.
items This property is required. Sequence[devops.DeployStageDeployStagePredecessorCollectionItem]
(Updatable) A list of stage predecessors for a stage.
items This property is required. List<Property Map>
(Updatable) A list of stage predecessors for a stage.

DeployStageDeployStagePredecessorCollectionItem
, DeployStageDeployStagePredecessorCollectionItemArgs

Id This property is required. string
(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.
Id This property is required. string
(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.
id This property is required. String
(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.
id This property is required. string
(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.
id This property is required. str
(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.
id This property is required. String
(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.

DeployStageFailurePolicy
, DeployStageFailurePolicyArgs

PolicyType This property is required. string
(Updatable) Specifies if the failure instance size is given by absolute number or by percentage.
FailureCount int
(Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
FailurePercentage int
(Updatable) 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 This property is required. string
(Updatable) Specifies if the failure instance size is given by absolute number or by percentage.
FailureCount int
(Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
FailurePercentage int
(Updatable) 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 This property is required. String
(Updatable) Specifies if the failure instance size is given by absolute number or by percentage.
failureCount Integer
(Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
failurePercentage Integer
(Updatable) 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 This property is required. string
(Updatable) Specifies if the failure instance size is given by absolute number or by percentage.
failureCount number
(Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
failurePercentage number
(Updatable) 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 This property is required. str
(Updatable) Specifies if the failure instance size is given by absolute number or by percentage.
failure_count int
(Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
failure_percentage int
(Updatable) 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 This property is required. String
(Updatable) Specifies if the failure instance size is given by absolute number or by percentage.
failureCount Number
(Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
failurePercentage Number
(Updatable) 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.

DeployStageGreenBackendIps
, DeployStageGreenBackendIpsArgs

Items List<string>
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
Items []string
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
items List<String>
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
items string[]
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
items Sequence[str]
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.
items List<String>
(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

DeployStageLoadBalancerConfig
, DeployStageLoadBalancerConfigArgs

BackendPort int
(Updatable) Listen port for the backend server.
ListenerName string
(Updatable) Name of the load balancer listener.
LoadBalancerId string
(Updatable) The OCID of the load balancer.
State string
The current state of the deployment stage.
BackendPort int
(Updatable) Listen port for the backend server.
ListenerName string
(Updatable) Name of the load balancer listener.
LoadBalancerId string
(Updatable) The OCID of the load balancer.
State string
The current state of the deployment stage.
backendPort Integer
(Updatable) Listen port for the backend server.
listenerName String
(Updatable) Name of the load balancer listener.
loadBalancerId String
(Updatable) The OCID of the load balancer.
state String
The current state of the deployment stage.
backendPort number
(Updatable) Listen port for the backend server.
listenerName string
(Updatable) Name of the load balancer listener.
loadBalancerId string
(Updatable) The OCID of the load balancer.
state string
The current state of the deployment stage.
backend_port int
(Updatable) Listen port for the backend server.
listener_name str
(Updatable) Name of the load balancer listener.
load_balancer_id str
(Updatable) The OCID of the load balancer.
state str
The current state of the deployment stage.
backendPort Number
(Updatable) Listen port for the backend server.
listenerName String
(Updatable) Name of the load balancer listener.
loadBalancerId String
(Updatable) The OCID of the load balancer.
state String
The current state of the deployment stage.

DeployStageProductionLoadBalancerConfig
, DeployStageProductionLoadBalancerConfigArgs

BackendPort Changes to this property will trigger replacement. int
Listen port for the backend server.
ListenerName Changes to this property will trigger replacement. string
Name of the load balancer listener.
LoadBalancerId Changes to this property will trigger replacement. string
The OCID of the load balancer.
State string
The current state of the deployment stage.
BackendPort Changes to this property will trigger replacement. int
Listen port for the backend server.
ListenerName Changes to this property will trigger replacement. string
Name of the load balancer listener.
LoadBalancerId Changes to this property will trigger replacement. string
The OCID of the load balancer.
State string
The current state of the deployment stage.
backendPort Changes to this property will trigger replacement. Integer
Listen port for the backend server.
listenerName Changes to this property will trigger replacement. String
Name of the load balancer listener.
loadBalancerId Changes to this property will trigger replacement. String
The OCID of the load balancer.
state String
The current state of the deployment stage.
backendPort Changes to this property will trigger replacement. number
Listen port for the backend server.
listenerName Changes to this property will trigger replacement. string
Name of the load balancer listener.
loadBalancerId Changes to this property will trigger replacement. string
The OCID of the load balancer.
state string
The current state of the deployment stage.
backend_port Changes to this property will trigger replacement. int
Listen port for the backend server.
listener_name Changes to this property will trigger replacement. str
Name of the load balancer listener.
load_balancer_id Changes to this property will trigger replacement. str
The OCID of the load balancer.
state str
The current state of the deployment stage.
backendPort Changes to this property will trigger replacement. Number
Listen port for the backend server.
listenerName Changes to this property will trigger replacement. String
Name of the load balancer listener.
loadBalancerId Changes to this property will trigger replacement. String
The OCID of the load balancer.
state String
The current state of the deployment stage.

DeployStageRollbackPolicy
, DeployStageRollbackPolicyArgs

PolicyType string
(Updatable) Specifies type of the deployment stage rollback policy.
PolicyType string
(Updatable) Specifies type of the deployment stage rollback policy.
policyType String
(Updatable) Specifies type of the deployment stage rollback policy.
policyType string
(Updatable) Specifies type of the deployment stage rollback policy.
policy_type str
(Updatable) Specifies type of the deployment stage rollback policy.
policyType String
(Updatable) Specifies type of the deployment stage rollback policy.

DeployStageRolloutPolicy
, DeployStageRolloutPolicyArgs

BatchCount int
(Updatable) The number that will be used to determine how many instances will be deployed concurrently.
BatchDelayInSeconds int
(Updatable) The duration of delay between batch rollout. The default delay is 1 minute.
BatchPercentage int
(Updatable) The percentage that will be used to determine how many instances will be deployed concurrently.
PolicyType string
(Updatable) The type of policy used for rolling out a deployment stage.
RampLimitPercent double
(Updatable) Indicates the criteria to stop.
BatchCount int
(Updatable) The number that will be used to determine how many instances will be deployed concurrently.
BatchDelayInSeconds int
(Updatable) The duration of delay between batch rollout. The default delay is 1 minute.
BatchPercentage int
(Updatable) The percentage that will be used to determine how many instances will be deployed concurrently.
PolicyType string
(Updatable) The type of policy used for rolling out a deployment stage.
RampLimitPercent float64
(Updatable) Indicates the criteria to stop.
batchCount Integer
(Updatable) The number that will be used to determine how many instances will be deployed concurrently.
batchDelayInSeconds Integer
(Updatable) The duration of delay between batch rollout. The default delay is 1 minute.
batchPercentage Integer
(Updatable) The percentage that will be used to determine how many instances will be deployed concurrently.
policyType String
(Updatable) The type of policy used for rolling out a deployment stage.
rampLimitPercent Double
(Updatable) Indicates the criteria to stop.
batchCount number
(Updatable) The number that will be used to determine how many instances will be deployed concurrently.
batchDelayInSeconds number
(Updatable) The duration of delay between batch rollout. The default delay is 1 minute.
batchPercentage number
(Updatable) The percentage that will be used to determine how many instances will be deployed concurrently.
policyType string
(Updatable) The type of policy used for rolling out a deployment stage.
rampLimitPercent number
(Updatable) Indicates the criteria to stop.
batch_count int
(Updatable) The number that will be used to determine how many instances will be deployed concurrently.
batch_delay_in_seconds int
(Updatable) The duration of delay between batch rollout. The default delay is 1 minute.
batch_percentage int
(Updatable) The percentage that will be used to determine how many instances will be deployed concurrently.
policy_type str
(Updatable) The type of policy used for rolling out a deployment stage.
ramp_limit_percent float
(Updatable) Indicates the criteria to stop.
batchCount Number
(Updatable) The number that will be used to determine how many instances will be deployed concurrently.
batchDelayInSeconds Number
(Updatable) The duration of delay between batch rollout. The default delay is 1 minute.
batchPercentage Number
(Updatable) The percentage that will be used to determine how many instances will be deployed concurrently.
policyType String
(Updatable) The type of policy used for rolling out a deployment stage.
rampLimitPercent Number
(Updatable) Indicates the criteria to stop.

DeployStageSetString
, DeployStageSetStringArgs

Items List<DeployStageSetStringItem>
(Updatable) List of parameters defined to set helm value.
Items []DeployStageSetStringItem
(Updatable) List of parameters defined to set helm value.
items List<DeployStageSetStringItem>
(Updatable) List of parameters defined to set helm value.
items DeployStageSetStringItem[]
(Updatable) List of parameters defined to set helm value.
items Sequence[devops.DeployStageSetStringItem]
(Updatable) List of parameters defined to set helm value.
items List<Property Map>
(Updatable) List of parameters defined to set helm value.

DeployStageSetStringItem
, DeployStageSetStringItemArgs

Name string
(Updatable) Name of the parameter (case-sensitive).
Value string
(Updatable) Value of the parameter.
Name string
(Updatable) Name of the parameter (case-sensitive).
Value string
(Updatable) Value of the parameter.
name String
(Updatable) Name of the parameter (case-sensitive).
value String
(Updatable) Value of the parameter.
name string
(Updatable) Name of the parameter (case-sensitive).
value string
(Updatable) Value of the parameter.
name str
(Updatable) Name of the parameter (case-sensitive).
value str
(Updatable) Value of the parameter.
name String
(Updatable) Name of the parameter (case-sensitive).
value String
(Updatable) Value of the parameter.

DeployStageSetValues
, DeployStageSetValuesArgs

Items List<DeployStageSetValuesItem>
(Updatable) List of parameters defined to set helm value.
Items []DeployStageSetValuesItem
(Updatable) List of parameters defined to set helm value.
items List<DeployStageSetValuesItem>
(Updatable) List of parameters defined to set helm value.
items DeployStageSetValuesItem[]
(Updatable) List of parameters defined to set helm value.
items Sequence[devops.DeployStageSetValuesItem]
(Updatable) List of parameters defined to set helm value.
items List<Property Map>
(Updatable) List of parameters defined to set helm value.

DeployStageSetValuesItem
, DeployStageSetValuesItemArgs

Name string
(Updatable) Name of the parameter (case-sensitive).
Value string
(Updatable) Value of the parameter.
Name string
(Updatable) Name of the parameter (case-sensitive).
Value string
(Updatable) Value of the parameter.
name String
(Updatable) Name of the parameter (case-sensitive).
value String
(Updatable) Value of the parameter.
name string
(Updatable) Name of the parameter (case-sensitive).
value string
(Updatable) Value of the parameter.
name str
(Updatable) Name of the parameter (case-sensitive).
value str
(Updatable) Value of the parameter.
name String
(Updatable) Name of the parameter (case-sensitive).
value String
(Updatable) Value of the parameter.

DeployStageTestLoadBalancerConfig
, DeployStageTestLoadBalancerConfigArgs

BackendPort int
(Updatable) Listen port for the backend server.
ListenerName string
(Updatable) Name of the load balancer listener.
LoadBalancerId string
(Updatable) The OCID of the load balancer.
State string
The current state of the deployment stage.
BackendPort int
(Updatable) Listen port for the backend server.
ListenerName string
(Updatable) Name of the load balancer listener.
LoadBalancerId string
(Updatable) The OCID of the load balancer.
State string
The current state of the deployment stage.
backendPort Integer
(Updatable) Listen port for the backend server.
listenerName String
(Updatable) Name of the load balancer listener.
loadBalancerId String
(Updatable) The OCID of the load balancer.
state String
The current state of the deployment stage.
backendPort number
(Updatable) Listen port for the backend server.
listenerName string
(Updatable) Name of the load balancer listener.
loadBalancerId string
(Updatable) The OCID of the load balancer.
state string
The current state of the deployment stage.
backend_port int
(Updatable) Listen port for the backend server.
listener_name str
(Updatable) Name of the load balancer listener.
load_balancer_id str
(Updatable) The OCID of the load balancer.
state str
The current state of the deployment stage.
backendPort Number
(Updatable) Listen port for the backend server.
listenerName String
(Updatable) Name of the load balancer listener.
loadBalancerId String
(Updatable) The OCID of the load balancer.
state String
The current state of the deployment stage.

DeployStageWaitCriteria
, DeployStageWaitCriteriaArgs

WaitDuration This property is required. string
(Updatable) 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 This property is required. string

(Updatable) Wait criteria type.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

WaitDuration This property is required. string
(Updatable) 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 This property is required. string

(Updatable) Wait criteria type.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

waitDuration This property is required. String
(Updatable) 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 This property is required. String

(Updatable) Wait criteria type.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

waitDuration This property is required. string
(Updatable) 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 This property is required. string

(Updatable) Wait criteria type.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

wait_duration This property is required. str
(Updatable) 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 This property is required. str

(Updatable) Wait criteria type.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

waitDuration This property is required. String
(Updatable) 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 This property is required. String

(Updatable) Wait criteria type.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Import

DeployStages can be imported using the id, e.g.

$ pulumi import oci:DevOps/deployStage:DeployStage test_deploy_stage "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci