starlingx/stx-puppet README improvement

This story shall update the README file of a few most used StarlingX
repos.

Test Plan: N/A

Story: 2010814
Task: 48355

Change-Id: If7d4825337a8057d3be540d96885c7956b857730
Signed-off-by: Roger Ferraz <rogerio.ferraz@encora.com>
This commit is contained in:
Roger Ferraz 2023-07-11 12:39:19 -03:00
parent 28fd21419f
commit 580e839d9e
1 changed files with 15 additions and 0 deletions

15
README.rst Normal file
View File

@ -0,0 +1,15 @@
==========
stx-puppet
==========
The starlingx/stx-puppet repository handles the Puppet service [1]_.
The Puppet service runs during bootstrap, and at every reboot, to provide a
consistent configuration across the StarlingX system nodes.
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://www.puppet.com
.. [2] https://opendev.org/starlingx/manifest.git