Skip to main content
Version: 1.35

Install the Deeploy software stack

This repository contains detailed instructions for installing the Deeploy Core software stack. Here, you will find all the necessary scripts to configure the dependencies (Istio, Knative, and cert-manager), as well as the installation process for the Deeploy Core Helm chart.

Follow the steps outlined in the repository's readme. For the latest stable Helm chart installation of Deeploy Core, we recommend checking https://artifacthub.io/packages/helm/deeploy-install/deeploy. After adjusting the values, deploy the Deeploy stack. The resulting command should look something like:

helm repo add deeploy-install https://deeploy-charts.storage.googleapis.com/
helm repo update
helm install deeploy deeploy-install/deeploy --file values.yaml --namespace deeploy --create namespace deeploy --version <VERSION>

AWS values

Use the following AWS values for the values.yaml file:

ParameterDescriptionValue
images.registryIf you use the AWS marketplace description"709825985650.dkr.ecr.us-east-1.amazonaws.com/deeploy/"
license.typeIf you use the AWS marketplace description. Otherwise use "Deeploy""AWS"
license.aws.regionRegion for deployment cloud resources. If you use the AWS marketplace description"eu-central-1"

Remote blob storage values

ParameterDescriptionValue
objectStorage.typeStorage service to use with Deeploy"AWS_S3"
objectStorage.aws.bucketNameThe S3 bucket name to use""
objectStorage.aws.useEKSPodIdentityWebhookWhether to use AWS IAM Role with EKS service accounts to authenticate with AWS S3false
objectStorage.aws.trustedIamRoleArnAnnotationARN of the trusted AWS IAM role with the proper access rights to S3""
objectStorage.aws.s3AccessKeyThe IAM user access key with access to the S3 bucket""
objectStorage.aws.s3SecretKeyThe IAM user secret access key with access to the S3 bucket""
objectStorage.aws.regionRegion for deployment cloud resources"eu-central-1"

Security Values

ParameterDescriptionValue
security.keyManagement.kmsTypeKMS service to use with Deeploy"AWS"
security.keyManagement.aws.keyIdID of the AWS Vault key""
security.keyManagement.aws.useEKSPodIdentityWebhookWhether to use AWS IAM Role with EKS service accounts to authenticate with AWS KMSfalse
security.keyManagement.aws.trustedIamRoleArnARN of the trusted AWS IAM role with the proper access rights to KMS""
security.keyManagement.aws.accessKeyThe IAM user access key with access to the key""
security.keyManagement.aws.secretKeyThe IAM user secret access key with access to the key""
security.keyManagement.aws.regionRegion for deployment cloud resources"eu-central-1"

Upgrades

Make sure to regularly upgrade your Deeploy installation. Specific instructions are listed in the release notes (tags). The upgrade process consists of two steps:

  1. Infrastructure update (e.g., upgrade EKS Kubernetes version)
  2. Switch to a new version of Deeploy:
    • Patch (e.g., 1.20.1 to 1.20.2), small changes often a result of a bug fix
    • Major release (e.g., 1.20.1 to 1.21.0), larger (visual) changes that can include infrastructure changes

MyDeeploy license registration

When you install Deeploy for the first time, the Deeploy helm chart will register your license key (runPreInstall: true). In case you have to change your license key or run the cluster registration manually, you can find the instructions here. For AWS Marketplace installations, registering a license through MyDeeploy is not necessary.