Definitions
awsRegion
| Predicate | Object |
|---|---|
| defaultValue | us-east-1 |
| paramDescription | The AWS region where resources are deployed and managed. |
| paramName | awsRegion |
| type | Parameter |
azureRegion
| Predicate | Object |
|---|---|
| defaultValue | eastus |
| paramDescription | The Azure region where resources are deployed and managed. |
| paramName | azureRegion |
| type | Parameter |
databaseName
| Predicate | Object |
|---|---|
| defaultValue | mydatabase |
| paramDescription | Name of the database. |
| paramName | databaseName |
| type | Parameter |
databasePassword
| Predicate | Object |
|---|---|
| defaultValue | |
| paramDescription | Password for the database |
| paramName | databasePassword |
| type | Parameter |
databaseURL
| Predicate | Object |
|---|---|
| defaultValue | jdbc:mysql://localhost:3306/mydatabase |
| paramDescription | URL to the database. |
| paramName | databaseURL |
| type | Parameter |
databaseUsername
| Predicate | Object |
|---|---|
| defaultValue | admin |
| paramDescription | Username for the database |
| paramName | databaseUsername |
| type | Parameter |
domainOrIp
| Predicate | Object |
|---|---|
| defaultValue | example.com |
| isFile | false |
| parameterDescription | A parameter that can be used to specify either a domain name or an IP address. |
| parameterName | domainOrIp |
| type | Parameter |
ec2InstanceId
| Predicate | Object |
|---|---|
| defaultValue | |
| paramDescription | The unique identifier of an EC2 instance. |
| paramName | ec2InstanceId |
| type | Parameter |
env
| Predicate | Object |
|---|---|
| defaultValue | production |
| paramDescription | Environment type (e.g., development, staging, production). |
| paramName | env |
| type | Parameter |
gcpRegion
| Predicate | Object |
|---|---|
| defaultValue | us-central1 |
| paramDescription | The Google Cloud region where resources are deployed and managed. |
| paramName | gcpRegion |
| type | Parameter |
hetznerLocation
| Predicate | Object |
|---|---|
| defaultValue | fsn1 |
| paramDescription | The Hetzner Cloud location where resources are deployed (API location name). |
| paramName | hetznerLocation |
| type | Parameter |
ip
| Predicate | Object |
|---|---|
| defaultValue | 192.168.1.1 |
| paramDescription | IP address of the service. |
| paramName | ip |
| type | Parameter |
jsonConfigFile
| Predicate | Object |
|---|---|
| defaultValue | config.json |
| isFile | true |
| paramDescription | Path to the JSON configuration file. |
| paramName | jsonConfigFile |
| type | Parameter |
maxThreads
| Predicate | Object |
|---|---|
| defaultValue | 4 |
| paramDescription | Maximum number of threads. |
| paramName | maxThreads |
| type | Parameter |
port
| Predicate | Object |
|---|---|
| defaultValue | 80 |
| paramDescription | Port number for the service. |
| paramName | port |
| type | Parameter |
ram
| Predicate | Object |
|---|---|
| defaultValue | 1GB |
| paramDescription | Specifies the required amount of RAM in gigabytes. |
| paramName | RAM |
| type | Parameter |
redisConnectionString
| Predicate | Object |
|---|---|
| defaultValue | |
| isFile | false |
| paramDescription | A connection string for a redis instance |
| paramName | redisConnectionString |
| type | Parameter |
redisHost
| Predicate | Object |
|---|---|
| defaultValue | localhost |
| isFile | false |
| paramDescription | The host/url for accessing a Redis server |
| paramName | redisHost |
| type | Parameter |
redisPassword
| Predicate | Object |
|---|---|
| defaultValue | pass |
| isFile | false |
| paramDescription | The password for accessing a Redis server |
| paramName | redisPass |
| type | Parameter |
redisPort
| Predicate | Object |
|---|---|
| defaultValue | 6379 |
| isFile | false |
| paramDescription | The port for accessing a Redis server |
| paramName | redisPort |
| type | Parameter |
redisUser
| Predicate | Object |
|---|---|
| defaultValue | redis |
| isFile | false |
| paramDescription | The username for accessing a Redis server |
| paramName | redisUser |
| type | Parameter |
sshConnectionString
| Predicate | Object |
|---|---|
| defaultValue | user@hostname |
| paramDescription | The SSH connection string used for secure shell access, typically in the format user@hostname. |
| paramName | sshConnectionString |
| type | Parameter |
sshKey
| Predicate | Object |
|---|---|
| defaultValue | /path/to/ssh/key |
| isFile | true |
| paramDescription | Path to the SSH key file. |
| paramName | sshKey |
| type | Parameter |
sshKeyAsString
| Predicate | Object |
|---|---|
| defaultValue | ssh-rsa AAAA... |
| paramDescription | SSH string for secure connections. |
| paramName | sshKeyAsString |
| type | Parameter |
storage
| Predicate | Object |
|---|---|
| defaultValue | 10GB |
| paramDescription | Specifies the required hard disk storage in gigabytes. |
| paramName | Hard Storage |
| type | Parameter |
tomlConfigFile
| Predicate | Object |
|---|---|
| defaultValue | config.toml |
| isFile | true |
| paramDescription | Path to the TOML configuration file. |
| paramName | tomlConfigFile |
| type | Parameter |
url
| Predicate | Object |
|---|---|
| defaultValue | |
| isFile | false |
| paramDescription | The URL used for accessing a resource or endpoint. |
| paramName | url |
| type | Parameter |
vCPU
| Predicate | Object |
|---|---|
| defaultValue | 2 |
| paramDescription | Specifies the number of virtual CPUs allocated to a computing instance. vCPUs are a measure of compute resources in cloud environments, often used to gauge processing power alongside physical CPUs. |
| paramName | vCPU |
| type | Parameter |
yamlConfigFile
| Predicate | Object |
|---|---|
| defaultValue | config.yaml |
| isFile | true |
| paramDescription | Path to the YAML configuration file. |
| paramName | yamlConfigFile |
| type | Parameter |