diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..442d944d4 --- /dev/null +++ b/README.rst @@ -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