kotsclient

package
v0.89.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 22, 2025 License: MIT Imports: 20 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrForbidden = errors.New("the action is not allowed for the current user or team")
)
View Source 
var (
	ErrNotFound = errors.New("not found")
)

Functions

This section is empty.

Types

type AddKOTSRegistryRequest added in v0.40.4 

type AddKOTSRegistryRequest struct {
	Provider       string `json:"provider"`
	Endpoint       string `json:"endpoint"`
	AuthType       string `json:"authType"`
	Username       string `json:"username"`
	Password       string `json:"password"`
	SkipValidation bool   `json:"skipValidation"`
}

type AddKOTSRegistryResponse added in v0.40.4 

type AddKOTSRegistryResponse struct {
	Registry *types.Registry `json:"external_registry"`
}

type ClusterNodegroupValidationError added in v0.79.0 

type ClusterNodegroupValidationError struct {
	Errors []string `json:"errors"`
}

type ClusterValidationError added in v0.58.0 

type ClusterValidationError struct {
	Errors                 []string                `json:"errors"`
	SupportedDistributions []*types.ClusterVersion `json:"supported_distributions"`
}

type CreateClusterAddonErrorResponse added in v0.72.0 

type CreateClusterAddonErrorResponse struct {
	Message string `json:"message"`
}

type CreateClusterAddonObjectStoreOpts added in v0.72.0 

type CreateClusterAddonObjectStoreOpts struct {
	ClusterID string
	Bucket    string
	DryRun    bool
}

type CreateClusterAddonObjectStoreRequest added in v0.72.0 

type CreateClusterAddonObjectStoreRequest struct {
	Bucket string `json:"bucket"`
}

type CreateClusterAddonObjectStoreResponse added in v0.72.0 

type CreateClusterAddonObjectStoreResponse struct {
	Addon *types.ClusterAddon `json:"addon"`
}

type CreateClusterDryRunResponse added in v0.79.0 

type CreateClusterDryRunResponse struct {
	TotalCost *int64                  `json:"total_cost"`
	TTL       *string                 `json:"ttl"`
	Error     CreateClusterErrorError `json:"error"`
}

type CreateClusterErrorError added in v0.59.1 

type CreateClusterErrorError struct {
	Message         string                  `json:"message"`
	MaxDiskGiB      int64                   `json:"maxDiskGiB,omitempty"`
	MaxEKS          int64                   `json:"maxEKS,omitempty"`
	MaxGKE          int64                   `json:"maxGKE,omitempty"`
	MaxAKS          int64                   `json:"maxAKS,omitempty"`
	ValidationError *ClusterValidationError `json:"validationError,omitempty"`
}

type CreateClusterErrorResponse added in v0.59.1 

type CreateClusterErrorResponse struct {
	Error CreateClusterErrorError `json:"error"`
}

type CreateClusterOpts added in v0.44.0 

type CreateClusterOpts struct {
	Name                   string
	KubernetesDistribution string
	KubernetesVersion      string
	IPFamily               string
	LicenseID              string
	NodeCount              int
	MinNodeCount           *int
	MaxNodeCount           *int
	DiskGiB                int64
	TTL                    string
	InstanceType           string
	NodeGroups             []NodeGroup
	Tags                   []types.Tag
	DryRun                 bool
}

type CreateClusterRequest added in v0.44.0 

type CreateClusterRequest struct {
	Name                   string      `json:"name"`
	KubernetesDistribution string      `json:"kubernetes_distribution"`
	KubernetesVersion      string      `json:"kubernetes_version"`
	IPFamily               string      `json:"ip_family"`
	LicenseID              string      `json:"license_id"`
	NodeCount              int         `json:"node_count"`
	MinNodeCount           *int        `json:"min_node_count"`
	MaxNodeCount           *int        `json:"max_node_count"`
	DiskGiB                int64       `json:"disk_gib"`
	TTL                    string      `json:"ttl"`
	NodeGroups             []NodeGroup `json:"node_groups"`
	InstanceType           string      `json:"instance_type"`
	Tags                   []types.Tag `json:"tags"`
}

type CreateClusterResponse added in v0.44.0 

type CreateClusterResponse struct {
	Cluster                *types.Cluster    `json:"cluster"`
	Errors                 []string          `json:"errors"`
	SupportedDistributions map[string]string `json:"supported_distributions"`
}

type CreateCustomerOpts added in v0.45.0 

