Operations Guide

apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease
metadata:
  name: synopsys-alert
spec:
  releaseName: synopsys-alert
  chart:
    spec:
      chart: blackduck-alert
      version: 8.0.0
      sourceRef:
        kind: HelmRepository
        name: synopsys-alert
  install:
    crds: Skip
  upgrade:
    crds: Skip
  interval: 10m
  timeout: 20m

  valuesFrom:
    # Default values of the chart. Shall not be modified.
    - kind: ConfigMap
      name: helm-common-values
      valuesKey: swf-chart-default-values.yaml
    # All overrides are here (if not in a more specialized files below)
    - kind: ConfigMap
      name: helm-common-values
      valuesKey: swf-overrides-default-all.yaml
    # Overrides related to the usage of a private registry
    - kind: ConfigMap
      name: helm-images-values
      valuesKey: swf-overrides-var-images.yaml
    # These platform specific Values shall always exist. Even empty.
    - kind: ConfigMap
      name: helm-sizing-values
      valuesKey: sizing.yaml
    - kind: ConfigMap
      name: helm-platform-values
      valuesKey: platform.yaml
    - kind: Secret
      name: alertencryption
      valuesKey: password
      targetPath: alertEncryptionPassword
      optional: true
    - kind: Secret
      name: alertencryption
      valuesKey: password
      targetPath: secretEnvirons.ALERT_ENCRYPTION_PASSWORD
      optional: true
    - kind: Secret
      name: alertencryption
      valuesKey: salt
      targetPath: alertEncryptionGlobalSalt
      optional: true
    - kind: Secret
      name: alertencryption
      valuesKey: salt
      targetPath: secretEnvirons.ALERT_ENCRYPTION_GLOBAL_SALT
      optional: true
  postRenderers:
    - kustomize:
        patches:
          - target:
              kind: Deployment
            patch: |
              - op: add
                path: /metadata/annotations/linkerd.io~1inject
                value: disabled
              - op: add
                path: /spec/template/metadata/annotations/linkerd.io~1inject
                value: disabled

apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: HelmRepository
metadata:
  name: synopsys-alert
spec:
  interval: 30m
  url: ${helmRepositoryUrl:="https://repo.blackduck.com/sig-cloudnative"}

primary:
  persistence:
    size: 10Gi

curl -X 'GET' \
  'https://alert_url/api/diagnostic' \
  -H 'accept: */*'

{
  "notificationDiagnosticModel": {
    "numberOfNotifications": 0,
    "numberOfNotificationsProcessed": 0,
    "numberOfNotificationsUnprocessed": 0,
    "providerNotificationCounts": [
      {
        "providerConfigId": 0,
        "notificationCounts": [
          {
            "notificationType": "BOM_EDIT",
            "count": 0
          }
        ]
      }
    ]
  },
  "auditDiagnosticModel": {
    "numberOfAuditEntriesSuccessful": 0,
    "numberOfAuditEntriesFailed": 0,
    "numberOfAuditEntriesPending": 0,
    "averageAuditTime": "string"
  },
  "systemDiagnosticModel": {
    "availableProcessors": 0,
    "maxMemory": 0,
    "totalMemory": 0,
    "freeMemory": 0,
    "usedMemory": 0
  },
  "rabbitMQDiagnosticModel": {
    "queues": [
      {
        "name": "string",
        "messageCount": 0,
        "consumerCount": 0
      }
    ]
  },
  "completedJobsDiagnosticModel": {
    "completedJobs": [
      {
        "jobConfigId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "jobName": "string",
        "latestNotificationCount": 0,
        "totalNotificationCount": 0,
        "successCount": 0,
        "failureCount": 0,
        "latestStatus": "string",
        "lastRun": "string",
        "durations": {
          "jobDuration": "string",
          "stageDurations": [
            {
              "name": "string",
              "duration": "string"
            }
          ]
        }
      }
    ]
  },
  "jobExecutionsDiagnosticModel": {
    "totalJobsInSystem": 0,
    "pendingJobs": 0,
    "successFulJobs": 0,
    "failedJobs": 0,
    "jobExecutions": [
      {
        "jobName": "string",
        "channelName": "string",
        "start": "string",
        "end": "string",
        "status": "PENDING",
        "processedNotificationCount": 0,
        "totalNotificationCount": 0,
        "remainingEvents": 0,
        "stages": [
          {
            "stage": "NOTIFICATION_PROCESSING",
            "start": "string",
            "end": "string"
          }
        ]
      }
    ]
  },
  "requestTimestamp": "string"
}

