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

Include PG Replication User Option #851

Merged
merged 4 commits into from
Feb 20, 2024

Conversation

bhardwajRahul
Copy link
Contributor

@bhardwajRahul bhardwajRahul commented Feb 8, 2024

This PR aims at updating documentation for Add a Database User

  • This API call will create a postgres cluster user with replication rights i.e. pg_allow_replication.

image

  • Sample curl request and response.

Request

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
  -d '{"name": "app-01", "settings":{"pg_allow_replication":true}}' \
  "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/users"
  

Response

{
  "user": {
    "name": "app-01",
    "role": "normal",
    "password": "jge5lfxtzhx42iff"
    "settings": {
       "pg_allow_replication":true
       }
    }
}

Copy link

gitguardian bot commented Feb 8, 2024

⚠️ GitGuardian has uncovered 5 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
- Generic Password ae7a0e8 specification/resources/databases/responses/user.yml View secret
- Generic Password 2e5c072 specification/resources/databases/responses/user.yml View secret
- Generic Password 2e5c072 specification/resources/databases/responses/user.yml View secret
- Generic Private Key ae7a0e8 specification/resources/databases/models/database_user.yml View secret
- Generic Private Key 2e5c072 specification/resources/databases/models/database_user.yml View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

Copy link
Member

@andrewsomething andrewsomething left a comment

Choose a reason for hiding this comment

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

Setting this to requiring changes to prevent it accidentally being merged as per the discussion in Slack.

Copy link
Member

@andrewsomething andrewsomething left a comment

Choose a reason for hiding this comment

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

👍 LGTM!

@andrewsomething andrewsomething merged commit 6748be6 into digitalocean:main Feb 20, 2024
6 checks passed
@bhardwajRahul bhardwajRahul deleted the rbhardwaj/DBAAS-4690 branch February 20, 2024 15:55
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.

2 participants