type CreateCustomerOpts struct {
	Name                             string
	CustomID                         string
	Channels                         []CustomerChannel
	AppID                            string
	ExpiresAt                        string
	ExpiresAtDuration                time.Duration
	IsAirgapEnabled                  bool
	IsGitopsSupported                bool
	IsSnapshotSupported              bool
	IsKotsInstallEnabled             bool
	IsHelmInstallEnabled             *bool
	IsKurlInstallEnabled             *bool
	IsEmbeddedClusterDownloadEnabled bool
	IsGeoaxisSupported               bool
	IsHelmVMDownloadEnabled          bool
	IsIdentityServiceSupported       bool
	IsInstallerSupportEnabled        bool
	IsSupportBundleUploadEnabled     bool
	IsDeveloperModeEnabled           bool
	LicenseType                      string
	Email                            string
	EntitlementValues                []EntitlementValue
}

type CreateCustomerRequest added in v0.29.0 

type CreateCustomerRequest struct {
	Name                             string             `json:"name"`
	Channels                         []CustomerChannel  `json:"channels"`
	CustomID                         string             `json:"custom_id"`
	AppID                            string             `json:"app_id"`
	Type                             string             `json:"type"`
	ExpiresAt                        string             `json:"expires_at"`
	IsAirgapEnabled                  bool               `json:"is_airgap_enabled"`
	IsGitopsSupported                bool               `json:"is_gitops_supported"`
	IsSnapshotSupported              bool               `json:"is_snapshot_supported"`
	IsKotsInstallEnabled             bool               `json:"is_kots_install_enabled"`
	IsEmbeddedClusterDownloadEnabled bool               `json:"is_embedded_cluster_download_enabled"`
	IsGeoaxisSupported               bool               `json:"is_geoaxis_supported"`
	IsHelmVMDownloadEnabled          bool               `json:"is_helm_vm_download_enabled"`
	IsIdentityServiceSupported       bool               `json:"is_identity_service_supported"`
	IsInstallerSupportEnabled        bool               `json:"is_installer_support_enabled"`
	IsSupportBundleUploadEnabled     bool               `json:"is_support_bundle_upload_enabled"`
	IsDeveloperModeEnabled           bool               `json:"is_dev_mode_enabled"`
	Email                            string             `json:"email,omitempty"`
	EntitlementValues                []EntitlementValue `json:"entitlementValues"`

	// These fields were added after the "built in" fields feature was released.
	// If they are not pointer types, they will override the defaults.
	IsHelmInstallEnabled *bool `json:"is_helm_install_enabled,omitempty"`
	IsKurlInstallEnabled *bool `json:"is_kurl_install_enabled,omitempty"`
}

type CreateCustomerResponse added in v0.29.0 

type CreateCustomerResponse struct {
	Customer *types.Customer `json:"customer"`
}

type CreateKOTSAppRequest added in v0.31.0 

type CreateKOTSAppRequest struct {
	Name string `json:"name"`
}

type CreateVMDryRunResponse added in v0.82.0 

type CreateVMDryRunResponse struct {
	TotalCost *int64             `json:"total_cost"`
	TTL       *string            `json:"ttl"`
	Error     CreateVMErrorError `json:"error"`
}

type CreateVMErrorError added in v0.82.0 

type CreateVMErrorError struct {
	Message         string             `json:"message"`
	MaxDiskGiB      int64              `json:"maxDiskGiB,omitempty"`
	ValidationError *VMValidationError `json:"validationError,omitempty"`
}

type CreateVMErrorResponse added in v0.82.0 

type CreateVMErrorResponse struct {
	Error CreateVMErrorError `json:"error"`
}

type CreateVMOpts added in v0.82.0 

type CreateVMOpts struct {
	Name         string
	Distribution string
	Version      string
	Count        int
	DiskGiB      int64
	TTL          string
	InstanceType string
	Tags         []types.Tag
	DryRun       bool
}

type CreateVMRequest added in v0.82.0 

type CreateVMRequest struct {
	Name         string      `json:"name"`
	Distribution string      `json:"distribution"`
	Version      string      `json:"version"`
	Count        int         `json:"count"`
	DiskGiB      int64       `json:"disk_gib"`
	TTL          string      `json:"ttl"`
	InstanceType string      `json:"instance_type"`
	Tags         []types.Tag `json:"tags"`
}

type CreateVMResponse added in v0.82.0 

type CreateVMResponse struct {
	VMs                    []*types.VM       `json:"vms"`
	Errors                 []string          `json:"errors"`
	SupportedDistributions map[string]string `json:"supported_distributions"`
}

type CustomHostnamesListResponse added in v0.52.0 

type CustomHostnamesListResponse struct {
	Body types.KotsAppCustomHostnames
}

type CustomerChannel added in v0.78.0 

type CustomerChannel struct {
	ID                    string `json:"channel_id"`
	PinnedChannelSequence *int64 `json:"pinned_channel_sequence"`
	IsDefault             bool   `json:"is_default_for_customer"`
}

