com.anchore.jenkins.plugins.anchore

Class AnchoreBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.anchore.jenkins.plugins.anchore.AnchoreBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class AnchoreBuilder
extends hudson.tasks.Builder

The Anchore Jenkins Plugin enables jenkins users the ability to add a build step to a jenkins job that executes anchore analysis, gate policy evaluation, image scanning, and customizable anchore container image queries.

Requirements:

1. Jenkins installed and configured either as a single system, or with multiple configured jenkins worker nodes
2. Each host on which jenkins jobs will run must have docker installed and the jenkins user (or whichever user you have configured jenkins to run jobs as) must be allowed to interact with docker (either directly or via sudo)
3. Each host on which jenkins jobs will run must have the latest anchore container image installed in the local docker host. To install, run 'docker pull anchore/jenkins:latest' on each jenkins host to make the image available to the plugin. The plugin will start an instance of the anchore/jenkins:latest docker container named 'jenkins_anchore' by default, on each host that runs a jenkins job that includes an Anchore Container Image Scanner build step.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnchoreBuilder.AnchoreQueriesBlock
static class	AnchoreBuilder.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
AnchoreBuilder(String name, String policyName, String userScripts, boolean bailOnFail, boolean bailOnWarn, boolean bailOnPluginFail, boolean doCleanup, AnchoreBuilder.AnchoreQueriesBlock queriesBlock)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBailOnFail()
boolean	getBailOnPluginFail()
boolean	getBailOnWarn()
AnchoreBuilder.DescriptorImpl	getDescriptor()
boolean	getDoCleanup()
List<AnchoreQuery>	getInputQueries()
String	getName()
String	getPolicyName()
String	getQuery1()
String	getQuery2()
String	getQuery3()
String	getQuery4()
String	getUserScripts()
boolean	isDoQuery()
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher inLauncher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnchoreBuilder

@DataBoundConstructor
public AnchoreBuilder(String name,
                                   String policyName,
                                   String userScripts,
                                   boolean bailOnFail,
                                   boolean bailOnWarn,
                                   boolean bailOnPluginFail,
                                   boolean doCleanup,
                                   AnchoreBuilder.AnchoreQueriesBlock queriesBlock)

Method Detail

getName

public String getName()

getPolicyName

public String getPolicyName()

getUserScripts

public String getUserScripts()

getBailOnFail

public boolean getBailOnFail()

getBailOnWarn

public boolean getBailOnWarn()

getBailOnPluginFail

public boolean getBailOnPluginFail()

getDoCleanup

public boolean getDoCleanup()

getInputQueries

public List<AnchoreQuery> getInputQueries()

isDoQuery

public boolean isDoQuery()

getQuery1

public String getQuery1()

getQuery2

public String getQuery2()

getQuery3

public String getQuery3()

getQuery4

public String getQuery4()

perform

public boolean perform(hudson.model.AbstractBuild build,
              hudson.Launcher inLauncher,
              hudson.model.BuildListener listener)
                throws hudson.AbortException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

hudson.AbortException

getDescriptor

public AnchoreBuilder.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder