package v1 import ( "bufio" "encoding/base64" "encoding/json" "errors" "fmt" sq "github.com/Masterminds/squirrel" "github.com/ghodss/yaml" "github.com/hashicorp/go-uuid" "github.com/onepanelio/core/pkg/util/label" "github.com/onepanelio/core/pkg/util/pagination" "github.com/onepanelio/core/pkg/util/ptr" "io" "io/ioutil" "net/http" "regexp" "strconv" "strings" "time" wfv1 "github.com/argoproj/argo/pkg/apis/workflow/v1alpha1" "github.com/argoproj/argo/workflow/common" "github.com/argoproj/argo/workflow/templateresolution" argoutil "github.com/argoproj/argo/workflow/util" "github.com/argoproj/argo/workflow/validate" argojson "github.com/argoproj/pkg/json" "github.com/onepanelio/core/pkg/util" "github.com/onepanelio/core/pkg/util/env" "github.com/onepanelio/core/pkg/util/s3" log "github.com/sirupsen/logrus" "google.golang.org/grpc/codes" corev1 "k8s.io/api/core/v1" k8serrors "k8s.io/apimachinery/pkg/api/errors" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/fields" _ "k8s.io/client-go/plugin/pkg/client/auth" ) var ( readEndOffset = env.GetEnv("ARTIFACT_RERPOSITORY_OBJECT_RANGE", "-102400") workflowTemplateUIDLabelKey = "onepanel.io/workflow-template-uid" workflowTemplateVersionLabelKey = "onepanel.io/workflow-template-version" ) func typeWorkflow(wf *wfv1.Workflow) (workflow *WorkflowExecution) { manifest, err := json.Marshal(wf) if err != nil { return } workflow = &WorkflowExecution{ UID: string(wf.UID), CreatedAt: wf.CreationTimestamp.UTC(), Name: wf.Name, Manifest: string(manifest), } return } func UnmarshalWorkflows(wfBytes []byte, strict bool) (wfs []wfv1.Workflow, err error) { if len(wfBytes) == 0 { return nil, fmt.Errorf("UnmarshalWorkflows unable to work on empty bytes") } var wf wfv1.Workflow var jsonOpts []argojson.JSONOpt if strict { jsonOpts = append(jsonOpts, argojson.DisallowUnknownFields) } wfBytes, err = filterOutCustomTypesFromManifest(wfBytes) if err != nil { return } err = argojson.Unmarshal(wfBytes, &wf, jsonOpts...) if err == nil { return []wfv1.Workflow{wf}, nil } wfs, err = common.SplitWorkflowYAMLFile(wfBytes, strict) if err == nil { return } return } func addSystemUIDParameter(wf *wfv1.Workflow) { for _, p := range wf.Spec.Arguments.Parameters { if p.Name == "sys-uid" { return } } uid := wf.Labels[label.WorkflowUid] if uid == "" { uid = "00000000-0000-0000-0000-000000000000" } if wf.Spec.Arguments.Parameters == nil { wf.Spec.Arguments.Parameters = make([]wfv1.Parameter, 0) } wf.Spec.Arguments.Parameters = append(wf.Spec.Arguments.Parameters, wfv1.Parameter{ Name: "sys-uid", Value: ptr.String(uid), }) return } func addEnvToTemplate(template *wfv1.Template, key string, value string) { //Flag to prevent over-writing user's envs overwriteUserEnv := true for _, templateEnv := range template.Container.Env { if templateEnv.Name == key { overwriteUserEnv = false break } } if overwriteUserEnv { template.Container.Env = append(template.Container.Env, corev1.EnvVar{ Name: key, Value: value, }) } } func (c *Client) injectAutomatedFields(namespace string, wf *wfv1.Workflow, opts *WorkflowExecutionOptions) (err error) { if opts.PodGCStrategy == nil { if wf.Spec.PodGC == nil { //TODO - Load this data from onepanel config-map or secret podGCStrategy := env.GetEnv("ARGO_POD_GC_STRATEGY", "OnPodCompletion") strategy := PodGCStrategy(podGCStrategy) wf.Spec.PodGC = &wfv1.PodGC{ Strategy: strategy, } } } else { wf.Spec.PodGC = &wfv1.PodGC{ Strategy: *opts.PodGCStrategy, } } addSystemUIDParameter(wf) addSecretValsToTemplate := true secret, err := c.GetSecret(namespace, "onepanel-default-env") if err != nil { var statusError *k8serrors.StatusError if errors.As(err, &statusError) { if statusError.ErrStatus.Reason == "NotFound" { addSecretValsToTemplate = false } else { return err } } else { return err } } // Create dev/shm volume wf.Spec.Volumes = append(wf.Spec.Volumes, corev1.Volume{ Name: "sys-dshm", VolumeSource: corev1.VolumeSource{ EmptyDir: &corev1.EmptyDirVolumeSource{ Medium: corev1.StorageMediumMemory, }, }, }) for i, template := range wf.Spec.Templates { // Do not inject Istio sidecars in workflows if template.Metadata.Annotations == nil { wf.Spec.Templates[i].Metadata.Annotations = make(map[string]string) } wf.Spec.Templates[i].Metadata.Annotations["sidecar.istio.io/inject"] = "false" if template.Container == nil { continue } // Mount dev/shm wf.Spec.Templates[i].Container.VolumeMounts = append(template.Container.VolumeMounts, corev1.VolumeMount{ Name: "sys-dshm", MountPath: "/dev/shm", }) // Always add output artifacts for metrics but make them optional wf.Spec.Templates[i].Outputs.Artifacts = append(template.Outputs.Artifacts, wfv1.Artifact{ Name: "sys-metrics", Path: "/tmp/sys-metrics.json", Optional: true, Archive: &wfv1.ArchiveStrategy{ None: &wfv1.NoneStrategy{}, }, }) if !addSecretValsToTemplate { continue } //Generate ENV vars from secret, if there is a container present in the workflow //Get template ENV vars, avoid over-writing them with secret values for key, value := range secret.Data { decodedValue, errDecode := base64.StdEncoding.DecodeString(value) if errDecode != nil { return errDecode } addEnvToTemplate(&template, key, string(decodedValue)) } sysConfig, sysErr := c.GetSystemConfig() if sysErr != nil { return sysErr } addEnvToTemplate(&template, "ONEPANEL_API_URL", sysConfig["ONEPANEL_API_URL"]) addEnvToTemplate(&template, "ONEPANEL_FQDN", sysConfig["ONEPANEL_FQDN"]) addEnvToTemplate(&template, "ONEPANEL_DOMAIN", sysConfig["ONEPANEL_DOMAIN"]) addEnvToTemplate(&template, "PROVIDER_TYPE", sysConfig["PROVIDER_TYPE"]) } return } func (c *Client) createWorkflow(namespace string, workflowTemplateId uint64, workflowTemplateVersionId uint64, wf *wfv1.Workflow, opts *WorkflowExecutionOptions) (newDbId uint64, createdWorkflow *wfv1.Workflow, err error) { if opts == nil { opts = &WorkflowExecutionOptions{} } if opts.Name != "" { wf.ObjectMeta.Name = opts.Name } if opts.GenerateName != "" { wf.ObjectMeta.GenerateName = opts.GenerateName } if opts.Entrypoint != "" { wf.Spec.Entrypoint = opts.Entrypoint } if opts.ServiceAccount != "" { wf.Spec.ServiceAccountName = opts.ServiceAccount } if len(opts.Parameters) > 0 { newParams := make([]wfv1.Parameter, 0) passedParams := make(map[string]bool) for _, param := range opts.Parameters { newParams = append(newParams, wfv1.Parameter{ Name: param.Name, Value: param.Value, }) passedParams[param.Name] = true } for _, param := range wf.Spec.Arguments.Parameters { if _, ok := passedParams[param.Name]; ok { // this parameter was overridden via command line continue } newParams = append(newParams, param) } wf.Spec.Arguments.Parameters = newParams } if opts.Labels != nil { wf.ObjectMeta.Labels = *opts.Labels } err = injectExitHandlerWorkflowExecutionStatistic(wf, namespace, &workflowTemplateId) if err != nil { return 0, nil, err } if err = c.injectAutomatedFields(namespace, wf, opts); err != nil { return 0, nil, err } createdWorkflow, err = c.ArgoprojV1alpha1().Workflows(namespace).Create(wf) if err != nil { return 0, nil, err } uid := wf.Labels[label.WorkflowUid] //Create an entry for workflow_executions statistic //CURL code will hit the API endpoint that will update the db row newDbId, err = c.insertPreWorkflowExecutionStatistic(namespace, createdWorkflow.Name, workflowTemplateVersionId, createdWorkflow.CreationTimestamp.UTC(), uid, opts.Parameters) if err != nil { return 0, nil, err } return } func (c *Client) ValidateWorkflowExecution(namespace string, manifest []byte) (err error) { manifest, err = filterOutCustomTypesFromManifest(manifest) if err != nil { return } workflows, err := UnmarshalWorkflows(manifest, true) if err != nil { return } wftmplGetter := templateresolution.WrapWorkflowTemplateInterface(c.ArgoprojV1alpha1().WorkflowTemplates(namespace)) for _, wf := range workflows { c.injectAutomatedFields(namespace, &wf, &WorkflowExecutionOptions{}) _, err = validate.ValidateWorkflow(wftmplGetter, &wf, validate.ValidateOpts{}) if err != nil { return } // Check that entrypoint and onExit templates are DAGs for _, t := range wf.Spec.Templates { if t.Name == wf.Spec.Entrypoint && t.DAG == nil { return errors.New("\"entrypoint\" template should be a DAG") } if wf.Spec.OnExit != "" && t.Name == wf.Spec.OnExit && t.DAG == nil { return errors.New("\"onExit\" template should be a DAG") } } } return } func (c *Client) CreateWorkflowExecution(namespace string, workflow *WorkflowExecution) (*WorkflowExecution, error) { workflowTemplate, err := c.GetWorkflowTemplate(namespace, workflow.WorkflowTemplate.UID, workflow.WorkflowTemplate.Version) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Workflow": workflow, "Error": err.Error(), }).Error("Error with getting workflow template.") return nil, util.NewUserError(codes.NotFound, "Error with getting workflow template.") } // TODO: Need to pull system parameters from k8s config/secret here, example: HOST opts := &WorkflowExecutionOptions{ Labels: &map[string]string{}, Parameters: workflow.Parameters, } re, _ := regexp.Compile(`[^a-zA-Z0-9-]{1,}`) opts.GenerateName = strings.ToLower(re.ReplaceAllString(workflowTemplate.Name, `-`)) + "-" workflowUid, err := uuid.GenerateUUID() if err != nil { return nil, err } (*opts.Labels)[workflowTemplateUIDLabelKey] = workflowTemplate.UID (*opts.Labels)[workflowTemplateVersionLabelKey] = fmt.Sprint(workflowTemplate.Version) (*opts.Labels)[label.WorkflowUid] = workflowUid label.MergeLabelsPrefix(*opts.Labels, workflow.Labels, label.TagPrefix) // @todo we need to enforce the below requirement in API. //UX will prevent multiple workflows manifest, err := workflowTemplate.GetWorkflowManifestBytes() if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "WorkflowTemplate": workflowTemplate, "Error": err.Error(), }).Error("Error with getting WorkflowManifest from workflow template") return nil, err } workflows, err := UnmarshalWorkflows(manifest, true) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Workflow": workflow, "Error": err.Error(), }).Error("Error parsing workflow.") return nil, err } id, createdWorkflow, err := c.createWorkflow(namespace, workflowTemplate.ID, workflowTemplate.WorkflowTemplateVersionId, &workflows[0], opts) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Workflow": workflow, "Error": err.Error(), }).Error("Error parsing workflow.") return nil, err } if len(workflow.Labels) > 0 { _, err = c.InsertLabelsBuilder(TypeWorkflowExecution, id, workflow.Labels). RunWith(c.DB). Exec() if err != nil { return nil, err } } if createdWorkflow == nil { err = errors.New("unable to create workflow") log.WithFields(log.Fields{ "Namespace": namespace, "WorkflowTemplate": workflowTemplate, "Error": err.Error(), }).Error("Error parsing workflow.") return nil, err } workflow.ID = id workflow.Name = createdWorkflow.Name workflow.CreatedAt = createdWorkflow.CreationTimestamp.UTC() workflow.UID = workflowUid workflow.WorkflowTemplate = workflowTemplate // Manifests could get big, don't return them in this case. workflow.WorkflowTemplate.Manifest = "" return workflow, nil } func (c *Client) CloneWorkflowExecution(namespace, name string) (*WorkflowExecution, error) { workflowExecution, err := c.getWorkflowExecutionAndTemplate(namespace, name) if err != nil { return nil, err } return c.CreateWorkflowExecution(namespace, workflowExecution) } func (c *Client) insertPreWorkflowExecutionStatistic(namespace, name string, workflowTemplateVersionId uint64, createdAt time.Time, uid string, parameters []Parameter) (newId uint64, err error) { tx, err := c.DB.Begin() if err != nil { return 0, err } defer tx.Rollback() parametersJson, err := json.Marshal(parameters) if err != nil { return 0, err } insertMap := sq.Eq{ "uid": uid, "workflow_template_version_id": workflowTemplateVersionId, "name": name, "namespace": namespace, "created_at": createdAt.UTC(), "phase": wfv1.NodePending, "parameters": string(parametersJson), } err = sb.Insert("workflow_executions"). SetMap(insertMap). Suffix("RETURNING id"). RunWith(tx). QueryRow(). Scan(&newId) if err != nil { return 0, err } err = tx.Commit() if err != nil { return 0, err } return newId, err } func (c *Client) FinishWorkflowExecutionStatisticViaExitHandler(namespace, name string, workflowTemplateID int64, phase wfv1.NodePhase, startedAt time.Time) (err error) { tx, err := c.DB.Begin() if err != nil { return err } defer tx.Rollback() updateMap := sq.Eq{ "started_at": startedAt.UTC(), "name": name, "namespace": namespace, "finished_at": time.Now().UTC(), "phase": phase, } _, err = sb.Update("workflow_executions"). SetMap(updateMap).Where(sq.Eq{"name": name}).RunWith(tx).Exec() if err != nil { return err } err = tx.Commit() if err != nil { return err } return err } func (c *Client) CronStartWorkflowExecutionStatisticInsert(namespace, name string, workflowTemplateID int64) (err error) { query, args, err := c.workflowTemplatesSelectBuilder(namespace). Where(sq.Eq{ "wt.id": workflowTemplateID, }). ToSql() if err != nil { return err } workflowTemplate := &WorkflowTemplate{} if err := c.DB.Get(workflowTemplate, query, args...); err != nil { return err } query, args, err = c.cronWorkflowSelectBuilder(namespace, workflowTemplate.UID).ToSql() if err != nil { return err } cronWorkflow := &CronWorkflow{} if err := c.DB.Get(cronWorkflow, query, args...); err != nil { return err } cronLabels, err := c.GetDbLabels(TypeCronWorkflow, cronWorkflow.ID) if err != nil { return err } tx, err := c.DB.Begin() if err != nil { return err } defer tx.Rollback() parametersJson, err := cronWorkflow.GetParametersFromWorkflowSpecJson() if err != nil { return err } cronUid, err := uuid.GenerateUUID() if err != nil { return err } insertMap := sq.Eq{ "uid": cronUid, "workflow_template_version_id": cronWorkflow.WorkflowTemplateVersionId, "name": name, "namespace": namespace, "phase": wfv1.NodePending, "cron_workflow_id": cronWorkflow.ID, "parameters": string(parametersJson), } workflowExecutionId := uint64(0) err = sb.Insert("workflow_executions"). SetMap(insertMap). Suffix("RETURNING id"). RunWith(tx). QueryRow(). Scan(&workflowExecutionId) if err != nil { return err } if len(cronLabels) > 0 { labelsMapped := LabelsToMapping(cronLabels...) _, err = c.InsertLabelsBuilder(TypeWorkflowExecution, workflowExecutionId, labelsMapped). RunWith(tx). Exec() if err != nil { return err } } err = tx.Commit() if err != nil { return err } return err } func (c *Client) GetWorkflowExecution(namespace, name string) (workflow *WorkflowExecution, err error) { workflow = &WorkflowExecution{} query, args, err := sb.Select(getWorkflowExecutionColumns("we", "")...). From("workflow_executions we"). Join("workflow_template_versions wtv ON wtv.id = we.workflow_template_version_id"). Join("workflow_templates wt ON wt.id = wtv.workflow_template_id"). Where(sq.Eq{ "wt.namespace": namespace, "we.name": name, }). ToSql() if err != nil { return nil, err } if err := c.DB.Get(workflow, query, args...); err != nil { return nil, err } wf, err := c.ArgoprojV1alpha1().Workflows(namespace).Get(name, metav1.GetOptions{}) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Workflow not found.") return nil, util.NewUserError(codes.NotFound, "Workflow not found.") } uid := wf.ObjectMeta.Labels[workflowTemplateUIDLabelKey] version, err := strconv.ParseInt( wf.ObjectMeta.Labels[workflowTemplateVersionLabelKey], 10, 32, ) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Invalid version number.") return nil, util.NewUserError(codes.InvalidArgument, "Invalid version number.") } workflowTemplate, err := c.GetWorkflowTemplate(namespace, uid, version) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Cannot get Workflow Template.") return nil, util.NewUserError(codes.NotFound, "Cannot get Workflow Template.") } // TODO: Do we need to parse parameters into workflow.Parameters? manifest, err := json.Marshal(wf) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Invalid status.") return nil, util.NewUserError(codes.InvalidArgument, "Invalid status.") } workflow.Manifest = string(manifest) workflow.WorkflowTemplate = workflowTemplate return } func (c *Client) ListWorkflowExecutions(namespace, workflowTemplateUID, workflowTemplateVersion string, paginator *pagination.PaginationRequest) (workflows []*WorkflowExecution, err error) { sb := workflowExecutionsSelectBuilder(namespace, workflowTemplateUID, workflowTemplateVersion). OrderBy("we.created_at DESC") sb = *paginator.ApplyToSelect(&sb) query, args, err := sb.ToSql() if err != nil { return nil, err } if err := c.DB.Select(&workflows, query, args...); err != nil { return nil, err } return } func (c *Client) CountWorkflowExecutions(namespace, workflowTemplateUID, workflowTemplateVersion string) (count int, err error) { err = workflowExecutionsSelectBuilderNoColumns(namespace, workflowTemplateUID, workflowTemplateVersion). Columns("COUNT(*)"). RunWith(c.DB.DB). QueryRow(). Scan(&count) return } func (c *Client) WatchWorkflowExecution(namespace, name string) (<-chan *WorkflowExecution, error) { _, err := c.GetWorkflowExecution(namespace, name) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Workflow template not found.") return nil, util.NewUserError(codes.NotFound, "Workflow not found.") } fieldSelector, _ := fields.ParseSelector(fmt.Sprintf("metadata.name=%s", name)) watcher, err := c.ArgoprojV1alpha1().Workflows(namespace).Watch(metav1.ListOptions{ FieldSelector: fieldSelector.String(), }) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Watch Workflow error.") return nil, util.NewUserError(codes.Unknown, "Error with watching workflow.") } workflowWatcher := make(chan *WorkflowExecution) ticker := time.NewTicker(time.Second) go func() { var workflow *wfv1.Workflow ok := true for { select { case next := <-watcher.ResultChan(): workflow, ok = next.Object.(*wfv1.Workflow) case <-ticker.C: } if workflow == nil && ok { continue } if workflow == nil && !ok { workflow, err = c.ArgoprojV1alpha1().Workflows(namespace).Get(name, metav1.GetOptions{}) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Workflow": workflow, "Error": err.Error(), }).Error("Unable to get workflow.") break } if workflow == nil { break } } manifest, err := json.Marshal(workflow) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Workflow": workflow, "Error": err.Error(), }).Error("Error with trying to JSON Marshal workflow.Status.") break } workflowWatcher <- &WorkflowExecution{ CreatedAt: workflow.CreationTimestamp.UTC(), StartedAt: ptr.Time(workflow.Status.StartedAt.UTC()), FinishedAt: ptr.Time(workflow.Status.FinishedAt.UTC()), UID: string(workflow.UID), Name: workflow.Name, Manifest: string(manifest), } if !workflow.Status.FinishedAt.IsZero() || !ok { break } } close(workflowWatcher) watcher.Stop() ticker.Stop() }() return workflowWatcher, nil } func (c *Client) GetWorkflowExecutionLogs(namespace, name, podName, containerName string) (<-chan *LogEntry, error) { wf, err := c.ArgoprojV1alpha1().Workflows(namespace).Get(name, metav1.GetOptions{}) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "PodName": podName, "ContainerName": containerName, "Error": err.Error(), }).Error("Workflow not found.") return nil, util.NewUserError(codes.NotFound, "Workflow not found.") } var ( stream io.ReadCloser s3Client *s3.Client config map[string]string endOffset int ) if wf.Status.Nodes[podName].Completed() { config, err = c.GetNamespaceConfig(namespace) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "PodName": podName, "ContainerName": containerName, "Error": err.Error(), }).Error("Can't get configuration.") return nil, util.NewUserError(codes.PermissionDenied, "Can't get configuration.") } s3Client, err = c.GetS3Client(namespace, config) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "PodName": podName, "ContainerName": containerName, "Error": err.Error(), }).Error("Can't connect to S3 storage.") return nil, util.NewUserError(codes.PermissionDenied, "Can't connect to S3 storage.") } opts := s3.GetObjectOptions{} endOffset, err = strconv.Atoi(readEndOffset) if err != nil { return nil, util.NewUserError(codes.InvalidArgument, "Invaild range.") } opts.SetRange(0, int64(endOffset)) stream, err = s3Client.GetObject(config[artifactRepositoryBucketKey], "artifacts/"+namespace+"/"+name+"/"+podName+"/"+containerName+".log", opts) } else { stream, err = c.CoreV1().Pods(namespace).GetLogs(podName, &corev1.PodLogOptions{ Container: containerName, Follow: true, Timestamps: true, }).Stream() } // TODO: Catch exact kubernetes error //Todo: Can above todo be removed with the logging error? if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "PodName": podName, "ContainerName": containerName, "Error": err.Error(), }).Error("Error with logs.") return nil, util.NewUserError(codes.NotFound, "Log not found.") } logWatcher := make(chan *LogEntry) go func() { scanner := bufio.NewScanner(stream) for scanner.Scan() { text := scanner.Text() parts := strings.Split(text, " ") timestamp, err := time.Parse(time.RFC3339, parts[0]) if err != nil { logWatcher <- &LogEntry{Content: text} } else { logWatcher <- &LogEntry{ Timestamp: timestamp, Content: strings.Join(parts[1:], " "), } } } close(logWatcher) }() return logWatcher, err } func (c *Client) GetWorkflowExecutionMetrics(namespace, name, podName string) (metrics []*Metric, err error) { _, err = c.GetWorkflowExecution(namespace, name) if err != nil { return nil, util.NewUserError(codes.NotFound, "Workflow not found.") } var ( stream io.ReadCloser s3Client *s3.Client config map[string]string ) config, err = c.GetNamespaceConfig(namespace) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "PodName": podName, "Error": err.Error(), }).Error("Can't get configuration.") return nil, util.NewUserError(codes.PermissionDenied, "Can't get configuration.") } s3Client, err = c.GetS3Client(namespace, config) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "PodName": podName, "Error": err.Error(), }).Error("Can't connect to S3 storage.") return nil, util.NewUserError(codes.PermissionDenied, "Can't connect to S3 storage.") } opts := s3.GetObjectOptions{} stream, err = s3Client.GetObject(config[artifactRepositoryBucketKey], "artifacts/"+namespace+"/"+name+"/"+podName+"/sys-metrics.json", opts) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "PodName": podName, "Error": err.Error(), }).Error("Metrics do not exist.") return nil, util.NewUserError(codes.NotFound, "Metrics do not exist.") } content, err := ioutil.ReadAll(stream) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "PodName": podName, "Error": err.Error(), }).Error("Unknown.") if strings.Contains("The specified key does not exist.", err.Error()) { return nil, util.NewUserError(codes.NotFound, "Metrics were not found.") } return nil, util.NewUserError(codes.Unknown, "Unknown error.") } if err = json.Unmarshal(content, &metrics); err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "PodName": podName, "Error": err.Error(), }).Error("Error parsing metrics.") return nil, util.NewUserError(codes.InvalidArgument, "Error parsing metrics.") } return } func (c *Client) RetryWorkflowExecution(namespace, name string) (workflow *WorkflowExecution, err error) { wf, err := c.ArgoprojV1alpha1().Workflows(namespace).Get(name, metav1.GetOptions{}) if err != nil { return } wf, err = argoutil.RetryWorkflow(c, c.ArgoprojV1alpha1().Workflows(namespace), wf) workflow = typeWorkflow(wf) return } func (c *Client) ResubmitWorkflowExecution(namespace, name string) (workflow *WorkflowExecution, err error) { wf, err := c.ArgoprojV1alpha1().Workflows(namespace).Get(name, metav1.GetOptions{}) if err != nil { return } wf, err = argoutil.FormulateResubmitWorkflow(wf, false) if err != nil { return } wf, err = argoutil.SubmitWorkflow(c.ArgoprojV1alpha1().Workflows(namespace), c, namespace, wf, &argoutil.SubmitOpts{}) if err != nil { return } workflow = typeWorkflow(wf) return } func (c *Client) ResumeWorkflowExecution(namespace, name string) (workflow *WorkflowExecution, err error) { err = argoutil.ResumeWorkflow(c.ArgoprojV1alpha1().Workflows(namespace), name, "") if err != nil { return } wf, err := c.ArgoprojV1alpha1().Workflows(namespace).Get(name, metav1.GetOptions{}) workflow = typeWorkflow(wf) return } func (c *Client) SuspendWorkflowExecution(namespace, name string) (err error) { err = argoutil.SuspendWorkflow(c.ArgoprojV1alpha1().Workflows(namespace), name) return } func (c *Client) TerminateWorkflowExecution(namespace, name string) (err error) { query := `DELETE FROM workflow_executions USING workflow_template_versions, workflow_templates WHERE workflow_executions.workflow_template_version_id = workflow_template_versions.id AND workflow_template_versions.workflow_template_id = workflow_templates.id AND workflow_templates.namespace = $1 AND workflow_executions.name = $2` if _, err := c.DB.Exec(query, namespace, name); err != nil { return err } err = argoutil.TerminateWorkflow(c.ArgoprojV1alpha1().Workflows(namespace), name) return } func (c *Client) GetArtifact(namespace, name, key string) (data []byte, err error) { config, err := c.GetNamespaceConfig(namespace) if err != nil { return } s3Client, err := c.GetS3Client(namespace, config) if err != nil { return } opts := s3.GetObjectOptions{} stream, err := s3Client.GetObject(config[artifactRepositoryBucketKey], key, opts) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Key": key, "Error": err.Error(), }).Error("Metrics do not exist.") return } data, err = ioutil.ReadAll(stream) if err != nil { return } return } func (c *Client) ListFiles(namespace, key string) (files []*File, err error) { config, err := c.GetNamespaceConfig(namespace) if err != nil { return } s3Client, err := c.GetS3Client(namespace, config) if err != nil { return } files = make([]*File, 0) if len(key) > 0 { if string(key[len(key)-1]) != "/" { key += "/" } } doneCh := make(chan struct{}) defer close(doneCh) for objInfo := range s3Client.ListObjectsV2(config[artifactRepositoryBucketKey], key, false, doneCh) { if objInfo.Key == key { continue } isDirectory := (objInfo.ETag == "" || strings.HasSuffix(objInfo.Key, "/")) && objInfo.Size == 0 newFile := &File{ Path: objInfo.Key, Name: FilePathToName(objInfo.Key), Extension: FilePathToExtension(objInfo.Key), Size: objInfo.Size, LastModified: objInfo.LastModified, ContentType: objInfo.ContentType, Directory: isDirectory, } files = append(files, newFile) } return } func filterOutCustomTypesFromManifest(manifest []byte) (result []byte, err error) { data := make(map[string]interface{}) err = yaml.Unmarshal(manifest, &data) if err != nil { return } spec, ok := data["spec"] if !ok { return manifest, nil } specMap, ok := spec.(map[string]interface{}) if !ok { return manifest, nil } arguments, ok := specMap["arguments"] if !ok { return manifest, nil } argumentsMap, ok := arguments.(map[string]interface{}) if !ok { return manifest, nil } parameters, ok := argumentsMap["parameters"] if !ok { return manifest, nil } parametersList, ok := parameters.([]interface{}) if !ok { return manifest, nil } // We might not want some parameters due to data structuring. parametersToKeep := make([]interface{}, 0) for _, parameter := range parametersList { paramMap, ok := parameter.(map[string]interface{}) if !ok { continue } // If the parameter does not have a value, skip it so argo doesn't try to process it and fail. if _, hasValue := paramMap["value"]; !hasValue { paramMap["value"] = "" } parametersToKeep = append(parametersToKeep, parameter) keysToDelete := make([]string, 0) for key := range paramMap { if key != "name" && key != "value" { keysToDelete = append(keysToDelete, key) } } for _, key := range keysToDelete { delete(paramMap, key) } } argumentsMap["parameters"] = parametersToKeep return yaml.Marshal(data) } // prefix is the label prefix. // e.g. prefix/my-label-key: my-label-value func (c *Client) GetWorkflowExecutionLabels(namespace, name, prefix string) (labels map[string]string, err error) { wf, err := c.ArgoprojV1alpha1().Workflows(namespace).Get(name, metav1.GetOptions{}) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Workflow not found.") return nil, util.NewUserError(codes.NotFound, "Workflow not found.") } labels = label.FilterByPrefix(prefix, wf.Labels) labels = label.RemovePrefix(prefix, labels) return } func (c *Client) DeleteWorkflowExecutionLabel(namespace, name string, keysToDelete ...string) (labels map[string]string, err error) { wf, err := c.ArgoprojV1alpha1().Workflows(namespace).Get(name, metav1.GetOptions{}) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Workflow not found.") return nil, util.NewUserError(codes.NotFound, "Workflow not found.") } label.Delete(wf.Labels, keysToDelete...) return wf.Labels, nil } func (c *Client) DeleteWorkflowTemplateLabel(namespace, name string, keysToDelete ...string) (labels map[string]string, err error) { wf, err := c.ArgoprojV1alpha1().WorkflowTemplates(namespace).Get(name, metav1.GetOptions{}) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Workflow Template not found.") return nil, util.NewUserError(codes.NotFound, "Workflow Template not found.") } label.Delete(wf.Labels, keysToDelete...) return wf.Labels, nil } // prefix is the label prefix. // we delete all labels with that prefix and set the new ones // e.g. prefix/my-label-key: my-label-value func (c *Client) SetWorkflowExecutionLabels(namespace, name, prefix string, keyValues map[string]string, deleteOld bool) (workflowLabels map[string]string, err error) { wf, err := c.ArgoprojV1alpha1().Workflows(namespace).Get(name, metav1.GetOptions{}) if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Workflow not found.") return nil, util.NewUserError(codes.NotFound, "Workflow not found.") } if deleteOld { label.DeleteWithPrefix(wf.Labels, prefix) } label.MergeLabelsPrefix(wf.Labels, keyValues, prefix) wf, err = c.ArgoprojV1alpha1().Workflows(namespace).Update(wf) if err != nil { return nil, err } filteredMap := label.FilterByPrefix(prefix, wf.Labels) filteredMap = label.RemovePrefix(prefix, filteredMap) return filteredMap, nil } // prefix is the label prefix. // we delete all labels with that prefix and set the new ones // e.g. prefix/my-label-key: my-label-value func (c *Client) SetWorkflowTemplateLabels(namespace, name, prefix string, keyValues map[string]string, deleteOld bool) (workflowLabels map[string]string, err error) { wf, err := c.getArgoWorkflowTemplate(namespace, name, "latest") if err != nil { log.WithFields(log.Fields{ "Namespace": namespace, "Name": name, "Error": err.Error(), }).Error("Workflow Template not found.") return nil, util.NewUserError(codes.NotFound, "Workflow Template not found.") } if deleteOld { label.DeleteWithPrefix(wf.Labels, prefix) } if wf.Labels == nil { wf.Labels = make(map[string]string) } label.MergeLabelsPrefix(wf.Labels, keyValues, prefix) wf, err = c.ArgoprojV1alpha1().WorkflowTemplates(namespace).Update(wf) if err != nil { return nil, err } filteredMap := label.FilterByPrefix(prefix, wf.Labels) filteredMap = label.RemovePrefix(prefix, filteredMap) return filteredMap, nil } func (c *Client) GetWorkflowExecutionStatisticsForTemplates(workflowTemplates ...*WorkflowTemplate) (err error) { if len(workflowTemplates) == 0 { return nil } tx, err := c.DB.Begin() if err != nil { return err } whereIn := "wtv.workflow_template_id IN (?" for i := range workflowTemplates { if i == 0 { continue } whereIn += ",?" } whereIn += ")" ids := make([]interface{}, len(workflowTemplates)) for i, workflowTemplate := range workflowTemplates { ids[i] = workflowTemplate.ID } defer tx.Rollback() statsSelect := ` workflow_template_id, MAX(we.created_at) last_executed, COUNT(*) FILTER (WHERE finished_at IS NULL AND (phase = 'Running' OR phase = 'Pending')) running, COUNT(*) FILTER (WHERE finished_at IS NOT NULL AND phase = 'Succeeded') completed, COUNT(*) FILTER (WHERE finished_at IS NOT NULL AND (phase = 'Failed' OR phase = 'Error')) failed, COUNT(*) total` query, args, err := sb.Select(statsSelect). From("workflow_executions we"). Join("workflow_template_versions wtv ON wtv.id = we.workflow_template_version_id"). Where(whereIn, ids...). GroupBy("wtv.workflow_template_id"). ToSql() if err != nil { return err } result := make([]*WorkflowExecutionStatisticReport, 0) err = c.DB.Select(&result, query, args...) if err != nil { return err } resultMapping := make(map[uint64]*WorkflowExecutionStatisticReport) for i := range result { report := result[i] resultMapping[report.WorkflowTemplateId] = report } for _, workflowTemplate := range workflowTemplates { resultMap, ok := resultMapping[workflowTemplate.ID] if ok { workflowTemplate.WorkflowExecutionStatisticReport = resultMap } } return } /** Will build a template that makes a CURL request to the onepanel-core API, with statistics about the workflow that was just executed. */ func getCURLNodeTemplate(name, curlMethod, curlPath, curlBody string, inputs wfv1.Inputs) (template *wfv1.Template, err error) { host := env.GetEnv("ONEPANEL_CORE_SERVICE_HOST", "onepanel-core.onepanel.svc.cluster.local") if host == "" { err = errors.New("ONEPANEL_CORE_SERVICE_HOST is empty.") return } port := env.GetEnv("ONEPANEL_CORE_SERVICE_PORT", "80") if port == "" { err = errors.New("ONEPANEL_CORE_SERVICE_PORT is empty.") return } endpoint := fmt.Sprintf("http://%s:%s%s", host, port, curlPath) template = &wfv1.Template{ Name: name, Inputs: inputs, Container: &corev1.Container{ Name: "curl", Image: "curlimages/curl", Command: []string{"sh", "-c"}, Args: []string{ "SERVICE_ACCOUNT_TOKEN=$(cat /var/run/secrets/kubernetes.io/serviceaccount/token) " + "&& curl -X " + curlMethod + " -s -o /dev/null -w '%{http_code}' '" + endpoint + "' -H \"Content-Type: application/json\" -H 'Connection: keep-alive' -H 'Accept: application/json' " + "-H 'Authorization: Bearer '\"$SERVICE_ACCOUNT_TOKEN\"'' " + "--data '" + curlBody + "' --compressed", }, }, } return } func injectExitHandlerWorkflowExecutionStatistic(wf *wfv1.Workflow, namespace string, workflowTemplateId *uint64) error { curlPath := "/apis/v1beta1/{{workflow.namespace}}/workflow_executions/{{workflow.name}}/statistics" statistics := map[string]interface{}{ "workflowStatus": "{{workflow.status}}", "workflowTemplateId": int64(*workflowTemplateId), } statisticsBytes, err := json.Marshal(statistics) if err != nil { return err } statsTemplate, err := getCURLNodeTemplate("sys-send-exit-stats", http.MethodPost, curlPath, string(statisticsBytes), wfv1.Inputs{}) if err != nil { return err } dagTask := wfv1.DAGTask{ Name: statsTemplate.Name, Template: statsTemplate.Name, } wf.Spec.Templates = append(wf.Spec.Templates, *statsTemplate) if wf.Spec.OnExit != "" { for _, t := range wf.Spec.Templates { if t.Name == wf.Spec.OnExit { lasTaskIndex := len(t.DAG.Tasks) - 1 dagTask.Dependencies = []string{t.DAG.Tasks[lasTaskIndex].Name} t.DAG.Tasks = append(t.DAG.Tasks, dagTask) break } } } else { exitHandlerDAG := wfv1.Template{ Name: "exit-handler", DAG: &wfv1.DAGTemplate{ Tasks: []wfv1.DAGTask{ dagTask, }, }, } wf.Spec.OnExit = "exit-handler" wf.Spec.Templates = append(wf.Spec.Templates, exitHandlerDAG) } return nil } func injectInitHandlerWorkflowExecutionStatistic(wf *wfv1.Workflow, namespace string, workflowTemplateId *uint64) error { curlPath := "/apis/v1beta1/{{workflow.namespace}}/workflow_executions/{{workflow.name}}/cron_start_statistics" statistics := map[string]interface{}{ "workflowTemplateId": int64(*workflowTemplateId), } statisticsBytes, err := json.Marshal(statistics) if err != nil { return err } containerTemplate, err := getCURLNodeTemplate("sys-send-init-stats", http.MethodPost, curlPath, string(statisticsBytes), wfv1.Inputs{}) if err != nil { return err } wf.Spec.Templates = append(wf.Spec.Templates, *containerTemplate) for i, t := range wf.Spec.Templates { if t.Name == wf.Spec.Entrypoint { // DAG is always required for entrypoint templates if t.DAG != nil { for j, task := range t.DAG.Tasks { if task.Dependencies == nil { wf.Spec.Templates[i].DAG.Tasks[j].Dependencies = []string{containerTemplate.Name} wf.Spec.Templates[i].DAG.Tasks = append(t.DAG.Tasks, wfv1.DAGTask{ Name: containerTemplate.Name, Template: containerTemplate.Name, }) } } } break } } return nil } func workflowExecutionsSelectBuilderNoColumns(namespace, workflowTemplateUID, workflowTemplateVersion string) sq.SelectBuilder { whereMap := sq.Eq{ "wt.namespace": namespace, "wt.uid": workflowTemplateUID, } if workflowTemplateVersion != "" { whereMap["wtv.version"] = workflowTemplateVersion } sb := sb.Select(). From("workflow_executions we"). LeftJoin("workflow_template_versions wtv ON wtv.id = we.workflow_template_version_id"). LeftJoin("workflow_templates wt ON wt.id = wtv.workflow_template_id"). Where(whereMap) return sb } func workflowExecutionsSelectBuilder(namespace, workflowTemplateUID, workflowTemplateVersion string) sq.SelectBuilder { sb := workflowExecutionsSelectBuilderNoColumns(namespace, workflowTemplateUID, workflowTemplateVersion) sb = sb.Columns("we.id", "we.created_at", "we.uid", "we.name", "we.phase", "we.started_at", "we.finished_at", `wtv.version "workflow_template.version"`) return sb } func (c *Client) getWorkflowExecutionAndTemplate(namespace string, name string) (workflow *WorkflowExecution, err error) { query, args, err := sb.Select(getWorkflowExecutionColumns("we", "")...). Columns(getWorkflowTemplateColumns("wt", "workflow_template")...). Columns(`wtv.manifest "workflow_template.manifest"`, `wtv.version "workflow_template.version"`). From("workflow_executions we"). Join("workflow_template_versions wtv ON we.workflow_template_version_id = wtv.id"). Join("workflow_templates wt ON wtv.workflow_template_id = wt.id"). Where(sq.Eq{ "wt.namespace": namespace, "we.name": name, }). ToSql() if err != nil { return nil, err } workflow = &WorkflowExecution{} if err = c.DB.Get(workflow, query, args...); err != nil { return nil, err } workflow.Parameters = make([]Parameter, 0) if err := json.Unmarshal(workflow.ParametersBytes, &workflow.Parameters); err != nil { return nil, err } return }