Client-side scanner installation

Artifactory Integration

Version
latest

To install the client-side scanner:

  1. Get a copy of scass-scanner helm chart:

    helm repo add https://repo.blackduck.com/cloudnative/
  2. Create a new client-side-scanner.yaml file to run scanner in client side mode with the following contents:

    onprem:
      enabled: true
    
    global:
      environs:
        SPRING_PROFILES_ACTIVE: "LOCAL"
        ARTIFACTORY_IDENTITY_TOKEN: "<ARTIFACTORY_USER_IDENTITY_TOKEN>"
        ARTIFACTORY_URL: "<ARTIFACTORY_URL>"
    service:
      type: NodePort
      nodePort: 30000
    
    healthChecks:
      enabled: true
      readinessProbe:
        failureThreshold: 1
        periodSeconds: 1
    
    # Change the replica count based on the customer/user needs
    # The max supported right now is 10
    replicaCount: 10
    
    metrics:
      enabled: false
    
    bdbaworker:
      enabled: true
      repository: blackducksoftware
    
    autoscaling:
      enabled: false
    
    configurations:
      - name: onprem
        maxMemory: "7608m"
        minMemory: "1024m"
        signatureScannerMemory: "6144"
        resources:
          requests:
            cpu: 200m
            memory: 4096Mi
          limits:
            cpu: 1000m
            memory: 10240Mi
        bdbaworker:
          resources:
            requests:
              cpu: 200m
              memory: 3072Mi
            limits:
              cpu: 1000m
              memory: 6656Mi

    Update the values of <ARTIFACTORY_USER_IDENTITY_TOKEN> and <ARTIFACTORY_URL> in the created file.

  3. Create a namespace:

    kubectl create ns client-side-scanner
  4. Do a dry run of the charts to find any pre-installation errors:

    helm upgrade --install scass-scanner blackduck/scass-scanner -n client-side-scanner --dry-run -f client-side-scanner.yaml
  5. Install the charts:

    helm upgrade --install scass-scanner blackduck/scass-scanner -n client-side-scanner -f client-side-scanner.yaml
  6. Check the status of the services:

    kubectl get pods -n client-side-scanner

Once completed, the scanner will be up and running on http://<hostname>:<nodePort> and Artifactory will start sending scans.