client

Documentation

Index

• type Client
  • func New(client *http.Client, baseURL string) *Client
  • func (c *Client) Delete() error
  • func (c *Client) GetConfig(configs []string) (GetConfigResult, error)
  • func (c *Client) IsPullSecretDefined() (bool, error)
  • func (c *Client) SetConfig(configs SetConfigRequest) (SetOrUnsetConfigResult, error)
  • func (c *Client) SetPullSecret(data string) error
  • func (c *Client) Start(config StartConfig) (StartResult, error)
  • func (c *Client) Status() (ClusterStatusResult, error)
  • func (c *Client) Stop() error
  • func (c *Client) Telemetry(action string) error
  • func (c *Client) UnsetConfig(configs []string) (SetOrUnsetConfigResult, error)
  • func (c *Client) Version() (VersionResult, error)
  • func (c *Client) WebconsoleURL() (ConsoleResult, error)
• type ClusterStatusResult
• type ConsoleResult
• type GetConfigResult
• type GetOrUnsetConfigRequest
• type SetConfigRequest
• type SetOrUnsetConfigResult
• type StartConfig
• type StartResult
• type TelemetryRequest
• type VersionResult

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(client *http.Client, baseURL string) *Client

func (*Client) Delete

func (c *Client) Delete() error

func (*Client) GetConfig

func (c *Client) GetConfig(configs []string) (GetConfigResult, error)

func (*Client) IsPullSecretDefined

func (c *Client) IsPullSecretDefined() (bool, error)

func (*Client) SetConfig

func (c *Client) SetConfig(configs SetConfigRequest) (SetOrUnsetConfigResult, error)

func (*Client) SetPullSecret

func (c *Client) SetPullSecret(data string) error

func (*Client) Start

func (c *Client) Start(config StartConfig) (StartResult, error)

func (*Client) Status

func (c *Client) Status() (ClusterStatusResult, error)

func (*Client) Stop

func (c *Client) Stop() error

func (*Client) Telemetry

func (c *Client) Telemetry(action string) error

func (*Client) UnsetConfig

func (c *Client) UnsetConfig(configs []string) (SetOrUnsetConfigResult, error)

func (*Client) Version

func (c *Client) Version() (VersionResult, error)

func (*Client) WebconsoleURL

func (c *Client) WebconsoleURL() (ConsoleResult, error)

type ClusterStatusResult

type ClusterStatusResult struct {
	CrcStatus        string
	OpenshiftStatus  string
	OpenshiftVersion string
	PodmanVersion    string
	DiskUse          int64
	DiskSize         int64
	Preset           preset.Preset
}

type ConsoleResult

type ConsoleResult struct {
	ClusterConfig types.ClusterConfig
}

type GetConfigResult

type GetConfigResult struct {
	Configs map[string]interface{}
}

getConfigResult struct is used to return the result of getconfig command

type GetOrUnsetConfigRequest

type GetOrUnsetConfigRequest struct {
	Properties []string `json:"properties"`
}

type SetConfigRequest

type SetConfigRequest struct {
	Properties map[string]interface{} `json:"properties"`
}

type SetOrUnsetConfigResult

type SetOrUnsetConfigResult struct {
	Properties []string
}

setOrUnsetConfigResult struct is used to return the result of setconfig/unsetconfig command

type StartConfig

type StartConfig struct {
	PullSecretFile string `json:"pullSecretFile"`
}

type StartResult

type StartResult struct {
	Status         string
	ClusterConfig  types.ClusterConfig
	KubeletStarted bool
}

type TelemetryRequest

type TelemetryRequest struct {
	Action string `json:"action"`
	Source string `json:"source"`
	Status string `json:"status"`
}

type VersionResult

type VersionResult struct {
	CrcVersion       string
	CommitSha        string
	OpenshiftVersion string
	PodmanVersion    string
}