Skip to content

Commit

Permalink
Add support for setting Restate configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
@pcholakov
pcholakov committed Aug 9, 2024
1 parent 7837d62 commit e474d88
Show file tree
Hide file tree
Showing 2 changed files with 143 additions and 11 deletions.
74 changes: 70 additions & 4 deletions lib/restate-constructs/single-node-restate-deployment.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,24 @@ export interface SingleNodeRestateProps {
/** Restate Docker image tag. Defaults to `latest`. */
restateTag?: string;

/** Restate high-level configuration options. Alternatively, you can set {@link restateConfigOverride}. */
restateConfig?: {
/** Defaults to the construct id if left unspecified. */
clusterName?: string;
/** RocksDB settings. */
rocksdb?: {
/** Defaults to `512.0 MB`. */
totalMemorySize?: string;
};
};

/**
* Completely override the Restate server configuration. Note that other Restate configuration options
* will effectively be ignored if this is set. See https://docs.restate.dev/operate/configuration/server/
* for details.
*/
restateConfigOverride?: string;

/** Amazon Distro for Open Telemetry Docker image tag. Defaults to `latest`. */
adotTag?: string;

Expand Down Expand Up @@ -124,7 +142,9 @@ export class SingleNodeRestateDeployment extends Construct implements IRestateEn
initScript.addCommands(
"yum install -y docker nginx",

"systemctl enable docker.service",
"mkdir /etc/restate",
["cat << EOF > /etc/restate/config.toml", this.restateConfig(id, props), "EOF"].join("\n"),

"systemctl start docker.service",
[
"docker run --name adot --restart unless-stopped --detach",
Expand All @@ -133,11 +153,14 @@ export class SingleNodeRestateDeployment extends Construct implements IRestateEn
].join(""),
[
"docker run --name restate --restart unless-stopped --detach",
" --volume /var/restate:/target --network=host",
" --volume /etc/restate:/etc/restate",
" --volume /var/restate:/restate-data",
" --network=host",
" -e RESTATE_OBSERVABILITY__LOG__FORMAT=Json -e RUST_LOG=info,restate_worker::partition=warn",
" -e RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://localhost:4317",
` --log-driver=awslogs --log-opt awslogs-group=${logGroup.logGroupName}`,
` ${restateImage}:${restateTag}`,
" --config-file /etc/restate/config.toml",
].join(""),

"mkdir -p /etc/pki/private",
Expand All @@ -148,9 +171,7 @@ export class SingleNodeRestateDeployment extends Construct implements IRestateEn
].join(""),

["cat << EOF > /etc/nginx/conf.d/restate-ingress.conf", ingressNginxConfig, "EOF"].join("\n"),
"systemctl enable nginx",
"systemctl start nginx",
"systemctl reload nginx", // ensure that we reload config on subsequent reboots in case nginx was already running
);

const cloudConfig = ec2.UserData.custom([`cloud_final_modules:`, `- [scripts-user, always]`].join("\n"));
Expand Down Expand Up @@ -201,6 +222,51 @@ export class SingleNodeRestateDeployment extends Construct implements IRestateEn
this.adminUrl = `https://${restateInstance.instancePublicDnsName}:${PUBLIC_ADMIN_PORT}`;
}

protected restateConfig(id: string, props: SingleNodeRestateProps) {
return (
props.restateConfigOverride ??
[
`roles = [`,
` "worker",`,
` "admin",`,
` "metadata-store",`,
`]`,
`node-name = "restate-0"`,
`cluster-name = "localcluster"`,
`allow-bootstrap = true`,
`bootstrap-num-partitions = 4`,
`default-thread-pool-size = 3`,
`storage-high-priority-bg-threads = 3`,
`storage-low-priority-bg-threads = 3`,
`rocksdb-total-memory-size = "${props.restateConfig?.rocksdb?.totalMemorySize ?? "512.0 MB"}"`,
`rocksdb-total-memtables-ratio = 0.6000000238418579`,
`rocksdb-bg-threads = 3`,
`rocksdb-high-priority-bg-threads = 3`,
``,
`[worker]`,
`internal-queue-length = 1000`,
``,
`[worker.storage]`,
`rocksdb-max-background-jobs = 3`,
`rocksdb-statistics-level = "except-detailed-timers"`,
`num-partitions-to-share-memory-budget = 4`,
``,
`[admin.query-engine]`,
`memory-size = "50.0 MB"`,
`query-parallelism = 4`,
``,
`[ingress]`,
`rocksdb-max-background-jobs = 3`,
`rocksdb-statistics-level = "except-detailed-timers"`,
`writer-batch-commit-count = 1000`,
``,
`[metadata-store.rocksdb]`,
`rocksdb-max-background-jobs = 1`,
`rocksdb-statistics-level = "except-detailed-timers"`,
].join("\n")
);
}

/**
* @param props construct properties
* @returns nginx configuration to use for ingress reverse proxy, formatted as a multi-line string
Expand Down
80 changes: 73 additions & 7 deletions test/__snapshots__/restate-constructs.test.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,76 @@ exports[`Restate constructs Create a self-hosted Restate environment deployed on
yum install -y docker nginx
systemctl enable docker.service
mkdir /etc/restate
cat << EOF > /etc/restate/config.toml
roles = [
"worker",
"admin",
"metadata-store",
]
node-name = "restate-0"
cluster-name = "localcluster"
allow-bootstrap = true
bootstrap-num-partitions = 4
default-thread-pool-size = 3
storage-high-priority-bg-threads = 3
storage-low-priority-bg-threads = 3
rocksdb-total-memory-size = "512.0 MB"
rocksdb-total-memtables-ratio = 0.6000000238418579
rocksdb-bg-threads = 3
rocksdb-high-priority-bg-threads = 3
[worker]
internal-queue-length = 1000
[worker.storage]
rocksdb-max-background-jobs = 3
rocksdb-statistics-level = "except-detailed-timers"
num-partitions-to-share-memory-budget = 4
[admin.query-engine]
memory-size = "50.0 MB"
query-parallelism = 4
[ingress]
rocksdb-max-background-jobs = 3
rocksdb-statistics-level = "except-detailed-timers"
writer-batch-commit-count = 1000
[metadata-store.rocksdb]
rocksdb-max-background-jobs = 1
rocksdb-statistics-level = "except-detailed-timers"
EOF
systemctl start docker.service
Expand All @@ -152,14 +221,15 @@ exports[`Restate constructs Create a self-hosted Restate environment deployed on
public.ecr.aws/aws-observability/aws-otel-collector:latest
docker run --name restate --restart unless-stopped
--detach --volume /var/restate:/target --network=host -e
--detach --volume /etc/restate:/etc/restate --volume
/var/restate:/restate-data --network=host -e
RESTATE_OBSERVABILITY__LOG__FORMAT=Json -e
RUST_LOG=info,restate_worker::partition=warn -e
RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://localhost:4317
--log-driver=awslogs --log-opt awslogs-group=
- Ref: RestateLogsFD86ECAE
- >2-
docker.io/restatedev/restate:latest
docker.io/restatedev/restate:latest --config-file /etc/restate/config.toml
mkdir -p /etc/pki/private
openssl req -new -x509 -nodes -sha256 -days 365
Expand Down Expand Up @@ -211,11 +281,7 @@ exports[`Restate constructs Create a self-hosted Restate environment deployed on
EOF
systemctl enable nginx
systemctl start nginx
systemctl reload nginx
- |
--+AWS+CDK+User+Data+Separator==--
Expand Down

0 comments on commit e474d88

Please sign in to comment.