v1alpha1

type Address struct {
	// Ref points to an addressable object.
	// +optional
	Ref *Reference `json:"ref,omitempty"`

	// URI can be an absolute URL(non-empty scheme and non-empty host) pointing to the target or a relative URI. Relative URIs will be resolved using the base URI retrieved from Ref.
	// +optional
	URI *apis.URL `json:"uri,omitempty"`
}

type BuiltInfunction struct {
	// Function name
	Name string `json:"name"`
	// The key to select.
	// +optional
	Args []string `json:"args,omitempty"`
}

type Condition struct {
	// type of condition in CamelCase or in foo.example.com/CamelCase.
	// ---
	// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
	// useful (see .node.status.conditions), the ability to deconflict is important.
	// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
	// +kubebuilder:validation:MaxLength=316
	Type string `json:"type"`
	// status of the condition, one of True, False, Unknown.
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=True;False;Unknown
	Status metav1.ConditionStatus `json:"status"`
	// lastTransitionTime is the last time the condition transitioned from one status to another.
	// This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Type=string
	// +kubebuilder:validation:Format=date-time
	LastTransitionTime metav1.Time `json:"lastTransitionTime"`
	// reason contains a programmatic identifier indicating the reason for the condition's last transition.
	// Producers of specific condition types may define expected values and meanings for this field,
	// and whether the values are considered a guaranteed API.
	// The value should be a CamelCase string.
	// This field may not be empty.
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MaxLength=1024
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:Pattern=`^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$`
	Reason string `json:"reason"`
	// message is a human readable message indicating details about the transition.
	// This may be an empty string.
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MaxLength=32768
	Message string `json:"message"`
}

type Conditions []Condition

type ConditionsFromHook struct {
	// Type of the condition to be informed.
	Type string `json:"type"`
}

type DeploymentFormFactor struct {
	// Replicas for the deployment.
	Replicas int `json:"replicas"`

	// Service to create pointing to the deployment.
	// +optional
	Service *DeploymentService `json:"service"`
}

type DeploymentService struct {
	// Port exposed at the service.
	Port int32 `json:"port"`
	// Port exposed at the target deployment.
	TargetPort int32 `json:"targetPort"`
}

type FormFactor struct {
	// Deployment hosting the user workload.
	Deployment *DeploymentFormFactor `json:"deployment,omitempty"`
	// KnativeService hosting the user workload.
	KnativeService *KnativeServiceFormFactor `json:"knativeService,omitempty"`
}

type FromSpecConfiguration struct {
	// JSON simplified path for the parameter.
	Path string `json:"path"`

	// Skip sets whether the object should skip rendering
	// as a workload item.
	// +optional
	Skip *bool `json:"skip,omitempty"`

	// Render options for the parameter generation.
	// +optional
	ToEnv *SpecToEnvConfiguration `json:"toEnv,omitempty"`

	// Render options for the parameter generation.
	// +optional
	ToVolume *SpecToVolumeConfiguration `json:"toVolume,omitempty"`
}

type GlobalParameterConfiguration struct {
	// DefaultPrefix to be appeneded to keys by all generated parameters.
	// This configuration does not affect parameter keys explicitly set by users.
	// +optional
	DefaultPrefix *string `json:"defaultPrefix,omitempty"`
}

type Hook struct {
	Version HookAPIVersion `json:"version"`

	Address Address `json:"address"`

	// Timeout for hook calls.
	// +optional
	Timeout *string `json:"timeout"`

	// Capabilities that a hook implements.
	Capabilities HookCapabilities `json:"capabilities,omitempty"`
}

type HookAPIVersion string

type HookCapabilities []HookCapability

type HookCapability string

type KnativeServiceFormFactor struct {
	// MinScale is the service minimum scaling replicas
	// +optional
	MinScale *int `json:"minScale"`
	// MaxScale is the service maximum scaling replicas
	// +optional
	MaxScale *int `json:"maxScale"`
	// Visibility is the network visibility for the service
	// +optional
	Visibility *string `json:"visibility,omitempty"`
}

type ObjectReference struct {
	// Object name
	Name string `json:"name"`
	// The key to select.
	Key string `json:"key"`
}

type ParameterConfiguration struct {
	// Global defines the configuration to be applied to all generated parameters.
	// +optional
	Global *GlobalParameterConfiguration `json:"global,omitempty"`

	// AddEnvs contains instructions to create environment variables at the workload
	// not derived from the user instance.
	// +optional
	AddEnvs []corev1.EnvVar `json:"addEnvs,omitempty"`

	// FromSpec contains instructions to generate workload items from
	// the instance's spec.
	// +optional
	FromSpec []FromSpecConfiguration `json:"fromSpec,omitempty"`
}

