models

Documentation

Index

• Constants
• type Application
  • func (app *Application) GetRolloutMessage(status string, rolloutImages []string) string
  • func (app *Application) GetRolloutStatus(rolloutImages []string, registryProxyUrl string, acceptSuspended bool) string
  • func (app *Application) IsManagedByWatcher() bool
  • func (app *Application) ListSyncResultResources() []string
  • func (app *Application) ListUnhealthyResources() []string
  • func (app *Application) UpdateGitImageTag(task *Task) error
• type ApplicationMetadata
• type ApplicationOperationResource
• type ApplicationResource
• type ApplicationSource
• type ApplicationSpec
• type ApplicationStatus
• type ApplicationStatusOperationState
• type ArgoApiErrorResponse
• type GitopsRepo
  • func NewGitopsRepo(app *Application) (GitopsRepo, error)
• type HealthStatus
• type Image
• type LockdownSchedule
• type SavedAppStatus
• type Task
  • func (task *Task) IsAppNotFoundError(err error) bool
  • func (task *Task) ListImages() []string
• type TaskStatus
• type TasksResponse
• type Userinfo

Constants

const (
	ArgoRolloutAppSuccess      = "success"
	ArgoRolloutAppNotSynced    = "not synced"
	ArgoRolloutAppNotAvailable = "not available"
	ArgoRolloutAppNotHealthy   = "not healthy"
	ArgoRolloutAppDegraded     = "degraded"
)

const (
	StatusAppNotFoundMessage       = "app not found"
	StatusInProgressMessage        = "in progress"
	StatusFailedMessage            = "failed"
	StatusAborted                  = "aborted"
	StatusArgoCDUnavailableMessage = "argocd is unavailable"
	StatusConnectionUnavailable    = "cannot connect to database"
	StatusArgoCDFailedLogin        = "failed to login to argocd"
	StatusDeployedMessage          = "deployed"
	StatusAccepted                 = "accepted"
)

Types

type Application

type Application struct {
	Metadata ApplicationMetadata `json:"metadata"`
	Spec     ApplicationSpec     `json:"spec"`
	Status   ApplicationStatus   `json:"status"`
}

func (*Application) GetRolloutMessage

func (app *Application) GetRolloutMessage(status string, rolloutImages []string) string

GetRolloutMessage generates rollout failure message.

func (*Application) GetRolloutStatus

func (app *Application) GetRolloutStatus(rolloutImages []string, registryProxyUrl string, acceptSuspended bool) string

GetRolloutStatus calculates application rollout status depending on the expected images and proxy configuration.

func (*Application) IsManagedByWatcher

func (app *Application) IsManagedByWatcher() bool

IsManagedByWatcher checks if the application is managed by the watcher. It checks if the application's metadata contains the "argo-watcher/managed" annotation with the value "true".

func (*Application) ListSyncResultResources

func (app *Application) ListSyncResultResources() []string

ListSyncResultResources returns a list of strings representing the sync result resources of the application. Each string in the list contains information about the resource's kind, name, hook type, hook phase, and message. The information is formatted as "{kind}({name}) {hookType} {hookPhase} with message {message}". The list is generated based on the Application's status and its operation state's sync result resources.

func (*Application) ListUnhealthyResources

func (app *Application) ListUnhealthyResources() []string

ListUnhealthyResources returns a list of strings representing the unhealthy resources of the application. Each string in the list contains information about the resource's kind, name, and health status. If available, the resource's health message is also included in the string. The format of each string is "{kind}({name}) {status}" or "{kind}({name}) {status} with message {message}". The list is generated based on the Application's status and its resources with non-empty health status.

func (*Application) UpdateGitImageTag

func (app *Application) UpdateGitImageTag(task *Task) error

type ApplicationMetadata

type ApplicationMetadata struct {
	Name        string            `json:"name"`
	Annotations map[string]string `json:"annotations"`
}

type ApplicationOperationResource

type ApplicationOperationResource struct {
	HookPhase string `json:"hookPhase"` // example: Failed
	HookType  string `json:"hookType"`  // example: PreSync
	Kind      string `json:"kind"`      // example: Pod | Job
	Message   string `json:"message"`   // example: Job has reached the specified backoff limit
	Status    string `json:"status"`    // example: Synced
	SyncPhase string `json:"syncPhase"` // example: PreSync
	Name      string `json:"name"`      // example: app-migrations
	Namespace string `json:"namespace"` // example: app
}