type CustomerGetResponse added in v0.83.2 

type CustomerGetResponse struct {
	Customer types.Customer `json:"customer"`
}

type CustomerListResponse added in v0.29.0 

type CustomerListResponse struct {
	Customers      []types.Customer `json:"customers"`
	TotalCustomers int              `json:"totalCustomers"`
}

type CustomerListWithInstancesResponse added in v0.51.0 

type CustomerListWithInstancesResponse struct {
	// Response from /v3/app/{appID}/customers
	Customers      []types.Customer `json:"customers"`
	TotalCustomers int              `json:"totalCustomers"`
}

type EnterprisePortalUser added in v0.83.2 

type EnterprisePortalUser struct {
	Email string `json:"email"`
}

type EntitlementValue added in v0.56.0 

type EntitlementValue struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type ErrCustomerNotFound added in v0.29.0 

type ErrCustomerNotFound struct {
	Name string
}

func (ErrCustomerNotFound) Error added in v0.29.0 

func (e ErrCustomerNotFound) Error() string

type ExportClusterPortRequest added in v0.71.0 

type ExportClusterPortRequest struct {
	Port       int      `json:"port"`
	Protocols  []string `json:"protocols"`
	IsWildcard bool     `json:"is_wildcard"`
}

type ExportVMPortRequest added in v0.84.0 

type ExportVMPortRequest struct {
	Port       int      `json:"port"`
	Protocols  []string `json:"protocols"`
	IsWildcard bool     `json:"is_wildcard"`
}

type ExposeClusterPortResponse added in v0.71.0 

type ExposeClusterPortResponse struct {
	Port *types.ClusterPort `json:"port"`
}

type ExposeVMPortResponse added in v0.84.0 

type ExposeVMPortResponse struct {
	Port *types.VMPort `json:"port"`
}

type GetClusterAddonResponse added in v0.72.0 

type GetClusterAddonResponse struct {
	Addon *types.ClusterAddon `json:"addon"`
}

type GetClusterKubeconfigResponse added in v0.44.0 

type GetClusterKubeconfigResponse struct {
	Kubeconfig []byte `json:"kubeconfig"`
	Error      string `json:"error"`
}

type GetClusterResponse added in v0.56.0 

type GetClusterResponse struct {
	Cluster *types.Cluster `json:"cluster"`
	Error   string         `json:"error"`
}

type GetEnterprisePortalStatusResponse added in v0.83.2 

type GetEnterprisePortalStatusResponse struct {
	Status string `json:"status"`
}

type GetVMResponse added in v0.82.0 

type GetVMResponse struct {
	VM    *types.VM `json:"vm"`
	Error string    `json:"error"`
}

type GraphQLResponseListReleases 

type GraphQLResponseListReleases struct {
	Data   *KotsReleasesData  `json:"data,omitempty"`
	Errors []graphql.GQLError `json:"errors,omitempty"`
}

type InstanceTags added in v0.64.0 

type InstanceTags struct {
	Tags []types.Tag `json:"tags"`
}

type InviteEnterprisePortalRequest added in v0.83.2 

type InviteEnterprisePortalRequest struct {
	CustomerID   string `json:"customer_id"`
	EmailAddress string `json:"email_address"`
}

type InviteEnterprisePortalResponse added in v0.83.2 

type InviteEnterprisePortalResponse struct {
	URL string `json:"url"`
}

type KOTSRegistryLogsResponse added in v0.40.4 

type KOTSRegistryLogsResponse struct {
	RegistryLogs []types.RegistryLog `json:"logs"`
}

type KotsRelease 

type KotsRelease struct {
	ID           string               `json:"id"`
	Sequence     int64                `json:"sequence"`
	CreatedAt    string               `json:"created"`
	ReleaseNotes string               `json:"releaseNotes"`
	Channels     []*types.KotsChannel `json:"channels"`
}

type KotsReleasesData 

type KotsReleasesData struct {
	KotsReleases []*KotsRelease `json:"allKotsReleases"`
}

type ListChannelsResponse added in v0.31.0 

type ListChannelsResponse struct {
	Channels []*types.KotsChannel `json:"channels"`
}

type ListClusterAddonsResponse added in v0.72.0 

type ListClusterAddonsResponse struct {
	Addons []*types.ClusterAddon `json:"addons"`
}

type ListClusterPortsResponse added in v0.71.0 

type ListClusterPortsResponse struct {
	Ports []*types.ClusterPort `json:"ports"`
}

type ListClusterVersionsResponse added in v0.50.0 

type ListClusterVersionsResponse struct {
	Clusters []*types.ClusterVersion `json:"cluster-versions"`
}

type ListClustersResponse added in v0.44.0 

type ListClustersResponse struct {
	Clusters      []*types.Cluster `json:"clusters"`
	TotalClusters int              `json:"totalClusters"`
}

type ListNetworksResponse added in v0.85.0 

type ListNetworksResponse struct {
	Networks      []*types.Network `json:"networks"`
	TotalNetworks int              `json:"totalNetworks"`
}

type ListVMPortsResponse added in v0.84.0 

type ListVMPortsResponse struct {
	Ports []*types.VMPort `json:"ports"`
}

type ListVMVersionsResponse added in v0.82.0 

type ListVMVersionsResponse struct {
	Versions []*types.VMVersion `json:"vm-versions"`
}

type ListVMsResponse added in v0.82.0 

type ListVMsResponse struct {
	VMs      []*types.VM `json:"vms"`
	TotalVMs int         `json:"totalVMs"`
}

type NodeGroup added in v0.65.0 

type NodeGroup struct {
	Name         string `json:"name"`
	InstanceType string `json:"instance_type"`
	Nodes        int    `json:"node_count"`
	MinNodes     *int   `json:"min_node_count"`
	MaxNodes     *int   `json:"max_node_count"`
	Disk         int    `json:"disk_gib"`
}

type RemoveClusterPortResponse added in v0.71.0 

type RemoveClusterPortResponse struct {
	Ports []*types.ClusterPort `json:"ports"`
}

type RemoveClusterRequest added in v0.44.0 

type RemoveClusterRequest struct {
	ID string `json:"id"`
}

type RemoveClusterResponse added in v0.44.0 

type RemoveClusterResponse struct {
	Error string `json:"error"`
}

type RemoveVMRequest added in v0.82.0 

type RemoveVMRequest struct {
	ID string `json:"id"`
}

type RemoveVMResponse added in v0.82.0 

type RemoveVMResponse struct {
	Error string `json:"error"`
}

type ReportReleaseCompatibilityErrorResponse added in v0.57.0 

type ReportReleaseCompatibilityErrorResponse struct {
	Message         string                  `json:"message"`
	ValidationError *ClusterValidationError `json:"validationError,omitempty"`
}

type ReportReleaseCompatibilityErrorResponseBody added in v0.57.0 

type ReportReleaseCompatibilityErrorResponseBody struct {
	Error ReportReleaseCompatibilityErrorResponse `json:"Error"`
}

type TestKOTSRegistryRequest added in v0.40.4 

type TestKOTSRegistryRequest struct {
	Endpoint string `json:"endpoint"`
	Image    string `json:"image"`
}

type TestKOTSRegistryResponse added in v0.40.4 

type TestKOTSRegistryResponse struct {
	Status int `json:"status"`
}

type UpdateClusterNodegroupErrorError added in v0.79.0 

type UpdateClusterNodegroupErrorError struct {
	Message         string                           `json:"message"`
	ValidationError *ClusterNodegroupValidationError `json:"validationError,omitempty"`
}

type UpdateClusterNodegroupErrorResponse added in v0.79.0 

type UpdateClusterNodegroupErrorResponse struct {
	Error UpdateClusterNodegroupErrorError `json:"Error"`
}

type UpdateClusterNodegroupOpts added in v0.79.0 

type UpdateClusterNodegroupOpts struct {
	Count    int64
	MinCount *int64
	MaxCount *int64
}

type UpdateClusterNodegroupRequest added in v0.79.0 

type UpdateClusterNodegroupRequest struct {
	Count    int64  `json:"count"`
	MinCount *int64 `json:"minCount,omitempty"`
	MaxCount *int64 `json:"maxCount,omitempty"`
}

type UpdateClusterNodegroupResponse added in v0.79.0 

type UpdateClusterNodegroupResponse struct {
	Cluster *types.Cluster `json:"cluster"`
	Errors  []string       `json:"errors"`
}

type UpdateClusterTTLOpts added in v0.60.0 

type UpdateClusterTTLOpts struct {
	TTL string
}

type UpdateClusterTTLRequest added in v0.60.0 

type UpdateClusterTTLRequest struct {
	TTL string `json:"ttl"`
}

type UpdateClusterTTLResponse added in v0.60.0 

type UpdateClusterTTLResponse struct {
	Cluster *types.Cluster `json:"cluster"`
	Errors  []string       `json:"errors"`
}

type UpdateCustomerOpts added in v0.73.2 

type UpdateCustomerOpts struct {
	Name                             string
	CustomID                         string
	Channels                         []CustomerChannel
	AppID                            string
	ExpiresAt                        string
	ExpiresAtDuration                time.Duration
	IsAirgapEnabled                  bool
	IsGitopsSupported                bool
	IsSnapshotSupported              bool
	IsKotsInstallEnabled             bool
	IsHelmInstallEnabled             *bool
	IsKurlInstallEnabled             *bool
	IsEmbeddedClusterDownloadEnabled bool
	IsGeoaxisSupported               bool
	IsHelmVMDownloadEnabled          bool
	IsIdentityServiceSupported       bool
	IsSupportBundleUploadEnabled     bool
	IsDeveloperModeEnabled           bool
	LicenseType                      string
	Email                            string
	EntitlementValues                []EntitlementValue
}

type UpdateCustomerRequest added in v0.73.2 

type UpdateCustomerRequest struct {
	Name                             string             `json:"name"`
	Channels                         []CustomerChannel  `json:"channels"`
	CustomID                         string             `json:"custom_id"`
	AppID                            string             `json:"app_id"`
	Type                             string             `json:"type"`
	ExpiresAt                        string             `json:"expires_at"`
	IsAirgapEnabled                  bool               `json:"is_airgap_enabled"`
	IsGitopsSupported                bool               `json:"is_gitops_supported"`
	IsSnapshotSupported              bool               `json:"is_snapshot_supported"`
	IsKotsInstallEnabled             bool               `json:"is_kots_install_enabled"`
	IsEmbeddedClusterDownloadEnabled bool               `json:"is_embedded_cluster_download_enabled"`
	IsGeoaxisSupported               bool               `json:"is_geoaxis_supported"`
	IsHelmVMDownloadEnabled          bool               `json:"is_helm_vm_download_enabled"`
	IsIdentityServiceSupported       bool               `json:"is_identity_service_supported"`
	IsSupportBundleUploadEnabled     bool               `json:"is_support_bundle_upload_enabled"`
	IsDeveloperModeEnabled           bool               `json:"is_dev_mode_enabled"`
	Email                            string             `json:"email,omitempty"`
	EntitlementValues                []EntitlementValue `json:"entitlementValues"`

	// These fields were added after the "built in" fields feature was released.
	// If they are not pointer types, they will override the defaults.
	IsHelmInstallEnabled *bool `json:"is_helm_install_enabled,omitempty"`
	IsKurlInstallEnabled *bool `json:"is_kurl_install_enabled,omitempty"`
}

type UpdateCustomerResponse added in v0.73.2 

type UpdateCustomerResponse struct {
	Customer *types.Customer `json:"customer"`
}

type UpdateVMTTLOpts added in v0.82.0 

type UpdateVMTTLOpts struct {
	TTL string
}

type UpdateVMTTLRequest added in v0.82.0 

type UpdateVMTTLRequest struct {
	TTL string `json:"ttl"`
}

type UpdateVMTTLResponse added in v0.82.0 

type UpdateVMTTLResponse struct {
	VM     *types.VM `json:"vm"`
	Errors []string  `json:"errors"`
}

type UpgradeClusterOpts added in v0.58.0 

type UpgradeClusterOpts struct {
	KubernetesVersion string
	DryRun            bool
}

type UpgradeClusterRequest added in v0.58.0 

type UpgradeClusterRequest struct {
	KubernetesVersion string `json:"kubernetes_version"`
}

type UpgradeClusterResponse added in v0.58.0 

type UpgradeClusterResponse struct {
	Cluster                *types.Cluster    `json:"cluster"`
	Errors                 []string          `json:"errors"`
	SupportedDistributions map[string]string `json:"supported_distributions"`
}

type VMValidationError added in v0.82.0 

type VMValidationError struct {
	Errors                 []string           `json:"errors"`
	SupportedDistributions []*types.VMVersion `json:"supported_distributions"`
}

type VendorV3Client added in v0.31.0 

type VendorV3Client struct {
	platformclient.HTTPClient
}

func (*VendorV3Client) AddKOTSRegistry added in v0.40.4 

func (c *VendorV3Client) AddKOTSRegistry(reqBody AddKOTSRegistryRequest) (*types.Registry, error)

func (*VendorV3Client) ArchiveChannel added in v0.37.0 

func (c *VendorV3Client) ArchiveChannel(appID, channelID string) error

func (*VendorV3Client) ArchiveCustomer added in v0.46.0 

func (c *VendorV3Client) ArchiveCustomer(customerID string) error

func (*VendorV3Client) CreateChannel added in v0.37.0 

func (c *VendorV3Client) CreateChannel(appID, name, description string) (*types.Channel, error)

func (*VendorV3Client) CreateCluster added in v0.44.0 

func (c *VendorV3Client) CreateCluster(opts CreateClusterOpts) (*types.Cluster, *CreateClusterErrorError, error)

func (*VendorV3Client) CreateClusterAddonObjectStore added in v0.72.0 

