diff --git a/README.md b/README.md index 70e8774dac1828b8b40136cc2f91873a568511f1..920c0ac6c4e776ea8134d70b9d9f7e129c6a4e0d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,26 @@ # stellar_account_database -## Documentation ideas +## Description -For more ideas about what to document here see the [pdk template -readme](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot_init/README.md.erb). +This configures an OpenLDAP server and initializes it for use by +[AI Academy](https://liu.se/en/research/ai/ai-academy) and computers in the "Stellar" system. +It also installs and configures scripts for account management. +This is not intended to be reused outside of that purpose. -For how to do it: -https://puppet.com/docs/puppet/latest/puppet_strings.html -https://puppet.com/docs/puppet/latest/puppet_strings_style.html +# Setup + +Add `stellar_account_database::role::server`. No parameters should be necessary. + +## Effects + +* Installs OpenLDAP server +* Writes certs +* Initializes a skeleton LDAP database + +# References + +* Owning organization is [AI Academy](https://liu.se/en/research/ai/ai-academy) +* Client configuration can be found in [BaolOps](https://gitlab.liu.se/stellar/baolops) +* User support info is at [Support](https://gitlab.liu.se/stellar/support) + +* Production host: kraz.ida.liu.se