adapters

Documentation

Index

• type HTTPClient
  • func NewHttpClient(endpoint string, client *resty.Client, out io.Writer) (*HTTPClient, error)
  • func (c *HTTPClient) CreatePullRequestFromTemplate(params capi.CreatePullRequestFromTemplateParams) (string, error)
  • func (c *HTTPClient) DeleteClusters(params clusters.DeleteClustersParams) (string, error)
  • func (c *HTTPClient) GetClusterKubeconfig(name string) (string, error)
  • func (c *HTTPClient) RenderTemplateWithParameters(name string, parameters map[string]string, creds capi.Credentials) (string, error)
  • func (c *HTTPClient) RetrieveClusters() ([]clusters.Cluster, error)
  • func (c *HTTPClient) RetrieveCredentials() ([]capi.Credentials, error)
  • func (c *HTTPClient) RetrieveCredentialsByName(name string) (capi.Credentials, error)
  • func (c *HTTPClient) RetrieveTemplateParameters(name string) ([]capi.TemplateParameter, error)
  • func (c *HTTPClient) RetrieveTemplateProfiles(name string) ([]capi.Profile, error)
  • func (c *HTTPClient) RetrieveTemplates() ([]capi.Template, error)
  • func (c *HTTPClient) RetrieveTemplatesByProvider(provider string) ([]capi.Template, error)
  • func (c *HTTPClient) Source() string
• type ServiceError
• type TemplateParameterValuesAndCredentials

Types

type HTTPClient

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

An HTTP client of the cluster service.

func NewHttpClient

func NewHttpClient(endpoint string, client *resty.Client, out io.Writer) (*HTTPClient, error)

NewHttpClient creates a new HTTP client of the cluster service. The endpoint is expected to be an absolute HTTP URI.

func (*HTTPClient) CreatePullRequestFromTemplate

func (c *HTTPClient) CreatePullRequestFromTemplate(params capi.CreatePullRequestFromTemplateParams) (string, error)

CreatePullRequestFromTemplate commits the YAML template to the specified branch and creates a pull request of that branch.

func (*HTTPClient) DeleteClusters

func (c *HTTPClient) DeleteClusters(params clusters.DeleteClustersParams) (string, error)

DeleteClusters deletes CAPI cluster using its name

func (*HTTPClient) GetClusterKubeconfig

func (c *HTTPClient) GetClusterKubeconfig(name string) (string, error)

func (*HTTPClient) RenderTemplateWithParameters

func (c *HTTPClient) RenderTemplateWithParameters(name string, parameters map[string]string, creds capi.Credentials) (string, error)

RenderTemplateWithParameters returns a YAML representation of the specified template populated with the supplied parameters.

func (*HTTPClient) RetrieveClusters

func (c *HTTPClient) RetrieveClusters() ([]clusters.Cluster, error)

RetrieveClusters returns the list of all clusters from the cluster service.

func (*HTTPClient) RetrieveCredentials

func (c *HTTPClient) RetrieveCredentials() ([]capi.Credentials, error)

RetrieveCredentials returns a list of all CAPI credentials.

func (*HTTPClient) RetrieveCredentialsByName

func (c *HTTPClient) RetrieveCredentialsByName(name string) (capi.Credentials, error)

RetrieveCredentialsByName returns a specific set of CAPI credentials.

func (*HTTPClient) RetrieveTemplateParameters

func (c *HTTPClient) RetrieveTemplateParameters(name string) ([]capi.TemplateParameter, error)

RetrieveTemplateParameters returns the list of all parameters of the specified template.

func (*HTTPClient) RetrieveTemplateProfiles

func (c *HTTPClient) RetrieveTemplateProfiles(name string) ([]capi.Profile, error)

RetrieveTemplateProfiles returns the list of all profiles of the specified template.

func (*HTTPClient) RetrieveTemplates

func (c *HTTPClient) RetrieveTemplates() ([]capi.Template, error)

RetrieveTemplates returns the list of all templates from the cluster service.

func (*HTTPClient) RetrieveTemplatesByProvider

func (c *HTTPClient) RetrieveTemplatesByProvider(provider string) ([]capi.Template, error)

RetrieveTemplatesByProvider returns the list of all templates for a given provider from the cluster service.

func (*HTTPClient) Source

func (c *HTTPClient) Source() string

Source returns the endpoint of the cluster service.

type ServiceError

type ServiceError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

type TemplateParameterValuesAndCredentials

type TemplateParameterValuesAndCredentials struct {
	Values      map[string]string `json:"values"`
	Credentials capi.Credentials  `json:"credentials"`
}

POST request payload