From 99604ec2b54941cfaa2cb876c48e6a47d73b8748 Mon Sep 17 00:00:00 2001 From: ereali-aneo <167760294+ereali-aneo@users.noreply.github.com> Date: Mon, 2 Dec 2024 15:12:25 +0100 Subject: [PATCH 1/3] docs: Update 2.verify-deployment.md --- .../1.linux/2.verify-deployment.md | 34 ++----------------- 1 file changed, 2 insertions(+), 32 deletions(-) diff --git a/.docs/content/1.installation/1.linux/2.verify-deployment.md b/.docs/content/1.installation/1.linux/2.verify-deployment.md index 48e2d96c9..247403bf2 100644 --- a/.docs/content/1.installation/1.linux/2.verify-deployment.md +++ b/.docs/content/1.installation/1.linux/2.verify-deployment.md @@ -38,40 +38,10 @@ Example: http://:5000 ``` -## Samples +## HTC Mock -There these scripts that can be used in order to verify the installation of ArmoniK : - -* [Symphony Like](https://github.com/aneoconsulting/ArmoniK.Samples/tree/main/tools/tests/symphony_like.sh) -* [Unified](https://github.com/aneoconsulting/ArmoniK.Samples/tree/main/tools/tests/unified_api.sh) -* [Stress Test](https://github.com/aneoconsulting/ArmoniK.Samples/tree/main/tools/tests/stress-tests.sh) - -::alert{type="info"} - -You can read more about samples in their [dedicated documentation](https://aneoconsulting.github.io/ArmoniK.Samples/). -:: - -### Install Samples - -::alert{type="info"} -You can find more information about samples in their [dedicated documentation](https://aneoconsulting.github.io/ArmoniK.Samples/). -:: - -Before executing the samples, you must clone [ArmoniK.Samples](https://github.com/aneoconsulting/ArmoniK.Samples) into a folder name `Source` from the root repository of ArmoniK: - -```bash [shell] -git clone https://github.com/aneoconsulting/ArmoniK.Samples.git ./Source/ArmoniK.Samples/ -``` - -### Execute Samples - - -* Execute [tools/tests/unified_api.sh](https://github.com/aneoconsulting/ArmoniK.Samples/blob/main/tools/tests/unified_api.sh) from the **root** repository: - - ```bash [shell] - tools/tests/unified_api.sh - ``` +You can now run [HTC Mock](https://aneoconsulting.github.io/ArmoniK/guide/how-to/how-to-use-htc-mock) to see a mock utilisation of ArmoniK and verify your installation. ::alert{type="info"} You can check the logs using Seq. From 9d27a59d41dd2a0f0cfc35587e7e42d345aae29e Mon Sep 17 00:00:00 2001 From: ereali-aneo Date: Mon, 2 Dec 2024 15:25:00 +0100 Subject: [PATCH 2/3] docs: remove wsl with geni --- .../2.windows/2.wsl2-with-genie.md | 102 ------------------ 1 file changed, 102 deletions(-) delete mode 100644 .docs/content/1.installation/2.windows/2.wsl2-with-genie.md diff --git a/.docs/content/1.installation/2.windows/2.wsl2-with-genie.md b/.docs/content/1.installation/2.windows/2.wsl2-with-genie.md deleted file mode 100644 index 611545925..000000000 --- a/.docs/content/1.installation/2.windows/2.wsl2-with-genie.md +++ /dev/null @@ -1,102 +0,0 @@ -# WSL2 with genie - -::alert{type="warning"} -This installation method is not recommended for production environments. -:: - -This installation will use [`genie`](https://github.com/arkane-systems/genie). Genie is a tool which gives you a way to run systemd as pid 1. The usage of this tool will disable some Windows goodies within your Ubuntu distribution. - -::alert{type="warning"} -We do not recommend to use this installation method, even for development environment since WSL2 support natively `systemd`. We recommend to use [WSL2 with systemd](./1.wsl2-with-systemd.md). -:: - -::alert{type="info"} -You must have installed WSL2 and Ubuntu before continuing. If you haven't, please refer to the [WSL2 installation](./0.installation-using-wsl2.md) method. -:: - -## Install genie - -To install `genie`, you can use the [install-genie](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/utils/scripts/installation/install-genie.sh) script: - -```bash [shell] -./infrastructure/utils/scripts/installation/install-genie.sh -``` - -::alert{type="info"} -Please, read the script `install-genie.sh` before executing it. -:: - -For manual installation, you can refer to [Genie How-To](https://arkane-systems.github.io/wsl-transdebian/). - -Finally, in order to avoid some issues, you need to mask some services. - -```bash [shell] -sudo systemctl disable getty@tty1.service multipathd.service multipathd.socket ssh.service -sudo systemctl mask systemd-remount-fs.service -``` - -::alert{type="info"} -You can find more information about this issue on the [genie documentation](https://github.com/arkane-systems/genie#warning-timing-out). This setup works for the version of Genie installed with our script but could vary with other versions. -:: - -Then, you need to exit your Ubuntu distribution and restart it. - -```bash [shell] -exit -``` - -```powershell [powershell] -wsl --shutdown -``` - -::alert{type="warning"} -Please, do not start a WSL2 session with native `systemd` in parallel of `genie`. This will cause some issues with k3s when you will try to install it. -:: - -## Start session - -Because `genie` must be started as PID 1, you need to start a session with `genie`. - -```bash [shell] -wsl genie -s -``` - -`-s` is used to initialize the bottle (if necessary), and run a shell in it. You can find more options on the [genie documentation](https://github.com/arkane-systems/genie#usage). - -::alert{type="info"} -You could also use `wsl genie -i` to initialize `genie` prior to starting a session. -:: - -::alert{type="info"} -If you have multiple WSL2 installations, you can specify the distribution name with `wsl -d genie -s`. -:: - -::alert{type="warning"} -Starting a WSL2 session with `wsl` alone will not create the session within the `genie` namespace, and thus services like Docker or Kubernetes will not behave as expected. **Be careful**. -:: - -When starting your session, you could see this : - -```text -Waiting for systemd....!!!!!!!!!!!!! -``` - -Because some services will start before `systemd`, you will see this message. You can ignore it. To start faster, you can hit `ctrl + c` to stop the waiting and re-run the command `wsl genie -s`. - -::alert{type="info"} -You can find more information about this issue on the [genie documentation](https://github.com/arkane-systems/genie#warning-timing-out) -:: - -## Install ArmoniK - -::alert{type="warning"} -Be careful, you must enable `genie` support before installing ArmoniK. -:: - -First, clone the ArmoniK repository (inside your home directory from WSL2 Ubuntu distribution): - -```bash [shell] -git clone https://github.com/aneoconsulting/ArmoniK.git -``` - -Then, you can install ArmoniK following the [Linux installation instructions](../1.linux/0.prerequisites.md). From a231ff629b91195fc95c83519cb4ff4ed250ab37 Mon Sep 17 00:00:00 2001 From: ereali-aneo Date: Tue, 3 Dec 2024 10:36:02 +0100 Subject: [PATCH 3/3] docs: remove reference to wsl with genie --- .../1.installation/2.windows/0.installation-using-wsl2.md | 5 ++--- .../content/1.installation/2.windows/1.wsl2-with-systemd.md | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.docs/content/1.installation/2.windows/0.installation-using-wsl2.md b/.docs/content/1.installation/2.windows/0.installation-using-wsl2.md index 887fbf8e0..9e7ee8552 100644 --- a/.docs/content/1.installation/2.windows/0.installation-using-wsl2.md +++ b/.docs/content/1.installation/2.windows/0.installation-using-wsl2.md @@ -25,7 +25,7 @@ If you are unable to use the store version, please refer to the [Microsoft docum ## Install Ubuntu LTS ::alert{type="warning"} -Currently, the LTS is the version 22.04. For Linux 20.04, please refer to the [WSL2 and Genie](./2.wsl2-with-genie.md.md) installation method. +Currently, the LTS is the version 22.04. :: Then you can install the Ubuntu distribution from the Windows Store. We recommend you to [install the latest LTS version](https://www.microsoft.com/store/productId/9PDXGNCFSCZV). @@ -77,8 +77,7 @@ sudo apt update && sudo apt upgrade -y Then, you have 2 options to continue the installation: - [WSL2 and systemd](./1.wsl2-with-systemd.md) -- [WSL2 and Genie](./2.wsl2-with-genie.md) ::alert{type="info"} -In order to have Docker and Kubernetes, we need to use `systemd`. WSL2 supports `systemd`natively but it is not enabled by default. You can also use `Genie` to enable `systemd` but it is not recommended. +In order to have Docker and Kubernetes, we need to use `systemd`. WSL2 supports `systemd`natively but it is not enabled by default. :: diff --git a/.docs/content/1.installation/2.windows/1.wsl2-with-systemd.md b/.docs/content/1.installation/2.windows/1.wsl2-with-systemd.md index 2080e4047..44a2fe6b9 100644 --- a/.docs/content/1.installation/2.windows/1.wsl2-with-systemd.md +++ b/.docs/content/1.installation/2.windows/1.wsl2-with-systemd.md @@ -4,7 +4,7 @@ This installation method is not recommended for production environments. :: -This installation will use the new `systemd` support of WSL2. You must verify that your Windows version is compatible with `systemd` support (WSL: Version 0.67.6 and above). If you are using an older version, you can use [Genie](./2.wsl2-with-genie.md). +This installation will use the new `systemd` support of WSL2. You must verify that your Windows version is compatible with `systemd` support (WSL: Version 0.67.6 and above). ::alert{type="info"} You must have installed WSL2 and Ubuntu LTS (22.04 or above) before continuing. If you haven't, please refer to the [WSL2 installation](./0.installation-using-wsl2.md) method.