@byndyusoft/casc
Advanced tools
Configuration as Code solution for Node.js (and not just) :pencil: :gear:
Source code of the microservice and its configuration for different environments must be versioned and deployed from the same commit. This project takes care of generating config from a template and managing values for different environments.
Why don't we just use Helm? Helm is heavily dependent on Kubernetes and this creates problems for various local scripts and migrating applications from Kubernetes to PaaS.
| Feature | Helm | node-casc |
|---|---|---|
| Container Orchestration Platform | Kubernetes | No limits |
| Microservice runtime | No limits | No limits |
| Runtime for configuration | No limits | Node.js |
| Template language | Go templates | Handlebars |
| Output config format | No limits | YAML or JSON |
| Support secret variables | Plugin | Built-in |
| Cryptography algorithm | No limits | RSA |
| Plugins | Yes | No |
npm install @byndyusoft/casc
or
yarn add @byndyusoft/casc
From releases you can download:
Execute in your terminal to initialize CASC directory:
casc init:dir
By default CASC directory is $(pwd)/.casc.
keys/ - directory with public and private keys for encrypting and decrypting secret values.env - override values.override.yaml through process.env (see dotenv for syntax)config.yaml - application config (see Handlebars for syntax)settings.yaml - CASC settingsvalues.yaml - values for config.yamlvalues.override.yaml - override values.yaml.gitignore.envvalues.override.yamlHandlebars helpers:
str - convert value to stringexists - checks that all values existsDefault settings:
crypto:
strategy: rsa
privateKey:
format: pkcs8-private-pem
strategies:
file: private.pem
env: CASC_PRIVATE_KEY
publicKey:
format: pkcs8-public-pem
strategies:
file: public.pem
Properties:
crypto.strategy - asymmetric cryptography algorithm, only rsa supportedprivateKey.format - private key format, rsa supports only pkcs8-private-pemprivateKey.strategies
publicKey.format - public key format, rsa supports only pkcs8-public-pempublicKey.strategies
file private or public key reading strategiesStrategy settings are a string or an array of strings, where each item is a path to a private or public key. The first found key will be read. If the path is relative, then it will be relative to the keys/ directory.
env private key reading strategyStrategy settings are a string or an array of strings, where each item is a key of process.env. The first found key will be read.
Example structure:
VALUE_NAME:
env_name: some value
other_env_name:
- some host 1
- some host 2
- some host 3
env_name_with_encrypted_value*: 6JM8YlugHyjnzatv/nOB7A==
env_name_with_decrypted_value!: secret value
default: default value if current environment is not found
Only english letters, digits and underscores are allowed in value names and environments. The digits at the beginning is prohibited. Values can only be strings, numbers, booleans, nulls, or their arrays.
We do recommend using this project as a CLI in order to avoid inadvertently affecting your application.
USAGE
$ casc config:build
OPTIONS
-c, --cascDir=cascDir [default: /app/.casc] CASC directory
-e, --env=env (required) environment
-o, --override=override [default: true] override values
-y, --yaml=yaml [default: false] YAML output instead JSON
USAGE
$ casc init:dir
OPTIONS
-c, --cascDir=cascDir [default: /app/.casc] CASC directory
USAGE
$ casc init:keys:rsa
OPTIONS
-b, --bits=bits [default: 2048] RSA key size in bits
-c, --cascDir=cascDir [default: /app/.casc] CASC directory
-f, --format=(pkcs8-pem) [default: pkcs8-pem] keys format
USAGE
$ casc values:decrypt
OPTIONS
-c, --cascDir=cascDir [default: /app/.casc] CASC directory
-y, --yaml=yaml [default: true] YAML output instead JSON
USAGE
$ casc values:encrypt
OPTIONS
-c, --cascDir=cascDir [default: /app/.casc] CASC directory
-y, --yaml=yaml [default: true] YAML output instead JSON
We do not recommend using this project as a library in order to avoid inadvertently affecting your application.
import "reflect-metadata";
import {
container,
IConfigBuilder,
IConfigBuilderToken,
IContextBuilder,
IContextBuilderToken,
IValuesReader,
IValuesReaderToken,
} from "@byndyusoft/casc";
const configBuilder = container.resolve<IConfigBuilder>(IConfigBuilderToken);
const contextBuilder = container.resolve<IContextBuilder>(IContextBuilderToken);
const valuesReader = container.resolve<IValuesReader>(IValuesReaderToken);
const config = await configBuilder.build(
await contextBuilder.build(
process.env.NODE_ENV,
await valuesReader.read(true),
),
);
console.log(config);
FAQs
Configuration as Code solution for Node.js (and not just)
We found that @byndyusoft/casc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.