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.
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 constent 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/googleas 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
| Parameter | Description | Value |
|---|---|---|
| oidc.enabled | Whether to allow OpenID Connect to login to Deeploy. | false |
| oidc.google.clientId | The Client ID of the Web platform. | "" |
| oidc.google.clientSecret | The Client Secret of the Web platform. | "" |
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:
- Infrastructure update (e.g., upgrade EKS Kubernetes version)
- 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.