{"id":13446492,"url":"https://github.com/saltstack-formulas/salt-formula","last_synced_at":"2025-05-15T06:08:23.723Z","repository":{"id":8925629,"uuid":"10654925","full_name":"saltstack-formulas/salt-formula","owner":"saltstack-formulas","description":"Yes, Salt can Salt itself!","archived":false,"fork":false,"pushed_at":"2025-04-07T20:02:54.000Z","size":1488,"stargazers_count":197,"open_issues_count":51,"forks_count":419,"subscribers_count":55,"default_branch":"master","last_synced_at":"2025-04-14T10:42:41.668Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html","language":"SaltStack","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saltstack-formulas.png","metadata":{"files":{"readme":"docs/README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2013-06-12T23:46:12.000Z","updated_at":"2025-03-05T10:15:14.000Z","dependencies_parsed_at":"2025-04-14T10:35:11.958Z","dependency_job_id":"c6c5d4eb-762f-421e-9c9c-1d163fd294a3","html_url":"https://github.com/saltstack-formulas/salt-formula","commit_stats":{"total_commits":748,"total_committers":139,"mean_commits":5.381294964028777,"dds":0.6804812834224598,"last_synced_commit":"2a7a9decee977fa418f49d368319bdda08fcf8db"},"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fsalt-formula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fsalt-formula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fsalt-formula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fsalt-formula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack-formulas","download_url":"https://codeload.github.com/saltstack-formulas/salt-formula/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254283350,"owners_count":22045141,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T05:00:53.828Z","updated_at":"2025-05-15T06:08:18.698Z","avatar_url":"https://github.com/saltstack-formulas.png","language":"SaltStack","funding_links":[],"categories":["SaltStack"],"sub_categories":[],"readme":".. _readme:\n\nsalt-formula\n============\n\n|img_travis| |img_sr|\n\n.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/salt-formula.svg?branch=master\n   :alt: Travis CI Build Status\n   :scale: 100%\n   :target: https://travis-ci.com/saltstack-formulas/salt-formula\n.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :alt: Semantic Release\n   :scale: 100%\n   :target: https://github.com/semantic-release/semantic-release\n\nYes, Salt can Salt itself!\n\n.. contents:: **Table of Contents**\n\nGeneral notes\n-------------\n\nSee the full `SaltStack Formulas installation and usage instructions\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html\u003e`_.\n\nIf you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas\u003e`_.\n\nIf you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,\nwhich contains the currently released version. This formula is versioned according to `Semantic Versioning \u003chttp://semver.org/\u003e`_.\n\nSee `Formula Versioning Section \u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning\u003e`_ for more details.\n\nContributing to this repo\n-------------------------\n\n**Commit message formatting is significant!!**\n\nPlease see `How to contribute \u003chttps://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst\u003e`_ for more details.\n\nAvailable states\n----------------\n\n.. contents::\n   :local:\n\n``salt``\n^^^^^^^^\n\n*Meta-state (This is a state that includes other states)*.\n\nThis calls all runable states based on configured pillar data.\n\n``salt.minion``\n^^^^^^^^^^^^^^^\n\nInstall a minion\n\n``salt.master``\n^^^^^^^^^^^^^^^\n\nInstall a master.\n\n``salt.syndic``\n^^^^^^^^^^^^^^^\n\nInstall a syndic.\n\n``salt.cloud``\n^^^^^^^^^^^^^^\n\nInstall salt cloud.\n\n``salt.ssh``\n^^^^^^^^^^^^\n\nInstall salt-ssh with roster file.\nConfigure pillar data under salt:ssh_roster to feed the template.\n\n``salt.api``\n^^^^^^^^^^^^\n\nInstall salt api\nRequisite: Configure salt-master with rest_cherrypy or rest_tornado.\n\n``salt.standalone``\n^^^^^^^^^^^^^^^^^^^\n\nInstall a minion and configure it in `standalone mode\n\u003chttp://docs.saltstack.com/en/latest/topics/tutorials/standalone_minion.html\u003e`_.\n\n``salt.gitfs.dulwich``\n^^^^^^^^^^^^^^^^^^^^^^\n\nInstall gitfs backend dulwich dependencies. Set ``salt:master:gitfs_provider: dulwich`` in your pillar.\n\n``salt.gitfs.gitpython``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nInstall gitfs backend GitPython dependenciess. Set ``salt:master:gitfs_provider: gitpython`` in your pillar.\n\n``salt.gitfs.keys``\n^^^^^^^^^^^^^^^^^^^\n\nInstall ssh keys to be used by gitfs\n\n``salt.gitfs.pygit2``\n^^^^^^^^^^^^^^^^^^^^^\n\nInstall gitfs backend libgit2/pygit2 dependenciess. Set ``salt:master:gitfs_provider: pygit2`` in your pillar.\nFor EL distributions, pygit is installed from packages from `EPEL \u003chttps://github.com/saltstack-formulas/epel-formula\u003e`_.\n\n``salt.pkgrepo``\n^^^^^^^^^^^^^^^^\n\nIt is recommended to use SaltStack repository for Debian, RedHat, and SuSE, to benefit from the latest stable salt release. Refer to official documentation at \u003chttp://docs.saltstack.com/en/latest/topics/installation/index.html#platform-specific-installation-instructions\u003e`_.\n\n``salt.pkgrepo.clean``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nUndo the effects of ``salt.pkgrepo`` on Debian, RedHat, and SuSE.\n\n``salt.formulas``\n^^^^^^^^^^^^^^^^^\n\nClone selected `Salt formulas\n\u003chttp://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html\u003e`_\nGit repositories under ``/srv/formulas`` and makes them available in the relevant ``file_roots`` settings. Please note that in order for ``file_roots`` to be updated, ``salt.master`` must be called after ``salt.formulas``. For example:\n\n::\n\n    base:\n      'saltmain':\n        - salt.formulas\n        - salt.master\n\n\nPillar data can be used to customize all paths, URLs, etc. Here's a minimal pillar sample installing two formulas in the base environment:\n\n::\n\n    salt_formulas:\n      list:\n        base:\n          - salt-formula\n          - openssh-formula\n\nSee pillar.example for an exhaustive list of settings available via pillar. Note\nthat by default this state:\n\n- downloads the latest formulas from the `saltstack-formulas project\n  \u003chttps://github.com/saltstack-formulas\u003e`_ on GitHub.\n- does not update the local repositories after the initial clone.\n  This is a safety measure since you do not control how the official\n  repositories evolve.\n\nIf you configure the state to download the formulas from repositories that\nyou control, then you can safely enable the\n``salt_formulas:git_opts:default:update`` pillar setting to ``True``.\n\n\nConfiguration\n-------------\n\nEvery option available in the templates can be set in pillar. Settings under 'salt' will be overridden by more specific settings under ``salt['master']``, ``salt['minion']`` or ``salt['cloud']``. Options specified in ``salt['minion']`` which are not present in the default configuration file will be added to the end of the configuration file.\n\n::\n\n    salt:\n      ret_port: 4506\n      master:\n        user: saltuser\n        ...\n      minion:\n        user: saltuser\n        ...\n      cloud:\n        providers: ec2\n        ...\n\nExtending\n---------\n\nAdditional templates can be added by the user under salt/files/minion.d and master.d. This might be useful if, for example, a recently-added configuration option is not yet provided by the default template.\n\nVagrant\n-------\n\nExecuting the provided `Vagrantfile \u003chttp://www.vagrantup.com/\u003e`_  will create a Ubuntu 14.04 VM, add the default Saltstack Repository and install the current stable version.\n\nThe folders inside the VM will be set up in a way that enables you to simply execute 'sudo salt \"*\" state.highstate' to apply the salt formula to the VM, using the pillar.example config. You can check /etc/salt/ for results.\n\nRemember, you will have to run ``state.highstate`` or ``state.sls salt.(master|minion|cloud)`` manually.\n\nMacOS Support\n-------------\n\nAs MacOS has no native package management that pkg.installed can leverage appropriately, and brew does not count, the salt.minion state  manages salt minion package upgrades by way of .pkg file download which is then installed using the macpackage.installed state.\n\nsalt-minion packages on MacOS will not be upgraded by default. To enable package management you must set the following at a minimum,\n\n::\n\n    install_packages: True\n    version: 3006.9\n    salt_minion_pkg_source: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3006.9/salt-3006.9-py3-x86_64.pkg\n\ninstall_packages must indicate that the installation of a package is desired. If so, version will be used to compare the version of the installed .pkg against the downloaded one. If version is not set and a salt.pkg is already installed the .pkg will not be installed again.\n\nA future update to the formula may include extraction of version from the downloaded .pkg itself; but for the time being you MUST set version to indicate what you believe it to be.\n\nRefer to pillar.example for more information.\n\nTesting\n-------\n\nLinux testing is done with ``kitchen-salt``.\n\nRequirements\n^^^^^^^^^^^^\n\n* Ruby\n* Docker\n\n.. code-block:: bash\n\n   $ gem install bundler\n   $ bundle install\n   $ bin/kitchen test [platform]\n\nWhere ``[platform]`` is the platform name defined in ``kitchen.yml``,\ne.g. ``debian-9-2019-2-py3``.\n\n``bin/kitchen converge``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nCreates the docker instance and runs the ``salt`` main states, ready for testing.\n\n``bin/kitchen verify``\n^^^^^^^^^^^^^^^^^^^^^^\n\nRuns the ``inspec`` tests on the actual instance.\n\n``bin/kitchen destroy``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nRemoves the docker instance.\n\n``bin/kitchen test``\n^^^^^^^^^^^^^^^^^^^^\n\nRuns all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.\n\n``bin/kitchen login``\n^^^^^^^^^^^^^^^^^^^^^\n\nGives you SSH access to the instance for manual testing.\n\nTesting with Vagrant\n--------------------\n\nWindows/FreeBSD/OpenBSD testing is done with ``kitchen-salt``.\n\nRequirements\n^^^^^^^^^^^^\n\n* Ruby\n* Virtualbox\n* Vagrant\n\nSetup\n^^^^^\n\n.. code-block:: bash\n\n   $ gem install bundler\n   $ bundle install --with=vagrant\n   $ bin/kitchen test [platform]\n\nWhere ``[platform]`` is the platform name defined in ``kitchen.vagrant.yml``,\ne.g. ``windows-81-latest-py3``.\n\nNote\n^^^^\n\nWhen testing using Vagrant you must set the environment variable ``KITCHEN_LOCAL_YAML`` to ``kitchen.vagrant.yml``.  For example:\n\n.. code-block:: bash\n\n   $ KITCHEN_LOCAL_YAML=kitchen.vagrant.yml bin/kitchen test      # Alternatively,\n   $ export KITCHEN_LOCAL_YAML=kitchen.vagrant.yml\n   $ bin/kitchen test\n\nThen run the following commands as needed.\n\n``bin/kitchen converge``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nCreates the Vagrant instance and runs the ``salt`` main states, ready for testing.\n\n``bin/kitchen verify``\n^^^^^^^^^^^^^^^^^^^^^^\n\nRuns the ``inspec`` tests on the actual instance.\n\n``bin/kitchen destroy``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nRemoves the Vagrant instance.\n\n``bin/kitchen test``\n^^^^^^^^^^^^^^^^^^^^\n\nRuns all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.\n\n``bin/kitchen login``\n^^^^^^^^^^^^^^^^^^^^^\n\nGives you RDP/SSH access to the instance for manual testing.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Fsalt-formula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack-formulas%2Fsalt-formula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Fsalt-formula/lists"}