diff --git a/README.rst b/README.rst index 8cd058d..bc1c7b6 100644 --- a/README.rst +++ b/README.rst @@ -1,41 +1,40 @@ apache ====== -DEPENDENCIES: - These salt-states are required: - 1) apt +Formulas to set up and configure the Apache HTTP server -POSSIBLE DEPENDENCIES - These salt-states may be required depending on what your doing: +.. note:: - 1) php + See the full `Salt Formulas installation and usage instructions + `_. -ORDERING: +Available states +---------------- -The ordering of the states for apache falls into block ranges which are: +``apache`` + Installs the Apache package and starts the service. +``apache.debian_full`` + Installs and configures Apache on Debian and Ubuntu systems. - 1) apache will use 1-500 for ordering - 2) apache will reserve 1 -100 as unused - 3) apache will reserve 101-150 for pre pkg install - 4) apache will reserve 151-200 for pkg install - 5) apache will reserve 201-250 for pkg configure - 6) apache will reserve 251-300 for downloads, git stuff, load data - 7) apache will reserve 301-400 for unknown purposes - 8) apache will reserve 401-450 for service restart-reloads - 9) apache WILL reserve 451-460 for service.running - 10) apache will reserve 461-500 for cmd requiring operational services + These states are ordered using the ``order`` declaration. Different stages + are divided into the following number ranges: -PILLARS: + 1) apache will use 1-500 for ordering + 2) apache will reserve 1 -100 as unused + 3) apache will reserve 101-150 for pre pkg install + 4) apache will reserve 151-200 for pkg install + 5) apache will reserve 201-250 for pkg configure + 6) apache will reserve 251-300 for downloads, git stuff, load data + 7) apache will reserve 301-400 for unknown purposes + 8) apache will reserve 401-450 for service restart-reloads + 9) apache WILL reserve 451-460 for service.running + 10) apache will reserve 461-500 for cmd requiring operational services - 1) No pillar data is required - 2) Full pillar structure: + Dependencies: -apache: - php-ini: 'salt://path/to/file/php.ini' - register-site: - {{UNQIUE}}: - name: 'my name' - path: 'salt://path/to/sites-available/conf/file' - state: 'enabled' + * `apt `_ + + Optional dependencies: + + 1) `php `_ - 3) UNIQUE can be any name as an array index, and you can duplicate this section diff --git a/pillar.example b/pillar.example index e69de29..884db9a 100644 --- a/pillar.example +++ b/pillar.example @@ -0,0 +1,10 @@ +# Example for the apache.debian_full formula: + +apache: + php-ini: 'salt://path/to/file/php.ini' + register-site: + # any name as an array index, and you can duplicate this section + {{UNQIUE}}: + name: 'my name' + path: 'salt://path/to/sites-available/conf/file' + state: 'enabled'