...
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 | Summary | Audience | Service Level Agreement (SLA) | Summary | ExamplesExample | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Community-Shared | Best-Effort / No SLA | For typical users or research groups sharing useful workNone. | No guaranteed response, or issue acknowledgement. Contributions and fixes depend entirely on community goodwill.Item is shared by the owner but not commitment on the maintenance which is left on best-effort and community-supported | A GitHub repository with a permissive license but no maintainer commitment | Community-Updated | Active / No SLA | For small teams or labs actively using the Item themselves | None. Maintainers monitor issues and PRs. Best-effort responses. Updates are featured occasionally (aligned with their internal usage) | • An enriched dataset with pre-calculated metricson atmospheric phenomena, updated at irregular interval and/or subject to data availability, without any formal commitment | Community-Supported | Well-defined SLAs | For organizations willing to stand behind their Items | Documented response channels (email, ticket system, GitHub issues). Defined response time (within hours or up to 7 business days). Regular security patches. Changelog publishing. | • A data pipeline template for various streaming analysis algorithms, regularly updated to support new datasets and increase throughput capabilities |
| EWC-Supported | Well-defined SLAs, Partner-Backed | For Items featured by EWC partners (ECMWF, EUMETSAT, etc.) or trusted collaboratorsSame as Community-Supported, plus guaranteed compatibility with the EWC hardware and clear escalation path in case of security sensitive issues. | 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 |
...
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 this Item's metadata example in GitHub. "ECMWF Data Flavour" Item, published on GitHub.
Putting all Information Together
Before formally submitting an initial version of your Item, or to request the indexing of a followup version, we kindly ask you to compile all relevant Item Metadata in a single editable file. The EWC uses YAML format to structure the Item metadata. Take as example the metadata of the "ECMWF Data Flavour" Item, published on GitHub:
| Warning |
|---|
| The key, at the top of an item's metadata, must be unique and match the value the `name` attribute. |
| Info |
|---|
A contact (email or URL) is required for successful submission. |
(EWCWF Data Flavour Item's Metadata Excerpt)
When compiling metadata for your own Item, we recommend you copy the aforementioned example YAML contents and adapt the attribute values according to your case.Please note that detailed information on all the supported metadata attributes, both required and optional, 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.
Finally, if you are unfamiliar with YAML, or needed additional guidance to correctly annotate your Item, feel free to please a support request on the EWC Support Portal.
Following Implementation Best-Practices
...
- 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.
...