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

RDS Upgrade Resources #3209

Merged
merged 13 commits into from
Oct 15, 2024
Merged

RDS Upgrade Resources #3209

merged 13 commits into from
Oct 15, 2024

Conversation

elipe17
Copy link

@elipe17 elipe17 commented Oct 2, 2024

Summary of Changes

  • Updated database upgrade documentation to reflect newest, most efficient, and safest way to roll DB versions
  • Added a manifest to allow easy connections to the DB(s) as we are rolling them over. Manifest is explained in the new docs
  • Fixed error in nexus doc

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

  • [insert ACs here]
  • lfrohlich and/or adpennington confirmed that ACs are met.

Deliverable 2: Tested Code

  • Are all areas of code introduced in this PR meaningfully tested?
    • If this PR introduces backend code changes, are they meaningfully tested?
    • If this PR introduces frontend code changes, are they meaningfully tested?
  • Are code coverage minimums met?
    • Frontend coverage: [insert coverage %] (see CodeCov Report comment in PR)
    • Backend coverage: [insert coverage %] (see CodeCov Report comment in PR)

Deliverable 3: Properly Styled Code

  • Are backend code style checks passing on CircleCI?
  • Are frontend code style checks passing on CircleCI?
  • Are code maintainability principles being followed?

Deliverable 4: Accessible

  • Does this PR complete the epic?
  • Are links included to any other gov-approved PRs associated with epic?
  • Does PR include documentation for Raft's a11y review?
  • Did automated and manual testing with iamjolly and ttran-hub using Accessibility Insights reveal any errors introduced in this PR?

Deliverable 5: Deployed

  • Was the code successfully deployed via automated CircleCI process to development on Cloud.gov?

Deliverable 6: Documented

  • Does this PR provide background for why coding decisions were made?
  • If this PR introduces backend code, is that code easy to understand and sufficiently documented, both inline and overall?
  • If this PR introduces frontend code, is that code easy to understand and sufficiently documented, both inline and overall?
  • If this PR introduces dependencies, are their licenses documented?
  • Can reviewer explain and take ownership of these elements presented in this code review?

Deliverable 7: Secure

  • Does the OWASP Scan pass on CircleCI?
  • Do manual code review and manual testing detect any new security issues?
  • If new issues detected, is investigation and/or remediation plan documented?

Deliverable 8: User Research

Research product(s) clearly articulate(s):

  • the purpose of the research
  • methods used to conduct the research
  • who participated in the research
  • what was tested and how
  • impact of research on TDP
  • (if applicable) final design mockups produced for TDP development

- Added connector app to support restoring DBs
@elipe17 elipe17 self-assigned this Oct 2, 2024
Copy link

codecov bot commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.66%. Comparing base (8c34106) to head (3ed27eb).
Report is 3 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #3209   +/-   ##
========================================
  Coverage    92.66%   92.66%           
========================================
  Files           47       47           
  Lines         1009     1009           
  Branches       169      169           
========================================
  Hits           935      935           
  Misses          42       42           
  Partials        32       32           
Flag Coverage Δ
dev-frontend 92.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 51981aa...3ed27eb. Read the comment docs.

@elipe17 elipe17 added the raft review This issue is ready for raft review label Oct 3, 2024
json_params = "{\"version\": \"15\", \"storage_type\": \"gp3\", \"storage\": 500}"
recursive_delete = true
timeouts {
create = "60m"

Choose a reason for hiding this comment

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

these timeouts seem extensively high! for example, which if our create queries take 60 m?

Copy link
Author

Choose a reason for hiding this comment

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

Just want to clarify that these timeouts are strictly for the terraform resource and not the database (and database queries) itself. Having these timeouts ensures that terraform monitors the infrastructure change until it is complete as opposed to timing out. In which case, the developer would have to query the state to see if the infrastructure has finished updating/creating/deleting. As another reference point, it took ~30 min just to delete an old elastic search service which did not have a lot of data in it and was a small service plan.

Copy link

@raftmsohani raftmsohani left a comment

Choose a reason for hiding this comment

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

This is great documentation and looks good, except I think we should reduce the timeout settings.

Copy link

@jtimpe jtimpe left a comment

Choose a reason for hiding this comment

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

Thanks for documenting these steps

Copy link

@raftmsohani raftmsohani left a comment

Choose a reason for hiding this comment

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

LGTM!

@vlasse86 vlasse86 closed this Oct 15, 2024
@elipe17 elipe17 merged commit ccb07cc into develop Oct 15, 2024
14 checks passed
@elipe17 elipe17 deleted the rds-upgrade-docs branch October 15, 2024 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev documentation raft review This issue is ready for raft review Ready to Merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants