adapters

Documentation

Index

• type HTTPClient
  • func NewHTTPClient() *HTTPClient
  • func (c *HTTPClient) ConfigureClientWithOptions(opts *config.Options, out io.Writer) error
  • func (c *HTTPClient) CreatePullRequestFromTemplate(params templates.CreatePullRequestFromTemplateParams) (string, error)
  • func (c *HTTPClient) DeleteClusters(params clusters.DeleteClustersParams) (string, error)
  • func (c *HTTPClient) EnableCLIAuth() *HTTPClient
  • func (c *HTTPClient) GetBaseClient() *http.Client
  • func (c *HTTPClient) GetClient() *resty.Client
  • func (c *HTTPClient) GetClusterKubeconfig(name string) (string, error)
  • func (c *HTTPClient) RenderTemplateWithParameters(kind templates.TemplateKind, name string, parameters map[string]string, ...) (string, error)
  • func (c *HTTPClient) RetrieveClusters() ([]clusters.Cluster, error)
  • func (c *HTTPClient) RetrieveCredentials() ([]templates.Credentials, error)
  • func (c *HTTPClient) RetrieveCredentialsByName(name string) (templates.Credentials, error)
  • func (c *HTTPClient) RetrieveProfiles() (*pb.GetProfilesResponse, error)
  • func (c *HTTPClient) RetrieveTemplate(name string, kind templates.TemplateKind) (*templates.Template, error)
  • func (c *HTTPClient) RetrieveTemplateParameters(kind templates.TemplateKind, name string) ([]templates.TemplateParameter, error)
  • func (c *HTTPClient) RetrieveTemplateProfiles(name string) ([]templates.Profile, error)
  • func (c *HTTPClient) RetrieveTemplates(kind templates.TemplateKind) ([]templates.Template, error)
  • func (c *HTTPClient) RetrieveTemplatesByProvider(kind templates.TemplateKind, provider string) ([]templates.Template, error)
  • func (c *HTTPClient) SetTLSClientConfig(config *tls.Config)
  • func (c *HTTPClient) SetTransport(transport http.RoundTripper)
  • 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() *HTTPClient

NewHTTPClient returns a new HTTP client for requests to Weave GitOps services.

func (*HTTPClient) ConfigureClientWithOptions

func (c *HTTPClient) ConfigureClientWithOptions(opts *config.Options, out io.Writer) error

ConfigureClientWithOptions accepts a config.Options object that configures the client with the necessary options to make a request.

func (*HTTPClient) CreatePullRequestFromTemplate

func (c *HTTPClient) CreatePullRequestFromTemplate(params templates.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) EnableCLIAuth

func (c *HTTPClient) EnableCLIAuth() *HTTPClient

EnableCLIAuth configures client to authenticate automatically with with either username or password, or kubeconfig, when a request is executed.

func (*HTTPClient) GetBaseClient

func (c *HTTPClient) GetBaseClient() *http.Client

GetBaseClient returns the underlying http.Client object.

func (*HTTPClient) GetClient

func (c *HTTPClient) GetClient() *resty.Client

GetClient returns the internal *resty.Client object.

func (*HTTPClient) GetClusterKubeconfig

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

func (*HTTPClient) RenderTemplateWithParameters

func (c *HTTPClient) RenderTemplateWithParameters(kind templates.TemplateKind, name string, parameters map[string]string, creds templates.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() ([]templates.Credentials, error)

RetrieveCredentials returns a list of all CAPI credentials.

func (*HTTPClient) RetrieveCredentialsByName

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

RetrieveCredentialsByName returns a specific set of CAPI credentials.

func (*HTTPClient) RetrieveProfiles

func (c *HTTPClient) RetrieveProfiles() (*pb.GetProfilesResponse, error)

func (*HTTPClient) RetrieveTemplate

func (c *HTTPClient) RetrieveTemplate(name string, kind templates.TemplateKind) (*templates.Template, error)

RetrieveTemplate returns a template from the cluster service.

func (*HTTPClient) RetrieveTemplateParameters

func (c *HTTPClient) RetrieveTemplateParameters(kind templates.TemplateKind, name string) ([]templates.TemplateParameter, error)

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

func (*HTTPClient) RetrieveTemplateProfiles

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

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

func (*HTTPClient) RetrieveTemplates

func (c *HTTPClient) RetrieveTemplates(kind templates.TemplateKind) ([]templates.Template, error)

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

func (*HTTPClient) RetrieveTemplatesByProvider

func (c *HTTPClient) RetrieveTemplatesByProvider(kind templates.TemplateKind, provider string) ([]templates.Template, error)

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

func (*HTTPClient) SetTLSClientConfig

func (c *HTTPClient) SetTLSClientConfig(config *tls.Config)

SetTLSClientConfig method sets TLSClientConfig for underling client Transport.

func (*HTTPClient) SetTransport

func (c *HTTPClient) SetTransport(transport http.RoundTripper)

SetTransport method sets custom `*http.Transport` or any `http.RoundTripper` compatible interface implementation in the client.

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 templates.Credentials `json:"credentials"`
}

POST request payload