Documentation
¶
Index ¶
- Constants
- type Canary
- type CanaryAction
- type ConfigurationChangeEventData
- type ConfigureMonitoringEventData
- type DeploymentStrategy
- type EvaluationStartEventData
- type ProblemEventData
- type ProjectCreateEventData
- type ProjectDeleteEventData
- type PropertyChange
- type ServiceCreateEventData
- type TestsFinishedEventData
Constants ¶
const ConfigurationChangeEventType = "sh.keptn.event.configuration.change"
ConfigurationChangeEventType is a CloudEvent type for changing the configuration
const ConfigureMonitoringEventType = "sh.keptn.event.monitoring.configure"
ConfigureMonitoringEventType is a CloudEvent for configuring monitoring
const DeploymentFinishedEventType = "sh.keptn.events.deployment-finished"
DeploymentFinishedEventType is a CloudEvent for indicating that the deployment has finished
const EvaluationDoneEventType = "sh.keptn.events.evaluation-done"
EvaluationDoneEventType is a CloudEvent for indicating that the evaluation has finished
const EvaluationStartEventType = "sh.keptn.event.evaluation.start"
EvaluationStartEventType is a CloudEvent to trigger an evaluation step
const InternalProjectCreateEventType = "sh.keptn.internal.event.project.create"
InternalProjectCreateEventType is a CloudEvent type for creating a new project
const InternalProjectDeleteEventType = "sh.keptn.internal.event.project.delete"
InternalProjectDeleteEventType is a CloudEvent type for deleting a project
const InternalServiceCreateEventType = "sh.keptn.internal.event.service.create"
InternalServiceCreateEventType is a CloudEvent type for creating a new service
const ProblemOpenEventType = "sh.keptn.event.problem.open"
ProblemOpenEventType is a CloudEvent type to inform about an open problem
const ProjectCreateEventType = "sh.keptn.event.project.create"
ProjectCreateEventType is a CloudEvent type for creating a new project
const ProjectDeleteEventType = "sh.keptn.event.project.delete"
ProjectDeleteEventType is a CloudEvent type for deleting a project
const ServiceCreateEventType = "sh.keptn.event.service.create"
ServiceCreateEventType is a CloudEvent type for creating a new service
const TestFinishedEventType_0_5_0_Compatible = "sh.keptn.events.tests-finished"
TestFinishedEventType_0_5_0_Compatible is a CloudEvent for indicating that tests have finished
const TestsFinishedEventType = "sh.keptn.event.tests.finished"
TestsFinishedEventType is a CloudEvent for indicating that tests have finished
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Canary ¶
type Canary struct {
// Value represents the traffic percentage on the canary
Value int32 `json:"value,omitempty"`
// Action represents the action of the canary
Action CanaryAction `json:"action"`
}
Canary describes the new configuration in a canary release
type CanaryAction ¶
type CanaryAction int
CanaryAction describes the excution of a canary release
const ( // Set is used for setting a new traffic weight for the canary Set CanaryAction = iota // Promote is used for promoting the canary Promote // Discard is used for discarding the canary Discard )
func (CanaryAction) MarshalJSON ¶
func (s CanaryAction) MarshalJSON() ([]byte, error)
MarshalJSON marshals the enum as a quoted json string
func (CanaryAction) String ¶
func (s CanaryAction) String() string
func (*CanaryAction) UnmarshalJSON ¶
func (s *CanaryAction) UnmarshalJSON(b []byte) error
UnmarshalJSON unmashals a quoted json string to the enum value
type ConfigurationChangeEventData ¶
type ConfigurationChangeEventData struct {
// Project is the name of the project
Project string `json:"project"`
// Service is the name of the new service
Service string `json:"service"`
// Stage is the name of the stage
Stage string `json:"stage"`
// ValuesCanary contains new Helm values for canary
ValuesCanary map[string]interface{} `json:"valuesCanary,omitempty"`
// Canary contains a new configuration for canary releases
Canary *Canary `json:"canary,omitempty"`
// DeploymentChanges contains changes of the primary deployment
DeploymentChanges []PropertyChange `json:"deploymentChanges,omitempty"`
}
ConfigurationChangeEventData represents the data for changing the service configuration
type ConfigureMonitoringEventData ¶
type ConfigureMonitoringEventData struct {
Type string `json:"type"`
Project string `json:"project"`
Service string `json:"service"`
ServiceIndicators *models.ServiceIndicators `json:"serviceIndicators"`
ServiceObjectives *models.ServiceObjectives `json:"serviceObjectives"`
Remediation *models.Remediations `json:"remediation"`
}
ConfigureMonitoringEventData represents the data necessary to configure monitoring for a service
type DeploymentStrategy ¶
type DeploymentStrategy int
DeploymentStrategy describes how a keptn-managed service is deployed
const ( // Direct stores the chart which results in the Direct DeploymentStrategy = iota + 1 // Duplicate generates a second chart in order to duplicate the deployments Duplicate )
func GetDeploymentStrategy ¶ added in v0.2.3
func GetDeploymentStrategy(deploymentStrategy string) (DeploymentStrategy, error)
GetDeploymentStrategy tries to parse the deployment strategy into the enum If the provided deployment strategy is unsupported, an error is returned
func (DeploymentStrategy) MarshalJSON ¶
func (s DeploymentStrategy) MarshalJSON() ([]byte, error)
MarshalJSON marshals the enum as a quoted json string
func (DeploymentStrategy) String ¶
func (s DeploymentStrategy) String() string
func (*DeploymentStrategy) UnmarshalJSON ¶
func (s *DeploymentStrategy) UnmarshalJSON(b []byte) error
UnmarshalJSON unmashals a quoted json string to the enum value
type EvaluationStartEventData ¶ added in v0.2.3
type EvaluationStartEventData struct {
// Project is the name of the project
Project string `json:"project"`
// Service is the name of the new service
Service string `json:"service"`
}
EvaluationStartEventData represents the data for a evaluation start event
type ProblemEventData ¶
type ProblemEventData struct {
State string `json:"state"`
ProblemID string `json:"problemID"`
ProblemTitle string `json:"problemtitle"`
ProblemDetails string `json:"problemdetails"`
ImpactedEntity string `json:"impactedEntity"`
}
ProblemEventData represents the data for describing a problem
type ProjectCreateEventData ¶
type ProjectCreateEventData struct {
// Project is the name of the project
Project string `json:"project"`
// Shipyard is a base64 encoded string of the shipyard file
Shipyard string `json:"shipyard"`
// GitUser is the name of a git user of an upstream repository
GitUser string `json:"gitUser,omitempty"`
// GitToken is the authentication token for the git user
GitToken string `json:"gitToken,omitempty"`
// GitRemoteURL is the remote url of a repository
GitRemoteURL string `json:"gitRemoteURL,omitempty"`
}
ProjectCreateEventData represents the data for creating a new project
type ProjectDeleteEventData ¶
type ProjectDeleteEventData struct {
// Project is the name of the project
Project string `json:"project"`
}
ProjectDeleteEventData represents the data for deleting a new project
type PropertyChange ¶
type PropertyChange struct {
PropertyPath string `json:"propertyPath"`
Value interface{} `json:"value"`
}
PropertyChange describes the property to be changed
type ServiceCreateEventData ¶
type ServiceCreateEventData struct {
// Project is the name of the project
Project string `json:"project"`
// Service is the name of the new service
Service string `json:"service"`
// HelmChart are the data of a Helm chart packed as tgz and base64 encoded
HelmChart string `json:"helmChart"`
// DeploymentStrategies contains the deployment strategy for the stages
DeploymentStrategies map[string]DeploymentStrategy `json:"deploymentStrategies"`
}
ServiceCreateEventData represents the data for creating a new service
type TestsFinishedEventData ¶
type TestsFinishedEventData struct {
// Project is the name of the project
Project string `json:"project"`
// Service is the name of the new service
Service string `json:"service"`
// Stage is the name of the stage
Stage string `json:"stage"`
// TestStrategy is the testing strategy
TestStrategy string `json:"teststrategy"`
}
TestsFinishedEventData represents the data for a test finished event
Source Files