Configu Configuration-as-Code Format

Location

.cfgu files essentially set the boundaries of different domains in the code relative to the configuration they use. Developers are free to organize and structure their .cfgu files in a way that makes sense for their specific needs and workflow. There is no limit on the number of .cfgu files that can be created, and they can be spread across different codebases, subfolders in the same project, and different repositories.

Format

The .cfgu file can be written in one of the following formats: YAML or JSON. The name suffix of this file should be .cfgu.yaml|yml|json according to the format used.

$schema

Include the $schema property at the beginning of the file to specify the Cfgu version to communicate to other readers and tooling which specification version is intended. Also, most modern editors will use this property to provide IntelliSense and validation for the Cfgu file.

Properties

description

String|Markdown

Describe a ConfigKey’s purpose within the application.

type

CfguType

required

Define the data type of a ConfigValue.

If the type is RegEx, a pattern property must be provided.
If the type is JSONSchema, a schema property must be provided.

Configu supports a variety of types to accommodate different data formats.

These types cover a wide range of data formats commonly used in configuration settings. You should choose the appropriate type for each configuration value based on your application’s requirements. Explore the available types and utilize them to define your configuration values accurately.

Boolean

true | false

Check if the string is a boolean.

Number

123 | 1.2 | -3

Check if the string contains only numbers.

String

'Hello, World!'

Any string of characters.

RegEx

/abc/

Check if the string matches a regular expression.

JSONSchema

{ "type": "string" }

A JSON schema.

IPv4

192.0.2.0

Check if the string is an IP (version 4).

IPv6

2001:0db8:85a3:0000:0000:8a2e:0370:7334

Check if the string is an IP (version 6).

FQDN

domain.com

Check if the string is a fully qualified domain name.

URL

http://foo.com

Check if the string is a URL.

Hex

deadBEEF

A hexadecimal number.

Base64

Zm9vYmFy

Check if the string is base64 encoded.

MD5

d41d8cd98f00b204e9800998ecf8427e

Check if the string is a hash of MD5 algorithm.

SHA

5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8

Check if the string is a hash of SHA algorithm (1, 256, 384, 512).

Color

#FF0000

A color in hexadecimal format.

foo@bar.com

An email address.

MobilePhone

19876543210

A mobile phone number.

Locale

en-US

A locale.

Language

A language code.

LatLong

(-17.738223, 85.605469)

A latitude-longitude pair.

Country

A country code.

Currency

USD

A currency code.

DateTime

'2000-01-01T00:00:00Z'

A date-time string in ISO 8601 format.

UUID

A987FBC9-4BED-3078-CF07-9141BA07C9F3

Check if the string is a UUID (version 1, 2, 3, 4 or 5).

SemVer

1.0.0

Check if the string is a Semantic Versioning Specification (SemVer).

DockerImage

nginx:latest

A Docker image.

MACAddress

3D:F2:C9:A6:B3:4F

A MAC address.

MIMEType

application/json

A MIME type.

MongoId

'507f1f77bcf86cd799439011'

A MongoDB ObjectId.

AWSRegion

us-west-2

An AWS region.

AZRegion

westus

An Azure region.

GCPRegion

us-central1

A Google Cloud Platform region.

OracleRegion

us-ashburn-1

An Oracle Cloud region.

IBMRegion

us-south

An IBM Cloud region.

AlibabaRegion

cn-hangzhou

An Alibaba Cloud region.

ARN

arn:aws:cloudformation:us-east-1:123456789012:stack/my-stack-name/1c2fa620-982a-11e3-aff7-50e2416294e0

An Amazon Resource Name (ARN).

Most of the validators are based on the validator.js library. You can refer to the library’s documentation for more information on the supported validators.

Configu is designed to be extensible, allowing you to add custom types as needed. If you require a type that is not currently supported, we encourage you to let us know or consider contributing it yourself. With Configu’s flexibility, you can tailor the configuration system to suit your specific requirements.

pattern

String

Define a regular expression a ConigValue must match.

This property must be provided if the type is RegEx.

schema

JSON Schema

Specify a JSON schema a ConigValue must conform to.

This property must be provided if the type is JSONSchema.

options

String[]

Specify a list of allowable ConigValues for a ConfigKey.

This property cannot be set together with template.

This property cannot be an empty array or contain empty strings.

Each option must be unique and according to the type of the ConfigKey.

default

String

Set a default ConfigValue for a ConfigKey if not explicitly provided.

This property cannot be set together with required or template or lazy properties.

If options is set, the default value must be one of the options.

required

Boolean

Indicate whether a ConfigKey is essential for the application’s functionality. When set to true, a ConfigValue must be found on EvalCommand.

This property cannot be set together with default.

depends

String[]

List other ConfigKeys this configuration depends on.

This property cannot be an empty array or contain reserved words.

template

String

Define a template for constructing a ConfigValue from other Configs.

This property cannot be set together with default or lazy.

lazy

Boolean

Indicate that a ConfigValue is set only during EvalCommand execution, excluding it from UpsertCommand assignments.

This property cannot be set together with default or template.

hidden

Boolean

Indicate that this ConfigKey will be omitted from ExportCommand results.

labels

String[]

List labels to categorize ConfigKeys for easier filtering on ExportCommand.

Introduction

Interfaces

Integrations

Configu Configuration-as-Code Format

Location

Format

$schema

Properties

Example

Introduction

Interfaces

Integrations

​Location

​Format

​$schema

​Properties

​Example

Location

Format

$schema

Properties

Example