package
0.0.0-20240302215016-ae3d3cc18e73
Repository: https://github.com/doout/formation.git
Documentation: pkg.go.dev
# Constants
No description provided by the author
HashKey conation the hash of the resource in the annotations.
No description provided by the author
StorageConfigTypeCreate are expected to be created by the controllers and then inserted in to the Volumes field of workload objects, just as with Existing.
StorageConfigTypeExisting will typically be inserted in to the Volumes field of the PodSpec for all workload objects (Deployment, StatefulSet) managed by this ResourceConfig.
StorageConfigTypeTemplate will typically be templated in to any StatefulSet managed by the ResourceConfig parent of this StorageConfig.
UpdateKey if is set to "disabled", the resource will not be updated.Once this is set on a resource, it will not be updated unless the annotation is removed.
No description provided by the author
# Variables
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
AddTemplateVolumeToContainer is the interface that adds a Volume Template to the builder and which container it belongs to.
AddVolumeToContainer is the interface that adds a Volume to a Container.
ConfigurableContainer is the interface that allows the user to customize the resource.
ConfigurablePod is the interface that allows the user to customize the Pod.
ConfigurableReplicas is the interface that allows the user to customize the number of replicas.
Converged The default implementation for a list of resources once it is created is to move on to the next one, if the controller need to wait for this resource to be ready, it can implement this interface.
ConvergedGroup group of resources that need to be converged together but not necessarily in order.
No description provided by the author
Reconcile If the resource need to implement their own reconcile logic, they can implement this interface Optional.
No description provided by the author
ResourcesName is the interface that returns the name of the resources that the builder creates For example, if the resource is a Deployment, it will return the with a list of container name with the format <Pod-Name>/<Container-Name>.
ToResource is the interface that converts a Builder to a Resource.
Update is the interface that allows each resource to implement their own update logic.
# Type aliases
No description provided by the author
StorageConfigType manages the formation's interpretation of a StorageConfig; each of the types has near-identical specifications but slightly different behavior.