type ApplicationResource

type ApplicationResource struct {
	Kind      string `json:"kind"`      // example: Pod | Job
	Name      string `json:"name"`      // example: app-migrations
	Namespace string `json:"namespace"` // example: app
	Health    struct {
		Message string `json:"message"` // example: Job has reached the specified backoff limit
		Status  string `json:"status"`  // example: Synced
	} `json:"health"`
}

type ApplicationSource

type ApplicationSource struct {
	RepoURL        string `json:"repoURL"`
	TargetRevision string `json:"targetRevision"`
	Path           string `json:"path"`
}

type ApplicationSpec

type ApplicationSpec struct {
	Source  ApplicationSource   `json:"source"`
	Sources []ApplicationSource `json:"sources"`
}

type ApplicationStatus

type ApplicationStatus struct {
	Health struct {
		Status string `json:"status"`
	}
	OperationState ApplicationStatusOperationState `json:"operationState"`
	Resources      []ApplicationResource           `json:"resources"`
	Summary        struct {
		Images []string `json:"images"`
	}
	Sync struct {
		Status string `json:"status"`
	}
}

type ApplicationStatusOperationState

type ApplicationStatusOperationState struct {
	Phase      string `json:"phase"`
	Message    string `json:"message"`
	SyncResult struct {
		Resources []ApplicationOperationResource `json:"resources"`
	} `json:"syncResult"`
}

type ArgoApiErrorResponse

type ArgoApiErrorResponse struct {
	Error   string `json:"error"`
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

type GitopsRepo

type GitopsRepo struct {
	RepoUrl    string `validate:"required"`
	BranchName string `validate:"required"`
	Path       string `validate:"required"`
	Filename   string
}

func NewGitopsRepo

func NewGitopsRepo(app *Application) (GitopsRepo, error)

type HealthStatus

type HealthStatus struct {
	Status string `json:"status"`
}

type Image

type Image struct {
	Image string `json:"image" example:"ghcr.io/shini4i/argo-watcher"`
	Tag   string `json:"tag" example:"dev"`
}

type LockdownSchedule

type LockdownSchedule struct {
	Cron     string `json:"cron" example:"0 2 * * *"`
	Duration string `json:"duration" example:"2h"`
}

type SavedAppStatus

type SavedAppStatus struct {
	Status     string `json:"app_status"`
	ImagesHash []byte `json:"app_hash"`
}

type Task

type Task struct {
	Id             string         `json:"id,omitempty"`
	Created        float64        `json:"created,omitempty"`
	Updated        float64        `json:"updated,omitempty"`
	App            string         `json:"app" binding:"required" example:"argo-watcher"`
	Author         string         `json:"author" binding:"required" example:"John Doe"`
	Project        string         `json:"project" binding:"required" example:"Demo"`
	Images         []Image        `json:"images" binding:"required"`
	Status         string         `json:"status,omitempty"`
	StatusReason   string         `json:"status_reason,omitempty"`
	Validated      bool           `json:"validated,omitempty"`
	SavedAppStatus SavedAppStatus `json:"-"`
}

func (*Task) IsAppNotFoundError

func (task *Task) IsAppNotFoundError(err error) bool

IsAppNotFoundError check if app not found error.

func (*Task) ListImages

func (task *Task) ListImages() []string

ListImages returns a list of strings representing the images of the task. Each string in the list is in the format "{image}:{tag}". The list is generated based on the Task's Images field.

type TaskStatus

type TaskStatus struct {
	Id           string  `json:"id,omitempty"`
	Created      float64 `json:"created,omitempty"`
	Updated      float64 `json:"updated,omitempty"`
	App          string  `json:"app,omitempty" binding:"required" example:"argo-watcher"`
	Author       string  `json:"author,omitempty" binding:"required" example:"John Doe"`
	Project      string  `json:"project,omitempty" binding:"required" example:"Demo"`
	Images       []Image `json:"images,omitempty" binding:"required"`
	Status       string  `json:"status,omitempty"`
	StatusReason string  `json:"status_reason,omitempty"`
	Error        string  `json:"error,omitempty"`
}

type TasksResponse

type TasksResponse struct {
	Tasks []Task `json:"tasks"`
	Error string `json:"error,omitempty"`
}

type Userinfo

type Userinfo struct {
	LoggedIn bool   `json:"loggedIn"`
	Username string `json:"username"`
}