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 47606c5e3..6b5724080 100644 --- a/.docs/content/1.installation/1.linux/2.verify-installation.md +++ b/.docs/content/1.installation/1.linux/2.verify-installation.md @@ -73,7 +73,6 @@ git clone https://github.com/aneoconsulting/ArmoniK.Samples.git ./Source/ArmoniK tools/tests/symphony_like.sh ``` - ::alert{type="info"} You can check the logs using Seq. :: 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 cd35582c2..8904c2e70 100644 --- a/.docs/content/1.installation/1.linux/3.deploy-script.md +++ b/.docs/content/1.installation/1.linux/3.deploy-script.md @@ -12,38 +12,38 @@ script [deploy-dev-test-infra.sh](../utils/scripts/deploy-dev-test-infra.sh) The infrastructure is composed of: -* Addons for Kubernetes: - * Keda - * Metrics server -* Storage: - * ActiveMQ - * MongoDB - * Redis -* Monitoring: - * ArmoniK metrics exporter - * Grafana - * Node exporter - * Prometheus - * Seq server for structured log data of ArmoniK. -* ArmoniK: - * AdminGUI - * Control plane - * Compute plane: polling agent and workers - * Ingress +- Addons for Kubernetes: + - Keda + - Metrics server +- Storage: + - ActiveMQ + - MongoDB + - Redis +- Monitoring: + - ArmoniK metrics exporter + - Grafana + - Node exporter + - Prometheus + - Seq server for structured log data of ArmoniK. +- ArmoniK: + - AdminGUI + - Control plane + - Compute plane: polling agent and workers + - Ingress # Prerequisites The following software or tool should be installed upon your local Linux machine: -* If You have Windows machine, You have to install [WSL 2](../docs/wsl2.md) -* [Docker](https://docs.docker.com/engine/install/) -* [GNU make](https://www.gnu.org/software/make/) -* [JQ](https://stedolan.github.io/jq/download/) -* [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) -* [Python](https://docs.python-guide.org/starting/install3/linux/) version 3 - * [hcl2](https://pypi.org/project/python-hcl2/) - * [jsonpath-ng](https://pypi.org/project/jsonpath-ng/) -* [Terraform](https://learn.hashicorp.com/tutorials/terraform/install-cli) +- If You have Windows machine, You have to install [WSL 2](../docs/wsl2.md) +- [Docker](https://docs.docker.com/engine/install/) +- [GNU make](https://www.gnu.org/software/make/) +- [JQ](https://stedolan.github.io/jq/download/) +- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) +- [Python](https://docs.python-guide.org/starting/install3/linux/) version 3 + - [hcl2](https://pypi.org/project/python-hcl2/) + - [jsonpath-ng](https://pypi.org/project/jsonpath-ng/) +- [Terraform](https://learn.hashicorp.com/tutorials/terraform/install-cli) # Install Kubernetes @@ -59,22 +59,31 @@ cd infrastructure/utils/scripts ``` - To see the usage command: + ```bash ./deploy-dev-test-infra.sh -h ``` + - To deploy for the first time all infrastructure: + ```bash ./deploy-dev-test-infra.sh -m deploy-all ``` + - To redeploy all infrastructure: + ```bash ./deploy-dev-test-infra.sh -m redeploy-all ``` + - To destroy all infrastructure: + ```bash ./deploy-dev-test-infra.sh -m destroy-all ``` + - To clean and delete all generated files from all deployment: + ```bash ./deploy-dev-test-infra.sh --clean all ``` @@ -82,22 +91,31 @@ cd infrastructure/utils/scripts If You want to deploy each resource independently: - To deploy Keda: + ```bash ./deploy-dev-test-infra.sh -m deploy-keda ``` + - To deploy Metrics server: + ```bash ./deploy-dev-test-infra.sh -m deploy-metrics-server ``` + - To deploy storage: + ```bash ./deploy-dev-test-infra.sh -m deploy-storage ``` + - To deploy monitoring: + ```bash ./deploy-dev-test-infra.sh -m deploy-monitoring ``` + - To deploy ArmoniK: + ```bash ./deploy-dev-test-infra.sh -m deploy-armonik ``` @@ -105,22 +123,31 @@ If You want to deploy each resource independently: If You want to redeploy each resource independently: - To redeploy Keda: + ```bash ./deploy-dev-test-infra.sh -m redeploy-keda ``` + - To redeploy Metrics server: + ```bash ./deploy-dev-test-infra.sh -m redeploy-metrics-server ``` + - To redeploy storage: + ```bash ./deploy-dev-test-infra.sh -m redeploy-storage ``` + - To redeploy monitoring: + ```bash ./deploy-dev-test-infra.sh -m redeploy-monitoring ``` + - To redeploy ArmoniK: + ```bash ./deploy-dev-test-infra.sh -m redeploy-armonik ``` @@ -128,22 +155,31 @@ If You want to redeploy each resource independently: If You want to destroy each resource independently: - To destroy Keda: + ```bash ./deploy-dev-test-infra.sh -m destroy-keda ``` + - To destroy Metrics server: + ```bash ./deploy-dev-test-infra.sh -m destroy-metrics-server ``` + - To destroy storage: + ```bash ./deploy-dev-test-infra.sh -m destroy-storage ``` + - To destroy monitoring: + ```bash ./deploy-dev-test-infra.sh -m destroy-monitoring ``` + - To destroy ArmoniK: + ```bash ./deploy-dev-test-infra.sh -m destroy-armonik ``` @@ -151,22 +187,31 @@ If You want to destroy each resource independently: If You want to clean and delete generated files from each deployment independently: - To clean Keda: + ```bash ./deploy-dev-test-infra.sh --clean keda ``` + - To clean Metrics server: + ```bash ./deploy-dev-test-infra.sh --clean metrics-server ``` + - To clean storage: + ```bash ./deploy-dev-test-infra.sh --clean storage ``` + - To clean monitoring: + ```bash ./deploy-dev-test-infra.sh --clean monitoring ``` + - To clean ArmoniK: + ```bash ./deploy-dev-test-infra.sh --clean armonik ``` @@ -263,7 +308,3 @@ If You want to deactivate the ingress with NGINX: ```bash ./deploy-dev-test-infra.sh -m deploy-all --without-nginx ``` - -### [Return to the infrastructure main page](../README.md) - -### [Return to the project main page](../../README.md) \ No newline at end of file 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 ef903765e..325ebee61 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 @@ -16,7 +16,7 @@ You must have installed WSL2 and Ubuntu before continuing. If you haven't, pleas ## Install genie -To install `genie` please refer to https://arkane-systems.github.io/wsl-transdebian/ +To install `genie` please 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.