Upgrade KubeRocketCI v3.8 to 3.9

important

We suggest backing up the KubeRocketCI environment before starting the upgrade procedure.

This section provides detailed instructions for upgrading the KubeRocketCI to version 3.9.0. Follow the steps and requirements outlined below:

warning

edp-install version v3.9 is not support Kiosk as tenancy engine. Please migrate to Capsule engine or disable this options.

1. (Optional) Migrate from Kiosk tenancy engine.

   Capsule

   1. Take look how to install Capsule using addons.

   2. Integrate Capsule with KubeRocketCI.

   3. Update edp-install values file:

      values.yaml

      ...
      cd-pipeline-operator:
        tenancyEngine: "capsule"
      ...

   Disable tenancy engine

   1. To disable tenancy engine update edp-install values file:

      values.yaml

      ...
      cd-pipeline-operator:
        tenancyEngine: "none"
      ...

2. (Optional) Align Keycloak integration.

   In KubeRocketCI version 3.9.0, the Keycloak configuration procedure has been altered in the values file. Please be attentive and align the configuration for your own use case.

   3.8.1

   values.yaml

   sso:
     # -- Install OAuth2-proxy and Keycloak CRs as a part of KubeRocketCI deployment.
     enabled: false
     # -- Defines Keycloak realm name that is used as the Identity Provider (IdP) realm
     realmName: "broker"
     # -- Keycloak URL.
     keycloakUrl: https://keycloak.example.com

   3.9.0

   values.yaml

   sso:
     # -- Install OAuth2-proxy and Keycloak CRs as a part of KubeRocketCI deployment.
     enabled: false
   
     keycloakOperatorResources:
       # Set to false if using the add-ons approach (refer to https://github.com/epam/edp-cluster-add-ons)
       # for KubeRocketCI installation and if the extension-oidc is already installed.
       # This prevents the creation of an additional Keycloak resource and secret.
       # The 'kind' and 'name' must be specified in case of using an existing Keycloak/ClusterKeycloak resource.
       # Create kind: Keycloak as a part of chart installation
       createKeycloakCR: true
       # Can be Keycloak or ClusterKeycloak.
       kind: Keycloak
       # Name of kind: Keycloak/ClusterKeycloak CR.
       name: main
   
     # -- Defines the Keycloak realm name, which by default is named after the namespace where KubeRocketCI is deployed.
     # realmName: edp
     # -- Defines Keycloak sso realm name that is used as the Identity Provider (IdP) realm
     ssoRealmName: "broker"
     # -- Defines Keycloak client name that is used for the Identity Provider (IdP) client
     ssoClientName: "edp"
     # -- Keycloak URL.
     keycloakUrl: https://keycloak.example.com/auth

3. To upgrade KubeRocketCI to the v3.9.0, run the following command:

   helm upgrade edp epamedp/edp-install -n edp --values values.yaml --version=3.9.0
   note

   To verify the installation, it is possible to test the deployment before applying it to the cluster with the --dry-run tag: helm upgrade edp epamedp/edp-install -n edp --values values.yaml --version=3.9.0 --dry-run