https://github.com/sunng87/stavka

Stavka manages configuration from various sources, for your Clojure application.
https://github.com/sunng87/stavka

clojure configuration-management

Last synced: 3 months ago
JSON representation

Stavka manages configuration from various sources, for your Clojure application.

• Host: GitHub
• URL: https://github.com/sunng87/stavka
• Owner: sunng87
• License: epl-1.0
• Created: 2018-05-30T13:37:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-06T14:28:42.000Z (almost 3 years ago)
• Last Synced: 2024-10-03T12:23:59.163Z (4 months ago)
• Topics: clojure, configuration-management
• Language: Clojure
• Homepage:
• Size: 128 KB
• Stars: 44
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# stavka

[![Build Status](https://travis-ci.org/sunng87/stavka.png?branch=master)](https://travis-ci.org/sunng87/stavka)

[![Clojars](https://img.shields.io/clojars/v/stavka.svg)](https://clojars.org/stavka)

[![Cljdoc](https://img.shields.io/badge/cljdoc-stavka-blue.svg)](https://cljdoc.xyz/d/stavka/stavka)

[![License](https://img.shields.io/badge/license-eclipse-blue.svg)](https://github.com/sunng87/stavka/blob/master/LICENSE)

[![Donate](https://img.shields.io/badge/donate-liberapay-yellow.svg)](https://liberapay.com/Sunng/donate)

Stavka (Ставка) is the high command of your clojure application,

which manages configuration from various sources.

## Features

* Extensible configuration sources and formats

  * Sources:

    * Classpath `(classpath)`

    * File system `(file)`

    * URL `(url)`, enabled when `clj-http` on classpath

    * JDBC (see [examples](https://github.com/sunng87/stavka/blob/master/examples/stavka/example/jdbc.clj))

    * Kubernetes configmap (see [examples](https://github.com/sunng87/stavka/blob/master/examples/stavka/example/kubernetes.clj))

  * Formats:

    * Environment variables `(env)`

    * JVM options (-D) `(options)`

    * Commandline options with tools.cli parser `(cli args

      cli-parser)`, enabled when `clojure.tools.cli` on classpath

    * EDN `(edn)`

    * JSON `(json)`, enabled when `cheshire` on classpath

    * YAML `(yaml)`, enabled when `clj-yaml` on classpath

    * Properties `(property)`

* Reloading by

  * Watching file system `(watch)`, enabled when `hawk` on classpath

  * Watching file system `(watch2)` using

    [beholder](https://github.com/nextjournal/beholder) as backend,

    enabled when `heholder` on classpath

  * Polling the source `(poll)`

* Listeners for value changing `(on-change!)`

* Type conversion `($l) ($f) ($b) ($s)`

## Usage

### Setup

Use stavka with [component](https://github.com/stuartsierra/component)

or [mount](https://github.com/tolitius/mount). You can have multiple

config instance and manage life-cycle of updater.

```clj

(require '[stavka.core :as sta :refer :all])

;; Use stavka with mount

(defstate config

    :start

    ;; load configuration from multiple sources and merge them like

    ;; clojure.core/merge.

    (sta/using

        ;; using environment variables by default

        (env)

        ;; also load edn from classpath

        (edn (classpath "/default.edn"))

        ;; load another properties from filesystem, and watch is for change

        (properties (watch (file "/etc/stavka.properties")))

        ;; and fetch a remote json configuration. check every 10 seconds

        ;; for update.

        (json (poll (url "http://somehost/configuration/my.json") 10000)))

    :stop (stop-updaters! config))

;; Use stavka with component

(defrecord StavkaConfiguration [config]

    component/Lifecycle

    (start [component]

        (assoc component :config

            (sta/using

                (env)

                (edn (classpath "/default.edn"))

                (properties (watch (file "/etc/stavka.properties")))

                (json (poll (url "http://somehost/configuration/my.json") 10000)))))

    (stop [component]

        (stop-updaters! config)

        (assoc component :config nil)))

```

### Configuration format:

#### ENV

```sh

export SOME_CONFIG_KEY="some-value"

```

#### EDN

```clojure

{:some {:config {:key "some-value"}}}

```

#### JSON

```javascript

{

  "some": {

    "config": {

      "key" : "some-value"

    }

  }

}

```

#### Properties

```properties

some.config.key=some-value

```

#### Yaml

```yaml

some:

  config:

    key: some-value

```

### Get configuration item:

```clj

;; get configuration

($ config :some.config.key)

;; get configuration with type convertion

;; $l: as long

;; $f: as double

;; $s: as string

;; $b: as boolean

($l config :some.config.key)

```

### Global config

And you can still use stavka globally:

```clj

(sta/global!

    (env)

    (edn (classpath "/default.edn"))

    (properties (watch (file "/etc/stavka.properties")))

    (json (poll (url "http://somehost/configuration/my.json") 10000)))

;; use double-$ to access global config

($$ :some.config.key)

($$l :some.config.key)

```

### Listeners

Add change listener on some key when you have updater configured:

```clj

(on-change! config :some.config.key

    (fn [new-value previous-value]

        ))

```

## License

Copyright © 2018 Ning Sun

Distributed under the Eclipse Public License either version 1.0 or (at

your option) any later version.

## Donation

I'm now accepting donation on [liberapay](https://liberapay.com/Sunng/donate),

if you find my work helpful and want to keep it going.