Skip to content

Web: Support auto discovery for self-hosted#36027

Merged
kimlisa merged 3 commits intomasterfrom
lisa/rds-auto-discover-self-hosted
Jan 9, 2024
Merged

Web: Support auto discovery for self-hosted#36027
kimlisa merged 3 commits intomasterfrom
lisa/rds-auto-discover-self-hosted

Conversation

@kimlisa
Copy link
Copy Markdown
Contributor

@kimlisa kimlisa commented Dec 22, 2023

resolves #35434

Adds support for auto discovery for self-hosted.

Self-hosted requires users to run their own discovery service (unlike cloud where every tenant has one running already whether they use it or not). This required some extra instructions for the user to help them run a discovery service.

The only difference in terms of web UI logic, is that user supplies us their own discovery group name (for cloud this is a hardcoded value), everything else is the same as cloud.

story: http://127.0.0.1:9002/?path=/story/teleport-discover-database-enrollrds--instance-list

image

@github-actions
Copy link
Copy Markdown
Contributor

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@kimlisa kimlisa added the no-changelog Indicates that a PR does not require a changelog entry label Dec 22, 2023
@kimlisa kimlisa requested review from rudream and removed request for ibeckermayer December 22, 2023 22:45
@kimlisa kimlisa force-pushed the lisa/rds-auto-discover-self-hosted branch from 3005447 to d58c6d6 Compare December 22, 2023 23:09
Comment on lines +442 to +441
const discoveryGroupToolTip = `Discovery group name is used to group discovered resources into different sets. \
This parameter is used to prevent Discovery Agents watching different sets of cloud resources from \
colliding against each other and deleting resources created by another services.`;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This reads a little weird. But tbh, i haven't used this in production so idk. what are the different "sets", is that the technical term or is there a better word we can use here. Also, "parameter" doesn't really seem UX friendly. Maybe "value" or something but idk, I won't die on that hill.

I don't recommend my suggestion 100%, but here are my thoughts.

"Discovery Group Name (i know its not all capital but maybe it'll help differentiate it as the term) is used to name a group of discovered resources. This group name is used to prevent deleting resources created by other services being watched by different Discovery Agents"

could fiddle with it idk

Copy link
Copy Markdown
Contributor Author

@kimlisa kimlisa Jan 3, 2024

Choose a reason for hiding this comment

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

i copied this directly from the docs, so i'm hesitant to change it since the texting at least was reviewed by the doc folks: https://docs-2dew2l61w-goteleport.vercel.app/docs/database-access/guides/aws-discovery/#step-24-configure-the-discovery-service

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sounds good to me

@kimlisa
Copy link
Copy Markdown
Contributor Author

kimlisa commented Jan 3, 2024

updated screenshot after moving the relevant docs into the web UI:

image image

Base automatically changed from lisa/rds-auto-discover to master January 8, 2024 17:37
@kimlisa kimlisa force-pushed the lisa/rds-auto-discover-self-hosted branch from 809fe56 to 1bf98f2 Compare January 8, 2024 23:55
@kimlisa kimlisa enabled auto-merge January 9, 2024 00:17
@kimlisa kimlisa added this pull request to the merge queue Jan 9, 2024
Merged via the queue into master with commit 9d02cfb Jan 9, 2024
@kimlisa kimlisa deleted the lisa/rds-auto-discover-self-hosted branch January 9, 2024 00:37
@public-teleport-github-review-bot
Copy link
Copy Markdown

@kimlisa See the table below for backport results.

Branch Result
branch/v14 Failed

kimlisa added a commit that referenced this pull request Jan 9, 2024
* Web: Support auto discovery for self-hosted

* Move doc instructions into web UI

* fix test
github-merge-queue Bot pushed a commit that referenced this pull request Jan 9, 2024
…) (#36434)

* Web: Add auto enrolling capabilities to RDS discover flow (#35646)

* Add discovery config endpoint

* Add autoDiscoveryConfig field to meta

* Hide custom label for auto discover

* Pull out re-usable parts for storybook fixture

* Only allow adding new traits when auto-enrolling

- Existing traits is not made editable
- Minor refactor: pull data from useDiscover context

* Auto select integration if only one result

* Skip test connection when auto enrolling

Refactor setup access story

* Add auto enroll toggler

* Create finish component for auto discover

* Add more disabled row states

* Add clarifying notes

* Address CRs

* Finish auto discovery

- When enrolling and opting for auto discovery,
  we need to first collect all missing vpcs to determine
  if its required to deploy database agents, and then
  create a discovery config for a discovery service
- When auto deploying and opting for auto discovery,
  it is out scope for this iteration to allow user to
  define custom labels, select security groups, and
  "wait" for deploying all services to finish. Instead
  after deploy request is finished, we render a box
  that tells user it will take a minute to finish deploying
  and give a AWS dashboard link to view progress
- Setup access screen is the final step (skip test connection)
  and we render how to setup access for both mysql and postgres
  since auto discovery discovers all supported engine types.

* Address CR

* Update straggling test

* Web: Support auto discovery for self-hosted (#36027)

* Web: Support auto discovery for self-hosted

* Move doc instructions into web UI

* fix test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog Indicates that a PR does not require a changelog entry size/md ui

Projects

None yet

Development

Successfully merging this pull request may close these issues.

UI for Discover RDS auto-discovery support

3 participants