Have Brooklyn entities or other catalog items you want to share? Fork this repository, edit directory.yaml to add a link to your repository, and submit a pull request!
The root of your repository should contain these files:
| Filename | Optionality | Notes |
|---|---|---|
| catalog.bom | Required | See below |
| README.md | Required | High-level description of the project |
| items.js | Optional | Documentation generated by brooklyn list-items command |
| LICENSE.txt | Optional but highly recommended | Licence covering the project |
| CHANGELOG.md | Optional | Changes grouped by version number, most recent version at top |
This should be a well-formed and valid Apache Brooklyn catalog file, as described in the Brooklyn catalog documentation.
The catalog metadata part will contain these keys:
| Key | Optionality | Notes |
|---|---|---|
| id | Required | blueprint ID (see user guide) |
| version | Required | blueprint version (see user guide) |
| license | Required | A license identifier from the SPDX license list; absent means that the project is not open source, which means it cannot be included in the community catalog |
| maintainer_name | Optional | Name of the person, team, or organisation responsible for the project |
| maintainer_email | Optional | Email address of the person, team, or organisation responsible for the project |
| issues_url | Optional | Link to a bug-tracking system for the project |