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

Add example for aws rds postgres integration with Kanister #334

Merged
merged 7 commits into from
Oct 22, 2019

Conversation

PrasadG193
Copy link
Contributor

@PrasadG193 PrasadG193 commented Oct 7, 2019

Change Overview

This PR adds an example to demonstrate Kanister integration with AWS RDS PostgreSQL engine

Pull request type

Please check the type of change your PR introduces:

  • Work in Progress
  • Refactoring (no functional changes, no api changes)
  • Trivial/Minor
  • Bugfix
  • Feature
  • Documentation

Issues

Test Plan

  • Manual
  • Unit test
  • E2E

@PrasadG193 PrasadG193 marked this pull request as ready for review October 9, 2019 13:52
@PrasadG193 PrasadG193 force-pushed the aws-rds-example branch 2 times, most recently from 9e8764a to c4750cf Compare October 9, 2019 14:12
Copy link
Contributor

@tdmanv tdmanv left a comment

Choose a reason for hiding this comment

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

Overall looks good, but please fix the licensing. We should remove the apache license and add our copyright to every file and append to the kubernetes copyrights.


aws rds wait db-instance-available --db-instance-identifier=test-postgresql-instance
```

Copy link

Choose a reason for hiding this comment

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

@PrasadG193 @tdmanv - I'm wondering if we can simplify this top level README. The only requirement for someone to test this out should be:

  1. Create a new RDS instance or have instanceID/host info available for an existing instance
  2. Create a ConfigMap with this info
  3. Create a Blueprint
  4. Run backup/restore commands

The pgtest app is useful for testing but complicates this example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Won't that confuse users? They may not get the context behind why do they need configmap and which configmap to use/update.
In current PR we can add a note suggesting instead of pgtest app, they can use their own application

Copy link

Choose a reason for hiding this comment

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

Users in this example likely already have an application that is using an RDS DB and pgtest on the top level will be confusing.

What will be most useful for them will be to know how they can use this example blueprint with their DB instance.

I think the pgtest example is useful but perhaps this detailed README.md is in a sub-folder and the top level is very minimal

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@vkamra @tdmanv I have updated the README as per your suggestions.

Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com>
Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com>
Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com>
Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com>
Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com>
@mergify mergify bot merged commit cfc493b into kanisterio:master Oct 22, 2019
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.

None yet

3 participants