search

cyberark / cyberark-conjur-cli

CyberArk Conjur command line interface written in Python
https://www.conjur.org
Apache License 2.0
17 stars 16 forks source link

Add SDK refactor design document #335

Closed sigalsax closed 2 years ago

sigalsax commented 3 years ago

What does this PR do?

This commit adds the SDK refactor design doc

Note that this design is very much an opinion and open to go in any direction we want to go in. I made a decision based on what I thought was most intuitive when thinking about UX and implementation but def am not bound to any idea

tzheleznyak commented 3 years ago

there is a factory for cred objects: why the objects called Configuration for file and Credentials for keystore. Cant they have more similar names like KeystoreCreds and FileCreds for example ?

sigalsax commented 3 years ago

@tzheleznyak to start, the design is very much an opinion and open to go in any direction we believe in and want to go down. I made decisions based on what I thought was most intuitive when thinking about UX and implementation. That being said, I am not bound to any idea so happy you are asking these questions

Now to your questions,

The idea is to have Configuration(action=file) so any change requires the least amount of effort by the user. Instead of changing the object, they change a simple param. In essence the two flows are the same thing because in the end, in the background, we are creating a KeystoreCreds and a FileCreds. There is just an extra layer of abstraction called Configuration/Credential factory so that if we have common logic, if can happen in that factory