func (c *VendorV3Client) CreateClusterAddonObjectStore(opts CreateClusterAddonObjectStoreOpts) (*types.ClusterAddon, error)

func (*VendorV3Client) CreateCollection added in v0.77.0 

func (c *VendorV3Client) CreateCollection(name string) (*types.ModelCollection, error)

func (*VendorV3Client) CreateCustomer added in v0.31.0 

func (c *VendorV3Client) CreateCustomer(opts CreateCustomerOpts) (*types.Customer, error)

func (*VendorV3Client) CreateInstaller added in v0.37.0 

func (c *VendorV3Client) CreateInstaller(appID string, yaml string) (*types.InstallerSpec, error)

func (*VendorV3Client) CreateKOTSApp added in v0.31.0 

func (c *VendorV3Client) CreateKOTSApp(ctx context.Context, name string) (*types.KotsAppWithChannels, error)

func (*VendorV3Client) CreateRelease added in v0.36.1 

func (c *VendorV3Client) CreateRelease(appID string, multiyaml string) (*types.ReleaseInfo, error)

func (*VendorV3Client) CreateVM added in v0.82.0 

func (c *VendorV3Client) CreateVM(opts CreateVMOpts) ([]*types.VM, *CreateVMErrorError, error)

func (*VendorV3Client) DeleteClusterAddon added in v0.72.0 

func (c *VendorV3Client) DeleteClusterAddon(clusterID, addonID string) error

func (*VendorV3Client) DeleteCollection added in v0.77.0 

func (c *VendorV3Client) DeleteCollection(collectionID string) error

func (*VendorV3Client) DeleteKOTSApp added in v0.37.0 

func (c *VendorV3Client) DeleteKOTSApp(ctx context.Context, id string) error

func (*VendorV3Client) DeleteVMAddon added in v0.84.0 

func (c *VendorV3Client) DeleteVMAddon(vmID, addonID string) error

func (*VendorV3Client) DemoteChannelRelease added in v0.89.0 

func (c *VendorV3Client) DemoteChannelRelease(appID string, channelID string, channelSequence int64) (*types.ChannelRelease, error)

func (*VendorV3Client) DownloadLicense added in v0.31.0 

func (c *VendorV3Client) DownloadLicense(appID string, customerID string) ([]byte, error)

func (*VendorV3Client) ExposeClusterPort added in v0.71.0 

func (c *VendorV3Client) ExposeClusterPort(clusterID string, portNumber int, protocols []string, isWildcard bool) (*types.ClusterPort, error)

func (*VendorV3Client) ExposeVMPort added in v0.84.0 

func (c *VendorV3Client) ExposeVMPort(vmID string, portNumber int, protocols []string, isWildcard bool) (*types.VMPort, error)

func (*VendorV3Client) Get added in v0.47.0 

func (c *VendorV3Client) Get(path string) ([]byte, error)

func (*VendorV3Client) GetApp added in v0.37.0 

func (c *VendorV3Client) GetApp(ctx context.Context, appIDOrSlug string, excludeChannels bool) (*types.App, error)

func (*VendorV3Client) GetChannel added in v0.34.0 

func (c *VendorV3Client) GetChannel(appID string, channelID string) (*types.Channel, error)

func (*VendorV3Client) GetCluster added in v0.53.1 

func (c *VendorV3Client) GetCluster(id string) (*types.Cluster, error)

func (*VendorV3Client) GetClusterAddon added in v0.72.0 

func (c *VendorV3Client) GetClusterAddon(clusterID, id string) (*types.ClusterAddon, error)

func (*VendorV3Client) GetClusterKubeconfig added in v0.44.0 

func (c *VendorV3Client) GetClusterKubeconfig(id string) ([]byte, error)

func (*VendorV3Client) GetCustomerByID added in v0.83.2 

func (c *VendorV3Client) GetCustomerByID(customerID string) (*types.Customer, error)

func (*VendorV3Client) GetCustomerByName added in v0.31.0 

func (c *VendorV3Client) GetCustomerByName(appID string, name string) (*types.Customer, error)

func (*VendorV3Client) GetCustomerByNameOrId added in v0.58.0 

func (c *VendorV3Client) GetCustomerByNameOrId(appID string, nameOrId string) (*types.Customer, error)

func (*VendorV3Client) GetEnterprisePortalStatus added in v0.83.2 

func (c *VendorV3Client) GetEnterprisePortalStatus(appID string) (string, error)

func (*VendorV3Client) GetKotsChannel added in v0.85.0 

func (c *VendorV3Client) GetKotsChannel(appID string, channelID string) (*types.KotsChannel, error)

func (*VendorV3Client) GetModelsEndpoint added in v0.80.0 

