├── participation-form └── participation-form.md ├── terms-conditions └── terms-and-conditions.md ├── .github └── settings.yml ├── reviewing.md ├── README.md ├── instructions.md └── LICENSE /participation-form/participation-form.md: -------------------------------------------------------------------------------- 1 | # Participation Form 2 | 3 | The Participation Form for the Crossplane Conformance Program is being finalized and will be published to this page soon. 4 | -------------------------------------------------------------------------------- /terms-conditions/terms-and-conditions.md: -------------------------------------------------------------------------------- 1 | # Terms and Conditions 2 | 3 | The Terms and Conditions of the Crossplane Conformance Program are being finalized and will be published to this page soon. 4 | -------------------------------------------------------------------------------- /.github/settings.yml: -------------------------------------------------------------------------------- 1 | # Get more info on the settings.yaml here:https://github.com/apps/settings 2 | repository: 3 | # See https://developer.github.com/v3/repos/#edit for all available settings. 4 | 5 | # The name of the repository. Changing this will rename the repository 6 | name: crossplane-conformance 7 | 8 | # A short description of the repository that will show up on GitHub 9 | description: Crossplane Conformance Program 10 | 11 | # A URL with more information about the repository 12 | homepage: https://cncf.io/projects 13 | 14 | # Collaborators: give specific users access to this repository. 15 | # see /governance/roles.md for details on write access policy 16 | # note that the permissions below may provide wider access than needed for 17 | # a specific role, and we trust these individuals to act according to their 18 | # role. If there are questions, please contact one of the chairs. 19 | collaborators: 20 | # Chairs 21 | - username: caniszczyk 22 | permission: admin 23 | 24 | - username: negz 25 | permission: push 26 | 27 | - username: jbw976 28 | permission: push 29 | -------------------------------------------------------------------------------- /reviewing.md: -------------------------------------------------------------------------------- 1 | # How to review conformance results 2 | 3 | ## Technical Requirements 4 | 5 | 1. Verify that the list of files matches the [expected list]. 6 | 7 | 2. Note the `vX.Y` subdirectory that the PR is in, this is the version of 8 | Crossplane for which conformance is being claimed, referenced as the 9 | "Conformance Version" from hereon. 10 | 11 | 3. Verify that the Conformance Version is the current or previous two versions 12 | of Crossplane. 13 | 14 | 4. Look at `results.log`. Verify that the `major.minor` component of the 15 | `Conformance test version` exactly matches the Conformance Version. The patch 16 | version does not matter. 17 | 18 | 5. Verify that the last line of `results.log` says `PASS`. 19 | 20 | 6. Verify that no files outside of the submitted subdirectory are being 21 | modified. For example, if a submission is adding files to 22 | `v1.2/distribution/coyote/`, ensure that it doesn't change `README.md` or 23 | `v1.2/distribution/roadrunner/`. 24 | 25 | ## Policy Requirements 26 | 27 | 1. Confirm that the vendor is currently a [member] of CNCF. If they are not, 28 | request that they reach out to memberships@cncf.io to become a member in 29 | order to complete their certification. (Companies can alternatively pay a 30 | certification fee equal to the cost of membership if, for whatever reason, 31 | they don't wish to become a CNCF member.) Alternatively, non-profit 32 | organizations (including community distributions like Debian) can certify at 33 | no cost. 34 | 35 | Review the `PRODUCT.yaml` file, and: 36 | 37 | 2. Verify that there is a Participation Form on file for the `vendor`, and that 38 | the vendor is in good standing in the program. 39 | 40 | 3. Verify the product `name` and `website_url` are listed in the "Qualifying 41 | Offerings" section of the vendor's Participation Form, i.e. that the `name` 42 | and `website_url` are listed. 43 | 44 | If the submission doesn't meet all policy requirements, reply with a message 45 | indicating "Signed participation form needed", "Files missing from PR", 46 | "Membership in CNCF or confirmation of non-profit status needed", etc. 47 | 48 | ## Tasks to Complete After Review 49 | 50 | 1. Add a comment saying "You are now Certified Crossplane" and merge the PR. 51 | 52 | [expected list]: instructions.md#contents-of-the-pr 53 | [member]: https://www.cncf.io/about/members/ 54 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Crossplane Conformance 2 | 3 | The Crossplane community continues to grow with new contributors, adopters, and vendors. As the 4 | diversity of the community and its needs has grown, a large ecosystem of extensions to Crossplane's 5 | functionality, known as Providers, has also been established to provision and manage infrastructure 6 | in a wealth of environments and scenarios. More than 20+ Providers have been published by the 7 | community at large, with many more expected to be created over time. 8 | 9 | Similarly, a need for Distributions of the Crossplane project has surfaced with its adopters. As 10 | there are many environments, marketplaces, and integrations in which adopters want to install and 11 | consume Crossplane, there is a need for a variety of packaged bundles ("Distributions") to deliver and consume 12 | Crossplane in these new targets. 13 | 14 | With this diversity of Providers and Distributions, there comes a need for a consistent set of 15 | expectations in their behavior and usage. To this end, a Crossplane Conformance Program has been 16 | established as described in this repository, in order to give end users the confidence that when 17 | they use a Certified Crossplane offering, they can rely on a high level of consistent and common 18 | functionality. This will enable the Crossplane community to continue to grow and thrive among both 19 | vendors and adopters. 20 | 21 | ## Certification Types 22 | 23 | Both Distributions of Crossplane as well as Crossplane Providers have a specific certification 24 | process to follow to verify conformance with the program's expectations. Further details on how to 25 | verify and submit results for your conformant Distribution or Provider are available in the 26 | [conformance instructions](instructions.md). 27 | 28 | ## Updates to the Conformance Program 29 | 30 | This conformance program will evolve over time as the functionality of Crossplane itself evolves, as 31 | well as the needs of the community continue to evolve. If you want to contribute ideas to improve, 32 | extend, or update the conformance process, you are welcome to propose your desired changes by 33 | creating an [issue in this repo](https://github.com/cncf/crossplane-conformance/issues). 34 | 35 | ## Applying for Conformance Certification 36 | 37 | All vendors are invited to submit conformance testing results for review and certification by the 38 | CNCF, which formally certifies conformant implementations. Instructions for submitting conformance 39 | results can be found on the [conformance instructions](instructions.md) page. 40 | 41 | Certification is available for Crossplane versions 1.2 and higher. 42 | 43 | ## Benefits of Certification 44 | 45 | In addition to providing confidence to end users of your Crossplane Distribution or Provider, 46 | offerings that certify are able to: 47 | 48 | * Proudly display the new Certified Crossplane logo mark on their marketing materials 49 | * Use Crossplane in their product name by taking advantage of a new combination trademark rule the 50 | CNCF adopted for Certified Crossplane providers that keep up to date with their certification 51 | 52 | ## Recertification 53 | 54 | To ensure the pace of innovation in Crossplane continues and benefits all users, Distributions and 55 | Providers must complete a recertification each year for the current or previous version of 56 | Crossplane to remain certified. This ensures that when you see the Certified Crossplane mark on a 57 | product, you’re not only getting something that’s proven conformant, but also contains the latest 58 | and greatest developments from the community. 59 | 60 | ## Crossplane Conformance Program Details 61 | 62 | * [Instructions](instructions.md) 63 | * [Terms and Conditions](terms-conditions/terms-and-conditions.md) 64 | * [Participation Form](participation-form/participation-form.md) 65 | * Brand Guidelines (coming soon) 66 | * Logos (coming soon) 67 | -------------------------------------------------------------------------------- /instructions.md: -------------------------------------------------------------------------------- 1 | # How to submit conformance results 2 | 3 | ## The tests 4 | 5 | The standard set of conformance tests is currently those defined by the 6 | [crossplane/conformance] Sonobuoy plugin. 7 | 8 | ## Running 9 | 10 | The standard tool for running these tests is [Sonobuoy]. Download a [binary 11 | release] of the CLI, or build it yourself by running: 12 | 13 | ```console 14 | go get -u -v github.com/vmware-tanzu/sonobuoy 15 | ``` 16 | 17 | Deploy a Sonobuoy pod to your cluster with: 18 | 19 | ```console 20 | # The version of Crossplane your wish to validate conformance against. 21 | xp_version=1.2 22 | 23 | # To validate the conformance of a Crossplane distribution. 24 | sonobuoy run --plugin https://raw.githubusercontent.com/crossplane/conformance/release-${xp_version}/plugin-crossplane.yaml 25 | 26 | # To validate the conformance of a Crossplane provider. 27 | sonobuoy run --plugin https://raw.githubusercontent.com/crossplane/conformance/release-${xp_version}/plugin-provider.yaml 28 | 29 | # To view the status of the conformance tests. 30 | sonobuoy status 31 | 32 | # To view Sonobuoy logs. 33 | sonobuoy logs 34 | ``` 35 | 36 | Once `sonobuoy status` shows the run as `completed`, copy the output directory 37 | from the main Sonobuoy pod to a local directory: 38 | 39 | ```console 40 | outfile=$(sonobuoy retrieve) 41 | 42 | # Extract the contents into `./results` 43 | mkdir ./results; tar xzf ${outfile} -C ./results 44 | ``` 45 | 46 | > The two files required for submission are located in the tarball as 47 | > `plugins/crossplane-conformance/results/global/{report.log,report.xml}`. 48 | 49 | To clean up Kubernetes objects created by Sonobuoy, run: 50 | 51 | ```console 52 | sonobuoy delete 53 | ``` 54 | 55 | ## Uploading 56 | 57 | Prepare a PR in this repository. Here are [directions] to prepare a pull request 58 | from a fork. In the descriptions below, `X.Y` refers to the Crossplane major and 59 | minor version, and `$dir` is a short subdirectory name to hold the results for 60 | your product. Examples would be `distribution/coolplane` or `provider/pizza`. 61 | 62 | Description: `Conformance results for vX.Y/$dir` 63 | 64 | ### Contents of the PR 65 | 66 | For simplicity you can submit the tarball or extract the relevant information 67 | from the tarball to compose your submission. 68 | 69 | If submitting test results for multiple versions, submit a PR for each product, 70 | ie. one PR for vX.Y results and a second PR for vX.Z 71 | 72 | ``` 73 | vX.Y/$dir/README.md: A script or human-readable description of how to reproduce 74 | your results. 75 | vX.Y/$dir/sonobuoy.tar.gz: Raw output from sonobuoy. (optional) 76 | vX.Y/$dir/report.log: Test log output (from Sonobuoy). 77 | vX.Y/$dir/report.xml: Machine-readable test log (from Sonobuoy). 78 | vX.Y/$dir/PRODUCT.yaml: See below. 79 | ``` 80 | 81 | #### PRODUCT.yaml 82 | 83 | This file describes your product. It is YAML formatted with the following 84 | root-level fields. Please fill in as appropriate. 85 | 86 | | Field | Description | 87 | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 88 | | `vendor` | Name of the legal entity that is certifying. This entity must have a signed participation form on file with the CNCF. | 89 | | `name` | Name of the product being certified. | 90 | | `version` | The version of the product being certified (not the version of Crossplane it runs). | 91 | | `website_url` | URL to the product information website. | 92 | | `repo_url` | If your product is open source, this field is necessary to point to the primary GitHub repo containing the source. It's OK if this is a mirror. OPTIONAL. | 93 | | `documentation_url` | URL to the product documentation. | 94 | | `product_logo_url` | URL to the product's logo, (must be in SVG, AI or EPS format -- not a PNG -- and include the product name). OPTIONAL. If not supplied, we'll use your company logo. Please see [logo guidelines]. | 95 | | `type` | Is your product a distribution of Crossplane or a Crossplane provider? (Specify one of `distribution` or `provider`.) | 96 | | `description` | One sentence description of your offering. | 97 | 98 | Examples below are for a fictional Crossplane distribution called _Coolplane_ 99 | produced by a company named _Compu-Hyper-Global-Meganet_. 100 | 101 | ```yaml 102 | vendor: Compu-Hyper-Global-Meganet 103 | name: Coolplane 104 | version: v1.7.4 105 | website_url: https://compuhyperglobalmega.net/coolplane 106 | repo_url: https://github.com/chgmnet/cooplane 107 | documentation_url: https://compuhyperglobalmega.net/coolplane/docs 108 | product_logo_url: https://compuhyperglobalmega.net/assets/coolplane.svg 109 | type: distribution 110 | description: "Coolplane is the coolest distribution of Crossplane." 111 | ``` 112 | 113 | ## Amendment for Private Review 114 | 115 | If you need a private review for an unreleased product, please email a zip file 116 | containing what you would otherwise submit as a pull request to 117 | conformance@cncf.io. We'll review and confirm that you are ready to be Certified 118 | Crossplane as soon as you open the pull request. We can then often arrange to 119 | accept your pull request soon after you make it, at which point you become 120 | Certified Crossplane. 121 | 122 | ## Review 123 | 124 | A reviewer will shortly comment on and/or accept your pull request, following 125 | this [process]. If you don't see a response within 3 business days, please 126 | contact conformance@cncf.io. 127 | 128 | ## Example Script 129 | 130 | Combining the steps provided here, the process looks like this: 131 | 132 | ``` 133 | $ xp_version=1.2 134 | $ prod_name=coolplane 135 | $ type=distribution 136 | $ results_dir=${xp_version}/${type}/${prod_name} 137 | 138 | $ go get -u -v github.com/vmware-tanzu/sonobuoy 139 | 140 | $ sonobuoy run --wait 141 | $ outfile=$(sonobuoy retrieve) 142 | $ mkdir ./results; tar xzf $outfile -C ./results 143 | 144 | $ mkdir -p ./${results_dir} 145 | $ cp ./results/plugins/e2e/results/global/* ./${results_dir} 146 | 147 | $ cat << EOF > ./${results_dir}/PRODUCT.yaml 148 | vendor: Compu-Hyper-Global-Meganet 149 | name: Coolplane 150 | version: v1.7.4 151 | website_url: https://compuhyperglobalmega.net/coolplane 152 | repo_url: https://github.com/chgmnet/cooplane 153 | documentation_url: https://compuhyperglobalmega.net/coolplane/docs 154 | product_logo_url: https://compuhyperglobalmega.net/assets/coolplane.svg 155 | type: distribution 156 | description: "Coolplane is the coolest distribution of Crossplane." 157 | EOF 158 | ``` 159 | 160 | ## Issues 161 | 162 | If you have problems certifying that you feel are an issue with the conformance 163 | program itself (and not just your own implementation), you can file an issue in 164 | this repository. 165 | 166 | [crossplane/conformance]: https://github.com/crossplane/conformance 167 | [sonobuoy]: https://github.com/vmware-tanzu/sonobuoy 168 | [binary release]: https://github.com/vmware-tanzu/sonobuoy/releases 169 | [directions]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork 170 | [logo guidelines]: https://github.com/cncf/landscape#logos 171 | [process]: reviewing.md 172 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------