Definitions
KuttAWS
| Predicate | Object |
|---|---|
| description | This strategy outlines the process for deploying Kutt on AWS, focusing on cloud-specific configurations and optimizations. |
| executedOnRunner | LinuxRunnerWithAWS |
| installScripts | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/Kutt/install.sh |
| optionalArgument | KuttAWSDomainOrIp |
| optionalArgument | KuttAWSPort |
| requiresArgument | KuttInstallSSHConnectionString |
| requiresArgument | KuttInstallSSHKey |
| requiresArgument | KuttRedisHost |
| requiresArgument | KuttRedisPort |
| requiresArgument | KuttRedisUser |
| requiresArgument | KuttRedisPassword |
| requiresArgument | KuttPostgresHost |
| requiresArgument | KuttPostgresPort |
| requiresArgument | KuttPostgresUser |
| requiresArgument | KuttPostgresPassword |
| requiresArgument | KuttPostgresDBName |
| supportFiles | KuttAWSEnv |
| supportFiles | KuttAWSKnex |
| supportFiles | KuttAWSKnexMigrate |
| targetsApplication | Kutt |
| title | Install Kutt on AWS |
| type | InstallStrategy |
KuttAWSDomainOrIp
| Predicate | Object |
|---|---|
| argumentDescription | This is the domain or ip that Kutt will be installed at |
| argumentName | domain |
| argumentType | domainOrIp |
| type | Argument |
KuttAWSEnv
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/Kutt/update_env.sh |
| localPath | ./update_env.sh |
| type | RemoteFileEntry |
KuttAWSKnex
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/Kutt/knex.ts |
| localPath | ./knex.ts |
| type | RemoteFileEntry |
KuttAWSKnexMigrate
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/Kutt/migration.ts |
| localPath | ./migration.ts |
| type | RemoteFileEntry |
KuttAWSPort
| Predicate | Object |
|---|---|
| argumentDescription | This is the (optional) port that Kutt will respond on |
| argumentName | port |
| argumentType | port |
| type | Argument |
KuttInstallSSHConnectionString
| Predicate | Object |
|---|---|
| argumentType | sshConnectionString |
| type | Argument |
KuttInstallSSHKey
| Predicate | Object |
|---|---|
| argumentType | sshKey |
| type | Argument |
KuttPostgresDBName
| Predicate | Object |
|---|---|
| argumentType | databaseName |
| type | Argument |
KuttPostgresHost
| Predicate | Object |
|---|---|
| argumentType | databaseURL |
| type | Argument |
KuttPostgresPassword
| Predicate | Object |
|---|---|
| argumentType | databasePassword |
| type | Argument |
KuttPostgresPort
| Predicate | Object |
|---|---|
| argumentType | port |
| type | Argument |
KuttPostgresUser
| Predicate | Object |
|---|---|
| argumentType | databaseUsername |
| type | Argument |
KuttRedisHost
| Predicate | Object |
|---|---|
| argumentType | redisHost |
| type | Argument |
KuttRedisPassword
| Predicate | Object |
|---|---|
| argumentType | redisPassword |
| type | Argument |
KuttRedisPort
| Predicate | Object |
|---|---|
| argumentType | redisPort |
| type | Argument |
KuttRedisUser
| Predicate | Object |
|---|---|
| argumentType | redisUser |
| type | Argument |
Node18AWS
| Predicate | Object |
|---|---|
| description | This install strategy outlines the steps to create an AWS EC2 instance specifically for running Node 18. It includes the application of a security policy that opens up port 80 to allow HTTP traffic, ensuring the Node application is accessible over the web. |
| documentation | https://example.com/install-node18-aws |
| executedOnRunner | LinuxRunnerWithAWS |
| installScripts | https://github.com/KyrtTech/spm.install_strategies/blob/master/Node18AWS/install.sh?raw=true |
| optionalArgument | Node18AWSRegion |
| producesParam | sshConnectionString |
| producesParam | sshKey |
| producesParam | ec2InstanceId |
| targetsApplication | NodeJS18 |
| title | Install Node 18 on AWS |
| type | InstallStrategy |
| usesInfrastructureProvider | AWS |
Node18AWSRegion
| Predicate | Object |
|---|---|
| allowedValues | awsUsEast1 |
| argumentDescription | AWS Regions in which this strategy can operate. If not provided will use the default value. If provided it will be used to filter out this strategy |
| argumentName | region |
| argumentType | awsRegion |
| type | Argument |
Node18GCP
| Predicate | Object |
|---|---|
| description | This install strategy outlines the steps to create an AWS EC2 instance specifically for running Node 20. It includes the application of a security policy that opens up port 80 to allow HTTP traffic, ensuring the Node application is accessible over the web. |
| documentation | https://example.com/install-node20-aws |
| executedOnRunner | LinuxRunnerWithAWS |
| installScripts | https://github.com/KyrtTech/spm.install_strategies/blob/master/Node20AWS/install.sh?raw=true |
| producesParam | sshConnectionString |
| producesParam | sshKey |
| producesParam | ec2InstanceId |
| targetsApplication | NodeJS18 |
| title | Install Node 18 on GCP |
| type | InstallStrategy |
| usesInfrastructureProvider | GCP |
Node20AWS
| Predicate | Object |
|---|---|
| description | This install strategy outlines the steps to create an AWS EC2 instance specifically for running Node 20. It includes the application of a security policy that opens up port 80 to allow HTTP traffic, ensuring the Node application is accessible over the web. |
| documentation | https://example.com/install-node20-aws |
| executedOnRunner | LinuxRunnerWithAWS |
| installScripts | https://github.com/KyrtTech/spm.install_strategies/blob/master/Node20AWS/install.sh?raw=true |
| producesParam | sshConnectionString |
| producesParam | sshKey |
| producesParam | ec2InstanceId |
| targetsApplication | NodeJS20 |
| title | Install Node 20 on AWS |
| type | InstallStrategy |
| usesInfrastructureProvider | AWS |
PostgresAWS
| Predicate | Object |
|---|---|
| description | This strategy outlines the installation process for RDS Postgress in AWS |
| installScripts | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/PostgresSQLAWS/install.sh |
| producesParam | databaseName |
| producesParam | databasePassword |
| producesParam | databaseURL |
| producesParam | databaseUsername |
| producesParam | port |
| supportFiles | PostgresAWSMain |
| supportFiles | PostgresAWSVariables |
| targetsApplication | Postgres |
| title | Install RDS Postgres |
| type | InstallStrategy |
| uninstallScripts | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/PostgresSQLAWS/uninstall.sh |
| usesInfrastructureProvider | AWS |
PostgresAWSMain
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/PostgresSQLAWS/main.tf |
| localPath | ./main.tf |
| type | RemoteFileEntry |
PostgresAWSVariables
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/PostgresSQLAWS/variables.tf |
| localPath | ./variables.tf |
| type | RemoteFileEntry |
RedisAWS
| Predicate | Object |
|---|---|
| description | This strategy outlines the installation process for Redis version 7.2.5, ensuring optimal configuration and performance tuning. |
| installScripts | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/RedisAWS/install.sh |
| producesParam | redisPort |
| producesParam | redisHost |
| producesParam | redisUser |
| producesParam | redisPassword |
| producesParam | redisConnectionString |
| supportFiles | RedisAWSSupportPackageLock |
| supportFiles | RedisAWSSupportPackage |
| supportFiles | RedisAWSSupportCDK |
| supportFiles | RedisAWSSupportCdkContext |
| supportFiles | RedisAWSSupportLib |
| supportFiles | RedisAWSSupportBin |
| targetsApplication | Redis |
| title | Install Redis |
| type | InstallStrategy |
| uninstallScripts | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/RedisAWS/uninstall.sh |
| usesInfrastructureProvider | AWS |
RedisAWSSupportBin
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/RedisAWS/bin/redis_aws.js |
| localPath | ./bin/redis_aws.js |
| type | RemoteFileEntry |
RedisAWSSupportCDK
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/RedisAWS/cdk.json |
| localPath | ./cdk.json |
| type | RemoteFileEntry |
RedisAWSSupportCdkContext
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/RedisAWS/cdk.context.json |
| localPath | ./cdk.context.json |
| type | RemoteFileEntry |
RedisAWSSupportLib
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/RedisAWS/lib/redis_aws-stack.js |
| localPath | ./lib/redis_aws-stack.js |
| type | RemoteFileEntry |
RedisAWSSupportPackage
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/RedisAWS/package.json |
| localPath | ./package.json |
| type | RemoteFileEntry |
RedisAWSSupportPackageLock
| Predicate | Object |
|---|---|
| accessUrl | https://raw.githubusercontent.com/KyrtTech/spm.install_strategies/master/RedisAWS/package-lock.json |
| localPath | ./package-lock.json |
| type | RemoteFileEntry |
SuriInstall
| Predicate | Object |
|---|---|
| description | Install strategy for Suri, requiring IP, SSH connection string, and SSH key. |
| executedOnRunner | LinuxRunnerWithAWS |
| installScripts | https://github.com/KyrtTech/spm.install_strategies/blob/master/Suri/install.sh?raw=true |
| optionalArgument | SuriInstallLinksConfig |
| producesParam | url |
| requiresArgument | SuriInstallSSHConnectionString |
| requiresArgument | SuriInstallSSHKey |
| targetsApplication | Suri |
| title | Install Suri on remote server using ssh |
| type | InstallStrategy |
SuriInstallLinksConfig
| Predicate | Object |
|---|---|
| argumentDescription | The key is the 'shortlink' path that gets redirected, and the value is the target URL. Keys can be as short or as long as you want, using whatever mixture of characters you want. / is a special entry for redirecting the root path. |
| argumentName | linksConfig |
| argumentType | jsonConfigFile |
| type | Argument |
SuriInstallSSHConnectionString
| Predicate | Object |
|---|---|
| argumentType | sshConnectionString |
| type | Argument |
SuriInstallSSHKey
| Predicate | Object |
|---|---|
| argumentType | sshKey |
| type | Argument |