Switch Release Channel

This section describes how to switch from release-1.4 to release-1.5 release channel for EKF. You only need to do this once, when you first upgrade to release 1.5.1.

What You’ll Need

  • An upgraded management environment.
  • Your local clone of the Arrikto GitOps repository with manifests for EKF 1.4.

Check Your Environment

  1. Go to your GitOps repository, inside your rok-tools management environment:

    root@rok-tools:~# cd ~/ops/deployments
  2. Ensure that you are currently on the release-1.4 branch:

    root@rok-tools:~/ops/deployments# git rev-parse --abbrev-ref HEAD release-1.4
  3. Get the current status of your GitOps repository and verify that your local repository is clean:

    root@rok-tools:~/ops/deployments# git status On branch release-1.4 nothing to commit, working tree clean
  4. Ensure that you are currently following the release-1.4 release channel:

    root@rok-tools::~/ops/deployments# git rev-parse --abbrev-ref --symbolic-full-name @{u} origin/release-1.4

Procedure

Important

Mirror the GitOps repo to a private remote to be able to recover it in case of failure.

  1. Go to your GitOps repository, inside your rok-tools management environment:

    root@rok-tools:~# cd ~/ops/deployments
  2. Set appropriate SSH command options for the GitOps repository:

    root@rok-tools:~/ops/deployments# git config core.sshCommand "ssh -o BatchMode=yes"
  3. Run keychain to start the SSH agent and use your SSH identity:

    root@rok-tools:~/ops/deployments# eval "$(keychain --eval id_rsa)" * keychain 2.8.2 ~ http://www.funtoo.org * Starting ssh-agent... * Adding 1 ssh key(s): /root/.ssh/id_rsa * ssh-add: Identities added: /root/.ssh/id_rsa

    Troubleshooting

    can’t find id_rsa

    If the above command shows the following warning message:

    Warning: can't find id_rsa; skipping

    it means that keychain could not find the file ~/.ssh/id_rsa, which normally contains your private SSH key.

    To proceed, follow the Configure Git guide to configure your private SSH key.

    Cannot find public key for id_rsa

    If the above command shows the following warning message:

    Warning: Cannot find public key for id_rsa

    it means that keychain clould not find the file ~/.ssh/id_rsa.pub, which normally contains your public SSH key.

    To proceed, generate the public SSH key based on your private key:

    root@rok-tools:~# ssh-keygen -yf /root/.ssh/id_rsa > /root/.ssh/id_rsa.pub
  4. Fetch latest upstream changes:

    root@rok-tools:~/ops/deployments# git fetch --all -p Fetching origin

    Troubleshooting

    Permission denied

    If the above command fails with the following error message:

    Permission denied (publickey)

    ensure that you have run keychain as specified in the Procedure or the Fast-Forward section of this guide.

    If the error persists, it means that you do not have access to the Arrikto GitOps repository. To proceed, follow the Configure Git guide to configure your SSH identity.

  5. Ensure that you are currently on the correct release channel:

    root@rok-tools::~/ops/deployments# git rev-parse --abbrev-ref --symbolic-full-name @{u} origin/release-1.4
  6. Prepare your branch for the upcoming rebase, with the rok-kf-rebase tool:

    root@rok-tools:~/ops/deployments# rok-kf-rebase
  7. After rok-kf-rebase completes, verify that the intermediate rebase branch was created:

    root@rok-tools:~/ops/deployments# git show --shortstat release-1.5-base commit 7ac4720df93325399aea44519bf69b55fec83e03 (release-1.5-base) Author: Rok Kubeflow Rebase <no-reply@arrikto.com> Date: Wed May 12 10:49:52 2021 +0000 Renaming commit

    Note

    The may be an empty commit if no renames are required.

  8. Switch to the release-1.5 local branch:

    root@rok-tools::~/ops/deployments# git checkout release-1.5 Already on 'release-1.5'

    Note

    rok-kf-rebase has already prepared this branch.

  9. Switch to the release-1.5 release channel and rebase your work on top of it:

    root@rok-tools:~/ops/deployments# git \ > -c merge.directoryRenames=false \ > -c merge.renameLimit=99999 \ > rebase -Xtheirs --onto origin/release-1.5 release-1.5-base

    Troubleshooting

    CONFLICT (modify/delete)

    Rebasing your work may cause conflicts when you have modified a file that has been removed from the latest version of Arrikto manifests. In such a case the rebase process will fail with:

    CONFLICT (modify/delete): path/to/file deleted in origin/release-1.5 and modified in HEAD~X. Version HEAD~X of path/to/file left in tree.
    1. Delete those files:

      root@rok-tools:~/ops/deployments# git status \ > --porcelain \ > | awk '{if ($1=="DU") print $2}' \ > | xargs git rm
    2. Continue the rebase process:

      root@rok-tools:~/ops/deployments# git rebase --continue
  10. Configure your local branch to track the new release channel:

    root@rok-tools:~/ops/deployments# git branch --set-upstream-to=origin/release-1.5
  11. Delete the intermediate rebase branch:

    root@rok-tools:~/ops/deployments# git branch -D release-1.5-base

Important

rok-kf-rebase has reverted custom changes in JWA ConfigMap patch. If you had added custom JWA images you have to re-add them, by following the Extend List of JWA Default Images guide. To see the reverted changes run:

root@rok-tools:~/ops/deployments# git diff release-1.4 -- \ > kubeflow/manifests/apps/jupyter/jupyter-web-app/upstream/overlays/deploy/patches/config-map.yaml

Air Gapped

rok-kf-rebase has reverted custom changes in JWA ConfigMap patch. Follow the Use Mirrored Kale Python Image guide again for HP tunning trials to work as expected.

Verify

  1. Go to your GitOps repository, inside your rok-tools management environment:

    root@rok-tools:~# cd ~/ops/deployments
  2. Ensure that you are currently on the release-1.5 branch:

    root@rok-tools:~/ops/deployments# git rev-parse --abbrev-ref HEAD release-1.5
  3. Get the current status of your GitOps repository and verify that your local repository is clean:

    root@rok-tools:~/ops/deployments# git status On branch release-1.5 nothing to commit, working tree clean
  4. Ensure that you are currently following the release-1.5 release channel:

    root@rok-tools::~/ops/deployments# git rev-parse --abbrev-ref --symbolic-full-name @{u} origin/release-1.5

Summary

You have successfully switched to the latest release channel and set up your GitOps repository to track it.

What’s Next

The next step is to update your manifests.