we would like the Oathkeeper charm belonging to the Identity Platform to be searchable /visible in Charmub.
Can you please help us to have it reviewed?
Thanks @shipperizer for the review request! @shayanp can you please help with this review? You can go through and tick off the items on the checklist available here and post the result in this thread. This prior listing request could be an example of how to go about it.
@varshigupta Yes! I will start reviewing shortly and share my results in this thread within the next few upcoming days
Here is the checklist for listing the charm on charmhub:
| Checked | Comments | Review item | Objective | Review criteria |
|---|---|---|---|---|
| ✓ | 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. | |
| ✓ | As listed below, the repo and the listing of charm on charmhub does not have -k8s (e.g. oathkeeper-k8s for the listing or oathkeeper-k8s-operator for the repo). Since there is no machine charm, the -k8s suffix is not necessary according to naming guidelines |
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: 1. The name complies with the naming guidelines. 2 The publisher is identified. 3. The links are provided. 4. 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. | |
| ✓ | Unit tests implementation | In particular, for the charms review, assuring a reasonable test suite is essential to allow for automated releases in future. | The unit tests show relevant coverage. It is a case-dependent review.At the time of review, the test runs successfully. | |
| ✓ | Unit tests results | Availability of test results is mandatory for a working collaborative project. | URL to test results from CI/CD automation. | |
| ✓ | 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. | |
| ✓ | There is an integration test with an example client (a simple auth-proxy-requirer charm that resides in the repo along with the integration tests) | 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. | |
| ✓ | As indicated below, there is no documentation on the charmhub listing. There is, however, a section in the README indicating how to deploy the charm | 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. |
A few other considerations:
oathkeeper-operator. However, according to our convention for K8s repos, the repo should be named oathkeeper-k8s-operatorWe added the docs with a how-to guide: Charmed Ory Oathkeeper documentation - index
The tutorial will be added soon.
@varshigupta All of the checklist items are checked, and documentation now exists. I believe that the charm is ready to be listed
Hi,
The charm is now listed.
Thanks,
Odysseus