search

dekorateio / dekorate

Tools for generating Kubernetes related manifests.
Apache License 2.0
479 stars 104 forks source link

Document the project design #21

Open iocanel opened 6 years ago

iocanel commented 6 years ago

Contributors and integrators need to have a clear view of how the project works.

cmoulliard commented 6 years ago

I agree with you and ideally we should maybe add some annotations within the code to generate the doc including what the different visitors, configurators and processors are generated or modifying or enriching.

cmoulliard commented 6 years ago

It is important that we have table which maps for each annotation the type of ressources generated

Name Generated resource Optional resources (included with configurator/visitor)
@KubernetesApplication K8s Deployment Label, Annotation, Env, Port, Mount, SecretVolume, ConfigMapVolume, PersistentVolumeClaimVolume, AzureFileVolume, AzureDiskVolume, AwsElasticBlockStoreVolume
@OpenshiftApplication Openshift DeploymentConfig Label, Annotation, Env, Port, Mount, SecretVolume, ConfigMapVolume, PersistentVolumeClaimVolume, AzureFileVolume, AzureDiskVolume, AwsElasticBlockStoreVolume
@OpenshiftApplication Openshift BuildConfig, ImageStream (project, s2i) ?? ??
@ServiceCatalog ServiceInstance, ServiceBinding, Secret ?
@CompositeApplication CRD Component (runtime, service, link)
@DockerBuild ??
@Istio ??
@IstioProxy ??

Can you check the ?? please @iocanel and next move it to the doc ?