Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type InstallCmd ¶ added in v3.33.0
type InstallCmd struct {
Version string `help:"Specify an agent version to install" default:"latest"`
Dest string `help:"Destination directory for the binary" type:"path"`
ClusterName string `help:"Cluster name to create the agent token on (resolved to UUID)" name:"cluster-name" optional:""`
ClusterUUID string `help:"Cluster UUID to create the agent token on (default: the \"Default\" cluster)" name:"cluster-uuid" optional:""`
Queue string `help:"Self-hosted queue key (default: the cluster's configured default queue)"`
NoToken bool `help:"Skip creating an agent token and config file" name:"no-token"`
ConfigPath string `help:"Path to write the agent config file" type:"path"`
BuildPath string `` /* 164-byte string literal not displayed */
Force bool `help:"Overwrite an existing agent config file"`
}
InstallCmd allows users to define which agent version they want to install We will take care of OS/arch in the command itself
func (*InstallCmd) Help ¶ added in v3.33.0
func (i *InstallCmd) Help() string
func (*InstallCmd) Run ¶ added in v3.33.0
func (i *InstallCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error
func (*InstallCmd) Validate ¶ added in v3.67.0
func (i *InstallCmd) Validate() error
type ListCmd ¶
type ListCmd struct {
Name string `help:"Filter agents by their name"`
Version string `help:"Filter agents by their version"`
Hostname string `help:"Filter agents by their hostname"`
State string `help:"Filter agents by state (running, idle, paused)"`
Tags []string `help:"Filter agents by tags"`
PerPage int `help:"Number of agents per page" default:"30"`
Limit int `help:"Maximum number of agents to return" default:"100"`
output.OutputFlags
}
type PauseCmd ¶
type RunCmd ¶ added in v3.33.0
type RunCmd struct {
Version string `help:"Specify an agent version to run" default:"latest"`
ClusterName string `help:"Cluster name to create the agent token on (resolved to UUID)" name:"cluster-name" optional:""`
ClusterUUID string `help:"Cluster UUID to create the agent token on (default: the \"Default\" cluster)" name:"cluster-uuid" optional:""`
Queue string `help:"Self-hosted queue key (default: the cluster's configured default queue)"`
}
RunCmd spins up an ephemeral buildkite-agent attached to a cluster.
type StopCmd ¶
Click to show internal directories.
Click to hide internal directories.