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, jenkins.tasks.SimpleBuildStep

public class AnchoreBuilder
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

Anchore Plugin enables Jenkins users to scan container images, generate analysis, evaluate gate policy, and execute customizable queries. The plugin can be used in a freestyle project as a build step or invoked from a pipeline script

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.DescriptorImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

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

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
AnchoreBuilder(String name)

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()
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setBailOnFail(boolean bailOnFail)
void	setBailOnPluginFail(boolean bailOnPluginFail)
void	setBailOnWarn(boolean bailOnWarn)
void	setDoCleanup(boolean doCleanup)
void	setInputQueries(List<AnchoreQuery> inputQueries)
void	setPolicyName(String policyName)
void	setQueriesBlock(AnchoreQueriesBlock queriesBlock)
void	setUserScripts(String userScripts)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Constructor Detail

AnchoreBuilder

@DataBoundConstructor
public AnchoreBuilder(String name)

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()

setPolicyName

@DataBoundSetter
public void setPolicyName(String policyName)

setUserScripts

@DataBoundSetter
public void setUserScripts(String userScripts)

setBailOnFail

@DataBoundSetter
public void setBailOnFail(boolean bailOnFail)

setBailOnWarn

@DataBoundSetter
public void setBailOnWarn(boolean bailOnWarn)

setBailOnPluginFail

@DataBoundSetter
public void setBailOnPluginFail(boolean bailOnPluginFail)

setDoCleanup

@DataBoundSetter
public void setDoCleanup(boolean doCleanup)

setInputQueries

@DataBoundSetter
public void setInputQueries(List<AnchoreQuery> inputQueries)

setQueriesBlock

@DataBoundSetter
public void setQueriesBlock(AnchoreQueriesBlock queriesBlock)

perform

public void perform(@Nonnull
           hudson.model.Run<?,?> run,
           @Nonnull
           hudson.FilePath workspace,
           @Nonnull
           hudson.Launcher launcher,
           @Nonnull
           hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

getDescriptor

public AnchoreBuilder.DescriptorImpl getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Builder