{"id":19871896,"url":"https://github.com/saltstack-formulas/mongodb-formula","last_synced_at":"2025-04-04T18:05:55.408Z","repository":{"id":8924486,"uuid":"10653459","full_name":"saltstack-formulas/mongodb-formula","owner":"saltstack-formulas","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-06T23:09:05.000Z","size":424,"stargazers_count":31,"open_issues_count":8,"forks_count":120,"subscribers_count":36,"default_branch":"master","last_synced_at":"2025-03-28T17:06:39.762Z","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}},"created_at":"2013-06-12T22:08:40.000Z","updated_at":"2022-01-06T08:06:26.000Z","dependencies_parsed_at":"2024-12-22T12:13:53.810Z","dependency_job_id":"67ea121b-6a45-4fbb-8e6b-1fc86a26da12","html_url":"https://github.com/saltstack-formulas/mongodb-formula","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fmongodb-formula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fmongodb-formula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fmongodb-formula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fmongodb-formula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack-formulas","download_url":"https://codeload.github.com/saltstack-formulas/mongodb-formula/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226213,"owners_count":20904465,"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-11-12T16:13:56.440Z","updated_at":"2025-04-04T18:05:55.384Z","avatar_url":"https://github.com/saltstack-formulas.png","language":"SaltStack","funding_links":[],"categories":[],"sub_categories":[],"readme":"mongodb-formula\n===============\n\nFormula for MongoDB on GNU/Linux and MacOS.\n\n|img_travis| |img_sr|\n\n.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/mongodb-formula.svg?branch=master\n   :alt: Travis CI Build Status\n   :scale: 100%\n   :target: https://travis-ci.com/saltstack-formulas/mongodb-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\n\n.. contents:: **Table of Contents**\n   :depth: 1\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`_.  If 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`_. If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``, which contains the currently released version. This formula is versioned according to `Semantic Versioning \u003chttp://semver.org/\u003e`_.  See `Formula Versioning Section \u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning\u003e`_ for more details.\n\nSpecial notes\n-------------\n\nBy default only MongoDB server component (`mongod`) is installed.  This behaviour is configurable via pillars.\n\n.. code-block:: yaml\n\n    mongodb:\n      wanted:\n        # choose what you want or everything\n        database:\n          - mongod\n          - mongos\n          - dbtools\n          - shell\n        gui:\n          - robo3t\n          - compass\n        connectors:\n          - bi\n          - kafka\n\nConfiguration can be supplied in yaml:\n\n.. code-block:: yaml\n\n    mongodb:\n      pkg:\n        database:\n          version: 4.2.6.1\n          archive:\n            skip_verify: true\n          config:\n            # http://docs.mongodb.org/manual/reference/configuration-options\n            storage:\n              dbPath: /var/lib/mongodb/mongod\n            replication:\n              replSetName: \"rs1\"\n            sharding:\n              clusterRole: shardsvr\n            net:\n              bindIp: '0.0.0.0,::'\n              port: 27018\n          firewall:\n            ports:\n              - tcp/27017\n              - tcp/27018\n              - tcp/27019\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 metastates\n--------------------\n\n.. contents::\n   :local:\n\n``mongodb``\n^^^^^^^^^^^\n\n*Meta-state (This is a state that includes other states)*.\n\nThis installs the MongoDB solution.\n\n\n``mongodb.install``\n^^^^^^^^^^^^^^^^^^^\n\nThis state will install mongodb components on MacOS and GNU/Linux from archive.\n\n``mongodb.config``\n^^^^^^^^^^^^^^^^^^\n\nThis state will apply mongodb service configuration (files).\n\n``mongodb.service``\n^^^^^^^^^^^^^^^^^^^\n\nThis state will start mongodb component services.\n\n``mongodb.service.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will stop mongodb component services.\n\n``mongodb.config.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will remove mongodb service configuration (files).\n\n``mongodb.clean``\n^^^^^^^^^^^^^^^^^\n\nThis state will remove mongodb components on MacOS and GNU/Linux.\n\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 ``mongodb`` main state, 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Fmongodb-formula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack-formulas%2Fmongodb-formula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Fmongodb-formula/lists"}