com.microsoft.jenkins.acs

Class ACSDeploymentContext

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

com.microsoft.jenkins.azurecommons.command.BaseCommandContext

com.microsoft.jenkins.acs.ACSDeploymentContext

All Implemented Interfaces:

AKSDeploymentCommand.IAKSDeploymentCommandData, DeploymentChoiceCommand.IDeploymentChoiceCommandData, EnablePortCommand.IEnablePortCommandData, GetContainerServiceInfoCommand.IGetContainerServiceInfoCommandData, KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData, MarathonDeploymentCommand.IMarathonDeploymentCommandData, SwarmDeploymentCommand.ISwarmDeploymentCommandData, com.microsoft.jenkins.azurecommons.command.IBaseCommandData, com.microsoft.jenkins.azurecommons.command.ICommandServiceData, hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class ACSDeploymentContext
extends com.microsoft.jenkins.azurecommons.command.BaseCommandContext
implements GetContainerServiceInfoCommand.IGetContainerServiceInfoCommandData, EnablePortCommand.IEnablePortCommandData, MarathonDeploymentCommand.IMarathonDeploymentCommandData, KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData, SwarmDeploymentCommand.ISwarmDeploymentCommandData, DeploymentChoiceCommand.IDeploymentChoiceCommandData, AKSDeploymentCommand.IAKSDeploymentCommandData

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ACSDeploymentContext.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
ACSDeploymentContext(String azureCredentialsId, String resourceGroupName, String containerService, String sshCredentialsId, String configFilePaths)

Method Summary

Modifier and Type	Method and Description
void	configure(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
String	getAzureCredentialsId()
String	getConfigFilePaths()
List<org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint>	getContainerRegistryCredentials()
String	getContainerService()
String	getContainerServiceName() In order to pass the container service orchestrator type to the front-end, the containerService field will be in the following format.
static String	getContainerServiceName(String containerService)
String	getContainerServiceType()
com.microsoft.jenkins.azurecommons.command.IBaseCommandData	getDataForCommand(com.microsoft.jenkins.azurecommons.command.ICommand command)
String	getDcosDockerCredentialsPath()
ACSDeploymentContext.DescriptorImpl	getDescriptor()
String	getMgmtFQDN()
com.microsoft.azure.management.containerservice.ContainerServiceOrchestratorTypes	getOrchestratorType() We use the orchestratorType bound at configuration time.
static String	getOrchestratorType(String containerService)
String	getResourceGroupName()
String	getSecretName()
String	getSecretNamespace()
com.cloudbees.jenkins.plugins.sshcredentials.SSHUserPrivateKey	getSshCredentials()
String	getSshCredentialsId()
boolean	isDcosDockerCredenditalsPathShared()
boolean	isEnableConfigSubstitution()
boolean	isSwarmRemoveContainersFirst()
List<com.microsoft.jenkins.kubernetes.credentials.ResolvedDockerRegistryEndpoint>	resolvedDockerRegistryEndpoints(hudson.model.Item context)
void	setContainerRegistryCredentials(List<org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint> containerRegistryCredentials)
void	setDcosDockerCredenditalsPathShared(boolean dcosDockerCredenditalsPathShared)
void	setDcosDockerCredentialsPath(String dcosDockerCredentialsPath)
void	setEnableConfigSubstitution(boolean enableConfigSubstitution)
void	setMgmtFQDN(String fqdn)
void	setSecretName(String secretName)
void	setSecretNamespace(String secretNamespace)
void	setSwarmRemoveContainersFirst(boolean swarmRemoveContainersFirst)
org.jenkinsci.plugins.workflow.steps.StepExecution	startImpl(org.jenkinsci.plugins.workflow.steps.StepContext context)
static String	validate(String azureCredentialsId, String resourceGroup, String containerService, String sshCredentialsId)

Methods inherited from class com.microsoft.jenkins.azurecommons.command.BaseCommandContext

configure, configure, executeCommands, getCommandService, getCommandState, getEnvVars, getJobContext, getLastCommandState, logError, logError, logError, logStatus, setCommandState, setLastCommandState, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.jenkins.azurecommons.command.IBaseCommandData

getCommandState, getEnvVars, getJobContext, logError, logError, logError, logStatus, setCommandState

Constructor Detail

ACSDeploymentContext

@DataBoundConstructor
public ACSDeploymentContext(String azureCredentialsId,
                                                   String resourceGroupName,
                                                   String containerService,
                                                   String sshCredentialsId,
                                                   String configFilePaths)

Method Detail

startImpl

public org.jenkinsci.plugins.workflow.steps.StepExecution startImpl(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                             throws Exception

Specified by:

startImpl in class com.microsoft.jenkins.azurecommons.command.BaseCommandContext

Throws:

Exception

getDescriptor

public ACSDeploymentContext.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>

Overrides:

getDescriptor in class org.jenkinsci.plugins.workflow.steps.Step

getAzureCredentialsId

public String getAzureCredentialsId()

Specified by:

getAzureCredentialsId in interface AKSDeploymentCommand.IAKSDeploymentCommandData

Specified by:

getAzureCredentialsId in interface EnablePortCommand.IEnablePortCommandData

Specified by:

getAzureCredentialsId in interface GetContainerServiceInfoCommand.IGetContainerServiceInfoCommandData

getConfigFilePaths

public String getConfigFilePaths()

Specified by:

getConfigFilePaths in interface EnablePortCommand.IEnablePortCommandData

Specified by:

getConfigFilePaths in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

Specified by:

getConfigFilePaths in interface MarathonDeploymentCommand.IMarathonDeploymentCommandData

Specified by:

getConfigFilePaths in interface SwarmDeploymentCommand.ISwarmDeploymentCommandData

getSshCredentialsId

public String getSshCredentialsId()

getSshCredentials

public com.cloudbees.jenkins.plugins.sshcredentials.SSHUserPrivateKey getSshCredentials()

Specified by:

getSshCredentials in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

Specified by:

getSshCredentials in interface MarathonDeploymentCommand.IMarathonDeploymentCommandData

Specified by:

getSshCredentials in interface SwarmDeploymentCommand.ISwarmDeploymentCommandData

setMgmtFQDN

public void setMgmtFQDN(String fqdn)

Specified by:

setMgmtFQDN in interface GetContainerServiceInfoCommand.IGetContainerServiceInfoCommandData

getResourceGroupName

public String getResourceGroupName()

Specified by:

getResourceGroupName in interface AKSDeploymentCommand.IAKSDeploymentCommandData

Specified by:

getResourceGroupName in interface EnablePortCommand.IEnablePortCommandData

Specified by:

getResourceGroupName in interface GetContainerServiceInfoCommand.IGetContainerServiceInfoCommandData

getMgmtFQDN

public String getMgmtFQDN()

Specified by:

getMgmtFQDN in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

Specified by:

getMgmtFQDN in interface MarathonDeploymentCommand.IMarathonDeploymentCommandData

Specified by:

getMgmtFQDN in interface SwarmDeploymentCommand.ISwarmDeploymentCommandData

getDataForCommand

public com.microsoft.jenkins.azurecommons.command.IBaseCommandData getDataForCommand(com.microsoft.jenkins.azurecommons.command.ICommand command)

Specified by:

getDataForCommand in interface com.microsoft.jenkins.azurecommons.command.ICommandServiceData

Specified by:

getDataForCommand in class com.microsoft.jenkins.azurecommons.command.BaseCommandContext

getOrchestratorType

public com.microsoft.azure.management.containerservice.ContainerServiceOrchestratorTypes getOrchestratorType()

We use the orchestratorType bound at configuration time. At build time we should check if this is consistent with the configuration and fail if not.

Specified by:

getOrchestratorType in interface EnablePortCommand.IEnablePortCommandData

Specified by:

getOrchestratorType in interface GetContainerServiceInfoCommand.IGetContainerServiceInfoCommandData

Specified by:

getOrchestratorType in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

Specified by:

getOrchestratorType in interface MarathonDeploymentCommand.IMarathonDeploymentCommandData

Specified by:

getOrchestratorType in interface SwarmDeploymentCommand.ISwarmDeploymentCommandData

Returns:

the container service's orchestrator type configured for the build

getContainerServiceType

public String getContainerServiceType()

Specified by:

getContainerServiceType in interface DeploymentChoiceCommand.IDeploymentChoiceCommandData

Specified by:

getContainerServiceType in interface GetContainerServiceInfoCommand.IGetContainerServiceInfoCommandData

Specified by:

getContainerServiceType in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

getContainerService

public String getContainerService()

getContainerServiceName

public String getContainerServiceName()

In order to pass the container service orchestrator type to the front-end, the containerService field will be in the following format. This will be stored into the configuration. At runtime, we need to extract the container service name in order to pass it to the Azure service.

container_service_name|orchestrator_type

Specified by:

getContainerServiceName in interface GetContainerServiceInfoCommand.IGetContainerServiceInfoCommandData

Specified by:

getContainerServiceName in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

See Also:

getContainerService()

getSecretNamespace

public String getSecretNamespace()

Specified by:

getSecretNamespace in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

setSecretNamespace

@DataBoundSetter
public void setSecretNamespace(String secretNamespace)

isSwarmRemoveContainersFirst

public boolean isSwarmRemoveContainersFirst()

Specified by:

isSwarmRemoveContainersFirst in interface SwarmDeploymentCommand.ISwarmDeploymentCommandData

setSwarmRemoveContainersFirst

@DataBoundSetter
public void setSwarmRemoveContainersFirst(boolean swarmRemoveContainersFirst)

isEnableConfigSubstitution

public boolean isEnableConfigSubstitution()

Specified by:

isEnableConfigSubstitution in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

Specified by:

isEnableConfigSubstitution in interface MarathonDeploymentCommand.IMarathonDeploymentCommandData

Specified by:

isEnableConfigSubstitution in interface SwarmDeploymentCommand.ISwarmDeploymentCommandData

setEnableConfigSubstitution

@DataBoundSetter
public void setEnableConfigSubstitution(boolean enableConfigSubstitution)

getSecretName

public String getSecretName()

Specified by:

getSecretName in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

setSecretName

@DataBoundSetter
public void setSecretName(String secretName)

getDcosDockerCredentialsPath

public String getDcosDockerCredentialsPath()

Specified by:

getDcosDockerCredentialsPath in interface MarathonDeploymentCommand.IMarathonDeploymentCommandData

setDcosDockerCredentialsPath

@DataBoundSetter
public void setDcosDockerCredentialsPath(String dcosDockerCredentialsPath)

isDcosDockerCredenditalsPathShared

public boolean isDcosDockerCredenditalsPathShared()

Specified by:

isDcosDockerCredenditalsPathShared in interface MarathonDeploymentCommand.IMarathonDeploymentCommandData

setDcosDockerCredenditalsPathShared

@DataBoundSetter
public void setDcosDockerCredenditalsPathShared(boolean dcosDockerCredenditalsPathShared)

getContainerRegistryCredentials

public List<org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint> getContainerRegistryCredentials()

setContainerRegistryCredentials

@DataBoundSetter
public void setContainerRegistryCredentials(List<org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint> containerRegistryCredentials)

resolvedDockerRegistryEndpoints

public List<com.microsoft.jenkins.kubernetes.credentials.ResolvedDockerRegistryEndpoint> resolvedDockerRegistryEndpoints(hudson.model.Item context)
                                                                                                                  throws IOException

Specified by:

resolvedDockerRegistryEndpoints in interface KubernetesDeploymentCommandBase.IKubernetesDeploymentCommandData

Specified by:

resolvedDockerRegistryEndpoints in interface MarathonDeploymentCommand.IMarathonDeploymentCommandData

Specified by:

resolvedDockerRegistryEndpoints in interface SwarmDeploymentCommand.ISwarmDeploymentCommandData

Throws:

IOException

configure

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

Throws:

IOException

InterruptedException

getContainerServiceName

public static String getContainerServiceName(String containerService)

getOrchestratorType

public static String getOrchestratorType(String containerService)

validate

public static String validate(String azureCredentialsId,
                              String resourceGroup,
                              String containerService,
                              String sshCredentialsId)