v1

Documentation

Index

• type HookRequest
• type HookRequestFinalize
• type HookRequestPostReconcile
• type HookRequestPreReconcile
• type HookResponse
• type HookResponseError
• type HookResponseFinalize
• type HookResponseWorkload

Types

type HookRequest

type HookRequest struct {
	// Reference to the object that is being reconciled.
	Object commonv1alpha1.Reference `json:"object"`
	// Reuse the hook capability name as the phase for the
	// hook API.
	Phase commonv1alpha1.HookCapability `json:"phase"`
}

HookRequest sent to configured hooks.

type HookRequestFinalize

type HookRequestFinalize struct {
	HookRequest `json:",inline"`
}

HookRequestFinalize sent to configured hooks for the finalize phase.

type HookRequestPostReconcile

type HookRequestPostReconcile struct {
	HookRequest `json:",inline"`
	// Objects rendered so far at the reconciliation.
	Rendered []unstructured.Unstructured `json:"rendered,omitempty"`
}

HookRequestPostReconcile sent to configured hooks for the post-reconcile phase.

type HookRequestPreReconcile

type HookRequestPreReconcile struct {
	HookRequest `json:",inline"`
}

HookRequestPreReconcile sent to configured hooks for the pre-reconcile phase.

type HookResponse

type HookResponse struct {
	Error *HookResponseError `json:"error,omitempty"`

	// Workload whose elements should be merged with those that Scoby creates.
	Workload *HookResponseWorkload `json:"workload,omitempty"`

	// Status whose elements should be merged with those that Scoby creates.
	Status *commonv1alpha1.Status `json:"status,omitempty"`
}

HookResponse is the expected reconcile reply from configured hooks.

type HookResponseError

type HookResponseError struct {
	Message string `json:"message"`
	// When true, informs Scoby that the reconciliation cycle should
	// not be requeued after this error.
	Permanent *bool `json:"permanent,omitempty"`
	// When true, informs Scoby that the reconciliation process
	// should not stop after this error.
	Continue *bool `json:"continue,omitempty"`
}

HookResponseError contains the information that Scoby needs to handle an error that ocurred at a hook.

type HookResponseFinalize

type HookResponseFinalize struct {
	Error *HookResponseError `json:"error,omitempty"`

	// Status whose elements should be merged with those that Scoby creates.
	Status *commonv1alpha1.Status `json:"status,omitempty"`
}

HookResponseFinalize is the expected finalize reply from configured hooks.

type HookResponseWorkload

type HookResponseWorkload struct {
	PodSpec        *corev1.PodSpec        `json:"podSpec,omitempty"`
	ServiceAccount *corev1.ServiceAccount `json:"serviceAccount,omitempty"`
}

HookResponseWorkload contains workload elements that the hook sets on the generated elements.