Introduction
If you are unfamiliar with GitHub pull requests (PRs), open a ticket you may also submit the necessary information as a ticket on the EWC Support Portal.
To formally submit an initial version of your Item, or to request the indexing of a followup version, you must fill all required information (also known as Item metadata) and share it with the EWC team.
Item Metadata
A contact (email or URL) is required for successful submission.
If you wish to check all the supported metadata fields, find the current version of the catalog schema on GitHub, at https://github.com/ewcloud/ewc-community-hub/blob/main/schemas/catalog/v1alpha1.json.
We use YAML format to structure the required Item metadata. Take as example the metadata of the "ECMWF Data Flavour", extracted from the Community Hub catalog:
ecmwf-data-flavour:
annotations:
licenseType: "Apache License 2.0"
category: Compute,Data Access
supportLevel: EWC-Supported
technology: Ansible Playbook
displayName: ECMWF Data Flavour
description: |
# ECMWF data flavour
Includes the basic ECMWF software stack, with MARS client and an environment with ecCodes, Metview, Earthkit and Aviso.
# Usage Example
usage:
bash
ansible-playbook -i inventory ecmwf-data-flavour.yml
# Inputs
You may use the following ansible variables to customize this playbook:
- reboot_if_required: Boolean to reboot the instance if required after an update. Default: true
- ecmwf_toolbox_env_wipe: Boolean to decide whether to wipe the environment if exists prior to a reinstallation. Default: false
- ecmwf_toolbox_env_name: Name of the environment containing the ECMWF toolbox. Default: ecmwf-toolbox
- ecmwf_toolbox_create_ipykernel: Boolean to create a system-wide kernel available. Default: true
- conda_prefix: Prefix where conda is installed. Default: /opt/conda
- conda_user: User owning the conda installation. Default: root
home: https://github.com/ewcloud/ewc-flavours
license: https://github.com/ewcloud/ewc-flavours/blob/main/LICENSE
icon: https://raw.githubusercontent.com/ewcloud/ewc-community-hub/refs/heads/main/logos/EWCLogo.png
maintainers:
- name: EWC Team
email: support@ewcloud.int
url: https://github.com/ewcloud/ewc-flavours/issues
name: ecmwf-data-flavour
published: false
sources:
- https://github.com/ewcloud/ewc-flavours/blob/main/playbooks/ecmwf-data-flavour/ecmwf-data-flavour.yml
summary: Includes the basic ECMWF software stack, with MARS client and an environment with ecCodes, Metview, Earthkit and Aviso.
version: "1.0.0"
Submission Steps
Once you have all the required information at hand, you may proceed to:
- Fork the EWC Community Hub repository
- Append your metadata to the catalog file, named
items.yaml - Validate your metadata (see the "Schema Validation" section file of the README.md)
- Submit the metadata by opening a pull request, between your fork and the main branch of official repository
- If you have submitted via pull request, assign one or two of the official repository maintainers for review
OR
Open a support ticket on the EWC Support Portal, including the metadata of your Item (in the aforementioned format), and let a support engineer open the pull request on your behalf.