mongodb-formula

Formula for MongoDB on GNU/Linux and MacOS.

Travis CI Build Status Semantic Release

1. General notes

See the full SaltStack Formulas installation and usage instructions. If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section. 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. See Formula Versioning Section for more details.

2. Special notes

By default only MongoDB server component (mongod) is installed. This behaviour is configurable via pillars.

mongodb:
  wanted:
    # choose what you want or everything
    database:
      - mongod
      - mongos
      - dbtools
      - shell
    gui:
      - robo3t
      - compass
    connectors:
      - bi
      - kafka

Configuration can be supplied in yaml:

mongodb:
  pkg:
    database:
      version: 4.2.6.1
      archive:
        skip_verify: true
      config:
        # http://docs.mongodb.org/manual/reference/configuration-options
        storage:
          dbPath: /var/lib/mongodb/mongod
        replication:
          replSetName: "rs1"
        sharding:
          clusterRole: shardsvr
        net:
          bindIp: '0.0.0.0,::'
          port: 27018
      firewall:
        ports:
          - tcp/27017
          - tcp/27018
          - tcp/27019

3. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

4. Available metastates

4.1. mongodb

Meta-state (This is a state that includes other states).

This installs the MongoDB solution.

4.2. mongodb.install

This state will install mongodb components on MacOS and GNU/Linux from archive.

4.3. mongodb.config

This state will apply mongodb service configuration (files).

4.4. mongodb.service

This state will start mongodb component services.

4.5. mongodb.service.clean

This state will stop mongodb component services.

4.6. mongodb.config.clean

This state will remove mongodb service configuration (files).

4.7. mongodb.clean

This state will remove mongodb components on MacOS and GNU/Linux.

5. Testing

Linux testing is done with kitchen-salt.

5.1. Requirements

  • Ruby

  • Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

5.2. bin/kitchen converge

Creates the docker instance and runs the mongodb main state, ready for testing.

5.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

5.4. bin/kitchen destroy

Removes the docker instance.

5.5. bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge
verify + destroy.

5.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.