Skip to main content

Google Cloud Storage - Upload Files from Shipyard

Overview​

Import one or more files directly into a Google Cloud Storage (GCS) bucket. The match type selected greatly affects how this Blueprint works.

If the folder name provided is new, a new folder will automatically be created.

All files uploaded will inherit the default settings for the GCS bucket.

Note: This Vessel cannot be used to upload a local file from your computer.

Recommended Setup:

  1. A Vessel built with this Blueprint should typically run after a Vessel that either downloads a file to Shipyard or generates a file with code.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Shipyard Folder NameGCS_SOURCE_FOLDER_NAMEAlphanumericβž–--Name of the local folder on Shipyard to upload the target file from. If left blank, will look in the home directory.
Shipyard File Name Match TypeGCS_SOURCE_FILE_NAME_MATCH_TYPESelectβœ…exact_matchExact Match: exact_match

Regex Match: regex_match

Determines if the text in "Shipyard File Name" will look for one file with exact match, or multiple files using regex.
Shipyard File NameGCS_SOURCE_FILE_NAMEAlphanumericβœ…--Name of the target file on Shipyard. Can be regex if "Match Type" is set accordingly.
GCS Bucket NameGCS_BUCKET_NAMEAlphanumericβœ…--Name of the GCS bucket to upload the file(s) to.
GCS Folder NameGCS_DESTINATION_FOLDER_NAMEAlphanumericβž–--Folder in the GCS bucket to upload the file(s) to. If left blank, will upload to the root directory.
GCS File NameGCS_DESTINATION_FILE_NAMEAlphanumericβž–--What to name the file(s) being downloaded. If left blank, defaults to the original file name(s).
Service AccountGOOGLE_APPLICATION_CREDENTIALSPasswordβœ…--JSON from a Google Cloud Service account key.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: Google Cloud Storage - Upload Files from Shipyard
inputs:
GCS_SOURCE_FOLDER_NAME: null
GCS_SOURCE_FILE_NAME_MATCH_TYPE: exact_match ## REQUIRED
GCS_SOURCE_FILE_NAME: null ## REQUIRED
GCS_BUCKET_NAME: null ## REQUIRED
GCS_DESTINATION_FOLDER_NAME: null
GCS_DESTINATION_FILE_NAME: null
GOOGLE_APPLICATION_CREDENTIALS: null ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '0'