> For the complete documentation index, see [llms.txt](https://docs.k9.io/key9-identity/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.k9.io/key9-identity/jsonair/1-what-is-jsonair.md).

# 1. What is JSONAir

A cloud based, simple to use,  centralized configurations storage system.

**JSONAir** ( /jās-on-âr/ n. ) - is a simple-to-use, centralized cloud-based configuration storage system.

In many situations, legacy flat-file configuration systems cause headaches. For example, in containerized environments, having to manually edit a YAML file, get it into a container, and redeploy is a pain. In clustered environments, it might be even worse because the flat file needs to be distributed to each container.

Some software takes this into account by using system environment variables. While this improves the process, in most cases, it requires the containers to be restarted to re-read the new environment variable.

JSONAir tackles this by making configuration distribution ‘a service.’ Configurations for your software can easily be retrieved by calling a simple API.

While many cloud providers offer proprietary configuration storage, these methods often impose a restrictive 'vendor lock-in' that limits future flexibility. JSONAir provides a simple, open-standard alternative, allowing you to secure your configuration data without being tied to a single ecosystem.

JSONAir is agnostic to “how” configuration data is stored. To JSONAir, configuration data is just “data.” It might be legacy flat ASCII files, YAML, JSON, etc. JSONAir doesn’t care. However, this means that your software still needs to “validate” the configuration data.

While there are similar projects to JSONAir, we found them to be overly complicated for most of our use cases. The concept behind JSONAir is for it to remain as simple as possible. The JSONAir API (`jsonair`) is a configuration retrieval system, and it does not validate, update, or modify configuration data. This makes it incredibly simple and uni-directional (read-only).

Changing configuration data is handled by separate programs, so the read API never needs write access to your data:

| Program           | Purpose                                                                                                                                                                                                      |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `jsonair`         | The read-only API. Agents and applications retrieve configurations from it.                                                                                                                                  |
| `jsonair-agent`   | Polls `jsonair`, writes the configuration to a local file, and runs a reload command when it changes.                                                                                                        |
| `jsonair-admin`   | A browser-based interface for people to create, edit and delete configurations.                                                                                                                              |
| `jsonair-write`   | An optional, **write-only** API for other services to create, update and delete configurations. It has no endpoint that returns configuration data, and it is meant to run on a restricted/internal network. |
| `jsonair-encrypt` | A command-line tool to encrypt (and decrypt) configuration data for manual database inserts.                                                                                                                 |

JSONAir is written in a memory-safe language (Golang) and can be used in containers and clusters itself for high availability. It is meant to be memory and CPU efficient.
