mirror of https://github.com/helm/helm.git
107 lines
3.6 KiB
Go
107 lines
3.6 KiB
Go
/*
|
|
Copyright The Helm Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package release
|
|
|
|
import (
|
|
"helm.sh/helm/v3/pkg/time"
|
|
)
|
|
|
|
// HookEvent specifies the hook event
|
|
type HookEvent string
|
|
|
|
// Hook event types
|
|
const (
|
|
HookPreInstall HookEvent = "pre-install"
|
|
HookPostInstall HookEvent = "post-install"
|
|
HookPreDelete HookEvent = "pre-delete"
|
|
HookPostDelete HookEvent = "post-delete"
|
|
HookPreUpgrade HookEvent = "pre-upgrade"
|
|
HookPostUpgrade HookEvent = "post-upgrade"
|
|
HookPreRollback HookEvent = "pre-rollback"
|
|
HookPostRollback HookEvent = "post-rollback"
|
|
HookTest HookEvent = "test"
|
|
)
|
|
|
|
func (x HookEvent) String() string { return string(x) }
|
|
|
|
// HookDeletePolicy specifies the hook delete policy
|
|
type HookDeletePolicy string
|
|
|
|
// Hook delete policy types
|
|
const (
|
|
HookSucceeded HookDeletePolicy = "hook-succeeded"
|
|
HookFailed HookDeletePolicy = "hook-failed"
|
|
HookBeforeHookCreation HookDeletePolicy = "before-hook-creation"
|
|
)
|
|
|
|
func (x HookDeletePolicy) String() string { return string(x) }
|
|
|
|
// HookAnnotation is the label name for a hook
|
|
const HookAnnotation = "helm.sh/hook"
|
|
|
|
// HookWeightAnnotation is the label name for a hook weight
|
|
const HookWeightAnnotation = "helm.sh/hook-weight"
|
|
|
|
// HookDeleteAnnotation is the label name for the delete policy for a hook
|
|
const HookDeleteAnnotation = "helm.sh/hook-delete-policy"
|
|
|
|
// Hook defines a hook object.
|
|
type Hook struct {
|
|
Name string `json:"name,omitempty"`
|
|
// Kind is the Kubernetes kind.
|
|
Kind string `json:"kind,omitempty"`
|
|
// Path is the chart-relative path to the template.
|
|
Path string `json:"path,omitempty"`
|
|
// Manifest is the manifest contents.
|
|
Manifest string `json:"manifest,omitempty"`
|
|
// Events are the events that this hook fires on.
|
|
Events []HookEvent `json:"events,omitempty"`
|
|
// LastRun indicates the date/time this was last run.
|
|
LastRun HookExecution `json:"last_run,omitempty"`
|
|
// Weight indicates the sort order for execution among similar Hook type
|
|
Weight int `json:"weight,omitempty"`
|
|
// DeletePolicies are the policies that indicate when to delete the hook
|
|
DeletePolicies []HookDeletePolicy `json:"delete_policies,omitempty"`
|
|
}
|
|
|
|
// A HookExecution records the result for the last execution of a hook for a given release.
|
|
type HookExecution struct {
|
|
// StartedAt indicates the date/time this hook was started
|
|
StartedAt time.Time `json:"started_at,omitempty"`
|
|
// CompletedAt indicates the date/time this hook was completed.
|
|
CompletedAt time.Time `json:"completed_at,omitempty"`
|
|
// Phase indicates whether the hook completed successfully
|
|
Phase HookPhase `json:"phase"`
|
|
}
|
|
|
|
// A HookPhase indicates the state of a hook execution
|
|
type HookPhase string
|
|
|
|
const (
|
|
// HookPhaseUnknown indicates that a hook is in an unknown state
|
|
HookPhaseUnknown HookPhase = "Unknown"
|
|
// HookPhaseRunning indicates that a hook is currently executing
|
|
HookPhaseRunning HookPhase = "Running"
|
|
// HookPhaseSucceeded indicates that hook execution succeeded
|
|
HookPhaseSucceeded HookPhase = "Succeeded"
|
|
// HookPhaseFailed indicates that hook execution failed
|
|
HookPhaseFailed HookPhase = "Failed"
|
|
)
|
|
|
|
// String converts a hook phase to a printable string
|
|
func (x HookPhase) String() string { return string(x) }
|