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

Update secrets programmatically #1122

Merged
merged 8 commits into from
Feb 29, 2024
Merged

Update secrets programmatically #1122

merged 8 commits into from
Feb 29, 2024

Conversation

jbirddog
Copy link
Contributor

@jbirddog jbirddog commented Feb 28, 2024

Work on #1044 - allows processes run with admin permissions to create/update a secret from a script task. Current use case is setting the session token for Iplict api calls. Also added a make target to load the current sqlitedb to help with debugging.

Summary by CodeRabbit

  • New Features

    • Introduced an environment variable for backend configuration.
    • Added support for SQLite database interaction in the backend.
    • Implemented a script for programmatically setting secret values.
  • Chores

    • Updated development Dockerfile to include sqlite3.
    • Adjusted Docker compose to provide a default value for the backend environment variable.

Copy link
Contributor

coderabbitai bot commented Feb 28, 2024

Walkthrough

Walkthrough

The changes focus on enhancing backend configuration and database capabilities. A new SPIFFWORKFLOW_BACKEND_ENV variable and be-sqlite target were introduced for backend settings and SQLite database management. The Docker development setup now includes SQLite instead of default-libmysqlclient-dev, signaling a shift in database support. Additionally, a script SetSecret was added to facilitate secure setting of secret values, improving secret management within the project.

Changes

File(s) Summary
Makefile Added SPIFFWORKFLOW_BACKEND_ENV for backend configuration and be-sqlite target for SQLite interaction.
spiffworkflow-backend/dev.Dockerfile Replaced default-libmysqlclient-dev with sqlite3 in installed packages.
spiffworkflow-backend/dev.docker-compose.yml Updated SPIFFWORKFLOW_BACKEND_ENV to provide a default value if not explicitly set.
spiffworkflow-backend/src/spiffworkflow_backend/scripts/set_secret.py Introduced SetSecret script for setting secret values programmatically using Flask and SecretService.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

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

Review Status

Actionable comments generated: 3

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 947c006 and 264007b.
Files selected for processing (4)
  • Makefile (3 hunks)
  • spiffworkflow-backend/dev.Dockerfile (1 hunks)
  • spiffworkflow-backend/dev.docker-compose.yml (1 hunks)
  • spiffworkflow-backend/src/spiffworkflow_backend/scripts/set_secret.py (1 hunks)

spiffworkflow-backend/dev.Dockerfile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
…cret.py

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

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

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 264007b and 70f2dd2.
Files selected for processing (1)
  • spiffworkflow-backend/src/spiffworkflow_backend/scripts/set_secret.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • spiffworkflow-backend/src/spiffworkflow_backend/scripts/set_secret.py

jbirddog and others added 2 commits February 28, 2024 12:25
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

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

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 70f2dd2 and 36bbe3c.
Files selected for processing (1)
  • spiffworkflow-backend/src/spiffworkflow_backend/scripts/set_secret.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • spiffworkflow-backend/src/spiffworkflow_backend/scripts/set_secret.py

Copy link
Contributor

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

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 36bbe3c and 21577fe.
Files selected for processing (3)
  • Makefile (3 hunks)
  • spiffworkflow-backend/dev.Dockerfile (1 hunks)
  • spiffworkflow-backend/dev.docker-compose.yml (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • Makefile
  • spiffworkflow-backend/dev.Dockerfile
Additional comments: 1
spiffworkflow-backend/dev.docker-compose.yml (1)
  • 13-13: The addition of a default value for SPIFFWORKFLOW_BACKEND_ENV using the ${VARIABLE:-default} syntax is a good practice. It ensures that the service has a sensible default environment, enhancing the configurability and robustness of the application. This change aligns well with Docker Compose best practices.

Makefile Outdated
be-sqlite:
@if [ ! -f "$(BACKEND_CONTAINER)/src/instance/db_$(SPIFFWORKFLOW_BACKEND_ENV).sqlite3" ]; then \
echo "SQLite database file does not exist: $(BACKEND_CONTAINER)/src/instance/db_$(SPIFFWORKFLOW_BACKEND_ENV).sqlite3"; \
exit 1; \
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe indent this exit 1 line?

Copy link
Contributor

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

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 21577fe and 802f947.
Files selected for processing (1)
  • Makefile (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • Makefile

@jbirddog jbirddog merged commit 840dd74 into main Feb 29, 2024
22 checks passed
@jbirddog jbirddog deleted the update_secret branch February 29, 2024 14: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.

None yet

2 participants