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

Revert conjurrc key names to match Ruby CLI #413

Closed szh closed 2 years ago

szh commented 2 years ago

Desired Outcome

Update the Python CLI to use the older names for the keys in the conjurrc file. This means changing conjur_account => account and conjur_url => appliance_url.

Implemented Changes

When reading or writing .conjurrc:

For now we are still supporting the old keys when reading the conjurrc in order not to break existing installations of the 7.x CLI. This is deprecated and will be removed in a future release.

This fixes incompatibility between this Python CLI and the previous Ruby/Docker based CLI, as well as summon-conjur.

The variable names remain the same. Only the key names are changed.

Connected Issue/Story

CyberArk internal issue link: ONYX-22955

Changelog

Test coverage

Documentation

Behavior

Security

szh commented 2 years ago

Code changes look good! Does this mean we're stuck with the old names forever?

@rpothier In planning we pointed out that the Python CLI is not really supported yet (only Community level) so we're ok with some breaking changes, and that we may want to come back around and change these values at some point in the future but for now there's no real reason to change them.

Could we read both the old and the new and only write the new so we upgrade everyone?

@jtuttle Do you think it's worth adding this in now? Is there a large number of users using the Python CLI?

jtuttle commented 2 years ago

@szh Yeah I guess it's pretty easy to read both so let's go ahead and do that. We can steer people towards one or the other via documentation and deprecation notices.

szh commented 2 years ago

@szh Yeah I guess it's pretty easy to read both so let's go ahead and do that. We can steer people towards one or the other via documentation and deprecation notices.

OK great. I've added that functionality and updated the PR description.