From 60df493504f228210449308335b9dee81d84b9dd Mon Sep 17 00:00:00 2001 From: Stef Robbe Date: Sun, 26 Nov 2023 00:54:00 +0100 Subject: [PATCH 1/5] Docs: add dependency installation commands for RHEL based systems --- docs/source/technical_design/localinstall.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/source/technical_design/localinstall.rst b/docs/source/technical_design/localinstall.rst index 9675855d585..dae36c79d67 100644 --- a/docs/source/technical_design/localinstall.rst +++ b/docs/source/technical_design/localinstall.rst @@ -35,6 +35,8 @@ Install dependencies Dependencies are packages required for OpenKAT to work. Run the following commands to install them: +*Debian based systems:* + .. code-block:: sh @@ -44,6 +46,16 @@ Dependencies are packages required for OpenKAT to work. Run the following comman $ echo "deb [signed-by=/usr/share/keyrings/yarnkey.gpg] https://dl.yarnpkg.com/debian stable main" | sudo tee /etc/apt/sources.list.d/yarn.list $ sudo apt-get update && sudo apt-get install yarn +*RHEL based systems:* + +.. code-block:: sh + + $ sudo dnf install https://rpm.nodesource.com/pub_18.x/nodistro/repo/nodesource-release-nodistro-1.noarch.rpm -y + $ sudo dnf install nodejs -y --setopt=nodesource-nodejs.module_hotfixes=1 + $ sudo dnf install -y nodejs gcc g++ make python3-pip docker-compose + $ curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo + $ sudo dnf install yarn -y + Getting Started --------------- @@ -126,4 +138,5 @@ OpenTelemetry OpenTelemetry is a way to trace requests through the system. It is used to find out where a request is going wrong and to instrument performance problems. OpenTelemetry is not enabled by default, but can be enabled by uncommenting the environment variable ``SPAN_EXPORT_GRPC_ENDPOINT`` in the ``.env`` file. -The `Jaeger `_ tracing system is used to view the traces. It can be enabled by enabling the `Docker Compose profile `, for example by running ``docker-compose --profile jaeger up -d`` or using ``export COMPOSE_PROFILES=jaeger`` and then running Make as usual. The Jaeger UI can then be found at http://localhost:16686. +The `Jaeger `_ tracing system is used to view the traces. It can be enabled by enabling the `Docker Compose profile `_, for example by running ``docker-compose --profile jaeger up -d`` or using ``export COMPOSE_PROFILES=jaeger`` and then running Make as usual. The Jaeger UI can then be found at http://localhost:16686. + From ae47828d357db312621a3429c7aa786bd4cd7784 Mon Sep 17 00:00:00 2001 From: Jan Klopper Date: Mon, 27 Nov 2023 11:51:41 +0100 Subject: [PATCH 2/5] Update docs/source/technical_design/localinstall.rst Co-authored-by: Rieven --- docs/source/technical_design/localinstall.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/technical_design/localinstall.rst b/docs/source/technical_design/localinstall.rst index dae36c79d67..7f5d1393547 100644 --- a/docs/source/technical_design/localinstall.rst +++ b/docs/source/technical_design/localinstall.rst @@ -139,4 +139,3 @@ OpenTelemetry OpenTelemetry is a way to trace requests through the system. It is used to find out where a request is going wrong and to instrument performance problems. OpenTelemetry is not enabled by default, but can be enabled by uncommenting the environment variable ``SPAN_EXPORT_GRPC_ENDPOINT`` in the ``.env`` file. The `Jaeger `_ tracing system is used to view the traces. It can be enabled by enabling the `Docker Compose profile `_, for example by running ``docker-compose --profile jaeger up -d`` or using ``export COMPOSE_PROFILES=jaeger`` and then running Make as usual. The Jaeger UI can then be found at http://localhost:16686. - From c3c94e647fd835186f6d7fb78b4bf3053f515c26 Mon Sep 17 00:00:00 2001 From: Stef Robbe Date: Tue, 28 Nov 2023 21:03:39 +0100 Subject: [PATCH 3/5] add openssl dependency to localinstall doc --- docs/source/technical_design/localinstall.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/technical_design/localinstall.rst b/docs/source/technical_design/localinstall.rst index 7f5d1393547..985813a722c 100644 --- a/docs/source/technical_design/localinstall.rst +++ b/docs/source/technical_design/localinstall.rst @@ -50,6 +50,7 @@ Dependencies are packages required for OpenKAT to work. Run the following comman .. code-block:: sh + $ sudo dnf install openssl -y $ sudo dnf install https://rpm.nodesource.com/pub_18.x/nodistro/repo/nodesource-release-nodistro-1.noarch.rpm -y $ sudo dnf install nodejs -y --setopt=nodesource-nodejs.module_hotfixes=1 $ sudo dnf install -y nodejs gcc g++ make python3-pip docker-compose From b983cb38a8133c6269f33493e74a53fcc0eff3ff Mon Sep 17 00:00:00 2001 From: stephanie0x00 <9821756+stephanie0x00@users.noreply.github.com> Date: Mon, 4 Dec 2023 11:07:31 +0100 Subject: [PATCH 4/5] Update localinstall.rst Make it more clear when to install from the Docker repositories, add the docker-compose symlink and add 'make env'. --- docs/source/technical_design/localinstall.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/source/technical_design/localinstall.rst b/docs/source/technical_design/localinstall.rst index 985813a722c..caf164beaca 100644 --- a/docs/source/technical_design/localinstall.rst +++ b/docs/source/technical_design/localinstall.rst @@ -24,9 +24,9 @@ Before installing Install Docker ************** -OpenKAT is installed in Docker, and therefore Docker must be installed first. The preferred method of installation is through a repository. +OpenKAT is installed in Docker, and therefore Docker must be installed first. The preferred method of installation is through a repository. However, OpenKAT requires a newer version of Docker than what is available in the default ubuntu and debian repositories. That is why you should always use Docker's repository. -OpenKAT requires a newer version of Docker than what is available in the default ubuntu and debian repositories. That is why you should always use Docker's repository. On the `Docker Engine installation overview `_ page you can find links to installation pages for all major Linux distributions. For a specific example using the Docker repository on Debian, see `Debian install using the repository `_. The installation pages for the other Linux distributions contain similar instructions. +On the `Docker Engine installation overview `_ page you can find links to installation pages for all major Linux distributions. For a specific example using the Docker repository on Debian, see `Debian install using the repository `_. The installation pages for the other Linux distributions contain similar instructions. **Important:** Please follow the post-installation steps as well! You can find them here: `Docker Engine post-installation steps `_. @@ -41,11 +41,17 @@ Dependencies are packages required for OpenKAT to work. Run the following comman .. code-block:: sh $ curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - - $ sudo apt-get install -y nodejs gcc g++ make python3-pip docker-compose + $ sudo apt-get install -y nodejs gcc g++ make python3-pip $ curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | gpg --dearmor | sudo tee /usr/share/keyrings/yarnkey.gpg >/dev/null $ echo "deb [signed-by=/usr/share/keyrings/yarnkey.gpg] https://dl.yarnpkg.com/debian stable main" | sudo tee /etc/apt/sources.list.d/yarn.list $ sudo apt-get update && sudo apt-get install yarn +After installing Docker from the Docker repository it might be necessary to create a symlink for the command `docker-compose` as the latest version now uses a space instead of a dash. You can do this with the following command: + +.. code-block:: sh + + $ ln -s /usr/libexec/docker/cli/plugins/compose /usr/bin/docker-compose + *RHEL based systems:* .. code-block:: sh @@ -81,6 +87,7 @@ Default installation .. code-block:: sh + $ make env $ make kat Currently, the ``make kat`` command only works for the first user on a ``*nix`` system. This is a known problem which will be solved soon. The current user must be user 1000. You can check this by executing `id`. From 0ffc7078d9d8d6968afeb5b7099f2936e4378792 Mon Sep 17 00:00:00 2001 From: stephanie0x00 <9821756+stephanie0x00@users.noreply.github.com> Date: Tue, 5 Dec 2023 10:29:58 +0100 Subject: [PATCH 5/5] Update localinstall.rst Fixed trailing spaces --- docs/source/technical_design/localinstall.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/technical_design/localinstall.rst b/docs/source/technical_design/localinstall.rst index caf164beaca..a16928f6ea2 100644 --- a/docs/source/technical_design/localinstall.rst +++ b/docs/source/technical_design/localinstall.rst @@ -24,7 +24,7 @@ Before installing Install Docker ************** -OpenKAT is installed in Docker, and therefore Docker must be installed first. The preferred method of installation is through a repository. However, OpenKAT requires a newer version of Docker than what is available in the default ubuntu and debian repositories. That is why you should always use Docker's repository. +OpenKAT is installed in Docker, and therefore Docker must be installed first. The preferred method of installation is through a repository. However, OpenKAT requires a newer version of Docker than what is available in the default ubuntu and debian repositories. That is why you should always use Docker's repository. On the `Docker Engine installation overview `_ page you can find links to installation pages for all major Linux distributions. For a specific example using the Docker repository on Debian, see `Debian install using the repository `_. The installation pages for the other Linux distributions contain similar instructions. @@ -46,7 +46,7 @@ Dependencies are packages required for OpenKAT to work. Run the following comman $ echo "deb [signed-by=/usr/share/keyrings/yarnkey.gpg] https://dl.yarnpkg.com/debian stable main" | sudo tee /etc/apt/sources.list.d/yarn.list $ sudo apt-get update && sudo apt-get install yarn -After installing Docker from the Docker repository it might be necessary to create a symlink for the command `docker-compose` as the latest version now uses a space instead of a dash. You can do this with the following command: +After installing Docker from the Docker repository it might be necessary to create a symlink for the command `docker-compose` as the latest version now uses a space instead of a dash. You can do this with the following command: .. code-block:: sh