Migrating Krateo PlatformOps from v2.5.0 to v2.5.1 (AKS example)

[!NOTE]
Skip this section if you have already Krateo v.2.5.0 installed

Krateo 2.5.1 release note is available here: ../../90-release-notes/11-release-note-2-5-1.md

Updated schemas for the new frontend are collected here: https://github.com/krateoplatformops/frontend-chart/tree/0.0.48/chart/crds.

The new Bleprints Marketplace has been introduced, and in this guide we will leverage the new https://github.com/krateoplatformops-blueprints/portal-composition-page-generic/tree/1.0.0, which is our opinionated and agnostic Composition page that shows Composition informations such as Events, Status of the managed resources and Values.

Starting point: Krateo 2.5.0, Fireworksapp compositiondefinition 2.0.2, fireworksapp-tomigrate composition

helm upgrade installer installer \
  --repo https://charts.krateo.io \
  --namespace krateo-system \
  --create-namespace \
  --set krateoplatformops.service.type=LoadBalancer \
  --set krateoplatformops.service.externalIpAvailable=true \
  --install \
  --version 2.5.0 \
  --wait

This is the login page of Krateo 2.5.0:

Login with the new password generated for the admin user:

kubectl get secret admin-password  -n krateo-system -o jsonpath="{.data.password}" | base64 -d

Let's apply a Fireworksapp compositiondefinition version 2.0.2: https://github.com/krateoplatformops/krateo-v2-template-fireworksapp, follow instruction for Krateo version 2.5.0:

This is the dashboard page of Krateo 2.5.0 installation with the installed compositiondefinition with status Ready:False:

This is the dashboard page of Krateo 2.5.0 installation with the install compositiondefinition that, after a while,e has status Ready:True:

Moving to the template page of Krateo 2.5.0 installation, a Card is available:

Let's click on the Card to open the Drawer with the CustomForm:

Let's fill the form:

Krateo automatically opens the compositions page once the fireworksapp-tomigrate composition is created:

Let's navigate the fireworksapp-tomigrate composition widgets:

This is the dashboard page of Krateo 2.5.0 installation with the installed fireworksapp-tomigrate composition:

Ending point: Krateo 2.5.1, Fireworksapp compositiondefinition 2.0.3 (version changed within the same compositiondefinition, previous fireworksapp-tomigrate composition

Let's upgrade Krateo from v2.5.0 to v2.5.1 on AKS in the following way. To prepare the update, start the following Job:

cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Namespace
metadata:
  name: krateo-system
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: helm-runner
  namespace: krateo-system
---
# For simplicity, cluster-admin. Tighten later if needed.
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: helm-runner-cluster-admin
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: cluster-admin
subjects:
  - kind: ServiceAccount
    name: helm-runner
    namespace: krateo-system
---
apiVersion: batch/v1
kind: Job
metadata:
  name: krateo-pre-upgrade-2-5-1
  namespace: krateo-system
spec:
  backoffLimit: 4
  ttlSecondsAfterFinished: 3600
  template:
    spec:
      serviceAccountName: helm-runner
      restartPolicy: OnFailure
      containers:
        - name: runner
          image: dtzar/helm-kubectl:3.14.4
          imagePullPolicy: IfNotPresent
          command: ["/bin/sh","-lc"]
          args:
            - |
              set -euo pipefail

              echo "Step 1) Annotate CRD ..."
              kubectl annotate crd krateoplatformops.krateo.io \
                meta.helm.sh/release-name=installer \
                meta.helm.sh/release-namespace=krateo-system \
                app.kubernetes.io/managed-by=Helm \
                --overwrite

              echo "Step 2) Label CRD ..."
              kubectl label crd krateoplatformops.krateo.io \
                app.kubernetes.io/managed-by=Helm --overwrite

              echo "Pre-upgrade 2.5.1 job done ✅"
EOF

Update then Krateo to version 2.5.1:

  helm upgrade installer installer \
    --repo https://charts.krateo.io \
    --namespace krateo-system \
    --create-namespace \
    --set krateoplatformops.service.type=LoadBalancer \
    --set krateoplatformops.service.externalIpAvailable=true \
    --install \
    --version 2.5.1 \
    --wait

To complete the upgrade, execute the following job:

cat <<EOF | kubectl apply -f -
apiVersion: batch/v1
kind: Job
metadata:
  name: krateo-post-upgrade-2-5-1
  namespace: krateo-system
spec:
  backoffLimit: 4
  ttlSecondsAfterFinished: 3600
  template:
    spec:
      serviceAccountName: helm-runner
      restartPolicy: OnFailure
      containers:
        - name: runner
          image: dtzar/helm-kubectl:3.14.4
          imagePullPolicy: IfNotPresent
          command: ["/bin/sh","-lc"]
          args:
            - |
              set -euo pipefail

              echo "Step 4) Add & update 'marketplace' repo ..."
              helm repo add marketplace https://marketplace.krateo.io
              helm repo update marketplace

              echo "Step 5) Uninstall old 'portal' release if present ..."
              helm uninstall portal -n krateo-system || true

              echo "Step 6) Install 'portal' from marketplace ..."
              helm install portal marketplace/portal \
                -n krateo-system \
                --version 1.0.0 \
                --wait

              echo "Post-upgrade 2.5.1 job done ✅"
EOF

[!NOTE]
The LoadBalancer IP for the Portal will change

Login with the new password generated for the admin user:

kubectl get secret admin-password  -n krateo-system -o jsonpath="{.data.password}" | base64 -d

This is the dashboard page:

This is the empty blueprints page (it substitues the old templates one):

This is the compositions page:

Compositions migration

In order to fully leverage the 2.5.1 Portal widgets, the dependency in Fireworksapp has been updated

We will update the related compositiondefinition:

cat <<EOF | kubectl apply -f -
apiVersion: core.krateo.io/v1alpha1
kind: CompositionDefinition
metadata:
  name: fireworksapp
  namespace: fireworksapp-system
spec:
  chart:
    repo: fireworks-app
    url: https://charts.krateo.io
    version: 2.0.3
EOF

And add Routes to the composition namespace fireworksapp-system:

cat <<EOF | kubectl apply -f -
apiVersion: widgets.templates.krateo.io/v1beta1
kind: Route
metadata:
  name: fireworksapp-system-composition-route
  namespace: fireworksapp-system
spec:
  widgetData:
    path: /compositions/fireworksapp-system/{name}
    resourceRefId: fireworksapp-system-composition-tablist
  resourcesRefs:
    items:
      - id: fireworksapp-system-composition-tablist
        apiVersion: widgets.templates.krateo.io/v1beta1
        name: "{name}-composition-tablist"
        namespace: fireworksapp-system
        resource: tablists
        verb: GET
EOF

Let's go back to the compositions page:

And click on the fireworksapp-tomigrate composition:

Templates migration

To add again the Blueprint to the catalog, we will leverage the new portal-blueprint-page blueprint:

cat <<EOF | kubectl apply -f -
apiVersion: core.krateo.io/v1alpha1
kind: CompositionDefinition
metadata:
  name: portal-blueprint-page
  namespace: krateo-system
spec:
  chart:
    repo: portal-blueprint-page
    url: https://marketplace.krateo.io
    version: 1.0.5
EOF

kubectl wait compositiondefinition portal-blueprint-page --for condition=Ready=True --namespace krateo-system --timeout=500s

Let's update the CompositionDefinition Custom Resource Definition:

kubectl apply -f https://raw.githubusercontent.com/krateoplatformops/core-provider-chart/refs/tags/0.33.4/chart/crds/core.krateo.io_compositiondefinitions.yaml

And now we add the Fireworksapp blueprint:

cat <<EOF | kubectl apply -f -
apiVersion: composition.krateo.io/v1-0-5
kind: PortalBlueprintPage
metadata:
  name: fireworks-app
  namespace: fireworksapp-system
spec:
  blueprint:
    url: https://charts.krateo.io
    version: 2.0.3 # this is the Blueprint version
    hasPage: false
  form:
    alphabeticalOrder: false
  panel:
    title: FireworksApp (Not Ordered Schema)
    icon:
      name: fa-cubes
EOF

Let's go back to the blueprints page:

The new form is available:

Important notes

• With the 2.5.1 release, every namespace that will contain at least a composition that will have a dedicated page on the Portal, requires the following yaml. i.e. for the demo-system namespace:

apiVersion: widgets.templates.krateo.io/v1beta1
kind: Route
metadata:
  name: demo-system-composition-route
  namespace: demo-system
spec:
  widgetData:
    path: /compositions/demo-system/{name}
    resourceRefId: demo-system-composition-tablist
  resourcesRefs:
    items:
      - id: demo-system-composition-tablist
        apiVersion: widgets.templates.krateo.io/v1beta1
        name: "{name}-composition-tablist"
        namespace: demo-system
        resource: tablists
        verb: GET
---
apiVersion: widgets.templates.krateo.io/v1beta1
kind: Route
metadata:
  name: demo-system-compositions-route
  namespace: demo-system
spec:
  widgetData:
    path: /compositions/demo-system
    resourceRefId: demo-system-compositions-page-datagrid
  resourcesRefs:
    items:
      - id: demo-system-compositions-page-datagrid
        apiVersion: widgets.templates.krateo.io/v1beta1
        name: demo-system-compositions-page-datagrid
        namespace: demo-system
        resource: datagrids
        verb: GET