diff --git a/README.md b/README.md index aae9319..a5df93f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ # k8ssalt -Salty mcsalt \ No newline at end of file +Salt-master / Salt-minion automatically configured for deploying within Kubernetes. Currently this repo supports 1 to N salt-minions. + + +#### Requirements +* An existing Kubernetes cluster +##### Limitations +Saltstack images don't include OpenRC, so restarting services within salt-minions poses an issue. +You can install packages / remove them just fine. + +##### Installation +1. git clone this repo +2. Run the deploySalt.sh +3. Please don't delete the files i created... please + +#### Flags + +* -r + * Replicas - How many replicas should salt-minions generate +* -d + * Delete - Deprovisions Salt-infrastructure + + + + +Salty mcsalt