From ac8f60b1201cda442311cff4532fbbe3daa658b5 Mon Sep 17 00:00:00 2001 From: Roger Ferraz Date: Thu, 13 Jul 2023 12:06:09 -0300 Subject: [PATCH] starlingx/ha README improvement This story shall update the README file of a few most used StarlingX repos. Test Plan: N/A Story: 2010814 Task: 48377 Change-Id: I34b14275e6b61e1be6d659701be568e208e380e4 Signed-off-by: Roger Ferraz --- README.rst | 18 ++++++++++++++---- bindep.txt | 1 + 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 90032864..c7c766a7 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,15 @@ -==== - ha -==== +== +ha +== +The starlingx/ha repository handles High Availability services [1]_. -StarlingX Service Management +Its key component is the StarlingX Service Management (SM), which coordinates +the StarlingX services. + +This repository is not intended to be developed standalone, but rather as part +of the StarlingX Source System, which is defined by the StarlingX manifest [2]_. + +References +========== +.. [1] https://docs.starlingx.io/api-ref/ha +.. [2] https://opendev.org/starlingx/manifest.git diff --git a/bindep.txt b/bindep.txt index 835f068c..5904b358 100644 --- a/bindep.txt +++ b/bindep.txt @@ -5,3 +5,4 @@ build-essential [platform:dpkg] python3-dev [platform:dpkg] # default-libmysqlclient-dev is debian specific default-libmysqlclient-dev [platform:debian] +pkg-config [platform:debian]