func (c *VendorV3Client) GetModelsEndpoint() (string, error)

func (*VendorV3Client) GetRelease added in v0.37.0 

func (c *VendorV3Client) GetRelease(appID string, sequence int64) (*types.AppRelease, error)

func (*VendorV3Client) GetVM added in v0.82.0 

func (c *VendorV3Client) GetVM(id string) (*types.VM, error)

func (*VendorV3Client) LintRelease added in v0.37.0 

func (c *VendorV3Client) LintRelease(data []byte, isBuildersRelease bool, contentType string) ([]types.LintMessage, error)

this is part of the gql client with plans to rename gql client to kotsclient and have endpoints for multiple release services included

func (*VendorV3Client) ListApps added in v0.37.0 

func (c *VendorV3Client) ListApps(ctx context.Context, excludeChannels bool) ([]types.AppAndChannels, error)

func (*VendorV3Client) ListChannels added in v0.31.0 

func (c *VendorV3Client) ListChannels(appID string, channelName string) ([]*types.Channel, error)

func (*VendorV3Client) ListClusterAddons added in v0.72.0 

func (c *VendorV3Client) ListClusterAddons(clusterID string) ([]*types.ClusterAddon, error)

func (*VendorV3Client) ListClusterPorts added in v0.71.0 

func (c *VendorV3Client) ListClusterPorts(clusterID string) ([]*types.ClusterPort, error)

func (*VendorV3Client) ListClusterVersions added in v0.50.0 

func (c *VendorV3Client) ListClusterVersions() ([]*types.ClusterVersion, error)

func (*VendorV3Client) ListClusters added in v0.44.0 

func (c *VendorV3Client) ListClusters(includeTerminated bool, startTime *time.Time, endTime *time.Time) ([]*types.Cluster, error)

func (*VendorV3Client) ListCollections added in v0.77.0 

func (c *VendorV3Client) ListCollections() ([]types.ModelCollection, error)

func (*VendorV3Client) ListCustomHostnames added in v0.52.0 

func (c *VendorV3Client) ListCustomHostnames(appID string) (*types.KotsAppCustomHostnames, error)

func (*VendorV3Client) ListCustomers added in v0.31.0 

func (c *VendorV3Client) ListCustomers(appID string, includeTest bool) ([]types.Customer, error)

func (*VendorV3Client) ListCustomersByAppAndVersion added in v0.51.0 

func (c *VendorV3Client) ListCustomersByAppAndVersion(appID string, appVersion string, appType string) ([]types.Customer, error)

func (*VendorV3Client) ListEnterprisePortalUsers added in v0.83.2 

func (c *VendorV3Client) ListEnterprisePortalUsers(appID string, includeInvites bool) ([]EnterprisePortalUser, error)

func (*VendorV3Client) ListInstallers added in v0.37.0 

func (c *VendorV3Client) ListInstallers(appID string) ([]types.InstallerSpec, error)

func (*VendorV3Client) ListKotsChannels added in v0.52.0 

func (c *VendorV3Client) ListKotsChannels(appID string, channelName string, excludeDetails bool) ([]*types.KotsChannel, error)

func (*VendorV3Client) ListModels added in v0.77.0 

func (c *VendorV3Client) ListModels() ([]types.Model, error)

func (*VendorV3Client) ListNetworks added in v0.85.0 

func (c *VendorV3Client) ListNetworks(startTime *time.Time, endTime *time.Time) ([]*types.Network, error)

func (*VendorV3Client) ListRegistries added in v0.40.4 

func (c *VendorV3Client) ListRegistries() ([]types.Registry, error)

func (*VendorV3Client) ListReleases added in v0.33.2 

func (c *VendorV3Client) ListReleases(appID string) ([]types.ReleaseInfo, error)

func (*VendorV3Client) ListVMPorts added in v0.84.0 

func (c *VendorV3Client) ListVMPorts(vmID string) ([]*types.VMPort, error)

func (*VendorV3Client) ListVMVersions added in v0.82.0 

func (c *VendorV3Client) ListVMVersions() ([]*types.VMVersion, error)

func (*VendorV3Client) ListVMs added in v0.82.0 

func (c *VendorV3Client) ListVMs(includeTerminated bool, startTime *time.Time, endTime *time.Time) ([]*types.VM, error)

func (*VendorV3Client) LogsRegistry added in v0.40.4 

func (c *VendorV3Client) LogsRegistry(hostname string) ([]types.RegistryLog, error)

func (*VendorV3Client) Patch added in v0.81.0 

func (c *VendorV3Client) Patch(path string, body string) ([]byte, error)

func (*VendorV3Client) Post added in v0.47.0 

