Package io.jenkins.plugins.namespacecloud.launcher

Class SshLaunchStrategy

java.lang.Object

hudson.model.AbstractDescribableImpl<AgentLaunchStrategy>

io.jenkins.plugins.namespacecloud.launcher.AgentLaunchStrategy

io.jenkins.plugins.namespacecloud.launcher.SshLaunchStrategy

All Implemented Interfaces:

ExtensionPoint, Describable<AgentLaunchStrategy>

public class SshLaunchStrategy
extends AgentLaunchStrategy

Connects by SSH from the controller into the instance.

Use this when the agent cannot dial out to Jenkins. The controller must be able to reach Namespace's regional ingress, and the token additionally needs the instance:ssh and ingress:access grants.

Namespace authorises SSH against public keys injected at instance creation. Those are computed from the configured private-key credential rather than configured alongside it: a separately stored public key silently stops matching the moment the credential is rotated, and the failure surfaces only as an agent that cannot be reached.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SshLaunchStrategy.DescriptorImpl

Nested classes/interfaces inherited from class io.jenkins.plugins.namespacecloud.launcher.AgentLaunchStrategy

AgentLaunchStrategy.AgentLaunchStrategyDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IMAGE	The image must contain a JRE; the controller copies agent.jar into it.

Constructor Summary

Constructors

Constructor	Description
SshLaunchStrategy(String credentialsId)

Method Summary

Modifier and Type	Method	Description
void	configureInstance(Compute.CreateInstanceRequest.Builder builder, LaunchContext ctx)	Contributes to the instance request before it is sent — typically the container that will host the agent, plus any credentials it needs.
ComputerLauncher	createLauncher(NamespaceClient client, Compute.InstanceMetadata instance, LaunchContext ctx)	Builds the Jenkins-side launcher.
String	getCredentialsId()
String	getImage()
String	getJavaPath()
boolean	requiresSshGrants()	Whether this strategy needs the instance:ssh and ingress:access grants.
void	setImage(String image)
void	setJavaPath(String javaPath)

Methods inherited from class io.jenkins.plugins.namespacecloud.launcher.AgentLaunchStrategy

getDescriptor, requiresNodeRegisteredFirst

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_IMAGE

public static final String DEFAULT_IMAGE

The image must contain a JRE; the controller copies agent.jar into it.

See Also:

• Constant Field Values

Constructor Details

SshLaunchStrategy

@DataBoundConstructor
public SshLaunchStrategy(String credentialsId)

Method Details

getImage

public String getImage()

setImage

@DataBoundSetter
public void setImage(String image)

getCredentialsId

public String getCredentialsId()

getJavaPath

public String getJavaPath()

setJavaPath

@DataBoundSetter
public void setJavaPath(String javaPath)

requiresSshGrants

public boolean requiresSshGrants()

Description copied from class: AgentLaunchStrategy

Whether this strategy needs the instance:ssh and ingress:access grants.

Overrides:

requiresSshGrants in class AgentLaunchStrategy

configureInstance

public void configureInstance(@NonNull
 Compute.CreateInstanceRequest.Builder builder,
 @NonNull
 LaunchContext ctx)
                       throws IOException

Description copied from class: AgentLaunchStrategy

Contributes to the instance request before it is sent — typically the container that will host the agent, plus any credentials it needs.

Specified by:

configureInstance in class AgentLaunchStrategy

Throws:

IOException - if the request cannot be completed, for instance because a configured credential is missing or unreadable. Failing here is preferable to provisioning an instance the controller would then be unable to connect to.

createLauncher

@NonNull
public ComputerLauncher createLauncher(@NonNull
 NamespaceClient client,
 @NonNull
 Compute.InstanceMetadata instance,
 @NonNull
 LaunchContext ctx)
                                throws IOException

Description copied from class: AgentLaunchStrategy

Builds the Jenkins-side launcher. Called once the instance is RUNNING, so implementations may query the instance for connection details.

Specified by:

createLauncher in class AgentLaunchStrategy

Throws:

IOException