From 56ed2a5b855249e62e3306fc4537f2bd3284a485 Mon Sep 17 00:00:00 2001 From: nico_dreylaq Date: Fri, 6 Dec 2024 11:03:20 +0100 Subject: [PATCH] style: fix linter --- .../3.aws/0. aws-first-setup.md | 9 ++--- .../2. aws-deployment-troubleshooting.md | 35 +++++++++++-------- 2 files changed, 26 insertions(+), 18 deletions(-) diff --git a/.docs/content/1.installation/3.aws/0. aws-first-setup.md b/.docs/content/1.installation/3.aws/0. aws-first-setup.md index acd788a84..54c965a30 100644 --- a/.docs/content/1.installation/3.aws/0. aws-first-setup.md +++ b/.docs/content/1.installation/3.aws/0. aws-first-setup.md @@ -1,14 +1,14 @@ # AWS Setup 🚀 - This guide will help you install and configure the AWS CLI on your system and set up your AWS environment for use. -# 1. Installation & Configuration +## 1. Installation & Configuration -Follow the official AWS CLI install guide [here](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) +Follow the official AWS CLI install guide [here](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html). For Linux-based systems, you can use the following commands: -```bash + +```bash curl "https://awscli.amazonaws.com/aws-cli-exe-linux-x86_64.zip" -o "awscliv2.zip" unzip awscliv2.zip sudo ./aws/install @@ -26,6 +26,7 @@ Once installed, you need to configure the AWS CLI with your credentials: ```bash aws configure ``` + During configuration: - Enter your **Access Key ID** and **Secret Access Key** (provided by AWS). - Choose a default region, e.g., *eu-west-3* (optional but recommended). diff --git a/.docs/content/1.installation/3.aws/2. aws-deployment-troubleshooting.md b/.docs/content/1.installation/3.aws/2. aws-deployment-troubleshooting.md index ea8aeec33..902abbeb7 100644 --- a/.docs/content/1.installation/3.aws/2. aws-deployment-troubleshooting.md +++ b/.docs/content/1.installation/3.aws/2. aws-deployment-troubleshooting.md @@ -5,12 +5,14 @@ This guide covers common issues you might encounter while deploying your applica ## 1. Error: Partition Not Found If you encounter a Partition Not Found error during deployment or runtime, ensure the following: + - Set the Replication Factor to 1 in the **parameters.tfvars**: -```tf - default = { - node_selector = { service = "workers" } +```hcl +default = { + node_selector = { service = "workers" } replicas = 1 # HERE +} ``` - Check Spelling in Configuration Files. @@ -18,14 +20,15 @@ If you encounter a Partition Not Found error during deployment or runtime, ensur For example in **parameters.tfvars**: -```tf +```hcl default = { node_selector = { service = "workers" } replicas = 1 # HERE ``` instead of -``` + +```hcl defautl = { node_selector = { service = "workers" } replicas = 1 # HERE @@ -44,14 +47,16 @@ After deploying your application or service, AWS typically generates a URL for t Ensure the endpoint is properly defined in your client application, as shown below: ```csharp - var endpoint = new Option("--endpoint", - description: "Endpoint pour la connexion au control plane ArmoniK.", - getDefaultValue: () => "http://localhost:5001"); +var endpoint = new Option("--endpoint", + description: "Endpoint pour la connexion au control plane ArmoniK.", + getDefaultValue: () => "http://localhost:5001"); + ``` ### Adapting the URL When Using Docker When running your application in a Docker container, remember to update the endpoint dynamically. For instance: + ```bash docker run --rm --name client --endpoint "http://:5001" --partition ``` @@ -71,6 +76,7 @@ You need to build the Docker image for the worker using the following command: ```bash docker build -f "./csharp/native/LinearSubTasking/Worker/Dockerfile" -t subtasking "./csharp/native/" ``` + - **-f**: Specifies the path to the Dockerfile for your worker. - **-t subtasking**: Tags the image as subtasking, which will be used as the image name. - **"./csharp/native/"**: Specifies the context for the build (i.e., the root directory containing your source files). @@ -79,15 +85,16 @@ Voici la documentation mise à jour pour inclure la gestion des erreurs liées a 3. Error: Docker Image Not Found If you encounter an error related to the Docker image not being found or incorrectly configured, follow these steps to ensure the image is built and referenced correctly. -Step 1: Ensure the Worker Image is Built Correctly -You need to build the Docker image for the worker using the following command: +**Ensure the Worker Image is Built Correctly** +You need to build the Docker image for the worker using the following command: +``` docker build -f "./csharp/native/LinearSubTasking/Worker/Dockerfile" -t subtasking "./csharp/native/" - - -f: Specifies the path to the Dockerfile for your worker. - -t subtasking: Tags the image as subtasking, which will be used as the image name. - "./csharp/native/": Specifies the context for the build (i.e., the root directory containing your source files). +``` +- **-f**: Specifies the path to the Dockerfile for your worker. +- **-t subtasking**: Tags the image as subtasking, which will be used as the image name. +- **"./csharp/native/"**: Specifies the context for the build (i.e., the root directory containing your source files). ### Verify the Image Tag Matches the Configuration