Documentation
¶
Index ¶
- type Config
- type Server
- func (s *Server) GetDeploy(ctx context.Context, req *deploypb.GetDeployRequest) (*deploypb.GetDeployResponse, error)
- func (s *Server) GetDeployReport(ctx context.Context, req *deploypb.GetDeployReportRequest) (*deploypb.GetDeployReportResponse, error)
- func (s *Server) GetMostRecentDeploy(ctx context.Context, _ *deploypb.GetMostRecentDeployRequest) (*deploypb.GetMostRecentDeployResponse, error)
- func (s *Server) ListRecentDeploys(ctx context.Context, _ *deploypb.ListRecentDeploysRequest) (*deploypb.ListRecentDeploysResponse, error)
- func (s *Server) PollForChanges(ctx context.Context, interval time.Duration)
- func (s *Server) Shutdown()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// DryRun is a flag controlling whether to actually attempt to update the Kubernetes cluster.
// If it is true, all actions will be performed up until the actual kubectl command would be
// run, and then that will be skipped and assumed to have succeeded.
DryRun bool
// GitHubRepo is the full name of the GitHub repository to pull the build artifact from.
GitHubRepo string
// GitHubBranch is the branch whose builds should be considered for deploying.
GitHubBranch string
// WorkflowName is the filename of the GitHub Actions workflow whose artifact should be used.
WorkflowName string
// ArtifactName is the name of the artifact in the workflow that contains the JSON files for
// the Nomad jobs to deploy.
ArtifactName string
PushoverRecipient *pushover.Recipient
ReportBucket string
}
Config contains configuration parameters for how to fetch the build artifact to deploy.
type Server ¶
type Server struct {
// Config is the configuration for deployment.
Config Config
// GitHubClient is the client to use to make API requests to GitHub.
GitHubClient *github.Client
// NomadClient is the client to use to submit jobs to Nomad
NomadClient *nomadapi.Client
Pushover *pushover.Pushover
S3 s3iface.S3API
// contains filtered or unexported fields
}
func (*Server) GetDeploy ¶
func (s *Server) GetDeploy(ctx context.Context, req *deploypb.GetDeployRequest) (*deploypb.GetDeployResponse, error)
func (*Server) GetDeployReport ¶
func (s *Server) GetDeployReport(ctx context.Context, req *deploypb.GetDeployReportRequest) (*deploypb.GetDeployReportResponse, error)
func (*Server) GetMostRecentDeploy ¶
func (s *Server) GetMostRecentDeploy(ctx context.Context, _ *deploypb.GetMostRecentDeployRequest) (*deploypb.GetMostRecentDeployResponse, error)
func (*Server) ListRecentDeploys ¶
func (s *Server) ListRecentDeploys(ctx context.Context, _ *deploypb.ListRecentDeploysRequest) (*deploypb.ListRecentDeploysResponse, error)
func (*Server) PollForChanges ¶
Click to show internal directories.
Click to hide internal directories.