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

Migrate this Ansible role to the Conjur Ansible collection #30

Open
2 of 3 tasks
izgeri opened this issue Apr 9, 2020 · 6 comments
Open
2 of 3 tasks

Migrate this Ansible role to the Conjur Ansible collection #30

izgeri opened this issue Apr 9, 2020 · 6 comments

Comments

@izgeri
Copy link
Contributor

izgeri commented Apr 9, 2020

AC:

@izgeri
Copy link
Contributor Author

izgeri commented Aug 10, 2020

@BradleyBoutcher This could likely be a handful of cards, so please split it out once you have a complete plan:

  • Migrate the role to the collection
  • Migrate the tests for the role to the collection
  • Migrate the docs for the role to the collection, and revise to be based on how the role works within the collection
  • Update the Conjur docs card cyberark/conjur-docs#895 to include what the docs should say now - my gist from the last update might be a useful baseline, and there are also some Word docs linked in the docs issue that may help
  • Add a tag in the collection that announces the role
  • Add a tag to the Ansible role project to note that it has been deprecated and has moved to the new Conjur Collection

@izgeri
Copy link
Contributor Author

izgeri commented Aug 13, 2020

@BradleyBoutcher fyi the docs card just got moved to cyberark/conjur-docs#1015. I added it to the epic.

@BradleyBoutcher
Copy link
Contributor

BradleyBoutcher commented Sep 15, 2020

We should take the following steps to deprecate this project:

  1. Complete migration of Role to the Collection
  2. Tag a release of Collection (ansible-conjur-collection#35)
  3. Migrate docs ansible-conjur-host-identity docs are migrated  ansible-conjur-collection#36
  4. Verify functionality of role in collection and document migration steps
  5. Merge PR Deprecate project #43 in conjur-host-identity
  6. Tag a release of the newly-deprecated conjur-host-identity (1.0.0, as this is a "breaking" change) (ansible-conjur-host-identity#42)
  7. Add deprecated tag to the conjur-host-identity page in Ansible Galaxy

@izgeri
Copy link
Contributor Author

izgeri commented Sep 15, 2020

I'd like to get @alexkalish's take on (5), e.g. what the right way to announce deprecation is. do we need a new tag? can we just update the README to indicate that if you are using Ansible v2.9+, we recommend using the collection instead (with a link)? do we need to add deprecated to this repo's title or topics?

@alexkalish
Copy link

@izgeri: I'm not sure that I have a strong opinion. I do know that users should be clearly informed of the following:

  1. What exactly is being deprecated? Be detailed.
  2. How long is the deprecation period? Said another way, when will the feature/component be removed?
  3. What is the alternative path to meet the same outcome? What do we advise?

Readme is probably fine, assuming that is primary place where the component is consumed.

@izgeri
Copy link
Contributor Author

izgeri commented Sep 15, 2020

Thanks @alexkalish. I'm going to copy this convo into #42, which is the issue for deprecating this standalone role.

This issue is the one for migrating the role to the collection, for which there is an open PR at cyberark/ansible-conjur-collection#38.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants