vmware / cloud-director-extension-standard-library

Standard Library for VMware Cloud Director solutions add-ons and add-on elements.
BSD 2-Clause "Simplified" License
18 stars 7 forks source link
solutions-engineering standard-library

Cloud Director Extension Standard Library

The VMware vcd-ext-shell command line interface allows vendors to use starter templates for creating solution add-ons and add-on elements. The source of the available templates is located in this Git repository.

All components of this repository are validated by VMware or its partners against particular Cloud Director version.

Documentation

Get familiar with Cloud Director Solution Add-Ons.

Repository Filesystem Layout

Every branch of the repository contains two folders at the root level.

Important The folder name for every template must be named after the major use case it delivers following the Kebab case naming convention (ex. work-word-word).

Both add-on and element/<element type> folders might contain folders starting with .. These folders contain helper tools for building, testing and documenting an add-on or its elements.

Filesystem Layout:

<branch>
- add-on/<use case>
- add-on/.<add-on centric toolchain>
- element/<element type>/<use case>
- element/<element type>/.<element centric toolchain>

The templates and tools are further organized by branches. The names of the branches follow cloud-director-X.X.X pattern and claim that all add-ons and elements templates in that branch have been validated against an environment running Cloud Director version X.X.X. The main branch contains alpha versions of the add-ons and elements for the next upcoming release.

Important Upon receiving a complaint from a provider running a newer version of Cloud Director X.Y.Z, a vendor who has bootstrapped his add-on with a minimal version of Cloud Director X.X.X using a starter template from cloud-director-X.X.X can review directly the fix made by VMware or its partners on the starter template by comparing the branches cloud-director-X.X.X and cloud-director-X.Y.Z and find out the exact line causing the issue.

Branching organization:

main
cloud-director-10.4.1
...
cloud-director-10.5

Contributing

The cloud-director-extension-standard-library project team welcomes contributions from the community. Before you start working with cloud-director-extension-standard-library, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING_DCO.md.

License

BSD-2-Clause