repository.storage

Repository Configuration

oneOf

Storage repository

Storage repository

type

object

properties

  • type

type

string

enum

GRIDFS

default

GRIDFS

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • mongoConfiguration

The configuration of the Mongo Database

MongoConfiguration

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

MongoConfiguration

type

object

properties

  • credential

The credential to connect with the database.

See MongoDB user management ↗️ for more information.

CredentialConfiguration

  • databaseName

The name of the database to use. The previous default value was alarms.

type

string

  • serverUrl

The hostname of the mongodb configuration. (For example: mongodb://<host-1>,…,<host-x>/?replicaSet=<replSet-id>)

Depending of your workload, some options can be useful to edit:

  • maxPoolSize: To increase the number of connection available (default: 100)

  • readPreference: To decrease the load on the primary node (default: primary)

See MongoDB documentation ↗️ for more information.

type

string

additionalProperties

False

CredentialConfiguration

type

object

properties

  • authenticationDatabase

The database where the user is defined.

By default, this will be the same database as the one used for the data.

type

string

  • password

The password corresponding to the user.

oneOf

PLAINTEXT

SECRET

ENCRYPTED

  • username

The username as configured on MongoDB

type

string

additionalProperties

False

PLAINTEXT

type

object

properties

  • type

type

string

enum

PLAINTEXT

default

PLAINTEXT

  • password

The password to use in plaintext. It can be for example thisIs@TestPassword123.

type

string

additionalProperties

False

SECRET

type

object

properties

  • type

type

string

enum

SECRET

default

SECRET

  • secretPath

The path of the secret containing the password. This is a path to the secret containing the password.

type

string

additionalProperties

False

ENCRYPTED

type

object

properties

  • type

type

string

enum

ENCRYPTED

default

ENCRYPTED

  • encryptedPassword

The password encrypted Base64(IV+AES256(password, input)) the password must be a shared secret available for the osp-configuration-dispatcher

see documentation ↗️ see toolbox ↗️

type

string

  • secretPath

The full path to the secret exposed by the orchestrator; this password is used to encrypt the encryptedPassword.

type

string

additionalProperties

False