oci_devops_build_pipeline_stage
This resource provides the Build Pipeline Stage resource in Oracle Cloud Infrastructure Devops service.
Creates a new stage.
Example Usage
resource "oci_devops_build_pipeline_stage" "test_build_pipeline_stage" {
#Required
build_pipeline_id = oci_devops_build_pipeline.test_build_pipeline.id
build_pipeline_stage_predecessor_collection {
#Required
items {
#Required
id = var.build_pipeline_stage_build_pipeline_stage_predecessor_collection_items_id
}
}
build_pipeline_stage_type = var.build_pipeline_stage_build_pipeline_stage_type
#Optional
build_runner_shape_config {
#Required
build_runner_type = var.build_pipeline_stage_build_runner_shape_config_build_runner_type
#Optional
memory_in_gbs = var.build_pipeline_stage_build_runner_shape_config_memory_in_gbs
ocpus = var.build_pipeline_stage_build_runner_shape_config_ocpus
}
build_source_collection {
#Optional
items {
#Required
connection_type = var.build_pipeline_stage_build_source_collection_items_connection_type
#Optional
branch = var.build_pipeline_stage_build_source_collection_items_branch
connection_id = oci_devops_connection.test_connection.id
name = var.build_pipeline_stage_build_source_collection_items_name
repository_id = oci_artifacts_repository.test_repository.id
repository_url = var.build_pipeline_stage_build_source_collection_items_repository_url
}
}
build_spec_file = var.build_pipeline_stage_build_spec_file
defined_tags = {"foo-namespace.bar-key"= "value"}
deliver_artifact_collection {
#Optional
items {
#Optional
artifact_id = oci_devops_artifact.test_artifact.id
artifact_name = var.build_pipeline_stage_deliver_artifact_collection_items_artifact_name
}
}
deploy_pipeline_id = oci_devops_deploy_pipeline.test_deploy_pipeline.id
description = var.build_pipeline_stage_description
display_name = var.build_pipeline_stage_display_name
freeform_tags = {"bar-key"= "value"}
image = var.build_pipeline_stage_image
is_pass_all_parameters_enabled = var.build_pipeline_stage_is_pass_all_parameters_enabled
primary_build_source = var.build_pipeline_stage_primary_build_source
private_access_config {
#Required
network_channel_type = var.build_pipeline_stage_private_access_config_network_channel_type
subnet_id = oci_core_subnet.test_subnet.id
#Optional
nsg_ids = var.build_pipeline_stage_private_access_config_nsg_ids
}
stage_execution_timeout_in_seconds = var.build_pipeline_stage_stage_execution_timeout_in_seconds
wait_criteria {
#Required
wait_duration = var.build_pipeline_stage_wait_criteria_wait_duration
wait_type = var.build_pipeline_stage_wait_criteria_wait_type
}
}
Argument Reference
The following arguments are supported:
build_pipeline_id
- (Required) The OCID of the build pipeline.build_pipeline_stage_predecessor_collection
- (Required) (Updatable) The collection containing the predecessors of a stage.items
- (Required) (Updatable) A list of build pipeline stage predecessors for a stage.id
- (Required) (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.
build_pipeline_stage_type
- (Required) (Updatable) Defines the stage type, which is one of the following: BUILD, DELIVER_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE.build_runner_shape_config
- (Applicable when build_pipeline_stage_type=BUILD) (Updatable) The information about build runner.build_runner_type
- (Required) (Updatable) Name of the build runner shape in which the execution occurs. If not specified, the default shape is chosen.memory_in_gbs
- (Required when build_runner_type=CUSTOM) (Updatable) The total amount of memory set for the instance in gigabytes.ocpus
- (Required when build_runner_type=CUSTOM) (Updatable) The total number of OCPUs set for the instance.
build_source_collection
- (Required when build_pipeline_stage_type=BUILD) (Updatable) Collection of build sources.items
- (Required when build_pipeline_stage_type=BUILD) (Updatable) Collection of build sources. In case of UPDATE operation, replaces existing build sources list. Merging with existing build sources is not supported.branch
- (Required when build_pipeline_stage_type=BUILD) (Updatable) Branch name.connection_id
- (Required when connection_type=BITBUCKET_CLOUD | BITBUCKET_SERVER | GITHUB | GITLAB | GITLAB_SERVER | VBS) (Updatable) Connection identifier pertinent to Bitbucket Server source providerconnection_type
- (Required) (Updatable) The type of source provider.name
- (Required when build_pipeline_stage_type=BUILD) (Updatable) Name of the build source. This must be unique within a build source collection. The name can be used by customers to locate the working directory pertinent to this repository.repository_id
- (Required when connection_type=DEVOPS_CODE_REPOSITORY) (Updatable) The DevOps code repository ID.repository_url
- (Required when build_pipeline_stage_type=BUILD) (Updatable) URL for the repository.
build_spec_file
- (Applicable when build_pipeline_stage_type=BUILD) (Updatable) The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml.defined_tags
- (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example:{"foo-namespace.bar-key": "value"}
deliver_artifact_collection
- (Required when build_pipeline_stage_type=DELIVER_ARTIFACT) (Updatable) Specifies an array of artifacts that need to be pushed to the artifactory stores.items
- (Required when build_pipeline_stage_type=DELIVER_ARTIFACT) (Updatable) Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported.artifact_id
- (Required when build_pipeline_stage_type=DELIVER_ARTIFACT) (Updatable) Artifact identifier that contains the artifact definition.artifact_name
- (Required when build_pipeline_stage_type=DELIVER_ARTIFACT) (Updatable) Name of the artifact specified in the build_spec.yaml file.
deploy_pipeline_id
- (Required when build_pipeline_stage_type=TRIGGER_DEPLOYMENT_PIPELINE) (Updatable) A target deployment pipeline OCID that will run in this stage.description
- (Optional) (Updatable) Optional description about the stage.display_name
- (Optional) (Updatable) Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.freeform_tags
- (Optional) (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"}
image
- (Required when build_pipeline_stage_type=BUILD) (Updatable) Image name for the build environmentis_pass_all_parameters_enabled
- (Required when build_pipeline_stage_type=TRIGGER_DEPLOYMENT_PIPELINE) (Updatable) A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered.primary_build_source
- (Applicable when build_pipeline_stage_type=BUILD) (Updatable) Name of the build source where the build_spec.yml file is located. If not specified, the first entry in the build source collection is chosen as primary build source.private_access_config
- (Applicable when build_pipeline_stage_type=BUILD) (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer’s private network.network_channel_type
- (Required) (Updatable) Network channel type.nsg_ids
- (Optional) (Updatable) An array of network security group OCIDs.subnet_id
- (Required) (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
stage_execution_timeout_in_seconds
- (Applicable when build_pipeline_stage_type=BUILD) (Updatable) Timeout for the build stage execution. Specify value in seconds.wait_criteria
- (Required when build_pipeline_stage_type=WAIT) (Updatable) Specifies wait criteria for the Wait stage.wait_duration
- (Required) (Updatable) The absolute wait duration. Minimum wait duration must be 5 seconds. Maximum wait duration can be up to 2 days.wait_type
- (Required) (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
Attributes Reference
The following attributes are exported:
build_pipeline_id
- The OCID of the build pipeline.build_pipeline_stage_predecessor_collection
- The collection containing the predecessors of a stage.items
- A list of build pipeline stage predecessors for a stage.id
- The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline’s OCID.
build_pipeline_stage_type
- Defines the stage type, which is one of the following: BUILD, DELIVER_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE.build_runner_shape_config
- The information about build runner.build_runner_type
- Name of the build runner shape in which the execution occurs. If not specified, the default shape is chosen.memory_in_gbs
- The total amount of memory set for the instance in gigabytes.ocpus
- The total number of OCPUs set for the instance.
build_source_collection
- Collection of build sources.items
- Collection of build sources. In case of UPDATE operation, replaces existing build sources list. Merging with existing build sources is not supported.branch
- Branch name.connection_id
- Connection identifier pertinent to Bitbucket Server source providerconnection_type
- The type of source provider.name
- Name of the build source. This must be unique within a build source collection. The name can be used by customers to locate the working directory pertinent to this repository.repository_id
- The DevOps code repository ID.repository_url
- URL for the repository.
build_spec_file
- The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml.compartment_id
- The OCID of the compartment where the pipeline is created.defined_tags
- Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example:{"foo-namespace.bar-key": "value"}
deliver_artifact_collection
- Specifies an array of artifacts that need to be pushed to the artifactory stores.items
- Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported.artifact_id
- Artifact identifier that contains the artifact definition.artifact_name
- Name of the artifact specified in the build_spec.yaml file.
deploy_pipeline_id
- A target deployment pipeline OCID that will run in this stage.description
- Optional description about the build stage.display_name
- Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.freeform_tags
- 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"}
id
- Unique identifier that is immutable on creation.image
- Image name for the build environment.is_pass_all_parameters_enabled
- A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered.lifecycle_details
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.primary_build_source
- Name of the build source where the build_spec.yml file is located. If not specified, then the first entry in the build source collection is chosen as primary build source.private_access_config
- Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer’s private network.network_channel_type
- Network channel type.nsg_ids
- An array of network security group OCIDs.subnet_id
- The OCID of the subnet where VNIC resources will be created for private endpoint.
project_id
- The OCID of the DevOps project.stage_execution_timeout_in_seconds
- Timeout for the build stage execution. Specify value in seconds.state
- The current state of the stage.system_tags
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:{"orcl-cloud.free-tier-retained": "true"}
time_created
- The time the stage was created. Format defined by RFC3339.time_updated
- The time the stage was updated. Format defined by RFC3339.wait_criteria
- Specifies wait criteria for the Wait stage.wait_duration
- 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
- Wait criteria type.
Timeouts
The timeouts
block allows you to specify timeouts for certain operations:
* create
- (Defaults to 20 minutes), when creating the Build Pipeline Stage
* update
- (Defaults to 20 minutes), when updating the Build Pipeline Stage
* delete
- (Defaults to 20 minutes), when destroying the Build Pipeline Stage
Import
BuildPipelineStages can be imported using the id
, e.g.
$ terraform import oci_devops_build_pipeline_stage.test_build_pipeline_stage "id"