func (c *VendorV3Client) Post(path string, body string) ([]byte, error)

func (*VendorV3Client) PromoteInstaller added in v0.37.0 

func (c *VendorV3Client) PromoteInstaller(appID string, sequence int64, channelID string, versionLabel string) error

func (*VendorV3Client) PromoteRelease added in v0.37.0 

func (c *VendorV3Client) PromoteRelease(appID string, sequence int64, label string, notes string, required bool, channelIDs ...string) error

func (*VendorV3Client) Put added in v0.47.0 

func (c *VendorV3Client) Put(path string, body string) ([]byte, error)

func (*VendorV3Client) RemoveCluster added in v0.44.0 

func (c *VendorV3Client) RemoveCluster(id string) error

func (*VendorV3Client) RemoveClusterPort added in v0.71.0 

func (c *VendorV3Client) RemoveClusterPort(clusterID string, portNumber int, protocols []string) ([]*types.ClusterPort, error)

func (*VendorV3Client) RemoveKOTSRegistry added in v0.40.4 

func (c *VendorV3Client) RemoveKOTSRegistry(endpoint string) error

func (*VendorV3Client) RemoveModel added in v0.80.0 

func (c *VendorV3Client) RemoveModel(modelName string) ([]types.Model, error)

func (*VendorV3Client) RemoveRegistry added in v0.40.4 

func (c *VendorV3Client) RemoveRegistry(endpoint string) error

func (*VendorV3Client) RemoveVM added in v0.82.0 

func (c *VendorV3Client) RemoveVM(id string) error

func (*VendorV3Client) ReportReleaseCompatibility added in v0.57.0 

func (c *VendorV3Client) ReportReleaseCompatibility(appID string, sequence int64, distribution string, version string, success bool, notes string) (*ClusterValidationError, error)

func (*VendorV3Client) SendEnterprisePortalInvite added in v0.83.2 

func (c *VendorV3Client) SendEnterprisePortalInvite(appID string, customerID string, emailAddress string) (string, error)

func (*VendorV3Client) SetIntanceTags added in v0.64.0 

func (c *VendorV3Client) SetIntanceTags(appID string, customerID string, instanceID string, tags []types.Tag) (*types.Instance, error)

func (*VendorV3Client) TestKOTSRegistry added in v0.40.4 

func (c *VendorV3Client) TestKOTSRegistry(hostname string, image string) (int, error)

func (*VendorV3Client) TestRelease added in v0.44.0 

func (c *VendorV3Client) TestRelease(appID string, sequence int64) (string, error)

func (*VendorV3Client) UnDemoteChannelRelease added in v0.89.0 

func (c *VendorV3Client) UnDemoteChannelRelease(appID string, channelID string, channelSequence int64) (*types.ChannelRelease, error)

func (*VendorV3Client) UpdateClusterNodegroup added in v0.79.0 

func (c *VendorV3Client) UpdateClusterNodegroup(clusterID string, nodegroupID string, opts UpdateClusterNodegroupOpts) (*types.Cluster, *UpdateClusterNodegroupErrorError, error)

func (*VendorV3Client) UpdateClusterTTL added in v0.60.0 

func (c *VendorV3Client) UpdateClusterTTL(clusterID string, opts UpdateClusterTTLOpts) (*types.Cluster, error)

func (*VendorV3Client) UpdateCustomer added in v0.73.2 

func (c *VendorV3Client) UpdateCustomer(customerID string, opts UpdateCustomerOpts) (*types.Customer, error)

func (*VendorV3Client) UpdateEnterprisePortalStatus added in v0.83.2 

func (c *VendorV3Client) UpdateEnterprisePortalStatus(appID string, status string) (string, error)

func (*VendorV3Client) UpdateModelsInCollection added in v0.77.0 

func (c *VendorV3Client) UpdateModelsInCollection(collectionID string, modelsToAdd []string, modelsToRemove []string) error

func (*VendorV3Client) UpdateRelease added in v0.36.1 

func (c *VendorV3Client) UpdateRelease(appID string, sequence int64, multiyaml string) error

func (*VendorV3Client) UpdateSemanticVersioning added in v0.38.0 

func (c *VendorV3Client) UpdateSemanticVersioning(appID string, channel *types.Channel, enableSemver bool) error

func (*VendorV3Client) UpdateVMTTL added in v0.82.0 

func (c *VendorV3Client) UpdateVMTTL(vmID string, opts UpdateVMTTLOpts) (*types.VM, error)

func (*VendorV3Client) UpgradeCluster added in v0.58.0 

func (c *VendorV3Client) UpgradeCluster(clusterID string, opts UpgradeClusterOpts) (*types.Cluster, *ClusterValidationError, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.