diff --git a/docs/source/release-notes/1.18.rst b/docs/source/release-notes/1.18.rst index f230641313a..5036623fd72 100644 --- a/docs/source/release-notes/1.18.rst +++ b/docs/source/release-notes/1.18.rst @@ -8,7 +8,7 @@ Dashboard and Report data also have historical versions available. Future versio We also included a new HTTP export boefje that you can use to export all objects in the graph to an external API either on an interval (e.g. every hour), or when the OOI is either created or changed, using our new Run-On functionality. This can be used to alert that findings have been created or their score has been updated. There's also a new S3 backend for Bytes and various new boefjes, normalizers and fixes to bits from our growing community. Thanks! Docs on how to setup S3 for your (new) install can be found here: https://docs.openkat.nl/installation-and-deployment/s3-buckets.html -The language Tamil has been added via the hard work of a communitee volunteer. Since we have not yet tested it ourselves, it's currently only available if you add it to the languages list manually. +The language Tamil has been added via the hard work of a community volunteer. Since we have not yet tested it ourselves, it's currently only available if you add it to the languages list manually. If you want to add a language to OpenKAT, or just help translate smaller parts, please take a look at our weblate: https://hosted.weblate.org/projects/openkat/nl-kat-coordination/ any help is much appreciated! The Keiko module (formerly used to generate reports Via LaTeX) has been removed as we are now using full html reports that can also be exported as PDF. @@ -298,28 +298,18 @@ Dependency Updates Upgrading ========= -Keiko has been removed. You can safely uninstall / remove the various Keiko packages/services and/or containers. +Keiko has been removed. You should uninstall / remove the Keiko package or container. -Removing / Stopping Keiko -------------------------- -When using docker: -.. code-block:: sh - -docker stop nl-kat-coordination-keiko-1 -docker container rm nl-kat-coordination-keiko-1 -docker rmi nl-kat-coordination-keiko +Containers +---------- -When using Debian packages: +When using docker with docker compose, you need to remove keiko from the +docker-compose.yml file. You can then use `--remove-orphan` option to tell +docker compose to remove containers that are no longer in the compose file: -as root / sudo: .. code-block:: sh -systemctl stop kat-keiko -systemctl disable kat-keiko -rm /etc/systemd/system/kat-keiko.service -rm /etc/kat/keiko.conf -systemcml daemon-reload - + docker compose up -d --remove-orphans Debian packages --------------- @@ -327,6 +317,18 @@ Debian packages If you are using the :doc:`/installation-and-deployment/scripts` we provide to install/upgrade OpenKAT you need to get the latest version that includes the kat-rocky-worker service. +You should also remove the kat-keiko package: + +.. code-block:: sh + + apt purge kat-keiko + +Note that if you use the openkat-update.sh script to update to a newer 1.18 +version (for example from 1.18.0rc1 to 1.18.0), then the kat-keiko will be +installed again because the script will update or install all the packages. In 1.19 +this won't happen because the kat-keiko package will not exist anymore. + + Full Changelog ==============