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.

GCP values

Alter the necessary values for your Helm installation. You can access example values files locally by running the following command: helm pull deeploy-install/deeploy --version 1.37.1 --untar.

OpenID Connect values (optional)

To set up OpenID Connect, follow these steps:

• Go to APIs and services → credentials → create credentials → oauth client id
• Set up a consent screen using the following scopes:
  • /auth/userinfo.email
  • /auth/userinfo.profile
• Add a web platform and use https://api.<HOST>/auth/self-service/methods/oidc/callback/google as the allowed redirect URI

Users are allowed to register based on their Google Account domain and cannot be restricted individually. To restrict users from access within Deeploy, you can use manage users in the admin panel or on workspace level

Troubleshooting

After a seemingly successful installation, your cluster may have insufficient CPU. We recommend enabling a Cluster Autoscaler to prevent your cluster from having insufficient CPU, if you haven't done this already.

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.