Package sh.createos.jenkins.sandbox

Class SandboxTemplate

java.lang.Object
hudson.model.AbstractDescribableImpl<SandboxTemplate>
sh.createos.jenkins.sandbox.SandboxTemplate
All Implemented Interfaces:
Describable<SandboxTemplate>, Serializable
public class SandboxTemplate extends AbstractDescribableImpl<SandboxTemplate> implements Serializable
Configuration template for a CreateOS Sandbox agent.

Like PodTemplate in the Kubernetes plugin — defines what kind of sandbox to create. In Go terms, this is a config struct that gets serialized to/from Jenkins XML.

Users configure these in Jenkins UI under Manage Jenkins > Clouds > CreateOS.

See Also:

  • Constructor Details

    • SandboxTemplate

      @DataBoundConstructor public SandboxTemplate(String label, String shape, String rootfs)
      Creates a sandbox template with its required Jenkins label, shape, and root filesystem.

  • Method Details

    • getLabel

      public String getLabel()

    • getShape

      public String getShape()

    • getRootfs

      public String getRootfs()

    • getRemoteFs

      public String getRemoteFs()

    • setRemoteFs

      @DataBoundSetter public void setRemoteFs(String remoteFs)

    • getRegion

      public String getRegion()

    • setRegion

      @DataBoundSetter public void setRegion(String region)

    • getDiskMiB

      public int getDiskMiB()

    • setDiskMiB

      @DataBoundSetter public void setDiskMiB(int diskMiB)

    • getLauncher

      public CreateOSLaunchMethod getLauncher()

    • setLauncher

      @DataBoundSetter public void setLauncher(CreateOSLaunchMethod launcher)

    • readResolve

      protected Object readResolve()
      Migrates templates written before the launch method became describable.

      The old form stored the transport as a string beside two SSH fields that were meaningless for inbound agents; the public key is now derived from the credential, so it is dropped.

    • isAllowPipelineOverrides

      public boolean isAllowPipelineOverrides()

    • setAllowPipelineOverrides

      @DataBoundSetter public void setAllowPipelineOverrides(boolean allowPipelineOverrides)

    • getNetworks

      public String getNetworks()

    • setNetworks

      @DataBoundSetter public void setNetworks(String networks)

    • getNetworkIdList

      public List<String> getNetworkIdList()
      Returns configured private network ids or names as normalized request values.

    • getDisks

      public List<CreateOSDiskAttachment> getDisks()

    • setDisks

      @DataBoundSetter public void setDisks(List<CreateOSDiskAttachment> disks)

    • getIdleMinutes

      public int getIdleMinutes()
      0 means never idle out, which only a reused agent may do: a one-shot agent would leak.

    • setIdleMinutes

      @DataBoundSetter public void setIdleMinutes(int idleMinutes)

    • isDeleteOnRestart

      public boolean isDeleteOnRestart()

    • setDeleteOnRestart

      @DataBoundSetter public void setDeleteOnRestart(boolean deleteOnRestart)

    • isReuseAgent

      public boolean isReuseAgent()

    • setReuseAgent

      @DataBoundSetter public void setReuseAgent(boolean reuseAgent)