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 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 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
String	getAnchoreioPass()
String	getAnchoreioUser()
List<Annotation>	getAnnotations()
boolean	getBailOnFail()
boolean	getBailOnPluginFail()
boolean	getBailOnWarn()
String	getBundleFileOverride()
AnchoreBuilder.DescriptorImpl	getDescriptor()
boolean	getDoCleanup()
String	getEngineCredentialsId()
String	getEngineRetries()
String	getEngineurl()
boolean	getEngineverify()
String	getGlobalWhiteList()
List<AnchoreQuery>	getInputQueries()
String	getName()
String	getPolicyBundleId()
String	getPolicyEvalMethod()
String	getPolicyName()
boolean	getUseCachedBundle()
String	getUserScripts()
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setAnchoreioPass(String anchoreioPass)
void	setAnchoreioUser(String anchoreioUser)
void	setAnnotations(List<Annotation> annotations)
void	setBailOnFail(boolean bailOnFail)
void	setBailOnPluginFail(boolean bailOnPluginFail)
void	setBailOnWarn(boolean bailOnWarn)
void	setBundleFileOverride(String bundleFileOverride)
void	setDoCleanup(boolean doCleanup)
void	setEngineCredentialsId(String engineCredentialsId)
void	setEngineRetries(String engineRetries)
void	setEngineurl(String engineurl)
void	setEngineverify(boolean engineverify)
void	setGlobalWhiteList(String globalWhiteList)
void	setInputQueries(List<AnchoreQuery> inputQueries)
void	setPolicyBundleId(String policyBundleId)
void	setPolicyEvalMethod(String policyEvalMethod)
void	setPolicyName(String policyName)
void	setUseCachedBundle(boolean useCachedBundle)
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()

getGlobalWhiteList

public String getGlobalWhiteList()

getAnchoreioUser

public String getAnchoreioUser()

getAnchoreioPass

public String getAnchoreioPass()

getUserScripts

public String getUserScripts()

getEngineRetries

public String getEngineRetries()

getBailOnFail

public boolean getBailOnFail()

getBailOnWarn

public boolean getBailOnWarn()

getBailOnPluginFail

public boolean getBailOnPluginFail()

getDoCleanup

public boolean getDoCleanup()

getUseCachedBundle

public boolean getUseCachedBundle()

getPolicyEvalMethod

public String getPolicyEvalMethod()

getBundleFileOverride

public String getBundleFileOverride()

getInputQueries

public List<AnchoreQuery> getInputQueries()

getPolicyBundleId

public String getPolicyBundleId()

getAnnotations

public List<Annotation> getAnnotations()

getEngineurl

public String getEngineurl()

getEngineCredentialsId

public String getEngineCredentialsId()

getEngineverify

public boolean getEngineverify()

setPolicyName

@DataBoundSetter
public void setPolicyName(String policyName)

setGlobalWhiteList

@DataBoundSetter
public void setGlobalWhiteList(String globalWhiteList)

setAnchoreioUser

@DataBoundSetter
public void setAnchoreioUser(String anchoreioUser)

setAnchoreioPass

@DataBoundSetter
public void setAnchoreioPass(String anchoreioPass)

setUserScripts

@DataBoundSetter
public void setUserScripts(String userScripts)

setEngineRetries

@DataBoundSetter
public void setEngineRetries(String engineRetries)

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)

setUseCachedBundle

@DataBoundSetter
public void setUseCachedBundle(boolean useCachedBundle)

setPolicyEvalMethod

@DataBoundSetter
public void setPolicyEvalMethod(String policyEvalMethod)

setBundleFileOverride

@DataBoundSetter
public void setBundleFileOverride(String bundleFileOverride)

setInputQueries

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

setPolicyBundleId

@DataBoundSetter
public void setPolicyBundleId(String policyBundleId)

setAnnotations

@DataBoundSetter
public void setAnnotations(List<Annotation> annotations)

setEngineurl

@DataBoundSetter
public void setEngineurl(String engineurl)

setEngineCredentialsId

@DataBoundSetter
public void setEngineCredentialsId(String engineCredentialsId)

setEngineverify

@DataBoundSetter
public void setEngineverify(boolean engineverify)

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