...
Unless your Item has dependencies linked to GPL terms of use, or on the contrary, they are constrained by a proprietary license, you, as the Item owner, are free to choose a suitable open-source license under which to feature Items. For reference, EWC -supported Items typically release under MIT or Apache 2.0 license.
...
Specifying a Support Level
| Info |
|---|
If you wish to change the support level of Item currently featured on the dashboard, bump its semantic version up from |
The Community Hub recognizes four different support levels, one of which is reserved for Items featured by the EWC and its close partners (e.g. EWC-Supported). You, as the Item owner, are free to choose, from any of the remaining support levels, the one that best fits your availability and commitment:
| Name |
|---|
| Audience |
|---|
| Summary | Examples |
|---|---|
| Community |
| For typical users or research groups sharing useful work |
| Item is shared by the owner but no commitment on the maintenance which is left on best-effort and community-supported | A GitHub repository with a permissive license but no maintainer commitment |
• An enriched dataset |
on atmospheric phenomena, updated at irregular interval and/or subject to data availability, without any formal commitment |
• A data pipeline template for various streaming analysis algorithms, regularly updated to support new datasets and increase throughput capabilities |
| EWC |
| For Items featured by EWC partners (ECMWF, EUMETSAT, etc.) or trusted collaborators |
| Maintained by E&E | A one-click deployable software stack for self-managed identity/policy/audit (IPA), hardened SSH access point and remote desktop environment hosting |
Defining Deployability
Whether an Item is deployable or not depends mainly on the Item Technology. Find the full list of currently supported ones , please refer to EWC Community Hub's home page(see Item Technology).
Item is not Deployable
No additional action required.
...
| Warning |
|---|
Before attempting to feature your Item as EWCCLI-compatible, please ensure you test and validate by carrying out a deployment via the ewccli. EWC reviewers review may refuse your submission if it is unclear if deployment worksvia |
| Info |
|---|
If you are convinced featuring your Item as compatible can greatly improve its reception among community members, but you are unsure how to conduct the necessary deployment tests, you can place a support ticket to request assistance. |
...
The ewccli is a Linux-native Python-based tool which allows you to interact with deployable Items directly into a EWC tenancy, with minimal setup required on your local working environment. See Deploying new instances and applying Ansible Playbooks on them with the ewccli. On paper, adding compatibility with the ewclid does not require additional development effort on your side, as the business logic is built into the tool itself. From your side, all that All what is required is additional Item metadata to be prepared, namely:
- Item input Inputs specification: If any available. May also include default values for each input.
- Item output Output specification: If any available.
- Annotations: Item annotations: Set as:
| Code Block | ||
|---|---|---|
| ||
annotations: others: "EWCCLI-compatible,Deployable" |
You can find references to the metadata schema in the Submit your Item page. For a complete Item Metadata example including full compatibility with the ewccli checkout the example metadata of the "ECMWF Data Flavour" Item, published on GitHub.
Putting it all Together
| Tip |
|---|
If you are unfamiliar with YAML, or needed additional guidance to correctly annotate your Item, feel free to place a support ticket on the EWC Support Portal. |
Besides the information highlighted in the previous sections, including a description (i.e. the features and usage), contact and a version for your Item is required, to increase the quality of submissions.
To help both contributor and reviewers to categorize this
...
information, we kindly ask you to fit in your Item details into the Item Metadata structured used by the EWC Community Hub (YAML format). Take as example metadata of the "ECMWF Data Flavour" Item, published on GitHub. When preparing metadata for your own Item, we recommend you copy the content of said example YAML and adapt values accordingly.
("EWCWF Data Flavour" Item, published on GitHub)
Detailed information on all the supported metadata attributes, both the required as well as the optional ones, is also publicly available; the current version of the Items schema definition is hosted on GitHub, at https://github.com/ewcloud/ewc-community-hub/blob/main/schemas/items/v1alpha1.json.
...
Best-Practices
Best-practices are not always well documented, and they tend to change. If you are not sure what is currently considered a best-practice, at least within the EWC community, we recommend you start here:
- Best-Practices of Community Hub Item Implementation: examples of EWC -supported Item Items implementation, ranging from basic documentation format to CI/CD automation, all details broken down per Item Technology.
Related Articles
- Submit your Item
- Contributing with your own new to someone else's Item