0.7.0.rst 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. ==============
  2. salt-api 0.7.0
  3. ==============
  4. :program:`salt-api` is ready for alpha-testing in the real world. This release
  5. solidifies how :program:`salt-api` will communicate with the larger Salt
  6. ecosystem. In addition authentication and encryption (via SSL) have been added.
  7. The first netapi module was a proof of concept written in Flask. It was quite
  8. useful to be able to quickly hammer out a URL structure and solidify on an
  9. interface for programmatically calling out to Salt components. As of this
  10. release that module has been deprecated and removed in favor of a netapi module
  11. written in CherryPy. CherryPy affords tremendous flexibility when composing a
  12. REST interface and will present a stable platform for building out a very
  13. adaptable and featureful REST API—also we're using the excellent and fast
  14. CherryPy webserver for securely serving the API.
  15. Low-data interface
  16. ==================
  17. The last release introduced a proof-of-concept for how the various Salt
  18. components will communicate with each other. This is done by passing a data
  19. structure to a client interface. This release expands on that. There are
  20. currently three client interfaces in Salt.
  21. .. seealso:: :ref:`netapi-introduction`
  22. Encryption and authentication
  23. =============================
  24. Encryption has been added via SSL. You can supply an existing certificate or
  25. generate a self-signed certificate through Salt's :py:mod:`~salt.modules.tls`
  26. module.
  27. Authentication is performed through Salt's incredibly flexible :ref:`external
  28. auth <acl-eauth>` system and is maintained when accessing the API via session
  29. tokens.
  30. Participation
  31. =============
  32. :program:`salt-api` is just getting off the ground so feedback, questions, and
  33. ideas are critical as we solidify how this project fits into the overall Salt
  34. infrastructure management stack. Please get involved by `filing issues`__ on
  35. GitHub, `discussing on the mailing list`__, and chatting in ``#salt-devel`` on
  36. Freenode.
  37. .. __: https://github.com/saltstack/salt-api/issues
  38. .. __: https://groups.google.com/forum/#!forum/salt-users