Documentation
¶
Index ¶
- Variables
- type Client
- func (c *Client) CreateProject(req *models.ProjectCreateRequest) (*models.Project, error)
- func (c *Client) CreateServer(req *models.ServerCreateRequest) (*models.Server, error)
- func (c *Client) DeleteAddonDeployment(deploymentID string) error
- func (c *Client) DeleteProject(projectID string) error
- func (c *Client) DeleteServer(serverID string) error
- func (c *Client) DeployAddon(req *models.AddonDeployRequest) (*models.AddonDeployResponse, error)
- func (c *Client) GetAddon(addonID string) (*models.Addon, error)
- func (c *Client) GetAddonDeployments(projectID string) ([]models.AddonDeployment, error)
- func (c *Client) GetAddons() (*models.AddonListResponse, error)
- func (c *Client) GetConfig() *config.Config
- func (c *Client) GetContainers(projectID string, addonID string) (*models.ListContainersResponse, error)
- func (c *Client) GetLogs(req *models.LogsRequest) (*models.LogsResponse, error)
- func (c *Client) GetOperatorID() string
- func (c *Client) GetProject(projectID string) (*models.Project, error)
- func (c *Client) GetProjects() (*models.ProjectsResponse, error)
- func (c *Client) GetServer(serverID string) (*models.Server, error)
- func (c *Client) GetServers() (*models.ServersResponse, error)
- func (c *Client) GetServices(projectID string, addonID string) (*models.ListServicesResponse, error)
- func (c *Client) GetToken() string
- func (c *Client) IsAuthenticated() bool
- func (c *Client) LoadConfig() error
- func (c *Client) SaveConfig() error
- func (c *Client) SetOperatorID(operatorID string)
- func (c *Client) SetToken(token string)
- func (c *Client) StartExec(req *models.ExecRequest) (*models.ExecResponse, error)
- func (c *Client) StartProxy(req *models.ProxyRequest) (*models.ProxyResponse, error)
- func (c *Client) StartShell(req *models.ShellRequest) (*models.ShellResponse, error)
- func (c *Client) StreamLogs(req *models.LogsRequest, callback func(*models.StreamLogEntry) error) error
- func (c *Client) UpdateProject(projectID string, req *models.ProjectUpdateRequest) (*models.Project, error)
- func (c *Client) UpdateServer(serverID string, req *models.ServerUpdateRequest) (*models.Server, error)
- func (c *Client) VerifyToken() (*models.PipeOpsTokenVerificationResponse, error)
- type ClientAPI
- type MockClient
- func (m *MockClient) CreateProject(req *models.ProjectCreateRequest) (*models.Project, error)
- func (m *MockClient) CreateServer(req *models.ServerCreateRequest) (*models.Server, error)
- func (m *MockClient) DeleteAddonDeployment(deploymentID string) error
- func (m *MockClient) DeleteProject(projectID string) error
- func (m *MockClient) DeleteServer(serverID string) error
- func (m *MockClient) DeployAddon(req *models.AddonDeployRequest) (*models.AddonDeployResponse, error)
- func (m *MockClient) GetAddon(addonID string) (*models.Addon, error)
- func (m *MockClient) GetAddonDeployments(projectID string) ([]models.AddonDeployment, error)
- func (m *MockClient) GetAddons() (*models.AddonListResponse, error)
- func (m *MockClient) GetConfig() *config.Config
- func (m *MockClient) GetContainers(projectID string, addonID string) (*models.ListContainersResponse, error)
- func (m *MockClient) GetLogs(req *models.LogsRequest) (*models.LogsResponse, error)
- func (m *MockClient) GetProject(projectID string) (*models.Project, error)
- func (m *MockClient) GetProjects() (*models.ProjectsResponse, error)
- func (m *MockClient) GetServer(serverID string) (*models.Server, error)
- func (m *MockClient) GetServers() (*models.ServersResponse, error)
- func (m *MockClient) GetServices(projectID string, addonID string) (*models.ListServicesResponse, error)
- func (m *MockClient) IsAuthenticated() bool
- func (m *MockClient) LoadConfig() error
- func (m *MockClient) SaveConfig() error
- func (m *MockClient) StartExec(req *models.ExecRequest) (*models.ExecResponse, error)
- func (m *MockClient) StartProxy(req *models.ProxyRequest) (*models.ProxyResponse, error)
- func (m *MockClient) StartShell(req *models.ShellRequest) (*models.ShellResponse, error)
- func (m *MockClient) StreamLogs(req *models.LogsRequest, callback func(*models.StreamLogEntry) error) error
- func (m *MockClient) UpdateProject(projectID string, req *models.ProjectUpdateRequest) (*models.Project, error)
- func (m *MockClient) UpdateServer(serverID string, req *models.ServerUpdateRequest) (*models.Server, error)
- func (m *MockClient) VerifyToken() (*models.PipeOpsTokenVerificationResponse, error)
Constants ¶
This section is empty.
Variables ¶
var ( NewClientFunc = NewClient NewClientWithConfigFunc = NewClientWithConfig )
Factory functions for creating clients, can be swapped for testing
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client represents the PipeOps client wrapping the Go SDK
func (*Client) CreateProject ¶
CreateProject creates a new project
func (*Client) CreateServer ¶ added in v0.2.9
CreateServer creates a new server
func (*Client) DeleteAddonDeployment ¶
DeleteAddonDeployment deletes an addon deployment
func (*Client) DeleteProject ¶
DeleteProject deletes a project
func (*Client) DeleteServer ¶ added in v0.2.9
DeleteServer deletes a server
func (*Client) DeployAddon ¶
func (c *Client) DeployAddon(req *models.AddonDeployRequest) (*models.AddonDeployResponse, error)
DeployAddon deploys an addon
func (*Client) GetAddonDeployments ¶
func (c *Client) GetAddonDeployments(projectID string) ([]models.AddonDeployment, error)
GetAddonDeployments retrieves a list of addon deployments
func (*Client) GetAddons ¶
func (c *Client) GetAddons() (*models.AddonListResponse, error)
GetAddons retrieves a list of addons
func (*Client) GetContainers ¶
func (c *Client) GetContainers(projectID string, addonID string) (*models.ListContainersResponse, error)
GetContainers retrieves containers for a project
func (*Client) GetLogs ¶
func (c *Client) GetLogs(req *models.LogsRequest) (*models.LogsResponse, error)
GetLogs retrieves project logs
func (*Client) GetOperatorID ¶
GetOperatorID returns the operator ID
func (*Client) GetProject ¶
GetProject retrieves a specific project
func (*Client) GetProjects ¶
func (c *Client) GetProjects() (*models.ProjectsResponse, error)
GetProjects retrieves all projects
func (*Client) GetServers ¶ added in v0.2.9
func (c *Client) GetServers() (*models.ServersResponse, error)
GetServers retrieves all servers
func (*Client) GetServices ¶
func (c *Client) GetServices(projectID string, addonID string) (*models.ListServicesResponse, error)
GetServices retrieves services for a project
func (*Client) IsAuthenticated ¶
IsAuthenticated checks if the user is authenticated
func (*Client) LoadConfig ¶
LoadConfig loads the configuration from the config file
func (*Client) SaveConfig ¶
SaveConfig saves the configuration to the config file
func (*Client) SetOperatorID ¶
SetOperatorID sets the operator ID
func (*Client) StartExec ¶
func (c *Client) StartExec(req *models.ExecRequest) (*models.ExecResponse, error)
StartExec starts an exec session
func (*Client) StartProxy ¶
func (c *Client) StartProxy(req *models.ProxyRequest) (*models.ProxyResponse, error)
StartProxy starts a proxy session
func (*Client) StartShell ¶
func (c *Client) StartShell(req *models.ShellRequest) (*models.ShellResponse, error)
StartShell starts a shell session
func (*Client) StreamLogs ¶
func (c *Client) StreamLogs(req *models.LogsRequest, callback func(*models.StreamLogEntry) error) error
StreamLogs streams project logs
func (*Client) UpdateProject ¶
func (c *Client) UpdateProject(projectID string, req *models.ProjectUpdateRequest) (*models.Project, error)
UpdateProject updates a project
func (*Client) UpdateServer ¶ added in v0.2.9
func (c *Client) UpdateServer(serverID string, req *models.ServerUpdateRequest) (*models.Server, error)
UpdateServer updates an existing server
func (*Client) VerifyToken ¶
func (c *Client) VerifyToken() (*models.PipeOpsTokenVerificationResponse, error)
VerifyToken verifies the authentication token
type ClientAPI ¶ added in v0.2.26
type ClientAPI interface {
IsAuthenticated() bool
GetProjects() (*models.ProjectsResponse, error)
GetProject(projectID string) (*models.Project, error)
CreateProject(req *models.ProjectCreateRequest) (*models.Project, error)
UpdateProject(projectID string, req *models.ProjectUpdateRequest) (*models.Project, error)
DeleteProject(projectID string) error
GetLogs(req *models.LogsRequest) (*models.LogsResponse, error)
StreamLogs(req *models.LogsRequest, callback func(*models.StreamLogEntry) error) error
GetServices(projectID string, addonID string) (*models.ListServicesResponse, error)
StartProxy(req *models.ProxyRequest) (*models.ProxyResponse, error)
GetContainers(projectID string, addonID string) (*models.ListContainersResponse, error)
StartExec(req *models.ExecRequest) (*models.ExecResponse, error)
StartShell(req *models.ShellRequest) (*models.ShellResponse, error)
GetAddons() (*models.AddonListResponse, error)
GetAddon(addonID string) (*models.Addon, error)
DeployAddon(req *models.AddonDeployRequest) (*models.AddonDeployResponse, error)
GetAddonDeployments(projectID string) ([]models.AddonDeployment, error)
DeleteAddonDeployment(deploymentID string) error
GetServers() (*models.ServersResponse, error)
GetServer(serverID string) (*models.Server, error)
CreateServer(req *models.ServerCreateRequest) (*models.Server, error)
UpdateServer(serverID string, req *models.ServerUpdateRequest) (*models.Server, error)
DeleteServer(serverID string) error
VerifyToken() (*models.PipeOpsTokenVerificationResponse, error)
LoadConfig() error
SaveConfig() error
GetConfig() *config.Config
}
ClientAPI defines the interface for PipeOps API operations
func NewClientWithConfig ¶ added in v0.2.9
NewClientWithConfig creates a new PipeOps client with the provided configuration
type MockClient ¶ added in v0.2.26
type MockClient struct {
IsAuthenticatedFunc func() bool
LoadConfigFunc func() error
SaveConfigFunc func() error
GetConfigFunc func() *config.Config
GetProjectsFunc func() (*models.ProjectsResponse, error)
GetProjectFunc func(projectID string) (*models.Project, error)
CreateProjectFunc func(req *models.ProjectCreateRequest) (*models.Project, error)
UpdateProjectFunc func(projectID string, req *models.ProjectUpdateRequest) (*models.Project, error)
DeleteProjectFunc func(projectID string) error
GetLogsFunc func(req *models.LogsRequest) (*models.LogsResponse, error)
StreamLogsFunc func(req *models.LogsRequest, callback func(*models.StreamLogEntry) error) error
GetServicesFunc func(projectID string, addonID string) (*models.ListServicesResponse, error)
StartProxyFunc func(req *models.ProxyRequest) (*models.ProxyResponse, error)
GetContainersFunc func(projectID string, addonID string) (*models.ListContainersResponse, error)
StartExecFunc func(req *models.ExecRequest) (*models.ExecResponse, error)
StartShellFunc func(req *models.ShellRequest) (*models.ShellResponse, error)
GetAddonsFunc func() (*models.AddonListResponse, error)
GetAddonFunc func(addonID string) (*models.Addon, error)
DeployAddonFunc func(req *models.AddonDeployRequest) (*models.AddonDeployResponse, error)
GetAddonDeploymentsFunc func(projectID string) ([]models.AddonDeployment, error)
DeleteAddonDeploymentFunc func(deploymentID string) error
GetServersFunc func() (*models.ServersResponse, error)
GetServerFunc func(serverID string) (*models.Server, error)
CreateServerFunc func(req *models.ServerCreateRequest) (*models.Server, error)
UpdateServerFunc func(serverID string, req *models.ServerUpdateRequest) (*models.Server, error)
DeleteServerFunc func(serverID string) error
VerifyTokenFunc func() (*models.PipeOpsTokenVerificationResponse, error)
}
MockClient is a mock implementation of ClientAPI
func (*MockClient) CreateProject ¶ added in v0.2.26
func (m *MockClient) CreateProject(req *models.ProjectCreateRequest) (*models.Project, error)
func (*MockClient) CreateServer ¶ added in v0.2.26
func (m *MockClient) CreateServer(req *models.ServerCreateRequest) (*models.Server, error)
func (*MockClient) DeleteAddonDeployment ¶ added in v0.2.26
func (m *MockClient) DeleteAddonDeployment(deploymentID string) error
func (*MockClient) DeleteProject ¶ added in v0.2.26
func (m *MockClient) DeleteProject(projectID string) error
func (*MockClient) DeleteServer ¶ added in v0.2.26
func (m *MockClient) DeleteServer(serverID string) error
func (*MockClient) DeployAddon ¶ added in v0.2.26
func (m *MockClient) DeployAddon(req *models.AddonDeployRequest) (*models.AddonDeployResponse, error)
func (*MockClient) GetAddon ¶ added in v0.2.26
func (m *MockClient) GetAddon(addonID string) (*models.Addon, error)
func (*MockClient) GetAddonDeployments ¶ added in v0.2.26
func (m *MockClient) GetAddonDeployments(projectID string) ([]models.AddonDeployment, error)
func (*MockClient) GetAddons ¶ added in v0.2.26
func (m *MockClient) GetAddons() (*models.AddonListResponse, error)
func (*MockClient) GetConfig ¶ added in v0.2.26
func (m *MockClient) GetConfig() *config.Config
func (*MockClient) GetContainers ¶ added in v0.2.26
func (m *MockClient) GetContainers(projectID string, addonID string) (*models.ListContainersResponse, error)
func (*MockClient) GetLogs ¶ added in v0.2.26
func (m *MockClient) GetLogs(req *models.LogsRequest) (*models.LogsResponse, error)
func (*MockClient) GetProject ¶ added in v0.2.26
func (m *MockClient) GetProject(projectID string) (*models.Project, error)
func (*MockClient) GetProjects ¶ added in v0.2.26
func (m *MockClient) GetProjects() (*models.ProjectsResponse, error)
func (*MockClient) GetServer ¶ added in v0.2.26
func (m *MockClient) GetServer(serverID string) (*models.Server, error)
func (*MockClient) GetServers ¶ added in v0.2.26
func (m *MockClient) GetServers() (*models.ServersResponse, error)
func (*MockClient) GetServices ¶ added in v0.2.26
func (m *MockClient) GetServices(projectID string, addonID string) (*models.ListServicesResponse, error)
func (*MockClient) IsAuthenticated ¶ added in v0.2.26
func (m *MockClient) IsAuthenticated() bool
func (*MockClient) LoadConfig ¶ added in v0.2.26
func (m *MockClient) LoadConfig() error
func (*MockClient) SaveConfig ¶ added in v0.2.26
func (m *MockClient) SaveConfig() error
func (*MockClient) StartExec ¶ added in v0.2.26
func (m *MockClient) StartExec(req *models.ExecRequest) (*models.ExecResponse, error)
func (*MockClient) StartProxy ¶ added in v0.2.26
func (m *MockClient) StartProxy(req *models.ProxyRequest) (*models.ProxyResponse, error)
func (*MockClient) StartShell ¶ added in v0.2.26
func (m *MockClient) StartShell(req *models.ShellRequest) (*models.ShellResponse, error)
func (*MockClient) StreamLogs ¶ added in v0.2.26
func (m *MockClient) StreamLogs(req *models.LogsRequest, callback func(*models.StreamLogEntry) error) error
func (*MockClient) UpdateProject ¶ added in v0.2.26
func (m *MockClient) UpdateProject(projectID string, req *models.ProjectUpdateRequest) (*models.Project, error)
func (*MockClient) UpdateServer ¶ added in v0.2.26
func (m *MockClient) UpdateServer(serverID string, req *models.ServerUpdateRequest) (*models.Server, error)
func (*MockClient) VerifyToken ¶ added in v0.2.26
func (m *MockClient) VerifyToken() (*models.PipeOpsTokenVerificationResponse, error)