Skip to content

Commit 5c9fb23

Browse files
authored
Update Thundra keywords and environment variables (#2)
1 parent 61894bc commit 5c9fb23

File tree

9 files changed

+4493
-20
lines changed

9 files changed

+4493
-20
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ServerlessDebugger Self-Hosted CDK
22

3-
This is the self-hosted version of Thundra's [ServerlessDebugger](https://serverlessdebugger.com). ServerlessDebugger brings the traditional debugging experience to the AWS Lambdas. It comes in as a VSCode extension and can be installed on your VSCode IDE in seconds and enable you to put breakpoints in your Lambda functions. All done with no code changes!
3+
This is the self-hosted version of [ServerlessDebugger](https://serverlessdebugger.com). ServerlessDebugger brings the traditional debugging experience to the AWS Lambdas. It comes in as a VSCode extension and can be installed on your VSCode IDE in seconds and enable you to put breakpoints in your Lambda functions. All done with no code changes!
44

55
Apart from the SaaS version of the ServerlessDebugger, we offer a way to install the debug broker into your own AWS account to satisfy your needs. To get the pricing and the license key for the self-hosted version, visit our [Pricing Page](https://www.serverlessdebugger.com/pricing).
66

@@ -31,7 +31,7 @@ You can start by just copying the `sample.env` as `.env` and move on from there.
3131
cp sample.env .env
3232
```
3333

34-
In the `.env` file, we've documented which variables are needed and why. Some parts of this stack is optional and some are required. `SUBNET_IDS` and `THUNDRA_LICENSE_KEY` must be specified in the `.env` file. See [below](#environment-variables) for more details.
34+
In the `.env` file, we've documented which variables are needed and why. Some parts of this stack is optional and some are required. `SUBNET_IDS` and `SLSDEBUG_LICENSE_KEY` must be specified in the `.env` file. See [below](#environment-variables) for more details.
3535

3636
Once the necessary environment variables are set, you can run the following commands in order.
3737

@@ -109,7 +109,7 @@ In an architectural view, self-hosted version can be used in multiple ways depen
109109
| Variable Name | Expectation | Default | Requires | Description |
110110
|--- |--- |--- |--- |--- |
111111
| SUBNET_IDS | **Required** | - | At least 2 subnet ids | Subnets to use to deploy the application. Requires at least 2 subnet ids. |
112-
| THUNDRA_LICENSE_KEY | **Required** | - | - | Thundra License Key for the self-hosted ServerlessDebugger. [Contact Us](https://www.serverlessdebugger.com/contact-us) if needed. |
112+
| SLSDEBUG_LICENSE_KEY | **Required** | - | - | ServerlessDebugger License Key for the self-hosted ServerlessDebugger. [Contact Us](https://www.serverlessdebugger.com/contact-us) if needed. |
113113
| STAGE | Optional | dev | - | Sets a suffix to all the resources. Used to separate environments, such as dev, staging, prod. Beware of that some resources have a name limitation of 32 characters. Can set this to and empty string. |
114114
| ENTITY_PREFIX | Optional | slsd | - | Sets a prefix to all the resources. Used to differentiate ServerlessDebugger resources from others. Beware of that some resources have a name limitation of 32 characters. Can set this to and empty string. |
115115
| USE_HTTPS | Optional | false | - | Decide if the broker endpoints should use SSL encryption. Expects `SSL_CERTIFICATE_ARN`. |

bin/app.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ new cdk.CfnOutput(
119119
description: `Set this value as \`thundra_agent_lambda_debugger_broker_host\` in your lambda
120120
to use the internal load balancer for communication.
121121
122-
You can also set this as the broker host in Thundra debug client configuration
122+
You can also set this as the broker host in ServerlessDebugger debug client configuration
123123
if you want to use the internal endpoint. Beware that you would need to connect
124124
to your VPC in order to access this endpoint.`,
125125
value: internalELBDNS
@@ -134,7 +134,7 @@ new cdk.CfnOutput(
134134
to use the external load balancer for communication. Beware that your lambda
135135
should have access to the internet.
136136
137-
You can also set this as the broker host in Thundra debug client configuration
137+
You can also set this as the broker host in ServerlessDebugger debug client configuration
138138
if you want to use the external endpoint.`,
139139
value: externalELBDNS
140140
}
@@ -144,7 +144,7 @@ new cdk.CfnOutput(
144144
slsDebuggerStack,
145145
`${helpers.ENTITY_PREFIX}broker-port${helpers.STAGE}`,
146146
{
147-
description: 'Set this as the broker port in Thundra debug client configuration.',
147+
description: 'Set this as the broker port in ServerlessDebugger debug client configuration.',
148148
value: helpers.getPort()
149149
}
150150
)

lib/dns/dns-stack.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export class DNSStack extends NestedStack {
4444
this,
4545
'internal-elb-cname-record',
4646
{
47-
comment: 'Creating records for private elb of Thundra lambda debug broker',
47+
comment: 'Creating records for private elb of ServerlessDebugger broker',
4848
zone: this.selectedHostedZone,
4949
domainName: this.slsDebuggerBrokerInternalELB.loadBalancerDnsName,
5050
recordName: this.slsDebuggerBrokerInternalELBDNSRecordName,
@@ -56,7 +56,7 @@ export class DNSStack extends NestedStack {
5656
this,
5757
'external-elb-cname-record',
5858
{
59-
comment: 'Creating records for public elb of Thundra lambda debug broker',
59+
comment: 'Creating records for public elb of ServerlessDebugger broker',
6060
zone: this.selectedHostedZone,
6161
domainName: this.slsDebuggerBrokerExternalELB.loadBalancerDnsName,
6262
recordName: this.slsDebuggerBrokerExternalELBDNSRecordName,

lib/ecs/ecs-stack.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ export class ECSStack extends NestedStack {
142142
}
143143
],
144144
environment: {
145-
THUNDRA_LICENSE_KEY: process.env.THUNDRA_LICENSE_KEY || ''
145+
SLSDEBUG_LICENSE_KEY: process.env.SLSDEBUG_LICENSE_KEY || ''
146146
}
147147
}
148148
)

lib/network/security-stack.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ export class SecurityStack extends NestedStack {
120120
this.slsDebuggerBrokerECSSecGroupName,
121121
{
122122
securityGroupName: this.slsDebuggerBrokerECSSecGroupName,
123-
description: 'Thundra Lambda Debug Broker Service ELB Security Group',
123+
description: 'ServerlessDebugger Broker Service ELB Security Group',
124124
vpc: this.selectedVPC,
125125
allowAllOutbound: true
126126
}

0 commit comments

Comments
 (0)