From 3c19f9ea0f6394ec1cc5dc0f1117240a4d41a549 Mon Sep 17 00:00:00 2001 From: Thomas Cardin <49320132+ThomasCardin@users.noreply.github.com> Date: Wed, 31 Jan 2024 08:35:51 -0500 Subject: [PATCH] issue #1: changed README.md content --- .gitignore | 6 ------ .vscode/extensions.json | 9 +++++++++ .vscode/settings.json | 6 ++++++ README.md | 42 ++++++++++++++++++++++++----------------- 4 files changed, 40 insertions(+), 23 deletions(-) create mode 100644 .vscode/extensions.json create mode 100644 .vscode/settings.json diff --git a/.gitignore b/.gitignore index 95d03621..9b8a46e6 100644 --- a/.gitignore +++ b/.gitignore @@ -32,9 +32,3 @@ override.tf.json # Ignore CLI configuration files .terraformrc terraform.rc - -# jq (used to gather information when terraform applying or planning) -jq - -# .vscode -.vscode diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..d156db8b --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,9 @@ +{ + "recommendations": [ + "stkb.rewrap", + "DavidAnson.vscode-markdownlint" + ], + "unwantedRecommendations": [ + + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..bbf84028 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,6 @@ +{ + "editor.rulers": [80], + "files.trimTrailingWhitespace": true, + "files.trimFinalNewlines": true, + "files.insertFinalNewline": true +} diff --git a/README.md b/README.md index e86b3008..5133fe1a 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,31 @@ # Infrastructure Repository for ACIA-CFIA AI-Lab -This repository is dedicated to the infrastructure management of the ACIA-CFIA -AI-Lab. It contains scripts, configurations, and documentation pertinent to -infrastructure and DevOps practices within the lab, facilitating setup, -deployment, and management across multiple cloud platforms including AWS, GCP, -and Azure. +This repository contains all the infrastructure used by the ACIA/CFIA AI Lab. +In this repository, you can find the Kubernetes manifests that deploy each of +the applications on the three different cloud providers: Google Cloud Platform +(GCP), Amazon Web Services (AWS), and Azure. -## Contents: +## Content -Cross-Cloud Setup Scripts: Automation scripts for seamless configuration across -AWS, GCP, and Azure, covering project initiation, billing account association, -artifact repository orchestration, and service account setup. GitHub Repository -Creation Guide: Detailed instructions for creating new repositories in alignment -with ACIA-CFIA standards. Getting Started: +- The Terraform configuration for the GCP cluster. +- Kubernetes manifests used to deploy the following applications: + - [Nachet backend](https://github.com/ai-cfia/nachet-backend) + - [Nachet frontend](https://github.com/ai-cfia/nachet-frontend) + - [Finesse backend](https://github.com/ai-cfia/finesse-backend) + - [Finesse frontend](https://github.com/ai-cfia/finesse-frontend) +- Configuration for Vault, Grafana, Prometheus, Alert Manager, Ingress NGINX, +and Cert Manager to meet our requirements. -## Clone this repository. -1. Navigate to the desired script or documentation. -2. Follow the provided instructions. -3. Related Repositories: +## Tooling -Dev-Rel-Docs: Contains introductory files and documentation related to developer -relations at ACIA-CFIA AI-Lab. +- [Hashicorp Vault](https://www.vaultproject.io/) +- [Grafana](https://grafana.com/) +- [Prometheus](https://prometheus.io/docs/visualization/grafana/) +- [Alert manager](https://github.com/prometheus/alertmanager) +- [Cert manager](https://cert-manager.io/) +- [Ingress NGINX](https://docs.nginx.com/nginx-ingress-controller/) +- [OTEL](https://opentelemetry.io/) + +## Liens utiles + +[ai-cfia github container registry](https://github.com/orgs/ai-cfia/packages)