NetBox K8s operator is a Juju 12-factor charm deploying and managing NetBox on Kubernetes. NetBox is a solution for modeling and documenting network infrastructure.
Metadata links
CI Links
Documentation Links
Hi @alithethird ! Thanks for the review request. I’ll work on this tomorrow.
1 Like
Hi @tony-meyer !
Hope you are well, any news about the review?
Hi - apologies for the delay, got caught up with 360s and things.
One blocking issue that’s hopefully minor: there’s a netbox and netbox-k8s charm on Charmhub, and they seem to be the same thing, and this is pretty confusing. Following the netbox-k8s tutorial, it gets you to deploy the netbox (no -k8s) charm, which adds to the confusion. My guess is that there’s been a rename here (the -k8s suffix is probably the right choice). Can that be cleaned up? At least within the “-k8s” documentation the “-k8s” charm should be used.
Comments:
- This doesn’t block public listing, but we’d like charms to standardise on “format” rather than “fmt” and to have “lint” include static type checking (details in OP061).
- Ideally, you’d add an icon to show in Charmhub.
- FYI, two of the badges on the README aren’t displaying correctly.
- Ideally, you’d have a SECURITY.md (or .txt or .rst) file in the repo that explains how to report security issues, what the support lifecycle is, etc.
| Review item |
Objective |
Review criteria |
Review comment |
| Intended functionality |
Despite all the items for publication readiness, the charm must work. |
Charm does what it is meant to do - ideally done in a demo. |
 |
| Charmhub.io charm detail page |
A complete and consistent appearance of the charm is required for a quality impression of the charm collection. |
The overall appearance looks good, which means:
* The name complies with the naming guidelines.
* The publisher is identified.
* The links are provided.
* The documentation looks reasonable. |
|
| Source repository |
Generally, the source code for charms must be accessible by the community for transparency and collaboration. |
It is not entirely mandatory to have the charm published as OSS for review, but the repository must be accessible from the persons working on the review request. |
|
| Coding conventions |
The source code of the charm is accessible in the sense of approachability. Consistent source code style and formatting are also considered a sign of being committed to quality. |
The implemented checks for coding conventions are reasonable and implemented in the regular CI/CD implementation. |
|
| Release automation implementation |
An implementation for automated releasing to charmhub.io improves the ability to provide updates covering vulnerabilities quickly. |
Release automation for unstable channels to enable testing when new versions of the charm code or the workload become available. |
|
| Installation test implemented (could be part of the integration test) |
In particular, for the charm review, assuring a reasonable test suite is essential to allow for automated releases in future. With this test, for every build, it is ensured that the installation is successful. |
An implementation for checking the installation is present. The implementation should also check for successful installation as part of the automation, and the workload behaves as expected. At the time of review, the test runs successfully. |
|
| Installation test results |
Availability of test results is mandatory for a working collaborative project. |
URL to test results from CI/CD automation. |
|
| Integration tests implemented |
In particular for the review of charms, assuring a reasonable test suite is important to allow for automated releases in future. With this test, for every build, it is ensured that the integration with other charms is successful. |
An implementation for testing the required integrations (if applicable) is present. The implementation should also check for successful integration as part of he automation and the workload behaves as expected.
At the time of review, the test runs successfully. |
|
| Integration test results |
Availability of test results is mandatory for a working collaborative project. |
URL to test results from CI/CD automation. |
|
| Documentation for usage |
The documentation for using the charm should be separate from the documentation for developing or contributing to the charm. |
URL to this documentation is present. |
|
| Documentation for contributing |
The documentation for contributing to the charm should be separate from the documentation for developing or using the charm. |
URL to this documentation is present. |
|
| Licensing statement |
For the charm shared, OSS or not, the licensing terms of the charm are clarified (which also implies an identified authorship of the charm). |
URL to the ruling licensing statement is present. |
|
Hi @tony-meyer ! Thank you so much.
I have updated the documentation and working on the non-blocking issues you mentioned.
Can you list it now 
Have a nice day!
1 Like
@adityagoel28 this one is good for listing, thanks!
Done.
But the charm should be released to a stable channel and have that channel as default to appear it in listing.
Thanks!
1 Like
