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

feat(snap): add secretstore token for edgex-ekuiper snap #3888

Conversation

MonicaisHer
Copy link
Contributor

@MonicaisHer MonicaisHer commented Feb 25, 2022

This PR adds edgex-ekuiper as an add-on service to secretStoreTokens and secretStoreKnownSecrets (for redisdb) lists.

The Vault token is required for the standalone deployment of eKuiper with snap, where a script queries the Redis credentials after authenticating with Vault. The snap receives the vault token using the edgex-secretstore-token content interface or via other means.

Signed-off-by: Mengyi Wang [email protected]

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-go/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
  • I am not introducing a new dependency (add notes below if you are)
  • I have added unit tests for the new feature or bug fix (if not, why?)
  • I have fully tested (add details below) this the new feature or bug fix (if not, why?)
  • I have opened a PR for the related docs change (if not, why?)

Testing Instructions

New Dependency Instructions (If applicable)

Copy link
Member

@farshidtz farshidtz 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 a feature addition. Please change the PR title prefix.

Also, the commits need to have semantic prefixes.

snap/snapcraft.yaml Outdated Show resolved Hide resolved
@MonicaisHer MonicaisHer force-pushed the EDGEX-315-create-a-standalone-edgex-ekuiper-snap branch from b6f7f62 to 23cfcde Compare February 25, 2022 14:46
@MonicaisHer MonicaisHer changed the title build(snap): add secretstore token for edgex-ekuiper snap feat(snap): add secretstore token for edgex-ekuiper snap Feb 25, 2022
@MonicaisHer MonicaisHer force-pushed the EDGEX-315-create-a-standalone-edgex-ekuiper-snap branch 2 times, most recently from 42b2064 to a119cc7 Compare February 25, 2022 15:00
The Vault token is required for the standalone deployment of eKuiper with snap, 
where a script queries the Redis credentials after authenticating with Vault.
Signed-off-by: Mengyi Wang <[email protected]>
@MonicaisHer MonicaisHer force-pushed the EDGEX-315-create-a-standalone-edgex-ekuiper-snap branch from a119cc7 to 13d2675 Compare February 25, 2022 15:01
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@lenny-goodell
Copy link
Member

eKuiper doesn't use secretStoreTokens and secretStoreKnownSecrets, we inject the Redis password into their config. This PR is not needed.

@farshidtz
Copy link
Member

eKuiper doesn't use secretStoreTokens and secretStoreKnownSecrets, we inject the Redis password into their config. This PR is not needed.

@lenny-intel, the embedded eKuiper doesn't. This is for a standalone ekuiper snap. I've just updated the PR description to:

This PR adds edgex-ekuiper as an add-on service to secretStoreTokens and secretStoreKnownSecrets (for redisdb) lists.

The Vault token is required for the standalone deployment of eKuiper with snap, where a script queries the Redis credentials after authenticating with Vault. The snap receives the vault token using the edgex-secretstore-token content interface or via other means.

The standalone edgex-ekuiper snap is work in progress. But we are almost sure that using the vault token to query the redis credentials is the cleanest way forward. This makes the edgex-ekuiper's server configurations (mostly unrelated to security) decoupled from an internal security component of EdgeX. Moreover, this makes edgex-ekuiper's interaction with the platform similar to other services.

I think we could eventually have a component which does this both for snapped and dockerized ekuiper. For example an edgex-ekuiper-setup app that takes a vault token and config file templates, queries the redis credentials, and outputs the config files. What do you think?

Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

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

LGTM

@farshidtz farshidtz merged commit d0bb8bc into edgexfoundry:main Mar 2, 2022
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.

3 participants