From 01e1db23ae02a069a9c5db305fc95fdd8598f0ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Est=C3=A9ban?= <103997512+esoubiran-aneo@users.noreply.github.com> Date: Wed, 21 Jun 2023 09:00:53 +0200 Subject: [PATCH] docs: add terminal into code blocks (#1146) --- .../1.installation/1.linux/0.prerequisites.md | 2 +- .../1.installation/1.linux/1.installation.md | 42 +++++------ .../1.linux/2.verify-installation.md | 8 +-- .../1.installation/1.linux/3.deploy-script.md | 72 +++++++++---------- .../2.windows/0.installation-using-wsl2.md | 12 ++-- .../2.windows/1.wsl2-with-systemd.md | 12 ++-- .../2.windows/2.wsl2-with-genie.md | 12 ++-- .../2.windows/3.useful-commands-for-wsl2.md | 18 ++--- .../3.aws/aws-deployment-using-k3s.md | 14 ++-- .../3.aws/aws-deployment-using-kubeadm.md | 14 ++-- .../how-to-configure-authentication.md | 12 ++-- .../2.guide/1.how-to/how-to-configure-seq.md | 2 +- 12 files changed, 110 insertions(+), 110 deletions(-) diff --git a/.docs/content/1.installation/1.linux/0.prerequisites.md b/.docs/content/1.installation/1.linux/0.prerequisites.md index 35eeae1d9..be569fd34 100644 --- a/.docs/content/1.installation/1.linux/0.prerequisites.md +++ b/.docs/content/1.installation/1.linux/0.prerequisites.md @@ -8,7 +8,7 @@ In order to install ArmoniK locally or on-premise, you must have a few of things You can easily install all of them using the [ArmoniK prerequisites installer](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/utils/scripts/installation/prerequisites-installer.sh) from the root repository. -```bash +```bash [shell] ./infrastructure/utils/scripts/installation/prerequisites-installer.sh ``` diff --git a/.docs/content/1.installation/1.linux/1.installation.md b/.docs/content/1.installation/1.linux/1.installation.md index d1ad7e182..b29bbfea7 100644 --- a/.docs/content/1.installation/1.linux/1.installation.md +++ b/.docs/content/1.installation/1.linux/1.installation.md @@ -12,13 +12,13 @@ Before running the script, you must set environment variables. From the root of the repository: -```bash +```bash [shell] cd infrastructure/quick-deploy/localhost ``` Then, you can set environment variables in the file `envvars.sh`: -```bash +```bash [shell] source envvars.sh ``` @@ -30,7 +30,7 @@ Please, read the file `envvars.sh` before running it. Create data directory: -```bash +```bash [shell] mkdir -p "${ARMONIK_SHARED_HOST_PATH}" ``` @@ -44,7 +44,7 @@ You can find why your pod doesn't start using `kubectl describe pod - Finally, you can run the script to deploy ArmoniK on your local machine: -```bash +```bash [shell] make deploy-all ``` @@ -66,23 +66,23 @@ armonik = { You can also deploy each resource independently: -```bash +```bash [shell] make deploy-keda ``` -```bash +```bash [shell] make deploy-metrics-server ``` -```bash +```bash [shell] make deploy-storage ``` -```bash +```bash [shell] make deploy-monitoring ``` -```bash +```bash [shell] make deploy-armonik ``` @@ -94,7 +94,7 @@ The order matters because top level resources depend on the bottom level resourc To destroy all the infrastructure, you can run the following command: -```bash +```bash [shell] make destroy-all ``` @@ -104,23 +104,23 @@ To reinstall, you must restart from [setup environment variables](#setup-environ You can also destroy each resource independently: -```bash +```bash [shell] make destroy-armonik ``` -```bash +```bash [shell] make destroy-monitoring ``` -```bash +```bash [shell] make destroy-storage ``` -```bash +```bash [shell] make destroy-metrics-server ``` -```bash +```bash [shell] make destroy-keda ``` @@ -132,7 +132,7 @@ The order matters. You must destroy the resources in the reverse order of the de To clean all the generated files from the deployment, you can run the following command: -```bash +```bash [shell] make clean-all ``` @@ -142,23 +142,23 @@ To reinstall, you must restart from [setup environment variables](#setup-environ You can also clean each resource independently: -```bash +```bash [shell] make clean-armonik ``` -```bash +```bash [shell] make clean-monitoring ``` -```bash +```bash [shell] make clean-storage ``` -```bash +```bash [shell] make clean-metrics-server ``` -```bash +```bash [shell] make clean-keda ``` diff --git a/.docs/content/1.installation/1.linux/2.verify-installation.md b/.docs/content/1.installation/1.linux/2.verify-installation.md index 6b5724080..6442bcb75 100644 --- a/.docs/content/1.installation/1.linux/2.verify-installation.md +++ b/.docs/content/1.installation/1.linux/2.verify-installation.md @@ -14,7 +14,7 @@ You can also retrieve the `seq.web_url` from the Terraform outputs `monitoring/g Example: -```bash +```bash [shell] http://:8080 ``` @@ -34,7 +34,7 @@ You can also retrieve the `armonik.admin_gui_url` from the Terraform outputs `ar Example: -```bash +```bash [shell] http://:5000 ``` @@ -60,7 +60,7 @@ You can find more information about samples in their [dedicated documentation](h 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 +```bash [shell] git clone https://github.com/aneoconsulting/ArmoniK.Samples.git ./Source/ArmoniK.Samples/ ``` @@ -69,7 +69,7 @@ git clone https://github.com/aneoconsulting/ArmoniK.Samples.git ./Source/ArmoniK * Execute [tools/tests/symphony_like.sh](https://github.com/aneoconsulting/ArmoniK.Samples/blob/main/tools/tests/symphony_like.sh) from the **root** repository: - ```bash + ```bash [shell] tools/tests/symphony_like.sh ``` diff --git a/.docs/content/1.installation/1.linux/3.deploy-script.md b/.docs/content/1.installation/1.linux/3.deploy-script.md index df7d9033a..8e1b7b0f3 100644 --- a/.docs/content/1.installation/1.linux/3.deploy-script.md +++ b/.docs/content/1.installation/1.linux/3.deploy-script.md @@ -9,37 +9,37 @@ You can find [prerequisites here](./0.prerequisites.md) and [installation instru From the **root** of the repository, position yourself in directory `infrastructure/utils/scripts/`: -```bash +```bash [shell] cd infrastructure/utils/scripts ``` - To see the usage command: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -h ``` - To deploy for the first time all infrastructure: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m deploy-all ``` - To redeploy all infrastructure: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m redeploy-all ``` - To destroy all infrastructure: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m destroy-all ``` - To clean and delete all generated files from all deployment: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh --clean all ``` @@ -47,31 +47,31 @@ If You want to deploy each resource independently: - To deploy Keda: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m deploy-keda ``` - To deploy Metrics server: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m deploy-metrics-server ``` - To deploy storage: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m deploy-storage ``` - To deploy monitoring: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m deploy-monitoring ``` - To deploy ArmoniK: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m deploy-armonik ``` @@ -79,31 +79,31 @@ If You want to redeploy each resource independently: - To redeploy Keda: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m redeploy-keda ``` - To redeploy Metrics server: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m redeploy-metrics-server ``` - To redeploy storage: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m redeploy-storage ``` - To redeploy monitoring: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m redeploy-monitoring ``` - To redeploy ArmoniK: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m redeploy-armonik ``` @@ -111,31 +111,31 @@ If You want to destroy each resource independently: - To destroy Keda: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m destroy-keda ``` - To destroy Metrics server: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m destroy-metrics-server ``` - To destroy storage: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m destroy-storage ``` - To destroy monitoring: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m destroy-monitoring ``` - To destroy ArmoniK: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh -m destroy-armonik ``` @@ -143,50 +143,50 @@ If You want to clean and delete generated files from each deployment independent - To clean Keda: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh --clean keda ``` - To clean Metrics server: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh --clean metrics-server ``` - To clean storage: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh --clean storage ``` - To clean monitoring: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh --clean monitoring ``` - To clean ArmoniK: - ```bash + ```bash [shell] ./deploy-dev-test-infra.sh --clean armonik ``` If You want to deploy ArmoniK components on specific Kubernetes namespace, You execute the following command: -```bash +```bash [shell] ./deploy-dev-test-infra.sh -m deploy-all --namespace ``` If the `host_path` for shared storage for ArmoniK workers is not `${HOME}/data`, You can deploy the infrastructure as follows: -```bash +```bash [shell] ./deploy-dev-test-infra.sh -m deploy-all --host-path ``` If You have a NFS filesystem as shared storage for ArmoniK workers, You deploy the infrastructure as follows: -```bash +```bash [shell] ./deploy-dev-test-infra.sh \ -m deploy-all \ --host-path \ @@ -196,7 +196,7 @@ If You have a NFS filesystem as shared storage for ArmoniK workers, You deploy t If You want to change container image and/or tag of control plane, polling agent, worker or metrics exporter: -```bash +```bash [shell] ./deploy-dev-test-infra.sh \ -m deploy-all \ --control-plane-image \ @@ -212,7 +212,7 @@ metrics exporter). If You change the max, min or idle replicas in the HPA of the compute plane: -```bash +```bash [shell] ./deploy-dev-test-infra.sh \ -m deploy-all \ --hpa-min-compute-plane-replicas \ @@ -227,7 +227,7 @@ where `` is the target value for the number of m If You change the max, min or idle replicas in the HPA of the control plane: -```bash +```bash [shell] ./deploy-dev-test-infra.sh \ -m deploy-all \ --hpa-min-control-plane-replicas \ @@ -242,24 +242,24 @@ where `` is the target value in percentage for t If You want to change logging level for ArmoniK components: -```bash +```bash [shell] ./deploy-dev-test-infra.sh -m deploy-all --logging-level ``` If You want to activate the TLS: -```bash +```bash [shell] ./deploy-dev-test-infra.sh -m deploy-all --with-tls ``` If You want to activate the mTLS: -```bash +```bash [shell] ./deploy-dev-test-infra.sh -m deploy-all --with-mtls ``` If You want to deactivate the ingress with NGINX: -```bash +```bash [shell] ./deploy-dev-test-infra.sh -m deploy-all --without-nginx ``` 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 e14358673..c6e0a6d2a 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 @@ -32,7 +32,7 @@ Then you can install the Ubuntu distribution from the Windows Store. We recommen You can also install Ubuntu LTS manually by following the instructions. -```powershell +```powershell [powershell] wsl --install -d Ubuntu ``` @@ -42,13 +42,13 @@ You can read more about Ubuntu on the [Microsoft documentation](https://learn.mi Once the installation is complete, verify the version of Ubuntu: -```powershell +```powershell [powershell] wsl -l -v ``` You should see something like this: -```powershell +```powershell [powershell] NAME STATE VERSION * Ubuntu Running 2 # or Ubuntu-22.04 depending if you install the LTS or a specific version @@ -56,19 +56,19 @@ You should see something like this: You can set the default WSL2 distro by using the following command: -```powershell +```powershell [powershell] wsl --set-default Ubuntu # or Ubuntu-22.04 depending if you install the LTS or a specific version ``` Then, you can start your Ubuntu distribution: -```powershell +```powershell [powershell] wsl -d Ubuntu # or Ubuntu-22.04 depending if you install the LTS or a specific version ``` Finally, you can update your packages: -```bash +```bash [shell] sudo apt update && sudo apt upgrade -y ``` 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 4f06dd901..2080e4047 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 @@ -16,7 +16,7 @@ Then, you will need to enable `systemd` support. In fact, ArmoniK uses Kubernete To enable `systemd` support, you must start your Ubuntu distribution and add these lines to the `/etc/wsl.conf` file (you will need sudo privileges): -```bash +```text [wsl.conf] [boot] systemd=true ``` @@ -27,25 +27,25 @@ Read more about `systemd` support on the [Microsoft documentation](https://devbl Then you must restart your Ubuntu distribution in order to apply the changes. -```powershell +```powershell [powershell] wsl --shutdown ``` Then, restart your Ubuntu distribution. -```powershell +```powershell [powershell] wsl -d Ubuntu # Or Ubuntu-22.04 depending if you install the LTS or a specific version ``` Don't forget to verify that `systemd` is enabled: -```bash +```bash [shell] systemctl ``` To finish, update your packages: -```bash +```bash [shell] sudo apt update && sudo apt upgrade -y ``` @@ -57,7 +57,7 @@ Be careful, you must enable `systemd` support before installing ArmoniK. First, clone the ArmoniK repository (inside your home directory from WSL2 Ubuntu distribution): -```bash +```bash [shell] git clone https://github.com/aneoconsulting/ArmoniK.git ``` 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 index c10dee2d0..611545925 100644 --- a/.docs/content/1.installation/2.windows/2.wsl2-with-genie.md +++ b/.docs/content/1.installation/2.windows/2.wsl2-with-genie.md @@ -18,7 +18,7 @@ You must have installed WSL2 and Ubuntu before continuing. If you haven't, pleas 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 +```bash [shell] ./infrastructure/utils/scripts/installation/install-genie.sh ``` @@ -30,7 +30,7 @@ For manual installation, you can refer to [Genie How-To](https://arkane-systems. Finally, in order to avoid some issues, you need to mask some services. -```bash +```bash [shell] sudo systemctl disable getty@tty1.service multipathd.service multipathd.socket ssh.service sudo systemctl mask systemd-remount-fs.service ``` @@ -41,11 +41,11 @@ You can find more information about this issue on the [genie documentation](http Then, you need to exit your Ubuntu distribution and restart it. -```bash +```bash [shell] exit ``` -```powershell +```powershell [powershell] wsl --shutdown ``` @@ -57,7 +57,7 @@ Please, do not start a WSL2 session with native `systemd` in parallel of `genie` Because `genie` must be started as PID 1, you need to start a session with `genie`. -```bash +```bash [shell] wsl genie -s ``` @@ -95,7 +95,7 @@ Be careful, you must enable `genie` support before installing ArmoniK. First, clone the ArmoniK repository (inside your home directory from WSL2 Ubuntu distribution): -```bash +```bash [shell] git clone https://github.com/aneoconsulting/ArmoniK.git ``` diff --git a/.docs/content/1.installation/2.windows/3.useful-commands-for-wsl2.md b/.docs/content/1.installation/2.windows/3.useful-commands-for-wsl2.md index 627de362e..e330eed78 100644 --- a/.docs/content/1.installation/2.windows/3.useful-commands-for-wsl2.md +++ b/.docs/content/1.installation/2.windows/3.useful-commands-for-wsl2.md @@ -2,54 +2,54 @@ - To verify the WSL version: - ```powershell + ```powershell [powershell] wsl --list --verbose ``` - To view installed distro list: - ```powershell + ```powershell [powershell] wsl --list ``` - To change the default distro: - ```powershell + ```powershell [powershell] wsl --set-default ``` - To launch a distro: - ```powershell + ```powershell [powershell] wsl -d ``` - To launch the default distro: - ```powershell + ```powershell [powershell] wsl ``` - To launch a distro with a specific user: - ```powershell + ```powershell [powershell] wsl -d -u ``` - To launch a command in a distro: - ```powershell + ```powershell [powershell] wsl -d -e ``` - To lanch a distro in a specific directory: - ```powershell + ```powershell [powershell] wsl -d -w ``` - To uninstall a distro: - ```powershell + ```powershell [powershell] wsl --unregister ``` diff --git a/.docs/content/1.installation/3.aws/aws-deployment-using-k3s.md b/.docs/content/1.installation/3.aws/aws-deployment-using-k3s.md index 6834172cf..6bc3ad597 100644 --- a/.docs/content/1.installation/3.aws/aws-deployment-using-k3s.md +++ b/.docs/content/1.installation/3.aws/aws-deployment-using-k3s.md @@ -19,7 +19,7 @@ You must create and provide your [AWS programmatic access keys](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) in your dev/test environment: -```bash +```bash [shell] mkdir -p ~/.aws cat <