From 64bcdc21f618696957dfccec8776f3539dcaae78 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Tom=C3=A1=C5=A1ek?= Date: Thu, 19 Sep 2024 12:03:43 +0200 Subject: [PATCH] updated docs for VA 2.13.0 (#177) --- .../06-deployment-appliance/01-overview.md | 8 ++--- .../06-deployment-appliance/05-operations.md | 35 +++++++++++++++++++ 2 files changed, 39 insertions(+), 4 deletions(-) diff --git a/docs/10-certificate-key/03-installation-guide/04-deployment/06-deployment-appliance/01-overview.md b/docs/10-certificate-key/03-installation-guide/04-deployment/06-deployment-appliance/01-overview.md index f39aafae3..5cc0dbd45 100644 --- a/docs/10-certificate-key/03-installation-guide/04-deployment/06-deployment-appliance/01-overview.md +++ b/docs/10-certificate-key/03-installation-guide/04-deployment/06-deployment-appliance/01-overview.md @@ -24,10 +24,10 @@ Because of different availability and public/private access to containers, the v | Resource | Optimum | Minimum | |----------|---------|---------| | CPU | 8 cores | 4 cores | -| RAM | 16 GB | 8 GB | +| RAM | 16 GB | 12 GB | | disk | 50 GB | 20 GB | -By *minimum* requirements we mean resources which needed for CZERTAINLY and kubernetes installation and for basic evaluation of its features. +By *minimum* requirements we mean resources which are needed for CZERTAINLY with all configurable componets and kubernetes installation and for basic evaluation of its features. :::tip[Resource management] Resources can be scaled up or down based on the needs of the platform. The resources needed for the CZERTAINLY platform differs based on the number of managed objects, implemented use-cases, and required connectors. @@ -36,9 +36,9 @@ Resources can be scaled up or down based on the needs of the platform. The resou ## Download and import image To get the virtual appliance running in your environment for further installation and configuration, you must: -1. Download virtual appliance [image](https://threekeycz-my.sharepoint.com/:f:/g/personal/jan_tomasek_3key_company/EvTNcHQYa4BInbGsK-YSGHkBIx9V6DfAxnMKqrvWdEB8NA?e=ujoUdt). +1. Download virtual appliance [image](https://threekeycz-my.sharepoint.com/:f:/g/personal/jan_tomasek_3key_company/EvTNcHQYa4BInbGsK-YSGHkB7BTKvI9JCZJJaQx2KC6eBw). 2. Optionally verify SHA256 hash of the image. -2. Import virtual appliance image to your virtual infrastructure. +3. Import virtual appliance image to your virtual infrastructure. For testing purposes, you can use: - [Oracle VirtualBox](https://www.virtualbox.org/wiki/Downloads) diff --git a/docs/10-certificate-key/03-installation-guide/04-deployment/06-deployment-appliance/05-operations.md b/docs/10-certificate-key/03-installation-guide/04-deployment/06-deployment-appliance/05-operations.md index 131644a64..e747ca2da 100644 --- a/docs/10-certificate-key/03-installation-guide/04-deployment/06-deployment-appliance/05-operations.md +++ b/docs/10-certificate-key/03-installation-guide/04-deployment/06-deployment-appliance/05-operations.md @@ -125,6 +125,41 @@ In case you decide to upgrade your Virtual appliance based on Debian Bullseye, y * [restore](#restore) database, * re-run CZERTAINLY installation from the main menu. +#### Kubernetes upgrades + +CZERTAINLY Virtual Appliance is using [RKE2](https://docs.rke2.io/) as Kubernetes distribution, latest version can be checked in their [Relase Notes](https://docs.rke2.io/release-notes/v1.31.X). The actual running version on Appliance can be checked by the shell command `kubectl version`. Example output: +```bash +$ kubectl version +Client Version: v1.28.11+rke2r1 +Kustomize Version: v5.0.4-0.20230601165947-6ce0bf390ce3 +Server Version: v1.28.11+rke2r1 +``` + +To upgrade exec "Install CZERTAINLY" from the main menu. This will download the a version of the RKE2 installer, which you can see in the Ansible output: +``` +TASK [rke2 : download rke2 installer] ****************************************** +changed: [localhost] +``` +Exec installer from shell command `sudo /usr/local/bin/rke2-install.sh`, example output: +```bash +$ sudo /usr/local/bin/rke2-install.sh +[sudo] password for czertainly: +[INFO] finding release for channel stable +[INFO] using v1.30.4+rke2r1 as release +[INFO] downloading checksums at https://github.com/rancher/rke2/releases/download/v1.30.4+rke2r1/sha256sum-amd64.txt +[INFO] downloading tarball at https://github.com/rancher/rke2/releases/download/v1.30.4+rke2r1/rke2.linux-amd64.tar.gz +[INFO] verifying tarball +[INFO] unpacking tarball file to /usr/local +``` +This downloads and deploys a new version of RKE2. Next, you need to restart RKE2. Exec `sudo systemctl restart rke2-server.service` and finally verify that Kubernetes was upgraded: + +```bash +$ kubectl version +Client Version: v1.30.4+rke2r1 +Kustomize Version: v5.0.4-0.20230601165947-6ce0bf390ce3 +Server Version: v1.30.4+rke2r1 +``` + #### CZERTAINLY upgrade