Skip to content
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

feat!: implements IKeyPair interface #279

Merged
merged 8 commits into from
Mar 21, 2024
Merged

feat!: implements IKeyPair interface #279

merged 8 commits into from
Mar 21, 2024

Conversation

udondan
Copy link
Owner

@udondan udondan commented Mar 20, 2024

For direct use in an ec2 instance construct.

As IKeyPair was introduced with aws-cdk-lib 2.116.0 this now is the required minimum version. (peerDependency)

Previously you would pass the keyPair name to an EC2 instance, which now is deprecated. You can still pass the name, so no change is required on your end yet. Nevertheless, 2.116.0 is the required min version for this pacakge now.

Copy link
Contributor

coderabbitai bot commented Mar 20, 2024

Warning

Rate Limit Exceeded

@udondan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 31 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 46be6c8 and 6bbdf80.

Walkthrough

The recent updates focus on enhancing the management of EC2 Key Pairs within AWS CDK, incorporating native CloudFormation support. It includes modifications in the README for better clarity on CDK version compatibility and the usage of custom KMS keys for key pair creation. Additionally, the core library has been refined by altering the inheritance model for the KeyPair class and introducing new functionality to assess operating system compatibility. Furthermore, testing enhancements include conditional EC2 instance creation logic based on specific environment settings.

Changes

Files Change Summaries
README.md Updated EC2 Key Pair management instructions, compatibility notes for CDK versions, and guidance on using custom KMS keys and public key integration with CloudFront.
lib/index.ts - Imported Resource, IKeyPair, and OperatingSystemType.
- Changed KeyPair's superclass to Resource and implemented IKeyPair.
- Added _isOsCompatible method for OS compatibility checks.
test/lib/test-stack.ts Added aws_ec2 import and logic for conditional EC2 instance creation based on the with_ec2 environment variable.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 113d07d and 9f90986.
Files selected for processing (3)
  • README.md (7 hunks)
  • lib/index.ts (3 hunks)
  • test/lib/test-stack.ts (2 hunks)
Additional comments: 3
README.md (1)
  • 17-21: Consider refining the wording for better clarity and readability. For example:
  • Change "CloudFormation now natively supports creating EC2 Key Pairs via [AWS::EC2::KeyPair]" to "CloudFormation now supports creating EC2 Key Pairs natively via [AWS::EC2::KeyPair]".
  • In the bullet points, consider rephrasing for consistency, such as "Keys are stored in AWS Secrets Manager, as opposed to SSM Parameter Store."
lib/index.ts (2)
  • 148-148: The change to extend Resource instead of Construct and implement IKeyPair aligns with best practices for AWS CDK resources. Ensure that all functionalities previously available are still supported or appropriately handled.
  • 416-423: Consider adding documentation for the _isOsCompatible method to clarify its purpose and potential future use. This helps maintain code readability and understandability, especially as the project evolves.

test/lib/test-stack.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9f90986 and fa46241.
Files selected for processing (1)
  • test/lib/test-stack.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • test/lib/test-stack.ts

@udondan udondan changed the title feat: implements IKeyPair interface feat!: implements IKeyPair interface Mar 21, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between fa46241 and 46be6c8.
Files ignored due to path filters (1)
  • package.json is excluded by: !**/*.json
Files selected for processing (1)
  • README.md (3 hunks)
Additional comments: 1
README.md (1)
  • 28-36: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [26-28]

The phrase "installed along in the expected version" might be clearer as "installed alongside in the expected versions." Additionally, consider using the official spelling "Node.js" instead of "NodeJS" for consistency with official documentation.

- For TypeScript/NodeJS, add these to your `dependencies` in `package.json`.
+ For TypeScript/Node.js, add these to your `dependencies` in `package.json`.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@udondan udondan enabled auto-merge (squash) March 21, 2024 18:30
@udondan udondan merged commit 0457985 into main Mar 21, 2024
3 checks passed
@udondan udondan deleted the IKeyPair branch March 21, 2024 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant