Kubernetes Set Image with YAML

Table of Contents

YAML parameters for Kubernetes Set Image

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_SET_IMAGE.
container
Required
StringThe name of the container.
namespace
Required
StringThe name of the namespace.
deployment
Required
StringThe name of the deployment from the namespace.
image_name
Required
StringThe name of the image to set.
image_tag
Required
StringThe tag of the chosen image.
record_argStringRecord current kubectl command in the resource annotation. Can be one of TRUE, FALSE or NOT_SET. If set to false, do not record the command. If set to TRUE, record the command. If not set, default to updating the existing annotation value only if one already exists.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Kubernetes Set Image

actions:
- action: "Set image"
  type: "KUBERNETES_SET_IMAGE"
  trigger_time: "ON_EVERY_EXECUTION"
  auth_type: "BASIC"
  server: "https://123.45.56.89:6443"
  login: "admin"
  password: "qwerty"
  record_arg: "NOT_SET"
  deployment: "nginx-deployment"
  namespace: "default"
  image_name: "nginx"
  image_tag: "1.7.8"
  container: "nginx"
  kubectl_version: "1.11.1"

Set Image on GKE cluster

YAML parameters for Kubernetes Set Image on GKE cluster

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_SET_IMAGE.
container
Required
StringThe name of the container.
namespace
Required
StringThe name of the namespace.
deployment
Required
StringThe name of the deployment from the namespace.
image_name
Required
StringThe name of the image to set.
image_tag
Required
StringThe tag of the chosen image.
integration_hash
Required
StringThe ID of the Google or Amazon integration.
zone_id
Required
StringThe ID of the GKE zone.
cluster
Required
StringThe ID of the GKE and Amazon EKS cluster.
application_id
Required
StringThe ID of the GKE application.
gke_auth_type
Required
StringAuthorization type. Set to SERVICE_ACCOUNT.
record_argStringRecord current kubectl command in the resource annotation. Can be one of TRUE, FALSE or NOT_SET. If set to false, do not record the command. If set to TRUE, record the command. If not set, default to updating the existing annotation value only if one already exists.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Set Image on GKE cluster

actions:
- action: "Set image"
  type: "KUBERNETES_SET_IMAGE"
  trigger_time: "ON_EVERY_EXECUTION"
  record_arg: "NOT_SET"
  deployment: "nginx-deployment"
  namespace: "default"
  image_name: "nginx"
  image_tag: "1.7.8"
  container: "nginx"
  kubectl_version: "1.11.1"
  integration_hash: "5ddb7c180fb38be67bd78a88a"
  zone_id: "europe-west1-c"
  cluster: "cluster-1"
  application_id: "tokyo-house-138923"
  gke_auth_type: "SERVICE_ACCOUNT"

Set Image on Amazon EKS cluster

YAML parameters for Set Image on Amazon EKS cluster

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_SET_IMAGE.
container
Required
StringThe name of the container.
namespace
Required
StringThe name of the namespace.
deployment
Required
StringThe name of the deployment from the namespace.
image_name
Required
StringThe name of the image to set.
image_tag
Required
StringThe tag of the chosen image.
integration_hash
Required
StringThe ID of the Amazon integration.
cluster
Required
StringThe ID of the GKE and Amazon EKS cluster.
region
Required
StringThe Amazon region. Required when Amazon EKS cluster is set.
role_arn
Required
StringContains information about an IAM role. Can be set for Amazon EKS cluster.
record_argStringRecord current kubectl command in the resource annotation. Can be one of TRUE, FALSE or NOT_SET. If set to false, do not record the command. If set to TRUE, record the command. If not set, default to updating the existing annotation value only if one already exists.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Set Image on Amazon EKS cluster

actions:
- action: "Set image"
  type: "KUBERNETES_SET_IMAGE"
  trigger_time: "ON_EVERY_EXECUTION"
  record_arg: "NOT_SET"
  deployment: "nginx-deployment"
  namespace: "default"
  image_name: "nginx"
  image_tag: "1.7.8"
  container: "nginx"
  kubectl_version: "1.11.1"
  integartion_hash: "5ddb7c180fb38be67bd78a88a"
  cluster: "cluster-1"
  region: "us-west-2"
  role_arn: arn:aws:iam::344123456789:role/EKS_TESTS

Set Image on Azure AKS cluster

YAML parameters for Set Image on Azure AKS cluster

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_SET_IMAGE.
container
Required
StringThe name of the container.
namespace
Required
StringThe name of the namespace.
deployment
Required
StringThe name of the deployment from the namespace.
image_name
Required
StringThe name of the image to set.
image_tag
Required
StringThe tag of the chosen image.
integration_hash
Required
StringThe ID of the Azure integration.
subscription_id
Required
StringThe ID of Azure subscription.
resource_group_name
Required
StringThe Azure resource group name in which the AKS cluster is set.
resource_name
Required
StringThe name of the Kubernetes service in Azure.
record_argStringRecord current kubectl command in the resource annotation. Can be one of TRUE, FALSE or NOT_SET. If set to false, do not record the command. If set to TRUE, record the command. If not set, default to updating the existing annotation value only if one already exists.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Set Image on Azure AKS cluster

actions:
- action: "Set image"
  type: "KUBERNETES_SET_IMAGE"
  trigger_time: "ON_EVERY_EXECUTION"
  record_arg: "NOT_SET"
  deployment: "nginx-deployment"
  namespace: "default"
  image_name: "nginx"
  image_tag: "1.7.8"
  container: "nginx"
  kubectl_version: "1.11.1"
  integration_hash: "5ddb7c180fb38be67bd78a88a"
  subscription_id: "d4fd0732-1b7f-47ff-8ca9-8b003428dcd8"
  resource_group_name: "test-buddy_group"
  resource_name: "buddy-tests"

Set Image on Digital Ocean cluster

YAML parameters for Set Image on Digital Ocean cluster

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_SET_IMAGE.
container
Required
StringThe name of the container.
namespace
Required
StringThe name of the namespace.
deployment
Required
StringThe name of the deployment from the namespace.
image_name
Required
StringThe name of the image to set.
image_tag
Required
StringThe tag of the chosen image.
integration_hash
Required
StringThe ID of Digital Ocean integration.
digital_ocean_cluster
Required
StringThe ID of the DO cluster.
record_argStringRecord current kubectl command in the resource annotation. Can be one of TRUE, FALSE or NOT_SET. If set to false, do not record the command. If set to TRUE, record the command. If not set, default to updating the existing annotation value only if one already exists.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Set Image on Digital Ocean cluster

actions:
- action: "Set image"
  type: "KUBERNETES_SET_IMAGE"
  trigger_time: "ON_EVERY_EXECUTION"
  record_arg: "NOT_SET"
  deployment: "nginx-deployment"
  namespace: "default"
  image_name: "nginx"
  image_tag: "1.7.8"
  container: "nginx"
  kubectl_version: "1.11.1"
  integration_hash: "5ddb7c180fb38be67bd78a88a"
  digital_ocean_cluster: "0ec55079-0398-4cfc-9b51-97e07cb07ae7"

Last modified on December 22, 2022

Get Started

Sign up for free and deploy your project in less than 10 minutes.