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

Add "decrypt" param to native st2kv function, deprecate "decrypt_kv" filter #3571

Open
Mierdin opened this issue Jul 15, 2017 · 0 comments
Open

Comments

@Mierdin
Copy link
Member

Mierdin commented Jul 15, 2017

StackStorm/st2mistral#30 modified the way that st2kv worked for encrypted values - it no longer decrypts by default, and users must explicitly ask for this via the decrypt parameter for that function. Because st2kv (within the context of mistral) natively offers decryption, the decrypt_kv filter that currently exists natively in StackStorm was not needed, and therefore not included in the filters copied over to Mistral.

However, we now have a bit of a functionality mismatch between Mistral workflows and the usage of st2kv elsewhere in StackStorm, such as in ActionChain workflows.

So, we should do a few things:

  • Add the ability to provide the same decrypt parameter to the st2-native st2kv function. The function does not currently decrypt by default, so that part is consistent with mistral's st2kv, but it should be something the user can specify in params if they want decryption to take place. This is just a parameter addition, so this shouldn't be a breaking change.
  • If the previous change is made, decrypt_kv filter is no longer needed and should be deprecated. Care should be taken to ensure that the surrounding work in Add ability to decrypt kv item in Jinja via filters #2939 is not undone - only the removal of the unneeded filter.
  • Update documentation, letting users know of the new parameter to st2kv as well as the deprecation of decrypt_kv.
  • Update examples in examples pack with new usages
  • Add/update integration or unit tests as needed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants