Skip to main content

Storage Facility

Storage Facility

This document describes the Rundeck Storage Facility which is used both for Key Storage, and for Project Definition Storage.

Storage Facility

The Storage facility provides a filesystem-like structure for storing files. Each file is located with a "/"-separated "path" and a name, similar to a file system path.

Currently the Storage Facility is split into two separate containers:

Both containers use the same storage mechanisms, but they can be configured independently of each other,
and have different APIs for modification.

Key Storage

The Key Storage container allows storing public keys, private keys, and passwords securely. The contents of these files can be accessed by Node Execution plugins for authenticating to remote nodes. The contents can be written via the Rundeck API, but only public keys can be read via the API.

See the chapter: Key Storage.

When configuring Key Storage providers, the configuration entries in rundeck-config.properties start with:

rundeck.storage.provider.[index]

And converter plugins start with:

rundeck.storage.converter.[index]

Project Storage

Similar to Key Storage, the Project Storage container keeps files related to Rundeck Projects:

  • contents of etc/project.properties - the Project configuration
  • contents of readme.md and motd.md - Readme and MOTD files

Access to these contents can be made via the Rundeck API.

See the chapter: Project Setup

When configuring Project Storage providers, the configuration entries in rundeck-config.properties start with:

rundeck.config.storage.provider.[index]

And converter plugins start with:

rundeck.config.storage.converter.[index]

Storage backends

The location of stored data can be either on the filesystem, the database, or some external system via usage of a Storage Plugin.

Rundeck provides these built-in implementations:

  • filesystem - stores files locally on the filesystem
  • db - stores file data as BLOBs in the database

It is highly recommended that you configure Rundeck to use a relational database instead of the default file-based data storage.

For information on configuring Rundeck to use specific Databases, see:

To develop your own storage plugin, see:

Storage Converters

Files can be encrypted in the storage backend by use of a Storage Converter plugin. A typical plugin would encrypt data at write time, and decrypt it at read time.

The Storage Converter Plugin handles reading and writing the content for any matching resources. The subsequent data is stored in the storage backend (on-disk or in a database) alongside the metadata for the file.

Converter plugins do not have to manage storing the data, that will be handled by the Storage backend.

To develop your own storage converter plugin, see:

Using Encryption

Rundeck provides a bundled Storage Converter plugin implementation: