Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add CDK reference page #234
Add CDK reference page #234
Changes from 2 commits
60e8108
c9ccd76
c229312
c686f73
e280983
70029e9
837dbfd
93900bf
c05b9be
d9f65cd
e3c3daa
4bf61f3
35d8675
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
Check warning on line 7 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L7
Raw output
Check warning on line 7 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L7
Raw output
Check notice on line 12 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L12
Raw output
Check notice on line 15 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L15
Raw output
Check warning on line 16 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L16
Raw output
Check warning on line 16 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L16
Raw output
Check notice on line 16 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L16
Raw output
Check notice on line 17 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L17
Raw output
Check notice on line 17 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L17
Raw output
Check notice on line 17 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L17
Raw output
Check notice on line 18 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L18
Raw output
Check notice on line 20 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L20
Raw output
Check notice on line 20 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L20
Raw output
Check notice on line 23 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L23
Raw output
Check notice on line 25 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L25
Raw output
Check notice on line 33 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L33
Raw output
Check warning on line 34 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L34
Raw output
Check failure on line 34 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L34
Raw output
Check notice on line 37 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L37
Raw output
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we put this behind tabs? One for TS, one for Java?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, on a second thought, the code itself is always Typescript... So not sure if tabs would make sense
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you're onto something though! I'll play with tabs - I hadn't thought of that in this context. Ditto for self-hosted / managed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It came out much nicer, thank you for the suggestion!
Check failure on line 52 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L52
Raw output
Check notice on line 65 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L65
Raw output
Check warning on line 69 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L69
Raw output
Check warning on line 69 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L69
Raw output
Check warning on line 70 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L70
Raw output
Check warning on line 70 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L70
Raw output
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this sentence might need a bit more context and explanation on how it differs from the normal registration practices.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the primary way this differs is in the same way how Lambda deployments differ – they always refer to an explicit version of the function, and every function update generates a new deployment revision. Is that what you had in mind?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've expanded the text to cover this - let me know if you can think of something more to add!
Check notice on line 101 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L101
Raw output
Check warning on line 101 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L101
Raw output
Check failure on line 101 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L101
Raw output
Check warning on line 101 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L101
Raw output
Check notice on line 101 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L101
Raw output
Check notice on line 103 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L103
Raw output
Check notice on line 103 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L103
Raw output
Check warning on line 103 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L103
Raw output
Check warning on line 104 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L104
Raw output
Check notice on line 104 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L104
Raw output
Check warning on line 104 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L104
Raw output
Check notice on line 104 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L104
Raw output
Check notice on line 104 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L104
Raw output
Check warning on line 105 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L105
Raw output
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we also add how to define a specific VPC for deployment here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left it out because I think it's a better default to deploy Restate in its own VPC. Advanced customers who know what they're doing can easily define their own or connect it to an existing VPC.
A related question is whether we should similarly auto-create a log group for Restate server logs if the user doesn't supply one. Right now that's a required property.
Check notice on line 127 in docs/services/deployment/cdk.md
GitHub Actions / vale
[vale] docs/services/deployment/cdk.md#L127
Raw output