docs(readme): add FreeBSD to readme

saltstack-formulas · Jul 1, 2019 · 96e275a · 96e275a
1 parent d4fd4f4
commit 96e275a
Showing 1 changed file with 26 additions and 64 deletions.
diff --git a/README.rst b/README.rst
@@ -18,12 +18,14 @@ Available states
 ``deepsea``
 ------------
 
-Meta-state runs all other states (except packages & remove). Afterwards, consult official DeepSea documentation at <https://github.com/SUSE/DeepSea.git> and <https://www.suse.com/documentation/suse-enterprise-storage-5/singlehtml/book_storage_deployment/book_storage_deployment.html#ses.deployment>
+Meta-state runs all other states (except remove).
+
+Afterwards, consult official DeepSea documentation at <https://github.com/SUSE/DeepSea.git> and <https://www.suse.com/documentation/suse-enterprise-storage-5/singlehtml/book_storage_deployment/book_storage_deployment.html#ses.deployment>
 
 ``deepsea.install``
 -------------------
 
-Install DeepSea software on GNU Linux. Support git repo (default) or package repo (suse only). Includes `config` and `service` states.
+Install DeepSea software on GNU Linux. Support git repo (default) or package repo (suse only). Includes the `config` and `service` states.
 
 ``deepsea.config``
 -----------------
@@ -40,115 +42,75 @@ Enable services needed by DeepSea, and disable services incompatible with DeepSe
 
 Basic remove state (suse only)
 
-``deepsea.packages``
------------------
-
-DeepSea should handle its own package dependencies so this state is disabled by default. Set `deepsea:packages:managed: True`  enables package mangement in this formula.
-
 
 
 Testing
 ================
 
-DeepSea deployment verification on GNU Linux: Ubuntu, Centos, and Fedora on python2/3.
+DeepSea deployment verification on GNU Linux: Ubuntu, Centos, and Fedora with python2.
+
+TODO: DeepSea runtime verification (ensure deepsea commands work).
 
 
 Integration with other formulae
 ===============================
 
-The following formulae pillars could be useful-
+The following formulae pillars support DeepSea-
 
-`firewalld-formula
-      <https://github.com/saltstack-formulas/firewalld-formula>`_
+`firewalld-formula <https://github.com/saltstack-formulas/firewalld-formula>`_
 
 .. code-block:: yaml
-     
-       - firewalld
 
     extends:
        firewalld:
-         enabled: True
          services:
-           saltstack:
-             short: salt
-             description: SaltStack rules
+           deepsea-formula:
+             short: deepsea
+             description: DeepSea firewall rules
              ports:
                tcp:
+                 - 4505
+                 - 4506 
+               udp:
                  - 4505
                  - 4506
-           ceph:
-             short: ceph
-             description: Ceph firewall rules
-             ports:
-               tcp:
-                 - 6789
-                 - 6800:6810
          zones:
            public:
-             short: Public
              services:
-               - http
-               - https
-               - ssh
-               - ntp
-               - saltstack
-               - ceph
-
-             {%- if grains.os == 'Fedora' %}
-           FedoraWorkstation:
-             short: FedoraWorkstation
-             services:
-               - http
-               - https
-               - ssh
-               - ntp
-               - saltstack
-               - ceph
-             {%- endif %}
+               - deepsea
      
      
 `packages-formula
      <https://github.com/saltstack-formulas/packages-formula>`_
 
 .. code-block:: bash
      
-       - packages
-
      extends:
        packages:
-         # Should this formula manage package dependencies? True means yes. False no.
-         # Ideally we let `DeepSea` (or `packages-formula`) manage packages.
-         managed: False
          pips:
            wanted:
              - tox
              - click
          pkgs:
            unwanted:
-             - unattended-upgrades
+             - unattended-upgrades    {# recommendation #}
            wanted:
              - python-setuptools
-             - salt-api
+             - salt-api      
              - git
              - make
-                 {% if grains.os_family in ('Debian', 'Suse',) %}
+          {% if grains.os_family == 'FreeBSD' %}
+             - devel/py-pip
+          {% elif grains.os_family == 'Debian' %}
              - python-pip
-                 {% elif grains.os_family == 'RedHat' %}
+          {% elif grains.os_family == 'RedHat' %}
              - python2-pip
              - python-click
              - python-tox
-                 {% elif grains.os_family == 'Arch' %}
+         {% elif grains.os_family == 'Suse' %}
+             - python-pip
+         {% elif grains.os_family == 'Arch' %}
              - python2-pip
-                 {% endif %}
-
-`ceph-formula
-     <https://github.com/saltstack-formulas/ceph-formula>`_
+         {% endif %}
      
-.. code-block:: bash
-
-       - ceph.repo
      
-     extends:
-       ceph:
-         use_upstream_repo: true
-