type Reference struct {
	// Kind of the referent.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind"`

	// Namespace of the referent.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
	// This is optional field, it gets defaulted to the object holding it if left out.
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// Name of the hook address.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
	Name string `json:"name"`

	// API version of the hook address.
	// +optional
	APIVersion string `json:"apiVersion,omitempty"`
}

type Registration interface {
	runtime.Object
	metav1.Object

	GetWorkload() *Workload
	GetHook() *Hook

	// Reconciler might add annotations to the status
	// that can be used at the component's registration.
	GetStatusAnnotation(string) *string
}

type RegistrationFromImage struct {
	// Repo where the image can be downloaded
	Repo string `json:"repo"`
}

type SpecToEnvConfiguration struct {
	// Name is the name of the parameter to be created.
	// +optional
	Name *string `json:"name,omitempty"`

	// Value is a literal value to be assigned to the parameter when
	// a value is not provided by users.
	// +optional
	DefaultValue *string `json:"defaultValue,omitempty"`

	// ValueFromConfigMap is a reference to a ConfigMap.
	// +optional
	ValueFromConfigMap *ObjectReference `json:"valueFromConfigMap,omitempty"`

	// ValueFromSecret is a reference to a Secret.
	// +optional
	ValueFromSecret *ObjectReference `json:"valueFromSecret,omitempty"`

	// ValueFromBuiltInFunc configures the field to
	// be rendered acording to the chosen built-in function.
	// +optional
	ValueFromBuiltInFunc *BuiltInfunction `json:"valueFromBuiltInFunc,omitempty"`
}

type SpecToVolumeConfiguration struct {
	// Name for the volume.
	Name string `json:"name,omitempty"`

	// Path where the file will be mounted.
	MountPath string `json:"mountPath,omitempty"`

	// ValueFromConfigMap is a reference to a ConfigMap.
	// +optional
	ValueFromConfigMap *ObjectReference `json:"valueFromConfigMap,omitempty"`

	// ValueFromSecret is a reference to a Secret.
	// +optional
	ValueFromSecret *ObjectReference `json:"valueFromSecret,omitempty"`
}

type Status struct {
	// ObservedGeneration is the 'Generation' of the Object that
	// was last processed by the controller.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Conditions the latest available observations of a resource's current state.
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions Conditions `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`

	// Annotations is additional Status fields for the Resource to save some
	// additional State as well as convey more information to the user. This is
	// roughly akin to Annotations on any k8s resource, just the reconciler conveying
	// richer information outwards.
	Annotations map[string]string `json:"annotations,omitempty"`
}

type StatusAddElement struct {
	// JSON simplified path for the status element.
	Path string `json:"path"`

	// Render options for the status.
	// +optional
	Render *StatusRenderConfiguration `json:"render,omitempty"`
}

type StatusConfiguration struct {
	// AddElements contains configurations for status elements to be added.
	// +optional
	AddElements []StatusAddElement `json:"addElements,omitempty"`

	// ConditionsFromHook contains conditions expected to be informed from the Hook.
	// +optional
	ConditionsFromHook []ConditionsFromHook `json:"conditionsFromHook,omitempty"`
}

type StatusManager struct {
	// contains filtered or unexported fields
}

type StatusRenderConfiguration struct {
	// Reference an object element and use its parameter to
	// fill the status.
	ValueFromParameter *StatusValueFromParameter `json:"valueFromParameter,omitempty"`
}

type StatusValueFromParameter struct {
	// JSON simplified path for the referenced element.
	Path string `json:"path"`
}

type Time interface {
	Now() metav1.Time
}

type Workload struct {
	// FormFactor indicates the kubernetes object that
	// will run instances of the component's workload.
	// +optional
	FormFactor *FormFactor `json:"formFactor,omitempty"`
	// FromImage contains the container image information.
	FromImage RegistrationFromImage `json:"fromImage"`
	// ParameterConfiguration sets how object elements
	// are transformed into workload parameters.
	// +optional
	ParameterConfiguration *ParameterConfiguration `json:"parameterConfiguration,omitempty"`
	// StatusConfiguration contains rules to populate
	// a controlled instance status.
	// +optional
	StatusConfiguration *StatusConfiguration `json:"statusConfiguration,omitempty"`
}