oci.DevOps.DeployStage
Explore with Pulumi AI
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 string
- The unique name of the resource.
- args DeployStageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args DeployStageArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeployStageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
},
});
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"),
},
})
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());
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",
})
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",
},
});
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
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:
- Deploy
Pipeline stringId - The OCID of a pipeline.
- Deploy
Stage DeployPredecessor Collection Stage Deploy Stage Predecessor Collection - (Updatable) Collection containing the predecessors of a stage.
- Deploy
Stage stringType - (Updatable) Deployment stage type.
- Approval
Policy DeployStage Approval Policy - (Updatable) Specifies the approval policy.
- Are
Hooks boolEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- Blue
Backend DeployIps Stage Blue Backend Ips - (Updatable) Collection of backend environment IP addresses.
- Blue
Green DeployStrategy Stage Blue Green Strategy - Specifies the required blue green release strategy for OKE deployment.
- Canary
Strategy DeployStage Canary Strategy - Specifies the required canary release strategy for OKE deployment.
- Command
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- Compute
Instance stringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- Compute
Instance stringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- Compute
Instance stringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- Compute
Instance stringGroup Deploy Environment Id - (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.
- Container
Config DeployStage Container Config - (Updatable) Specifies the container configuration.
- 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"}
- Deploy
Artifact stringId - (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 List<string>Ids - (Updatable) The list of file artifact OCIDs to deploy.
- Deploy
Environment stringId A - First compute instance group environment OCID for deployment.
- Deploy
Environment stringId B - Second compute instance group environment OCID for deployment.
- Deployment
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- Description string
- (Updatable) Optional description about the deployment stage.
- Display
Name string - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- Docker
Image stringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- Failure
Policy DeployStage Failure Policy - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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"}
- Function
Deploy stringEnvironment Id - (Updatable) Function environment OCID.
- Function
Timeout intIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- Green
Backend DeployIps Stage Green Backend Ips - (Updatable) Collection of backend environment IP addresses.
- Helm
Chart stringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- Helm
Command List<string>Artifact Ids - (Updatable) List of Helm command artifact OCIDs.
- Is
Async bool - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- Is
Debug boolEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- Is
Force boolEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- Is
Uninstall boolOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- Is
Validation boolEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- Kubernetes
Manifest List<string>Deploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- Load
Balancer DeployConfig Stage Load Balancer Config - (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 stringIn Mbs - (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.
- Oke
Blue stringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- Oke
Canary stringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- Oke
Canary stringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- Oke
Cluster stringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- Production
Load DeployBalancer Config Stage Production Load Balancer Config - 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
- Release
Name string - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- Rollback
Policy DeployStage Rollback Policy - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- Rollout
Policy DeployStage Rollout Policy - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- Set
String DeployStage Set String - (Updatable) Specifies the name and value pairs to set helm values.
- Set
Values DeployStage Set Values - (Updatable) Specifies the name and value pairs to set helm values.
- Should
Cleanup boolOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- Should
Not boolWait - (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 boolValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- Should
Reuse boolValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- Should
Skip boolCrds - (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 boolRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- Test
Load DeployBalancer Config Stage Test Load Balancer Config - (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 intSeconds - (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 stringTarget - (Updatable) Specifies the target or destination backend set.
- Values
Artifact List<string>Ids - (Updatable) List of values.yaml file artifact OCIDs.
- Wait
Criteria DeployStage Wait Criteria - (Updatable) Specifies wait criteria for the Wait stage.
- Deploy
Pipeline stringId - The OCID of a pipeline.
- Deploy
Stage DeployPredecessor Collection Stage Deploy Stage Predecessor Collection Args - (Updatable) Collection containing the predecessors of a stage.
- Deploy
Stage stringType - (Updatable) Deployment stage type.
- Approval
Policy DeployStage Approval Policy Args - (Updatable) Specifies the approval policy.
- Are
Hooks boolEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- Blue
Backend DeployIps Stage Blue Backend Ips Args - (Updatable) Collection of backend environment IP addresses.
- Blue
Green DeployStrategy Stage Blue Green Strategy Args - Specifies the required blue green release strategy for OKE deployment.
- Canary
Strategy DeployStage Canary Strategy Args - Specifies the required canary release strategy for OKE deployment.
- Command
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- Compute
Instance stringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- Compute
Instance stringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- Compute
Instance stringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- Compute
Instance stringGroup Deploy Environment Id - (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.
- Container
Config DeployStage Container Config Args - (Updatable) Specifies the container configuration.
- 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"}
- Deploy
Artifact stringId - (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 []stringIds - (Updatable) The list of file artifact OCIDs to deploy.
- Deploy
Environment stringId A - First compute instance group environment OCID for deployment.
- Deploy
Environment stringId B - Second compute instance group environment OCID for deployment.
- Deployment
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- Description string
- (Updatable) Optional description about the deployment stage.
- Display
Name string - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- Docker
Image stringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- Failure
Policy DeployStage Failure Policy Args - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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"}
- Function
Deploy stringEnvironment Id - (Updatable) Function environment OCID.
- Function
Timeout intIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- Green
Backend DeployIps Stage Green Backend Ips Args - (Updatable) Collection of backend environment IP addresses.
- Helm
Chart stringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- Helm
Command []stringArtifact Ids - (Updatable) List of Helm command artifact OCIDs.
- Is
Async bool - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- Is
Debug boolEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- Is
Force boolEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- Is
Uninstall boolOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- Is
Validation boolEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- Kubernetes
Manifest []stringDeploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- Load
Balancer DeployConfig Stage Load Balancer Config Args - (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 stringIn Mbs - (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.
- Oke
Blue stringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- Oke
Canary stringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- Oke
Canary stringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- Oke
Cluster stringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- Production
Load DeployBalancer Config Stage Production Load Balancer Config Args - 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
- Release
Name string - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- Rollback
Policy DeployStage Rollback Policy Args - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- Rollout
Policy DeployStage Rollout Policy Args - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- Set
String DeployStage Set String Args - (Updatable) Specifies the name and value pairs to set helm values.
- Set
Values DeployStage Set Values Args - (Updatable) Specifies the name and value pairs to set helm values.
- Should
Cleanup boolOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- Should
Not boolWait - (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 boolValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- Should
Reuse boolValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- Should
Skip boolCrds - (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 boolRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- Test
Load DeployBalancer Config Stage Test Load Balancer Config Args - (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 intSeconds - (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 stringTarget - (Updatable) Specifies the target or destination backend set.
- Values
Artifact []stringIds - (Updatable) List of values.yaml file artifact OCIDs.
- Wait
Criteria DeployStage Wait Criteria Args - (Updatable) Specifies wait criteria for the Wait stage.
- deploy
Pipeline StringId - The OCID of a pipeline.
- deploy
Stage DeployPredecessor Collection Stage Deploy Stage Predecessor Collection - (Updatable) Collection containing the predecessors of a stage.
- deploy
Stage StringType - (Updatable) Deployment stage type.
- approval
Policy DeployStage Approval Policy - (Updatable) Specifies the approval policy.
- are
Hooks BooleanEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- blue
Backend DeployIps Stage Blue Backend Ips - (Updatable) Collection of backend environment IP addresses.
- blue
Green DeployStrategy Stage Blue Green Strategy - Specifies the required blue green release strategy for OKE deployment.
- canary
Strategy DeployStage Canary Strategy - Specifies the required canary release strategy for OKE deployment.
- command
Spec StringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- compute
Instance StringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- compute
Instance StringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- compute
Instance StringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- compute
Instance StringGroup Deploy Environment Id - (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.
- container
Config DeployStage Container Config - (Updatable) Specifies the container configuration.
- 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"}
- deploy
Artifact StringId - (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 List<String>Ids - (Updatable) The list of file artifact OCIDs to deploy.
- deploy
Environment StringId A - First compute instance group environment OCID for deployment.
- deploy
Environment StringId B - Second compute instance group environment OCID for deployment.
- deployment
Spec StringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- description String
- (Updatable) Optional description about the deployment stage.
- display
Name String - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- docker
Image StringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- failure
Policy DeployStage Failure Policy - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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"}
- function
Deploy StringEnvironment Id - (Updatable) Function environment OCID.
- function
Timeout IntegerIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- green
Backend DeployIps Stage Green Backend Ips - (Updatable) Collection of backend environment IP addresses.
- helm
Chart StringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- helm
Command List<String>Artifact Ids - (Updatable) List of Helm command artifact OCIDs.
- is
Async Boolean - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- is
Debug BooleanEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- is
Force BooleanEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- is
Uninstall BooleanOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- is
Validation BooleanEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- kubernetes
Manifest List<String>Deploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- load
Balancer DeployConfig Stage Load Balancer Config - (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 Integer - (Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- max
Memory StringIn Mbs - (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.
- oke
Blue StringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- oke
Canary StringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- oke
Canary StringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- oke
Cluster StringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- production
Load DeployBalancer Config Stage Production Load Balancer Config - 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
- release
Name String - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- rollback
Policy DeployStage Rollback Policy - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rollout
Policy DeployStage Rollout Policy - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- set
String DeployStage Set String - (Updatable) Specifies the name and value pairs to set helm values.
- set
Values DeployStage Set Values - (Updatable) Specifies the name and value pairs to set helm values.
- should
Cleanup BooleanOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- should
Not BooleanWait - (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 BooleanValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- should
Reuse BooleanValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- should
Skip BooleanCrds - (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 BooleanRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- test
Load DeployBalancer Config Stage Test Load Balancer Config - (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 IntegerSeconds - (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 StringTarget - (Updatable) Specifies the target or destination backend set.
- values
Artifact List<String>Ids - (Updatable) List of values.yaml file artifact OCIDs.
- wait
Criteria DeployStage Wait Criteria - (Updatable) Specifies wait criteria for the Wait stage.
- deploy
Pipeline stringId - The OCID of a pipeline.
- deploy
Stage DeployPredecessor Collection Stage Deploy Stage Predecessor Collection - (Updatable) Collection containing the predecessors of a stage.
- deploy
Stage stringType - (Updatable) Deployment stage type.
- approval
Policy DeployStage Approval Policy - (Updatable) Specifies the approval policy.
- are
Hooks booleanEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- blue
Backend DeployIps Stage Blue Backend Ips - (Updatable) Collection of backend environment IP addresses.
- blue
Green DeployStrategy Stage Blue Green Strategy - Specifies the required blue green release strategy for OKE deployment.
- canary
Strategy DeployStage Canary Strategy - Specifies the required canary release strategy for OKE deployment.
- command
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- compute
Instance stringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- compute
Instance stringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- compute
Instance stringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- compute
Instance stringGroup Deploy Environment Id - (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.
- container
Config DeployStage Container Config - (Updatable) Specifies the container configuration.
- {[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"}
- deploy
Artifact stringId - (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 string[]Ids - (Updatable) The list of file artifact OCIDs to deploy.
- deploy
Environment stringId A - First compute instance group environment OCID for deployment.
- deploy
Environment stringId B - Second compute instance group environment OCID for deployment.
- deployment
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- description string
- (Updatable) Optional description about the deployment stage.
- display
Name string - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- docker
Image stringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- failure
Policy DeployStage Failure Policy - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- {[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"}
- function
Deploy stringEnvironment Id - (Updatable) Function environment OCID.
- function
Timeout numberIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- green
Backend DeployIps Stage Green Backend Ips - (Updatable) Collection of backend environment IP addresses.
- helm
Chart stringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- helm
Command string[]Artifact Ids - (Updatable) List of Helm command artifact OCIDs.
- is
Async boolean - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- is
Debug booleanEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- is
Force booleanEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- is
Uninstall booleanOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- is
Validation booleanEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- kubernetes
Manifest string[]Deploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- load
Balancer DeployConfig Stage Load Balancer Config - (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 number - (Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- max
Memory stringIn Mbs - (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.
- oke
Blue stringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- oke
Canary stringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- oke
Canary stringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- oke
Cluster stringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- production
Load DeployBalancer Config Stage Production Load Balancer Config - 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
- release
Name string - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- rollback
Policy DeployStage Rollback Policy - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rollout
Policy DeployStage Rollout Policy - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- set
String DeployStage Set String - (Updatable) Specifies the name and value pairs to set helm values.
- set
Values DeployStage Set Values - (Updatable) Specifies the name and value pairs to set helm values.
- should
Cleanup booleanOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- should
Not booleanWait - (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 booleanValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- should
Reuse booleanValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- should
Skip booleanCrds - (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 booleanRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- test
Load DeployBalancer Config Stage Test Load Balancer Config - (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 numberSeconds - (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 stringTarget - (Updatable) Specifies the target or destination backend set.
- values
Artifact string[]Ids - (Updatable) List of values.yaml file artifact OCIDs.
- wait
Criteria DeployStage Wait Criteria - (Updatable) Specifies wait criteria for the Wait stage.
- deploy_
pipeline_ strid - The OCID of a pipeline.
- deploy_
stage_ devops.predecessor_ collection Deploy Stage Deploy Stage Predecessor Collection Args - (Updatable) Collection containing the predecessors of a stage.
- deploy_
stage_ strtype - (Updatable) Deployment stage type.
- approval_
policy devops.Deploy Stage Approval Policy Args - (Updatable) Specifies the approval policy.
- are_
hooks_ boolenabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- blue_
backend_ devops.ips Deploy Stage Blue Backend Ips Args - (Updatable) Collection of backend environment IP addresses.
- blue_
green_ devops.strategy Deploy Stage Blue Green Strategy Args - Specifies the required blue green release strategy for OKE deployment.
- canary_
strategy devops.Deploy Stage Canary Strategy Args - Specifies the required canary release strategy for OKE deployment.
- command_
spec_ strdeploy_ artifact_ id - (Updatable) The OCID of the artifact that contains the command specification.
- compute_
instance_ strgroup_ blue_ green_ deployment_ deploy_ stage_ id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- compute_
instance_ strgroup_ canary_ deploy_ stage_ id - A compute instance group canary stage OCID for load balancer.
- compute_
instance_ strgroup_ canary_ traffic_ shift_ deploy_ stage_ id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- compute_
instance_ strgroup_ deploy_ environment_ id - (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.Deploy Stage Container Config Args - (Updatable) Specifies the container configuration.
- 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_ strid - (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_ Sequence[str]ids - (Updatable) The list of file artifact OCIDs to deploy.
- deploy_
environment_ strid_ a - First compute instance group environment OCID for deployment.
- deploy_
environment_ strid_ b - Second compute instance group environment OCID for deployment.
- deployment_
spec_ strdeploy_ artifact_ id - (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_ strdeploy_ artifact_ id - (Updatable) A Docker image artifact OCID.
- failure_
policy devops.Deploy Stage Failure Policy Args - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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_ strenvironment_ id - (Updatable) Function environment OCID.
- function_
timeout_ intin_ seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- green_
backend_ devops.ips Deploy Stage Green Backend Ips Args - (Updatable) Collection of backend environment IP addresses.
- helm_
chart_ strdeploy_ artifact_ id - (Updatable) Helm chart artifact OCID.
- helm_
command_ Sequence[str]artifact_ ids - (Updatable) List of Helm command artifact OCIDs.
- is_
async bool - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- is_
debug_ boolenabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- is_
force_ boolenabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- is_
uninstall_ boolon_ stage_ delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- is_
validation_ boolenabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- kubernetes_
manifest_ Sequence[str]deploy_ artifact_ ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- load_
balancer_ devops.config Deploy Stage Load Balancer Config Args - (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_ strin_ mbs - (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_ strgreen_ deploy_ stage_ id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- oke_
canary_ strdeploy_ stage_ id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- oke_
canary_ strtraffic_ shift_ deploy_ stage_ id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- oke_
cluster_ strdeploy_ environment_ id - (Updatable) Kubernetes cluster environment OCID for deployment.
- production_
load_ devops.balancer_ config Deploy Stage Production Load Balancer Config Args - 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.Deploy Stage Rollback Policy Args - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rollout_
policy devops.Deploy Stage Rollout Policy Args - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- set_
string devops.Deploy Stage Set String Args - (Updatable) Specifies the name and value pairs to set helm values.
- set_
values devops.Deploy Stage Set Values Args - (Updatable) Specifies the name and value pairs to set helm values.
- should_
cleanup_ boolon_ fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- should_
not_ boolwait - (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_ boolvalues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- should_
reuse_ boolvalues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- should_
skip_ boolcrds - (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_ boolrender_ subchart_ notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- test_
load_ devops.balancer_ config Deploy Stage Test Load Balancer Config Args - (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_ intseconds - (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_ strtarget - (Updatable) Specifies the target or destination backend set.
- values_
artifact_ Sequence[str]ids - (Updatable) List of values.yaml file artifact OCIDs.
- wait_
criteria devops.Deploy Stage Wait Criteria Args - (Updatable) Specifies wait criteria for the Wait stage.
- deploy
Pipeline StringId - The OCID of a pipeline.
- deploy
Stage Property MapPredecessor Collection - (Updatable) Collection containing the predecessors of a stage.
- deploy
Stage StringType - (Updatable) Deployment stage type.
- approval
Policy Property Map - (Updatable) Specifies the approval policy.
- are
Hooks BooleanEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- blue
Backend Property MapIps - (Updatable) Collection of backend environment IP addresses.
- blue
Green Property MapStrategy - Specifies the required blue green release strategy for OKE deployment.
- canary
Strategy Property Map - Specifies the required canary release strategy for OKE deployment.
- command
Spec StringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- compute
Instance StringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- compute
Instance StringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- compute
Instance StringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- compute
Instance StringGroup Deploy Environment Id - (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.
- container
Config Property Map - (Updatable) Specifies the container configuration.
- 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"}
- deploy
Artifact StringId - (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 List<String>Ids - (Updatable) The list of file artifact OCIDs to deploy.
- deploy
Environment StringId A - First compute instance group environment OCID for deployment.
- deploy
Environment StringId B - Second compute instance group environment OCID for deployment.
- deployment
Spec StringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- description String
- (Updatable) Optional description about the deployment stage.
- display
Name String - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- docker
Image StringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- failure
Policy Property Map - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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"}
- function
Deploy StringEnvironment Id - (Updatable) Function environment OCID.
- function
Timeout NumberIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- green
Backend Property MapIps - (Updatable) Collection of backend environment IP addresses.
- helm
Chart StringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- helm
Command List<String>Artifact Ids - (Updatable) List of Helm command artifact OCIDs.
- is
Async Boolean - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- is
Debug BooleanEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- is
Force BooleanEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- is
Uninstall BooleanOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- is
Validation BooleanEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- kubernetes
Manifest List<String>Deploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- load
Balancer Property MapConfig - (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 Number - (Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- max
Memory StringIn Mbs - (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.
- oke
Blue StringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- oke
Canary StringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- oke
Canary StringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- oke
Cluster StringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- production
Load Property MapBalancer Config - 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
- release
Name String - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- rollback
Policy Property Map - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rollout
Policy Property Map - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- set
String Property Map - (Updatable) Specifies the name and value pairs to set helm values.
- set
Values Property Map - (Updatable) Specifies the name and value pairs to set helm values.
- should
Cleanup BooleanOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- should
Not BooleanWait - (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 BooleanValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- should
Reuse BooleanValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- should
Skip BooleanCrds - (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 BooleanRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- test
Load Property MapBalancer Config - (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 NumberSeconds - (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 StringTarget - (Updatable) Specifies the target or destination backend set.
- values
Artifact List<String>Ids - (Updatable) List of values.yaml file artifact OCIDs.
- wait
Criteria 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:
- Compartment
Id string - The OCID of the compartment where the ContainerInstance will be created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details 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.
- Project
Id string - The OCID of a project.
- State string
- The current state of the deployment stage.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Time the deployment stage was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment stage was updated. Format defined by RFC3339.
- Compartment
Id string - The OCID of the compartment where the ContainerInstance will be created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details 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.
- Project
Id string - The OCID of a project.
- State string
- The current state of the deployment stage.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Time the deployment stage was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment stage was updated. Format defined by RFC3339.
- compartment
Id String - The OCID of the compartment where the ContainerInstance will be created.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- project
Id String - The OCID of a project.
- state String
- The current state of the deployment stage.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Time the deployment stage was created. Format defined by RFC3339.
- time
Updated String - Time the deployment stage was updated. Format defined by RFC3339.
- compartment
Id string - The OCID of the compartment where the ContainerInstance will be created.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- project
Id string - The OCID of a project.
- state string
- The current state of the deployment stage.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - Time the deployment stage was created. Format defined by RFC3339.
- time
Updated 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.
- 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.
- compartment
Id String - The OCID of the compartment where the ContainerInstance will be created.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- project
Id String - The OCID of a project.
- state String
- The current state of the deployment stage.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Time the deployment stage was created. Format defined by RFC3339.
- time
Updated 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Approval
Policy DeployStage Approval Policy - (Updatable) Specifies the approval policy.
- Are
Hooks boolEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- Blue
Backend DeployIps Stage Blue Backend Ips - (Updatable) Collection of backend environment IP addresses.
- Blue
Green DeployStrategy Stage Blue Green Strategy - Specifies the required blue green release strategy for OKE deployment.
- Canary
Strategy DeployStage Canary Strategy - Specifies the required canary release strategy for OKE deployment.
- Command
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- Compartment
Id string - The OCID of the compartment where the ContainerInstance will be created.
- Compute
Instance stringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- Compute
Instance stringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- Compute
Instance stringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- Compute
Instance stringGroup Deploy Environment Id - (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.
- Container
Config DeployStage Container Config - (Updatable) Specifies the container configuration.
- 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"}
- Deploy
Artifact stringId - (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 List<string>Ids - (Updatable) The list of file artifact OCIDs to deploy.
- Deploy
Environment stringId A - First compute instance group environment OCID for deployment.
- Deploy
Environment stringId B - Second compute instance group environment OCID for deployment.
- Deploy
Pipeline stringId - The OCID of a pipeline.
- Deploy
Stage DeployPredecessor Collection Stage Deploy Stage Predecessor Collection - (Updatable) Collection containing the predecessors of a stage.
- Deploy
Stage stringType - (Updatable) Deployment stage type.
- Deployment
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- Description string
- (Updatable) Optional description about the deployment stage.
- Display
Name string - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- Docker
Image stringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- Failure
Policy DeployStage Failure Policy - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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"}
- Function
Deploy stringEnvironment Id - (Updatable) Function environment OCID.
- Function
Timeout intIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- Green
Backend DeployIps Stage Green Backend Ips - (Updatable) Collection of backend environment IP addresses.
- Helm
Chart stringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- Helm
Command List<string>Artifact Ids - (Updatable) List of Helm command artifact OCIDs.
- Is
Async bool - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- Is
Debug boolEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- Is
Force boolEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- Is
Uninstall boolOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- Is
Validation boolEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- Kubernetes
Manifest List<string>Deploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- Lifecycle
Details 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.
- Load
Balancer DeployConfig Stage Load Balancer Config - (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 stringIn Mbs - (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.
- Oke
Blue stringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- Oke
Canary stringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- Oke
Canary stringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- Oke
Cluster stringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- Production
Load DeployBalancer Config Stage Production Load Balancer Config - 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 string - The OCID of a project.
- Purpose string
- (Updatable) The purpose of running this Helm stage
- Release
Name string - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- Rollback
Policy DeployStage Rollback Policy - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- Rollout
Policy DeployStage Rollout Policy - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- Set
String DeployStage Set String - (Updatable) Specifies the name and value pairs to set helm values.
- Set
Values DeployStage Set Values - (Updatable) Specifies the name and value pairs to set helm values.
- Should
Cleanup boolOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- Should
Not boolWait - (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 boolValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- Should
Reuse boolValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- Should
Skip boolCrds - (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 boolRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- State string
- The current state of the deployment stage.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Test
Load DeployBalancer Config Stage Test Load Balancer Config - (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 string - Time the deployment stage was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment stage was updated. Format defined by RFC3339.
- Timeout
In intSeconds - (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 stringTarget - (Updatable) Specifies the target or destination backend set.
- Values
Artifact List<string>Ids - (Updatable) List of values.yaml file artifact OCIDs.
- Wait
Criteria DeployStage Wait Criteria - (Updatable) Specifies wait criteria for the Wait stage.
- Approval
Policy DeployStage Approval Policy Args - (Updatable) Specifies the approval policy.
- Are
Hooks boolEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- Blue
Backend DeployIps Stage Blue Backend Ips Args - (Updatable) Collection of backend environment IP addresses.
- Blue
Green DeployStrategy Stage Blue Green Strategy Args - Specifies the required blue green release strategy for OKE deployment.
- Canary
Strategy DeployStage Canary Strategy Args - Specifies the required canary release strategy for OKE deployment.
- Command
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- Compartment
Id string - The OCID of the compartment where the ContainerInstance will be created.
- Compute
Instance stringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- Compute
Instance stringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- Compute
Instance stringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- Compute
Instance stringGroup Deploy Environment Id - (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.
- Container
Config DeployStage Container Config Args - (Updatable) Specifies the container configuration.
- 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"}
- Deploy
Artifact stringId - (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 []stringIds - (Updatable) The list of file artifact OCIDs to deploy.
- Deploy
Environment stringId A - First compute instance group environment OCID for deployment.
- Deploy
Environment stringId B - Second compute instance group environment OCID for deployment.
- Deploy
Pipeline stringId - The OCID of a pipeline.
- Deploy
Stage DeployPredecessor Collection Stage Deploy Stage Predecessor Collection Args - (Updatable) Collection containing the predecessors of a stage.
- Deploy
Stage stringType - (Updatable) Deployment stage type.
- Deployment
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- Description string
- (Updatable) Optional description about the deployment stage.
- Display
Name string - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- Docker
Image stringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- Failure
Policy DeployStage Failure Policy Args - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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"}
- Function
Deploy stringEnvironment Id - (Updatable) Function environment OCID.
- Function
Timeout intIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- Green
Backend DeployIps Stage Green Backend Ips Args - (Updatable) Collection of backend environment IP addresses.
- Helm
Chart stringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- Helm
Command []stringArtifact Ids - (Updatable) List of Helm command artifact OCIDs.
- Is
Async bool - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- Is
Debug boolEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- Is
Force boolEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- Is
Uninstall boolOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- Is
Validation boolEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- Kubernetes
Manifest []stringDeploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- Lifecycle
Details 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.
- Load
Balancer DeployConfig Stage Load Balancer Config Args - (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 stringIn Mbs - (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.
- Oke
Blue stringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- Oke
Canary stringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- Oke
Canary stringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- Oke
Cluster stringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- Production
Load DeployBalancer Config Stage Production Load Balancer Config Args - 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 string - The OCID of a project.
- Purpose string
- (Updatable) The purpose of running this Helm stage
- Release
Name string - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- Rollback
Policy DeployStage Rollback Policy Args - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- Rollout
Policy DeployStage Rollout Policy Args - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- Set
String DeployStage Set String Args - (Updatable) Specifies the name and value pairs to set helm values.
- Set
Values DeployStage Set Values Args - (Updatable) Specifies the name and value pairs to set helm values.
- Should
Cleanup boolOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- Should
Not boolWait - (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 boolValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- Should
Reuse boolValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- Should
Skip boolCrds - (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 boolRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- State string
- The current state of the deployment stage.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Test
Load DeployBalancer Config Stage Test Load Balancer Config Args - (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 string - Time the deployment stage was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment stage was updated. Format defined by RFC3339.
- Timeout
In intSeconds - (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 stringTarget - (Updatable) Specifies the target or destination backend set.
- Values
Artifact []stringIds - (Updatable) List of values.yaml file artifact OCIDs.
- Wait
Criteria DeployStage Wait Criteria Args - (Updatable) Specifies wait criteria for the Wait stage.
- approval
Policy DeployStage Approval Policy - (Updatable) Specifies the approval policy.
- are
Hooks BooleanEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- blue
Backend DeployIps Stage Blue Backend Ips - (Updatable) Collection of backend environment IP addresses.
- blue
Green DeployStrategy Stage Blue Green Strategy - Specifies the required blue green release strategy for OKE deployment.
- canary
Strategy DeployStage Canary Strategy - Specifies the required canary release strategy for OKE deployment.
- command
Spec StringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- compartment
Id String - The OCID of the compartment where the ContainerInstance will be created.
- compute
Instance StringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- compute
Instance StringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- compute
Instance StringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- compute
Instance StringGroup Deploy Environment Id - (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.
- container
Config DeployStage Container Config - (Updatable) Specifies the container configuration.
- 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"}
- deploy
Artifact StringId - (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 List<String>Ids - (Updatable) The list of file artifact OCIDs to deploy.
- deploy
Environment StringId A - First compute instance group environment OCID for deployment.
- deploy
Environment StringId B - Second compute instance group environment OCID for deployment.
- deploy
Pipeline StringId - The OCID of a pipeline.
- deploy
Stage DeployPredecessor Collection Stage Deploy Stage Predecessor Collection - (Updatable) Collection containing the predecessors of a stage.
- deploy
Stage StringType - (Updatable) Deployment stage type.
- deployment
Spec StringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- description String
- (Updatable) Optional description about the deployment stage.
- display
Name String - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- docker
Image StringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- failure
Policy DeployStage Failure Policy - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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"}
- function
Deploy StringEnvironment Id - (Updatable) Function environment OCID.
- function
Timeout IntegerIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- green
Backend DeployIps Stage Green Backend Ips - (Updatable) Collection of backend environment IP addresses.
- helm
Chart StringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- helm
Command List<String>Artifact Ids - (Updatable) List of Helm command artifact OCIDs.
- is
Async Boolean - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- is
Debug BooleanEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- is
Force BooleanEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- is
Uninstall BooleanOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- is
Validation BooleanEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- kubernetes
Manifest List<String>Deploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- lifecycle
Details 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.
- load
Balancer DeployConfig Stage Load Balancer Config - (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 Integer - (Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- max
Memory StringIn Mbs - (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.
- oke
Blue StringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- oke
Canary StringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- oke
Canary StringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- oke
Cluster StringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- production
Load DeployBalancer Config Stage Production Load Balancer Config - 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 String - The OCID of a project.
- purpose String
- (Updatable) The purpose of running this Helm stage
- release
Name String - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- rollback
Policy DeployStage Rollback Policy - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rollout
Policy DeployStage Rollout Policy - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- set
String DeployStage Set String - (Updatable) Specifies the name and value pairs to set helm values.
- set
Values DeployStage Set Values - (Updatable) Specifies the name and value pairs to set helm values.
- should
Cleanup BooleanOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- should
Not BooleanWait - (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 BooleanValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- should
Reuse BooleanValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- should
Skip BooleanCrds - (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 BooleanRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- state String
- The current state of the deployment stage.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- test
Load DeployBalancer Config Stage Test Load Balancer Config - (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 String - Time the deployment stage was created. Format defined by RFC3339.
- time
Updated String - Time the deployment stage was updated. Format defined by RFC3339.
- timeout
In IntegerSeconds - (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 StringTarget - (Updatable) Specifies the target or destination backend set.
- values
Artifact List<String>Ids - (Updatable) List of values.yaml file artifact OCIDs.
- wait
Criteria DeployStage Wait Criteria - (Updatable) Specifies wait criteria for the Wait stage.
- approval
Policy DeployStage Approval Policy - (Updatable) Specifies the approval policy.
- are
Hooks booleanEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- blue
Backend DeployIps Stage Blue Backend Ips - (Updatable) Collection of backend environment IP addresses.
- blue
Green DeployStrategy Stage Blue Green Strategy - Specifies the required blue green release strategy for OKE deployment.
- canary
Strategy DeployStage Canary Strategy - Specifies the required canary release strategy for OKE deployment.
- command
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- compartment
Id string - The OCID of the compartment where the ContainerInstance will be created.
- compute
Instance stringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- compute
Instance stringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- compute
Instance stringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- compute
Instance stringGroup Deploy Environment Id - (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.
- container
Config DeployStage Container Config - (Updatable) Specifies the container configuration.
- {[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"}
- deploy
Artifact stringId - (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 string[]Ids - (Updatable) The list of file artifact OCIDs to deploy.
- deploy
Environment stringId A - First compute instance group environment OCID for deployment.
- deploy
Environment stringId B - Second compute instance group environment OCID for deployment.
- deploy
Pipeline stringId - The OCID of a pipeline.
- deploy
Stage DeployPredecessor Collection Stage Deploy Stage Predecessor Collection - (Updatable) Collection containing the predecessors of a stage.
- deploy
Stage stringType - (Updatable) Deployment stage type.
- deployment
Spec stringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- description string
- (Updatable) Optional description about the deployment stage.
- display
Name string - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- docker
Image stringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- failure
Policy DeployStage Failure Policy - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- {[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"}
- function
Deploy stringEnvironment Id - (Updatable) Function environment OCID.
- function
Timeout numberIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- green
Backend DeployIps Stage Green Backend Ips - (Updatable) Collection of backend environment IP addresses.
- helm
Chart stringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- helm
Command string[]Artifact Ids - (Updatable) List of Helm command artifact OCIDs.
- is
Async boolean - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- is
Debug booleanEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- is
Force booleanEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- is
Uninstall booleanOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- is
Validation booleanEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- kubernetes
Manifest string[]Deploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- lifecycle
Details 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.
- load
Balancer DeployConfig Stage Load Balancer Config - (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 number - (Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- max
Memory stringIn Mbs - (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.
- oke
Blue stringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- oke
Canary stringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- oke
Canary stringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- oke
Cluster stringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- production
Load DeployBalancer Config Stage Production Load Balancer Config - 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 string - The OCID of a project.
- purpose string
- (Updatable) The purpose of running this Helm stage
- release
Name string - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- rollback
Policy DeployStage Rollback Policy - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rollout
Policy DeployStage Rollout Policy - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- set
String DeployStage Set String - (Updatable) Specifies the name and value pairs to set helm values.
- set
Values DeployStage Set Values - (Updatable) Specifies the name and value pairs to set helm values.
- should
Cleanup booleanOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- should
Not booleanWait - (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 booleanValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- should
Reuse booleanValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- should
Skip booleanCrds - (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 booleanRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- state string
- The current state of the deployment stage.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- test
Load DeployBalancer Config Stage Test Load Balancer Config - (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 string - Time the deployment stage was created. Format defined by RFC3339.
- time
Updated string - Time the deployment stage was updated. Format defined by RFC3339.
- timeout
In numberSeconds - (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 stringTarget - (Updatable) Specifies the target or destination backend set.
- values
Artifact string[]Ids - (Updatable) List of values.yaml file artifact OCIDs.
- wait
Criteria DeployStage Wait Criteria - (Updatable) Specifies wait criteria for the Wait stage.
- approval_
policy devops.Deploy Stage Approval Policy Args - (Updatable) Specifies the approval policy.
- are_
hooks_ boolenabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- blue_
backend_ devops.ips Deploy Stage Blue Backend Ips Args - (Updatable) Collection of backend environment IP addresses.
- blue_
green_ devops.strategy Deploy Stage Blue Green Strategy Args - Specifies the required blue green release strategy for OKE deployment.
- canary_
strategy devops.Deploy Stage Canary Strategy Args - Specifies the required canary release strategy for OKE deployment.
- command_
spec_ strdeploy_ artifact_ id - (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_ strgroup_ blue_ green_ deployment_ deploy_ stage_ id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- compute_
instance_ strgroup_ canary_ deploy_ stage_ id - A compute instance group canary stage OCID for load balancer.
- compute_
instance_ strgroup_ canary_ traffic_ shift_ deploy_ stage_ id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- compute_
instance_ strgroup_ deploy_ environment_ id - (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.Deploy Stage Container Config Args - (Updatable) Specifies the container configuration.
- 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_ strid - (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_ Sequence[str]ids - (Updatable) The list of file artifact OCIDs to deploy.
- deploy_
environment_ strid_ a - First compute instance group environment OCID for deployment.
- deploy_
environment_ strid_ b - Second compute instance group environment OCID for deployment.
- deploy_
pipeline_ strid - The OCID of a pipeline.
- deploy_
stage_ devops.predecessor_ collection Deploy Stage Deploy Stage Predecessor Collection Args - (Updatable) Collection containing the predecessors of a stage.
- deploy_
stage_ strtype - (Updatable) Deployment stage type.
- deployment_
spec_ strdeploy_ artifact_ id - (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_ strdeploy_ artifact_ id - (Updatable) A Docker image artifact OCID.
- failure_
policy devops.Deploy Stage Failure Policy Args - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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_ strenvironment_ id - (Updatable) Function environment OCID.
- function_
timeout_ intin_ seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- green_
backend_ devops.ips Deploy Stage Green Backend Ips Args - (Updatable) Collection of backend environment IP addresses.
- helm_
chart_ strdeploy_ artifact_ id - (Updatable) Helm chart artifact OCID.
- helm_
command_ Sequence[str]artifact_ ids - (Updatable) List of Helm command artifact OCIDs.
- is_
async bool - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- is_
debug_ boolenabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- is_
force_ boolenabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- is_
uninstall_ boolon_ stage_ delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- is_
validation_ boolenabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- kubernetes_
manifest_ Sequence[str]deploy_ artifact_ ids - (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_ devops.config Deploy Stage Load Balancer Config Args - (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_ strin_ mbs - (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_ strgreen_ deploy_ stage_ id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- oke_
canary_ strdeploy_ stage_ id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- oke_
canary_ strtraffic_ shift_ deploy_ stage_ id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- oke_
cluster_ strdeploy_ environment_ id - (Updatable) Kubernetes cluster environment OCID for deployment.
- production_
load_ devops.balancer_ config Deploy Stage Production Load Balancer Config Args - 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.Deploy Stage Rollback Policy Args - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rollout_
policy devops.Deploy Stage Rollout Policy Args - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- set_
string devops.Deploy Stage Set String Args - (Updatable) Specifies the name and value pairs to set helm values.
- set_
values devops.Deploy Stage Set Values Args - (Updatable) Specifies the name and value pairs to set helm values.
- should_
cleanup_ boolon_ fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- should_
not_ boolwait - (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_ boolvalues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- should_
reuse_ boolvalues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- should_
skip_ boolcrds - (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_ boolrender_ subchart_ notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- state str
- The current state of the deployment stage.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- test_
load_ devops.balancer_ config Deploy Stage Test Load Balancer Config Args - (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_ intseconds - (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_ strtarget - (Updatable) Specifies the target or destination backend set.
- values_
artifact_ Sequence[str]ids - (Updatable) List of values.yaml file artifact OCIDs.
- wait_
criteria devops.Deploy Stage Wait Criteria Args - (Updatable) Specifies wait criteria for the Wait stage.
- approval
Policy Property Map - (Updatable) Specifies the approval policy.
- are
Hooks BooleanEnabled - (Updatable) Disable pre/post upgrade hooks. Set to false by default.
- blue
Backend Property MapIps - (Updatable) Collection of backend environment IP addresses.
- blue
Green Property MapStrategy - Specifies the required blue green release strategy for OKE deployment.
- canary
Strategy Property Map - Specifies the required canary release strategy for OKE deployment.
- command
Spec StringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the command specification.
- compartment
Id String - The OCID of the compartment where the ContainerInstance will be created.
- compute
Instance StringGroup Blue Green Deployment Deploy Stage Id - The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
- compute
Instance StringGroup Canary Deploy Stage Id - A compute instance group canary stage OCID for load balancer.
- compute
Instance StringGroup Canary Traffic Shift Deploy Stage Id - (Updatable) A compute instance group canary traffic shift stage OCID for load balancer.
- compute
Instance StringGroup Deploy Environment Id - (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.
- container
Config Property Map - (Updatable) Specifies the container configuration.
- 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"}
- deploy
Artifact StringId - (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 List<String>Ids - (Updatable) The list of file artifact OCIDs to deploy.
- deploy
Environment StringId A - First compute instance group environment OCID for deployment.
- deploy
Environment StringId B - Second compute instance group environment OCID for deployment.
- deploy
Pipeline StringId - The OCID of a pipeline.
- deploy
Stage Property MapPredecessor Collection - (Updatable) Collection containing the predecessors of a stage.
- deploy
Stage StringType - (Updatable) Deployment stage type.
- deployment
Spec StringDeploy Artifact Id - (Updatable) The OCID of the artifact that contains the deployment specification.
- description String
- (Updatable) Optional description about the deployment stage.
- display
Name String - (Updatable) Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- docker
Image StringDeploy Artifact Id - (Updatable) A Docker image artifact OCID.
- failure
Policy Property Map - (Updatable) Specifies a failure policy for a compute instance group rolling deployment stage.
- 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"}
- function
Deploy StringEnvironment Id - (Updatable) Function environment OCID.
- function
Timeout NumberIn Seconds - (Updatable) Timeout for execution of the Function. Value in seconds.
- green
Backend Property MapIps - (Updatable) Collection of backend environment IP addresses.
- helm
Chart StringDeploy Artifact Id - (Updatable) Helm chart artifact OCID.
- helm
Command List<String>Artifact Ids - (Updatable) List of Helm command artifact OCIDs.
- is
Async Boolean - (Updatable) A boolean flag specifies whether this stage executes asynchronously.
- is
Debug BooleanEnabled - (Updatable) Enables helm --debug option to stream output to tf stdout. Set to false by default.
- is
Force BooleanEnabled - (Updatable) Force resource update through delete; or if required, recreate. Set to false by default.
- is
Uninstall BooleanOn Stage Delete - (Updatable) Uninstall the Helm chart release on deleting the stage.
- is
Validation BooleanEnabled - (Updatable) A boolean flag specifies whether the invoked function should be validated.
- kubernetes
Manifest List<String>Deploy Artifact Ids - (Updatable) List of Kubernetes manifest artifact OCIDs.
- lifecycle
Details 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.
- load
Balancer Property MapConfig - (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 Number - (Updatable) Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
- max
Memory StringIn Mbs - (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.
- oke
Blue StringGreen Deploy Stage Id - The OCID of the upstream OKE blue-green deployment stage in this pipeline.
- oke
Canary StringDeploy Stage Id - The OCID of an upstream OKE canary deployment stage in this pipeline.
- oke
Canary StringTraffic Shift Deploy Stage Id - The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
- oke
Cluster StringDeploy Environment Id - (Updatable) Kubernetes cluster environment OCID for deployment.
- production
Load Property MapBalancer Config - 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 String - The OCID of a project.
- purpose String
- (Updatable) The purpose of running this Helm stage
- release
Name String - (Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.
- rollback
Policy Property Map - (Updatable) Specifies the rollback policy. This is initiated on the failure of certain stage types.
- rollout
Policy Property Map - (Updatable) Description of rollout policy for load balancer traffic shift stage.
- set
String Property Map - (Updatable) Specifies the name and value pairs to set helm values.
- set
Values Property Map - (Updatable) Specifies the name and value pairs to set helm values.
- should
Cleanup BooleanOn Fail - (Updatable) Allow deletion of new resources created during when an upgrade fails. Set to false by default.
- should
Not BooleanWait - (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 BooleanValues - (Updatable) During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
- should
Reuse BooleanValues - (Updatable) During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
- should
Skip BooleanCrds - (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 BooleanRender Subchart Notes - (Updatable) If set, renders subchart notes along with the parent. Set to false by default.
- state String
- The current state of the deployment stage.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- test
Load Property MapBalancer Config - (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 String - Time the deployment stage was created. Format defined by RFC3339.
- time
Updated String - Time the deployment stage was updated. Format defined by RFC3339.
- timeout
In NumberSeconds - (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 StringTarget - (Updatable) Specifies the target or destination backend set.
- values
Artifact List<String>Ids - (Updatable) List of values.yaml file artifact OCIDs.
- wait
Criteria Property Map - (Updatable) Specifies wait criteria for the Wait stage.
Supporting Types
DeployStageApprovalPolicy, DeployStageApprovalPolicyArgs
- Approval
Policy stringType - (Updatable) Approval policy type.
- Number
Of intApprovals Required - (Updatable) A minimum number of approvals required for stage to proceed.
- Approval
Policy stringType - (Updatable) Approval policy type.
- Number
Of intApprovals Required - (Updatable) A minimum number of approvals required for stage to proceed.
- approval
Policy StringType - (Updatable) Approval policy type.
- number
Of IntegerApprovals Required - (Updatable) A minimum number of approvals required for stage to proceed.
- approval
Policy stringType - (Updatable) Approval policy type.
- number
Of numberApprovals Required - (Updatable) A minimum number of approvals required for stage to proceed.
- approval_
policy_ strtype - (Updatable) Approval policy type.
- number_
of_ intapprovals_ required - (Updatable) A minimum number of approvals required for stage to proceed.
- approval
Policy StringType - (Updatable) Approval policy type.
- number
Of NumberApprovals Required - (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
- Ingress
Name string - Name of the Ingress resource.
- Namespace
A string - First Namespace for deployment.
- Namespace
B string - Second Namespace for deployment.
- Strategy
Type string - Blue Green strategy type
- Ingress
Name string - Name of the Ingress resource.
- Namespace
A string - First Namespace for deployment.
- Namespace
B string - Second Namespace for deployment.
- Strategy
Type string - Blue Green strategy type
- ingress
Name String - Name of the Ingress resource.
- namespace
A String - First Namespace for deployment.
- namespace
B String - Second Namespace for deployment.
- strategy
Type String - Blue Green strategy type
- ingress
Name string - Name of the Ingress resource.
- namespace
A string - First Namespace for deployment.
- namespace
B string - Second Namespace for deployment.
- strategy
Type string - Blue Green strategy type
- ingress_
name str - Name of the Ingress resource.
- namespace_
a str - First Namespace for deployment.
- namespace_
b str - Second Namespace for deployment.
- strategy_
type str - Blue Green strategy type
- ingress
Name String - Name of the Ingress resource.
- namespace
A String - First Namespace for deployment.
- namespace
B String - Second Namespace for deployment.
- strategy
Type String - Blue Green strategy type
DeployStageCanaryStrategy, DeployStageCanaryStrategyArgs
- Ingress
Name string - Name of the Ingress resource.
- Namespace string
- Canary namespace to be used for Kubernetes canary deployment.
- Strategy
Type string - Canary strategy type.
- Ingress
Name string - Name of the Ingress resource.
- Namespace string
- Canary namespace to be used for Kubernetes canary deployment.
- Strategy
Type string - Canary strategy type.
- ingress
Name String - Name of the Ingress resource.
- namespace String
- Canary namespace to be used for Kubernetes canary deployment.
- strategy
Type String - Canary strategy type.
- ingress
Name string - Name of the Ingress resource.
- namespace string
- Canary namespace to be used for Kubernetes canary deployment.
- strategy
Type string - Canary strategy type.
- ingress_
name str - Name of the Ingress resource.
- namespace str
- Canary namespace to be used for Kubernetes canary deployment.
- strategy_
type str - Canary strategy type.
- ingress
Name String - Name of the Ingress resource.
- namespace String
- Canary namespace to be used for Kubernetes canary deployment.
- strategy
Type String - Canary strategy type.
DeployStageContainerConfig, DeployStageContainerConfigArgs
- Container
Config stringType - (Updatable) Container configuration type.
- Network
Channel DeployStage Container Config Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- Shape
Config DeployStage Container Config Shape Config - (Updatable) Determines the size and amount of resources available to the instance.
- Shape
Name string - (Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- Availability
Domain string - (Updatable) Availability domain where the ContainerInstance will be created.
- Compartment
Id string - (Updatable) The OCID of the compartment where the ContainerInstance will be created.
- Container
Config stringType - (Updatable) Container configuration type.
- Network
Channel DeployStage Container Config Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- Shape
Config DeployStage Container Config Shape Config - (Updatable) Determines the size and amount of resources available to the instance.
- Shape
Name string - (Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- Availability
Domain string - (Updatable) Availability domain where the ContainerInstance will be created.
- Compartment
Id string - (Updatable) The OCID of the compartment where the ContainerInstance will be created.
- container
Config StringType - (Updatable) Container configuration type.
- network
Channel DeployStage Container Config Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- shape
Config DeployStage Container Config Shape Config - (Updatable) Determines the size and amount of resources available to the instance.
- shape
Name String - (Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- availability
Domain String - (Updatable) Availability domain where the ContainerInstance will be created.
- compartment
Id String - (Updatable) The OCID of the compartment where the ContainerInstance will be created.
- container
Config stringType - (Updatable) Container configuration type.
- network
Channel DeployStage Container Config Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- shape
Config DeployStage Container Config Shape Config - (Updatable) Determines the size and amount of resources available to the instance.
- shape
Name string - (Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- availability
Domain string - (Updatable) Availability domain where the ContainerInstance will be created.
- compartment
Id string - (Updatable) The OCID of the compartment where the ContainerInstance will be created.
- container_
config_ strtype - (Updatable) Container configuration type.
- network_
channel devops.Deploy Stage Container Config Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- shape_
config devops.Deploy Stage Container Config Shape Config - (Updatable) Determines the size and amount of resources available to the instance.
- shape_
name 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.
- container
Config StringType - (Updatable) Container configuration type.
- network
Channel Property Map - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- shape
Config Property Map - (Updatable) Determines the size and amount of resources available to the instance.
- shape
Name String - (Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
- availability
Domain String - (Updatable) Availability domain where the ContainerInstance will be created.
- compartment
Id String - (Updatable) The OCID of the compartment where the ContainerInstance will be created.
DeployStageContainerConfigNetworkChannel, DeployStageContainerConfigNetworkChannelArgs
- Network
Channel stringType - (Updatable) Network channel type.
- Subnet
Id string - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- Nsg
Ids List<string> - (Updatable) An array of network security group OCIDs.
- Network
Channel stringType - (Updatable) Network channel type.
- Subnet
Id string - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- Nsg
Ids []string - (Updatable) An array of network security group OCIDs.
- network
Channel StringType - (Updatable) Network channel type.
- subnet
Id String - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- nsg
Ids List<String> - (Updatable) An array of network security group OCIDs.
- network
Channel stringType - (Updatable) Network channel type.
- subnet
Id string - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- nsg
Ids string[] - (Updatable) An array of network security group OCIDs.
- network_
channel_ strtype - (Updatable) Network channel type.
- subnet_
id 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.
- network
Channel StringType - (Updatable) Network channel type.
- subnet
Id String - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- nsg
Ids List<String> - (Updatable) An array of network security group OCIDs.
DeployStageContainerConfigShapeConfig, DeployStageContainerConfigShapeConfigArgs
- Ocpus double
- (Updatable) The total number of OCPUs available to the instance.
- Memory
In doubleGbs - (Updatable) The total amount of memory available to the instance, in gigabytes.
- Ocpus float64
- (Updatable) The total number of OCPUs available to the instance.
- Memory
In float64Gbs - (Updatable) The total amount of memory available to the instance, in gigabytes.
- ocpus Double
- (Updatable) The total number of OCPUs available to the instance.
- memory
In DoubleGbs - (Updatable) The total amount of memory available to the instance, in gigabytes.
- ocpus number
- (Updatable) The total number of OCPUs available to the instance.
- memory
In numberGbs - (Updatable) The total amount of memory available to the instance, in gigabytes.
- ocpus float
- (Updatable) The total number of OCPUs available to the instance.
- memory_
in_ floatgbs - (Updatable) The total amount of memory available to the instance, in gigabytes.
- ocpus Number
- (Updatable) The total number of OCPUs available to the instance.
- memory
In NumberGbs - (Updatable) The total amount of memory available to the instance, in gigabytes.
DeployStageDeployStagePredecessorCollection, DeployStageDeployStagePredecessorCollectionArgs
- Items
List<Deploy
Stage Deploy Stage Predecessor Collection Item> - (Updatable) A list of stage predecessors for a stage.
- Items
[]Deploy
Stage Deploy Stage Predecessor Collection Item - (Updatable) A list of stage predecessors for a stage.
- items
List<Deploy
Stage Deploy Stage Predecessor Collection Item> - (Updatable) A list of stage predecessors for a stage.
- items
Deploy
Stage Deploy Stage Predecessor Collection Item[] - (Updatable) A list of stage predecessors for a stage.
- items
Sequence[devops.
Deploy Stage Deploy Stage Predecessor Collection Item] - (Updatable) A list of stage predecessors for a stage.
- items List<Property Map>
- (Updatable) A list of stage predecessors for a stage.
DeployStageDeployStagePredecessorCollectionItem, DeployStageDeployStagePredecessorCollectionItemArgs
- Id 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 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 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 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 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 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
- Policy
Type string - (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.
- Policy
Type string - (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.
- policy
Type String - (Updatable) Specifies if the failure instance size is given by absolute number or by percentage.
- failure
Count Integer - (Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
- failure
Percentage 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.
- policy
Type string - (Updatable) Specifies if the failure instance size is given by absolute number or by percentage.
- failure
Count number - (Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
- failure
Percentage 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 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.
- policy
Type String - (Updatable) Specifies if the failure instance size is given by absolute number or by percentage.
- failure
Count Number - (Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.
- failure
Percentage 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
- Backend
Port int - (Updatable) Listen port for the backend server.
- Listener
Name string - (Updatable) Name of the load balancer listener.
- Load
Balancer stringId - (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 string - (Updatable) Name of the load balancer listener.
- Load
Balancer stringId - (Updatable) The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- backend
Port Integer - (Updatable) Listen port for the backend server.
- listener
Name String - (Updatable) Name of the load balancer listener.
- load
Balancer StringId - (Updatable) The OCID of the load balancer.
- state String
- The current state of the deployment stage.
- backend
Port number - (Updatable) Listen port for the backend server.
- listener
Name string - (Updatable) Name of the load balancer listener.
- load
Balancer stringId - (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_ strid - (Updatable) The OCID of the load balancer.
- state str
- The current state of the deployment stage.
- backend
Port Number - (Updatable) Listen port for the backend server.
- listener
Name String - (Updatable) Name of the load balancer listener.
- load
Balancer StringId - (Updatable) The OCID of the load balancer.
- state String
- The current state of the deployment stage.
DeployStageProductionLoadBalancerConfig, DeployStageProductionLoadBalancerConfigArgs
- Backend
Port int - Listen port for the backend server.
- Listener
Name string - Name of the load balancer listener.
- Load
Balancer stringId - The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- Backend
Port int - Listen port for the backend server.
- Listener
Name string - Name of the load balancer listener.
- Load
Balancer stringId - The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- backend
Port Integer - Listen port for the backend server.
- listener
Name String - Name of the load balancer listener.
- load
Balancer StringId - The OCID of the load balancer.
- state String
- The current state of the deployment stage.
- backend
Port number - Listen port for the backend server.
- listener
Name string - Name of the load balancer listener.
- load
Balancer stringId - The OCID of the load balancer.
- state string
- The current state of the deployment stage.
- backend_
port int - Listen port for the backend server.
- listener_
name str - Name of the load balancer listener.
- load_
balancer_ strid - The OCID of the load balancer.
- state str
- The current state of the deployment stage.
- backend
Port Number - Listen port for the backend server.
- listener
Name String - Name of the load balancer listener.
- load
Balancer StringId - The OCID of the load balancer.
- state String
- The current state of the deployment stage.
DeployStageRollbackPolicy, DeployStageRollbackPolicyArgs
- Policy
Type string - (Updatable) Specifies type of the deployment stage rollback policy.
- Policy
Type string - (Updatable) Specifies type of the deployment stage rollback policy.
- policy
Type String - (Updatable) Specifies type of the deployment stage rollback policy.
- policy
Type string - (Updatable) Specifies type of the deployment stage rollback policy.
- policy_
type str - (Updatable) Specifies type of the deployment stage rollback policy.
- policy
Type String - (Updatable) Specifies type of the deployment stage rollback policy.
DeployStageRolloutPolicy, DeployStageRolloutPolicyArgs
- Batch
Count int - (Updatable) The number that will be used to determine how many instances will be deployed concurrently.
- Batch
Delay intIn Seconds - (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 string - (Updatable) The type of policy used for rolling out a deployment stage.
- Ramp
Limit doublePercent - (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 intIn Seconds - (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 string - (Updatable) The type of policy used for rolling out a deployment stage.
- Ramp
Limit float64Percent - (Updatable) Indicates the criteria to stop.
- batch
Count Integer - (Updatable) The number that will be used to determine how many instances will be deployed concurrently.
- batch
Delay IntegerIn Seconds - (Updatable) The duration of delay between batch rollout. The default delay is 1 minute.
- batch
Percentage Integer - (Updatable) The percentage that will be used to determine how many instances will be deployed concurrently.
- policy
Type String - (Updatable) The type of policy used for rolling out a deployment stage.
- ramp
Limit DoublePercent - (Updatable) Indicates the criteria to stop.
- batch
Count number - (Updatable) The number that will be used to determine how many instances will be deployed concurrently.
- batch
Delay numberIn Seconds - (Updatable) The duration of delay between batch rollout. The default delay is 1 minute.
- batch
Percentage number - (Updatable) The percentage that will be used to determine how many instances will be deployed concurrently.
- policy
Type string - (Updatable) The type of policy used for rolling out a deployment stage.
- ramp
Limit numberPercent - (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_ intin_ seconds - (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_ floatpercent - (Updatable) Indicates the criteria to stop.
- batch
Count Number - (Updatable) The number that will be used to determine how many instances will be deployed concurrently.
- batch
Delay NumberIn Seconds - (Updatable) The duration of delay between batch rollout. The default delay is 1 minute.
- batch
Percentage Number - (Updatable) The percentage that will be used to determine how many instances will be deployed concurrently.
- policy
Type String - (Updatable) The type of policy used for rolling out a deployment stage.
- ramp
Limit NumberPercent - (Updatable) Indicates the criteria to stop.
DeployStageSetString, DeployStageSetStringArgs
- Items
List<Deploy
Stage Set String Item> - (Updatable) List of parameters defined to set helm value.
- Items
[]Deploy
Stage Set String Item - (Updatable) List of parameters defined to set helm value.
- items
List<Deploy
Stage Set String Item> - (Updatable) List of parameters defined to set helm value.
- items
Deploy
Stage Set String Item[] - (Updatable) List of parameters defined to set helm value.
- items
Sequence[devops.
Deploy Stage Set String Item] - (Updatable) List of parameters defined to set helm value.
- items List<Property Map>
- (Updatable) List of parameters defined to set helm value.
DeployStageSetStringItem, DeployStageSetStringItemArgs
DeployStageSetValues, DeployStageSetValuesArgs
- Items
List<Deploy
Stage Set Values Item> - (Updatable) List of parameters defined to set helm value.
- Items
[]Deploy
Stage Set Values Item - (Updatable) List of parameters defined to set helm value.
- items
List<Deploy
Stage Set Values Item> - (Updatable) List of parameters defined to set helm value.
- items
Deploy
Stage Set Values Item[] - (Updatable) List of parameters defined to set helm value.
- items
Sequence[devops.
Deploy Stage Set Values Item] - (Updatable) List of parameters defined to set helm value.
- items List<Property Map>
- (Updatable) List of parameters defined to set helm value.
DeployStageSetValuesItem, DeployStageSetValuesItemArgs
DeployStageTestLoadBalancerConfig, DeployStageTestLoadBalancerConfigArgs
- Backend
Port int - (Updatable) Listen port for the backend server.
- Listener
Name string - (Updatable) Name of the load balancer listener.
- Load
Balancer stringId - (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 string - (Updatable) Name of the load balancer listener.
- Load
Balancer stringId - (Updatable) The OCID of the load balancer.
- State string
- The current state of the deployment stage.
- backend
Port Integer - (Updatable) Listen port for the backend server.
- listener
Name String - (Updatable) Name of the load balancer listener.
- load
Balancer StringId - (Updatable) The OCID of the load balancer.
- state String
- The current state of the deployment stage.
- backend
Port number - (Updatable) Listen port for the backend server.
- listener
Name string - (Updatable) Name of the load balancer listener.
- load
Balancer stringId - (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_ strid - (Updatable) The OCID of the load balancer.
- state str
- The current state of the deployment stage.
- backend
Port Number - (Updatable) Listen port for the backend server.
- listener
Name String - (Updatable) Name of the load balancer listener.
- load
Balancer StringId - (Updatable) The OCID of the load balancer.
- state String
- The current state of the deployment stage.
DeployStageWaitCriteria, DeployStageWaitCriteriaArgs
- Wait
Duration 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.
- Wait
Type 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 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.
- Wait
Type 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 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.
- wait
Type 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 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.
- wait
Type 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 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 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
- wait
Duration 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.
- wait
Type 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"
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.