Skip to content

Commit

Permalink
docs: Update Linux installation documentation (#1338)
Browse files Browse the repository at this point in the history
  • Loading branch information
aneojgurhem authored Dec 3, 2024
2 parents 7089928 + a231ff6 commit 52e8326
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 138 deletions.
34 changes: 2 additions & 32 deletions .docs/content/1.installation/1.linux/2.verify-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,40 +38,10 @@ Example:
http://<ip_address>:5000
```

## Samples
## HTC Mock

<!-- TODO: Create a sample in order to test installation (no more Symphony or DataSynapse) -->
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"}
<!-- TODO: Redirect to a readme -->
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

<!-- TODO: Verify how to 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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.
::
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
102 changes: 0 additions & 102 deletions .docs/content/1.installation/2.windows/2.wsl2-with-genie.md

This file was deleted.

0 comments on commit 52e8326

Please sign in to comment.