candidate: network.offline_migration_sdn_to_ovnk

[traytorous]

Candidate Name

network.offline_migration_sdn_to_ovnk

Link to Github Repo

(https://github.com/openshift/network.offline_migration_sdn_to_ovnk)

Review Due By

CHECKLIST

Business Checks:

Content Viability

• must support a “business-viable” use case
• isn’t just a demo
• is production-ready, as in able to run in Ansible Controller “as-is”
• provides a solution an end-to-end automation use case and brings value to our customers

Content Duplication

• use case addressed by the content isn’t covered by another validated content collection already - to the best of our knowledge

Technical Checks:

Content Conformity

• is packaged as a content collection - see the Collection Requirements Checklist
• is YAML only (Exception: if plugin(s) included are necessary for this specific use-case and are not generic enough for a certified collection)
• if there is a plugin(s), it is not a duplicate of something from a certified or supported collection - to the best of our knowledge
• supported plugin/module used in a validated role is noted as a dependency

Content Compliance

• no known policy or legal reason for why the content shouldn’t be published
• README contains information about the purpose of the collection and how to install it
• README contains a link to the collection license file
• README contains general usage and requirements information such as required versions of ansible-core and Python, and other required libraries or SDKs
• install / requirements.yml information all points to Automation Hub, not a Github repo
• Repo is self-certified with the OpenSSF Best Practices and has the OpenSSF Best Practices Badge
• Has 2 or more active maintainers listed in a CODEOWNERS file.
• Has an approved OSI license
• Content falls logically into one of these domains - infra, security, network, cloud, edge
• (If internal content) Content has been or is being migrated into the redhat-cop Github org

Content Testing/Validation

• runs ansible-lint “Production” profile in an active Github workflow on the repository
• passes the ansible-lint “Production” profile
• ansible-lint.yml file (if present) only contains justified ignores - with a comment explaining the need for each ignore

[djdanielsson]

I don't see any action configured or running to lint this collection. I also don't understand why they are using Library vs plugins which is the standard. I haven't looked any deeper until these things get fixed.

[miheer]

hi @djdanielsson ! I am working getting the repo to be compatible with ansible collections.
Please check openshift/network.offline_migration_sdn_to_ovnk#8

We do CI testing in openshift/release. So, will add the lint tests over there.

I am very new to ansible and this collections part. Any help will be appreciated.

Please share your opinion.

[djdanielsson]

I think it is looking pretty good. It would be nice to be able to see that lint output but if it is passing now then it should be fine. I do wonder long term how much pain not having a GitHub action that runs lint and sanity per PR will cause you.

[samccann]

My recommendation from the partner engineering perspective (the people who approve future versions of this content after this CoP review/approval) - running lint per PR will save you potential rejections of the content down the road.

[miheer]

Hi,

I do run make sanity and make lint and make sure we follow 100% with no ignores or skips.

These are run on every pull request.

Please see this:
Collection code for CI for lint and sanity tests
https://github.com/openshift/network.offline_migration_sdn_to_ovnk/blob/main/Makefile#L20
https://github.com/openshift/network.offline_migration_sdn_to_ovnk/blob/main/Makefile#L23

CI code for every Pull Request:
https://github.com/openshift/release/blob/master/ci-operator/config/openshift/network.offline_migration_sdn_to_ovnk/openshift-network.offline_migration_sdn_to_ovnk-main.yaml#L42-#L50

Also in the README I have provided a note to always run make sanity and make lint after making any code changes.