From 113a0d011f2a7fc3e2b00a51b9c088af0d4761b9 Mon Sep 17 00:00:00 2001 From: bb Date: Tue, 30 Jul 2024 11:56:24 +0200 Subject: [PATCH] Actualiser README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 2e5e96c..91bc793 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ +# Purpose of this componenet + +The purpose of oc-deploy, is to deploy all the OC components over a Kubernetes cluster. + +An OpenCloud deployment is composed of the following layers: + +-------------------------- +| OpenCloud components | <-- TODO +-------------------------- +| KubernetesCluster | <-- TODO +-------------------------- +| IaaS (VMs, LAN) | <-- pre-requisite +-------------------------- +|HW (network and servers)| <-- pre-requisite +-------------------------- + + +It thus contains a first optional installation layer which deploys the Kubernetes nodes (control plane(s) and workers) above an existing infrastructure (Iaas). + +Then the second installation layer uses Helm charts to deploy and configure all the OC components. + +This documentation will be updated with the needed command and/or requirements to properly execute the installation. + # Deploy cluster ## For dev in Docker Install brew