events

Documentation

Index

• func GetEventTypes() []string
• type DeploymentEventData
• type DryRunAdditionalInfo
• type DryRunData
• type EventHookMessage
  • func (m *EventHookMessage) DeploymentId() (uint, error)
  • func (m *EventHookMessage) SetSubject(deploymentId uint, stageId *uuid.UUID)
• type EventType
  • func (e EventType) String() string

Functions

func GetEventTypes

func GetEventTypes() []string

Types

type DeploymentEventData

type DeploymentEventData struct {
	DeploymentId int        `json:"deploymentId,omitempty" mapstructure:"deploymentId"`
	StageId      *uuid.UUID `json:"stageId,omitempty" mapstructure:"stageId"`
	OperationId  uuid.UUID  `json:"operationId,omitempty" mapstructure:"operationId"`

	// the correlation ID used to track azure deployments. This may be nil if the particular event data is about something that
	// happened inside MODM and not azure.
	CorrelationId *uuid.UUID `json:"correlationId,omitempty" mapstructure:"correlationId"`
	Attempts      int        `json:"attempts,omitempty" mapstructure:"attempts"`
	Message       string     `json:"message,omitempty" mapstructure:"message"`
}

type DryRunAdditionalInfo

type DryRunAdditionalInfo struct {
	Info interface{} `json:"info,omitempty"`
	Type string      `json:"type,omitempty"`
}

Dry run message that's part of the dry run data, containing details of the specific dry run results

type DryRunData

type DryRunData struct {
	Status         string                 `json:"status,omitempty"`
	AdditionalInfo []DryRunAdditionalInfo `json:"additionalInfo,omitempty"`
}

Dry run data

type EventHookMessage

type EventHookMessage struct {
	// the ID of the message
	Id uuid.UUID `json:"id,omitempty"`

	// the ID of the hook
	HookId uuid.UUID `json:"hookId,omitempty"`

	// the type of the event, .e.g. "dryRunCompleted"
	Type string `json:"type,omitempty"`

	// the status of the event, e.g. "success"
	Status string `json:"status,omitempty"`

	// subject is in format like /deployments/{deploymentId}/stages/{stageId}/operations/{operationName}
	// /deployments/{deploymentId}/operations/{operationName}
	Subject string `json:"subject,omitempty"`
	Data    any    `json:"data,omitempty"`
}

subscription model for MODM webhook events

func (*EventHookMessage) DeploymentId

func (m *EventHookMessage) DeploymentId() (uint, error)

func (*EventHookMessage) SetSubject

func (m *EventHookMessage) SetSubject(deploymentId uint, stageId *uuid.UUID)

type EventType

type EventType string

Defines an event that occurs in MODM

const (
	EventTypeDeploymentCreated   EventType = "deploymentCreated"
	EventTypeDeploymentUpdated   EventType = "deploymentUpdated"
	EventTypeDeploymentDeleted   EventType = "deploymentDeleted"
	EventTypeDeploymentStarted   EventType = "deploymentStarted"
	EventTypeDeploymentCompleted EventType = "deploymentCompleted"
	EventTypeStageCompleted      EventType = "stageCompleted"

	EventTypeDeploymentRetried EventType = "deploymentRetried"
	EventTypeDryRunCompleted   EventType = "dryRunCompleted"

	EventTypeDeploymentOperationReceived EventType = "deploymentOperationReceived"
	EventTypeDeploymentEventReceived     EventType = "deploymentEventReceived"
)

the list of available / known event types

func (EventType) String

func (e EventType) String() string