Tag Docker Image with YAML

YAML Parameters for Tag Docker Image action

Hint

List with common parameters for all Buddy actions

Name	Type	Description
name `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `PROMOTE_IMAGE`.
same_location `Required`	Boolean	If set to `true`, promotes the image within the same registry (only tag changes). If `false`, promotes between different registries.
src `Required`	ImageDefinition	Source configuration defining where to pull the image from.
dest `Required`	ImageDefinition	Destination configuration defining where to push the image to.

Image Definition

Name	Type	Description
docker_registry `Required`	String	Source registry type. Available values: `DOCKER_HUB`, `AMAZON_ECR`, `GOOGLE_ARTIFACT_REGISTRY`, `GITHUB_CONTAINER_REGISTRY`, `OTHER`.
image `Required`	String	The source Docker image with tag (e.g., `myapp/image:v1.0)`.
registry	String	The registry URL. Required for `GOOGLE_ARTIFACT_REGISTRY` and `OTHER` registry types. For Google Artifact Registry: region-specific URLs like us-central1-docker.pkg.dev, europe-west1-docker.pkg.dev. For custom registries: full registry URL.
username	String	Username for authentication. Required when using `OTHER` registry type without integration.
password	String	Password for authentication. Required when using `OTHER` registry type without integration.
integration	String	Integration ID for authentication. Required for `DOCKER_HUB`, `AMAZON_ECR`, `GOOGLE_ARTIFACT_REGISTRY`, `GITHUB_CONTAINER_REGISTRY`.
region	String	AWS region name. Required for `AMAZON_ECR`. The full list of regions is available here.
tag	String	New tag for the image (in dest object). Required when `same_location` is `true`.

Examples

Promote within the same registry (retag)

yaml
actions:
  - action: "Promote to production tag"
    type: PROMOTE_IMAGE
    same_location: true
    src:
      docker_registry: DOCKER_HUB
      image: mycompany/myapp:v1.2.3
      integration: DOCKER_HUB
    dest:
      tag: production

Promote from Google Artifact Registry to custom registry

yaml
actions:
  - action: "Promote to private registry"
    type: PROMOTE_IMAGE
    same_location: false
    src:
      docker_registry: GOOGLE_ARTIFACT_REGISTRY
      registry: us-central1-docker.pkg.dev
      image: my-gcp-project/my-repo/myapp:staging
      integration: GOOGLE_SERVICE_ACCOUNT
    dest:
      docker_registry: OTHER
      registry: registry.mycompany.com
      image: mycompany/myapp:production
      username: deploy-user
      password: '!encrypted abc123def456ghi789jkl012mno345pqr678stu901vwx=='

Promote from Docker Hub to Google Artifact Registry

yaml
actions:
  - action: "Promote to Artifact Registry"
    type: PROMOTE_IMAGE
    same_location: false
    src:
      docker_registry: DOCKER_HUB
      image: mycompany/myapp:v2.1.0
      integration: DOCKER_HUB
    dest:
      docker_registry: GOOGLE_ARTIFACT_REGISTRY
      registry: us-central1-docker.pkg.dev
      image: my-gcp-project/my-repo/myapp:production
      integration: GOOGLE_SERVICE_ACCOUNT

Promote from GitHub Container Registry to Amazon ECR

yaml
actions:
  - action: "Promote from GHCR to ECR"
    type: PROMOTE_IMAGE
    same_location: false
    src:
      docker_registry: GITHUB_CONTAINER_REGISTRY
      image: mycompany/myapp:latest
      integration: GITHUB_TOKEN
    dest:
      docker_registry: AMAZON_ECR
      image: 123456789.dkr.ecr.us-east-1.amazonaws.com/myapp:production
      integration: AWS_INTEGRATION
      region: us-east-1

Last modified on Jun 12, 2025

StackHawk CLI TCP Monitoring