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

docs: added warning for Databricks integration #3219

Closed
wants to merge 1 commit into from

Conversation

vikramnagwal
Copy link

@vikramnagwal vikramnagwal commented Mar 11, 2025

Resolves: #3173

Description 📣

This PR will add a prominent warning to the Databricks integration documentation page so users can avoid losing their important secrets. This warning will inform them until the bug is fixed.

Type ✨

  • Documentation
  • Bug fix
  • New feature
  • Improvement
  • Breaking change

Tests 🛠️

image


Summary by CodeRabbit

  • Documentation
    • Updated the Databricks integration docs with a warning about deletion of all existing secrets.
    • Users are advised to back up their secrets before proceeding, noting this known limitation will be improved in future releases.

Copy link

coderabbitai bot commented Mar 11, 2025

Walkthrough

The documentation for the Databricks integration has been updated to include a warning message. This message informs users that applying the integration will delete all existing secrets in Databricks, and it advises them to back up their secrets beforehand. The documentation also clarifies that this deletion behavior is a known limitation and indicates that it will be addressed in a future update. No changes were made to the declarations of exported or public entities.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/integrations/cloud/databricks.mdx (1)

6-8: Fix Typo in Warning Message

There's a minor typo in the warning message ("integeration" should be "integration"). Correcting this will ensure clarity and professionalism in the documentation.

Apply the following diff:

-Databricks integeration will delete all your existing secrets. Make sure to back them up before starting the integration. This is a known limitation and will be fixed in the future.
+Databricks integration will delete all your existing secrets. Make sure to back them up before starting the integration. This is a known limitation and will be fixed in the future.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 872a3fe and 825fc58.

📒 Files selected for processing (1)
  • docs/integrations/cloud/databricks.mdx (1 hunks)

@scott-ray-wilson
Copy link
Contributor

Hey @vikramnagwal, thanks for opening this PR and this concern to our attention. The behavior you've pointed out is not unique to Databricks; Infisical integrations are intended to act as the source of truth for the destination and at the moment we don't recommend trying to manually manage secrets outside of Infisical with an integration.

With the Native Integration you can avoid this behavior by creating a designated scope for Infisical secrets in Databricks; that way secrets in other Databricks scopes will not be affected. We'll add this to the docs to help clarify this behavior as you suggested.

We've also made this behavior more clear with our new Secret Syncs (think integrations v2) which we do have a Databricks release for.

In addition, we do intend to release the ability to disable deletion of secrets in the coming weeks for Secret Syncs which will address that concern.

@scott-ray-wilson
Copy link
Contributor

closing as resolved by #3225

@vikramnagwal
Copy link
Author

@scott-ray-wilson, I was unaware of that. Please excuse me.

@vikramnagwal vikramnagwal deleted the docs-cloud branch March 12, 2025 02:48
@scott-ray-wilson
Copy link
Contributor

@vikramnagwal just wanted to notify you we've released the ability to disable secret deletion for our Databricks Secret Sync as an alternative to creating a unique secret scope for Infisical.

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.

Issue on docs: Give Warning that Databricks Integration will delete existing secrets
2 participants