SystemDiagnosticModel{
  availableProcessors integer($int32)
  maxMemory integer($int64)
  totalMemory integer($int64)
  freeMemory  integer($int64)
  usedMemory  integer($int64)
}

RabbitMQDiagnosticModel{
  queues  [AlertQueueInformation{
    name  string
    messageCount  integer($int32)
    consumerCount integer($int32)
  }]
}

AlertQueueInformation{
  name  string
  messageCount  integer($int32)
  consumerCount integer($int32)
}

DiagnosticModel {
    notificationDiagnosticModel NotificationDiagnosticModel {
        numberOfNotifications integer($int64)
        numberOfNotificationsProcessed integer($int64)
        numberOfNotificationsUnprocessed integer($int64)
        providerNotificationCounts[ProviderNotificationCounts {
            providerConfigId integer($int64)
            notificationCounts[NotificationTypeCount {
                notificationType string
                  Enum: [BOM_EDIT, COMPONENT_UNKNOWN_VERSION, LICENSE_LIMIT, POLICY_OVERRIDE, PROJECT, PROJECT_VERSION, RULE_VIOLATION, RULE_VIOLATION_CLEARED, VERSION_BOM_CODE_LOCATION_BOM_COMPUTED, VULNERABILITY]
                count integer($int64)
            }]
        }]
    }
    auditDiagnosticModel AuditDiagnosticModel {
        numberOfAuditEntriesSuccessful integer($int64)
        numberOfAuditEntriesFailed integer($int64)
        numberOfAuditEntriesPending integer($int64)
        averageAuditTime string
    }
    systemDiagnosticModel SystemDiagnosticModel {
        availableProcessors integer($int32)
        maxMemory integer($int64)
        totalMemory integer($int64)
        freeMemory integer($int64)
        usedMemory integer($int64)
    }
    rabbitMQDiagnosticModel RabbitMQDiagnosticModel {
        queues[AlertQueueInformation {
            name string
            messageCount integer($int32)
            consumerCount integer($int32)
        }]
    }
    completedJobsDiagnosticModel CompletedJobsDiagnosticModel {
        completedJobs[CompletedJobDiagnosticModel {
            jobConfigId string($uuid)
            jobName string
            latestNotificationCount integer($int64)
            totalNotificationCount integer($int64)
            successCount integer($int64)
            failureCount integer($int64)
            latestStatus string
            lastRun string
            durations CompletedJobDurationDiagnosticModel {
                jobDuration string
                stageDurations[CompletedJobStageDurationModel {
                    name string
                    duration string
                }]
            }
        }]
    }
    jobExecutionsDiagnosticModel JobExecutionsDiagnosticModel {
        totalJobsInSystem integer($int64)
        pendingJobs integer($int64)
        successFulJobs integer($int64)
        failedJobs integer($int64)
        jobExecutions[JobExecutionDiagnosticModel {
            jobName string
            channelName string
            start string
            end string
            status string
              Enum: [PENDING, SUCCESS, FAILURE]
            processedNotificationCount integer($int32)
            totalNotificationCount integer($int32)
            remainingEvents integer($int32)
            stages[JobStageDiagnosticModel {
                stage string
                  Enum: [NOTIFICATION_PROCESSING, CHANNEL_PROCESSING, ISSUE_CREATION, ISSUE_COMMENTING, ISSUE_TRANSITION]
                start string
                end string
            }]
        }]
    }
    requestTimestamp string
}