Documentation ¶
Index ¶
- Variables
- type AddKOTSRegistryRequest
- type AddKOTSRegistryResponse
- type ClusterNodegroupValidationError
- type ClusterValidationError
- type CreateClusterAddonErrorResponse
- type CreateClusterAddonObjectStoreOpts
- type CreateClusterAddonObjectStoreRequest
- type CreateClusterAddonObjectStoreResponse
- type CreateClusterAddonPostgresOpts
- type CreateClusterAddonPostgresRequest
- type CreateClusterDryRunResponse
- type CreateClusterErrorError
- type CreateClusterErrorResponse
- type CreateClusterOpts
- type CreateClusterRequest
- type CreateClusterResponse
- type CreateCustomerOpts
- type CreateCustomerRequest
- type CreateCustomerResponse
- type CreateKOTSAppRequest
- type CreateVMDryRunResponse
- type CreateVMErrorError
- type CreateVMErrorResponse
- type CreateVMOpts
- type CreateVMRequest
- type CreateVMResponse
- type CustomHostnamesListResponse
- type CustomerChannel
- type CustomerGetResponse
- type CustomerListResponse
- type CustomerListWithInstancesResponse
- type EnterprisePortalUser
- type EntitlementValue
- type ErrCustomerNotFound
- type ExportClusterPortRequest
- type ExportVMPortRequest
- type ExposeClusterPortResponse
- type ExposeVMPortResponse
- type GetClusterAddonResponse
- type GetClusterKubeconfigResponse
- type GetClusterResponse
- type GetEnterprisePortalStatusResponse
- type GetVMResponse
- type GraphQLResponseListReleases
- type InstanceTags
- type InviteEnterprisePortalRequest
- type InviteEnterprisePortalResponse
- type KOTSRegistryLogsResponse
- type KotsRelease
- type KotsReleasesData
- type ListChannelsResponse
- type ListClusterAddonsResponse
- type ListClusterPortsResponse
- type ListClusterVersionsResponse
- type ListClustersResponse
- type ListVMPortsResponse
- type ListVMVersionsResponse
- type ListVMsResponse
- type NodeGroup
- type RemoveClusterPortResponse
- type RemoveClusterRequest
- type RemoveClusterResponse
- type RemoveVMRequest
- type RemoveVMResponse
- type ReportReleaseCompatibilityErrorResponse
- type ReportReleaseCompatibilityErrorResponseBody
- type TestKOTSRegistryRequest
- type TestKOTSRegistryResponse
- type UpdateClusterNodegroupErrorError
- type UpdateClusterNodegroupErrorResponse
- type UpdateClusterNodegroupOpts
- type UpdateClusterNodegroupRequest
- type UpdateClusterNodegroupResponse
- type UpdateClusterTTLOpts
- type UpdateClusterTTLRequest
- type UpdateClusterTTLResponse
- type UpdateCustomerOpts
- type UpdateCustomerRequest
- type UpdateCustomerResponse
- type UpdateVMTTLOpts
- type UpdateVMTTLRequest
- type UpdateVMTTLResponse
- type UpgradeClusterOpts
- type UpgradeClusterRequest
- type UpgradeClusterResponse
- type VMValidationError
- type VendorV3Client
- func (c *VendorV3Client) AddKOTSRegistry(reqBody AddKOTSRegistryRequest) (*types.Registry, error)
- func (c *VendorV3Client) ArchiveChannel(appID, channelID string) error
- func (c *VendorV3Client) ArchiveCustomer(customerID string) error
- func (c *VendorV3Client) CreateChannel(appID, name, description string) (*types.Channel, error)
- func (c *VendorV3Client) CreateCluster(opts CreateClusterOpts) (*types.Cluster, *CreateClusterErrorError, error)
- func (c *VendorV3Client) CreateClusterAddonObjectStore(opts CreateClusterAddonObjectStoreOpts) (*types.ClusterAddon, error)
- func (c *VendorV3Client) CreateClusterAddonPostgres(opts CreateClusterAddonPostgresOpts) (*types.ClusterAddon, error)
- func (c *VendorV3Client) CreateCollection(name string) (*types.ModelCollection, error)
- func (c *VendorV3Client) CreateCustomer(opts CreateCustomerOpts) (*types.Customer, error)
- func (c *VendorV3Client) CreateInstaller(appID string, yaml string) (*types.InstallerSpec, error)
- func (c *VendorV3Client) CreateKOTSApp(ctx context.Context, name string) (*types.KotsAppWithChannels, error)
- func (c *VendorV3Client) CreateRelease(appID string, multiyaml string) (*types.ReleaseInfo, error)
- func (c *VendorV3Client) CreateVM(opts CreateVMOpts) ([]*types.VM, *CreateVMErrorError, error)
- func (c *VendorV3Client) DeleteClusterAddon(clusterID, addonID string) error
- func (c *VendorV3Client) DeleteCollection(collectionID string) error
- func (c *VendorV3Client) DeleteKOTSApp(ctx context.Context, id string) error
- func (c *VendorV3Client) DeleteVMAddon(vmID, addonID string) error
- func (c *VendorV3Client) DownloadLicense(appID string, customerID string) ([]byte, error)
- func (c *VendorV3Client) ExposeClusterPort(clusterID string, portNumber int, protocols []string, isWildcard bool) (*types.ClusterPort, error)
- func (c *VendorV3Client) ExposeVMPort(vmID string, portNumber int, protocols []string, isWildcard bool) (*types.VMPort, error)
- func (c *VendorV3Client) Get(path string) ([]byte, error)
- func (c *VendorV3Client) GetApp(ctx context.Context, appIDOrSlug string, excludeChannels bool) (*types.App, error)
- func (c *VendorV3Client) GetChannel(appID string, channelID string) (*types.Channel, error)
- func (c *VendorV3Client) GetCluster(id string) (*types.Cluster, error)
- func (c *VendorV3Client) GetClusterAddon(clusterID, id string) (*types.ClusterAddon, error)
- func (c *VendorV3Client) GetClusterKubeconfig(id string) ([]byte, error)
- func (c *VendorV3Client) GetCustomerByID(customerID string) (*types.Customer, error)
- func (c *VendorV3Client) GetCustomerByName(appID string, name string) (*types.Customer, error)
- func (c *VendorV3Client) GetCustomerByNameOrId(appID string, nameOrId string) (*types.Customer, error)
- func (c *VendorV3Client) GetEnterprisePortalStatus(appID string) (string, error)
- func (c *VendorV3Client) GetModelsEndpoint() (string, error)
- func (c *VendorV3Client) GetRelease(appID string, sequence int64) (*types.AppRelease, error)
- func (c *VendorV3Client) GetVM(id string) (*types.VM, error)
- func (c *VendorV3Client) LintRelease(data []byte, isBuildersRelease bool, contentType string) ([]types.LintMessage, error)
- func (c *VendorV3Client) ListApps(ctx context.Context, excludeChannels bool) ([]types.AppAndChannels, error)
- func (c *VendorV3Client) ListChannels(appID string, channelName string) ([]*types.Channel, error)
- func (c *VendorV3Client) ListClusterAddons(clusterID string) ([]*types.ClusterAddon, error)
- func (c *VendorV3Client) ListClusterPorts(clusterID string) ([]*types.ClusterPort, error)
- func (c *VendorV3Client) ListClusterVersions() ([]*types.ClusterVersion, error)
- func (c *VendorV3Client) ListClusters(includeTerminated bool, startTime *time.Time, endTime *time.Time) ([]*types.Cluster, error)
- func (c *VendorV3Client) ListCollections() ([]types.ModelCollection, error)
- func (c *VendorV3Client) ListCustomHostnames(appID string) (*types.KotsAppCustomHostnames, error)
- func (c *VendorV3Client) ListCustomers(appID string, includeTest bool) ([]types.Customer, error)
- func (c *VendorV3Client) ListCustomersByAppAndVersion(appID string, appVersion string, appType string) ([]types.Customer, error)
- func (c *VendorV3Client) ListEnterprisePortalUsers(appID string, includeInvites bool) ([]EnterprisePortalUser, error)
- func (c *VendorV3Client) ListInstallers(appID string) ([]types.InstallerSpec, error)
- func (c *VendorV3Client) ListKotsChannels(appID string, channelName string, excludeDetails bool) ([]*types.KotsChannel, error)
- func (c *VendorV3Client) ListModels() ([]types.Model, error)
- func (c *VendorV3Client) ListRegistries() ([]types.Registry, error)
- func (c *VendorV3Client) ListReleases(appID string) ([]types.ReleaseInfo, error)
- func (c *VendorV3Client) ListVMPorts(vmID string) ([]*types.VMPort, error)
- func (c *VendorV3Client) ListVMVersions() ([]*types.VMVersion, error)
- func (c *VendorV3Client) ListVMs(includeTerminated bool, startTime *time.Time, endTime *time.Time) ([]*types.VM, error)
- func (c *VendorV3Client) LogsRegistry(hostname string) ([]types.RegistryLog, error)
- func (c *VendorV3Client) Patch(path string, body string) ([]byte, error)
- func (c *VendorV3Client) Post(path string, body string) ([]byte, error)
- func (c *VendorV3Client) PromoteInstaller(appID string, sequence int64, channelID string, versionLabel string) error
- func (c *VendorV3Client) PromoteRelease(appID string, sequence int64, label string, notes string, required bool, ...) error
- func (c *VendorV3Client) Put(path string, body string) ([]byte, error)
- func (c *VendorV3Client) RemoveCluster(id string) error
- func (c *VendorV3Client) RemoveClusterPort(clusterID string, portNumber int, protocols []string) ([]*types.ClusterPort, error)
- func (c *VendorV3Client) RemoveKOTSRegistry(endpoint string) error
- func (c *VendorV3Client) RemoveModel(modelName string) ([]types.Model, error)
- func (c *VendorV3Client) RemoveRegistry(endpoint string) error
- func (c *VendorV3Client) RemoveVM(id string) error
- func (c *VendorV3Client) ReportReleaseCompatibility(appID string, sequence int64, distribution string, version string, ...) (*ClusterValidationError, error)
- func (c *VendorV3Client) SendEnterprisePortalInvite(appID string, customerID string, emailAddress string) (string, error)
- func (c *VendorV3Client) SetIntanceTags(appID string, customerID string, instanceID string, tags []types.Tag) (*types.Instance, error)
- func (c *VendorV3Client) TestKOTSRegistry(hostname string, image string) (int, error)
- func (c *VendorV3Client) TestRelease(appID string, sequence int64) (string, error)
- func (c *VendorV3Client) UpdateClusterNodegroup(clusterID string, nodegroupID string, opts UpdateClusterNodegroupOpts) (*types.Cluster, *UpdateClusterNodegroupErrorError, error)
- func (c *VendorV3Client) UpdateClusterTTL(clusterID string, opts UpdateClusterTTLOpts) (*types.Cluster, error)
- func (c *VendorV3Client) UpdateCustomer(customerID string, opts UpdateCustomerOpts) (*types.Customer, error)
- func (c *VendorV3Client) UpdateEnterprisePortalStatus(appID string, status string) (string, error)
- func (c *VendorV3Client) UpdateModelsInCollection(collectionID string, modelsToAdd []string, modelsToRemove []string) error
- func (c *VendorV3Client) UpdateRelease(appID string, sequence int64, multiyaml string) error
- func (c *VendorV3Client) UpdateSemanticVersioning(appID string, channel *types.Channel, enableSemver bool) error
- func (c *VendorV3Client) UpdateVMTTL(vmID string, opts UpdateVMTTLOpts) (*types.VM, error)
- func (c *VendorV3Client) UpgradeCluster(clusterID string, opts UpgradeClusterOpts) (*types.Cluster, *ClusterValidationError, error)
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 AddKOTSRegistryResponse ¶ added in v0.40.4
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 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 CreateClusterAddonPostgresOpts ¶ added in v0.73.0
type CreateClusterAddonPostgresRequest ¶ added in v0.73.0
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 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 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 IsEmbeddedClusterDownloadEnabled bool IsGeoaxisSupported bool IsHelmVMDownloadEnabled bool IsIdentityServiceSupported bool IsInstallerSupportEnabled bool IsSupportBundleUploadEnabled 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"` Email string `json:"email,omitempty"` EntitlementValues []EntitlementValue `json:"entitlementValues"` }
type CreateCustomerResponse ¶ added in v0.29.0
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 CreateVMRequest ¶ added in v0.82.0
type CreateVMResponse ¶ added in v0.82.0
type CustomHostnamesListResponse ¶ added in v0.52.0
type CustomHostnamesListResponse struct {
Body types.KotsAppCustomHostnames
}
type CustomerChannel ¶ added in v0.78.0
type CustomerGetResponse ¶ added in v0.83.2
type CustomerListResponse ¶ added in v0.29.0
type CustomerListWithInstancesResponse ¶ added in v0.51.0
type EnterprisePortalUser ¶ added in v0.83.2
type EnterprisePortalUser struct {
Email string `json:"email"`
}
type EntitlementValue ¶ added in v0.56.0
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 ExportVMPortRequest ¶ added in v0.84.0
type ExposeClusterPortResponse ¶ added in v0.71.0
type ExposeClusterPortResponse struct {
Port *types.ClusterPort `json:"port"`
}
type ExposeVMPortResponse ¶ added in v0.84.0
type GetClusterAddonResponse ¶ added in v0.72.0
type GetClusterAddonResponse struct {
Addon *types.ClusterAddon `json:"addon"`
}
type GetClusterKubeconfigResponse ¶ added in v0.44.0
type GetClusterResponse ¶ added in v0.56.0
type GetEnterprisePortalStatusResponse ¶ added in v0.83.2
type GetEnterprisePortalStatusResponse struct {
Status string `json:"status"`
}
type GetVMResponse ¶ added in v0.82.0
type GraphQLResponseListReleases ¶
type GraphQLResponseListReleases struct { Data *KotsReleasesData `json:"data,omitempty"` Errors []graphql.GQLError `json:"errors,omitempty"` }
type InstanceTags ¶ added in v0.64.0
type InviteEnterprisePortalRequest ¶ added in v0.83.2
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 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 ListVMPortsResponse ¶ added in v0.84.0
type ListVMVersionsResponse ¶ added in v0.82.0
type ListVMsResponse ¶ added in v0.82.0
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 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 UpdateClusterNodegroupRequest ¶ added in v0.79.0
type UpdateClusterNodegroupResponse ¶ added in v0.79.0
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 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 IsEmbeddedClusterDownloadEnabled bool IsGeoaxisSupported bool IsHelmVMDownloadEnabled bool IsIdentityServiceSupported bool IsSupportBundleUploadEnabled 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"` Email string `json:"email,omitempty"` EntitlementValues []EntitlementValue `json:"entitlementValues"` }
type UpdateCustomerResponse ¶ added in v0.73.2
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 UpgradeClusterOpts ¶ added in v0.58.0
type UpgradeClusterRequest ¶ added in v0.58.0
type UpgradeClusterRequest struct {
KubernetesVersion string `json:"kubernetes_version"`
}
type UpgradeClusterResponse ¶ added in v0.58.0
type VMValidationError ¶ added in v0.82.0
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) CreateClusterAddonPostgres ¶ added in v0.73.0
func (c *VendorV3Client) CreateClusterAddonPostgres(opts CreateClusterAddonPostgresOpts) (*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) 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 (*VendorV3Client) Get ¶ added in v0.47.0
func (c *VendorV3Client) Get(path string) ([]byte, error)
func (*VendorV3Client) GetChannel ¶ added in v0.34.0
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 (*VendorV3Client) GetCustomerByNameOrId ¶ added in v0.58.0
func (*VendorV3Client) GetEnterprisePortalStatus ¶ added in v0.83.2
func (c *VendorV3Client) GetEnterprisePortalStatus(appID string) (string, 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 (*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 (*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 (*VendorV3Client) ListCustomersByAppAndVersion ¶ added in v0.51.0
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) 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) 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 (*VendorV3Client) PromoteRelease ¶ added in v0.37.0
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 (*VendorV3Client) SetIntanceTags ¶ added in v0.64.0
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) 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 (*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 ¶
- api.go
- app.go
- app_create.go
- channel.go
- client.go
- cluster_addon_get.go
- cluster_addon_objectstore_create.go
- cluster_addon_postgres_create.go
- cluster_addon_rm.go
- cluster_addons_list.go
- cluster_create.go
- cluster_get.go
- cluster_kubeconfig.go
- cluster_list.go
- cluster_port_expose.go
- cluster_port_list.go
- cluster_port_remove.go
- cluster_rm.go
- cluster_update_nodegroup.go
- cluster_update_ttl.go
- cluster_upgrade.go
- cluster_versions.go
- collection_create.go
- collection_list.go
- collection_rm.go
- collection_update_models.go
- custom_hostname.go
- customer_archive.go
- customer_create.go
- customer_license_download.go
- customer_list.go
- customer_list_by_app_version.go
- customer_update.go
- enterprise-portal.go
- errors.go
- installer.go
- instance.go
- model_list.go
- model_rm.go
- models_get_endpoint.go
- registry_add.go
- registry_list.go
- registry_logs.go
- registry_remove.go
- registry_rm.go
- registry_validate.go
- release.go
- release_compatibility.go
- release_lint.go
- vm_addon_rm.go
- vm_create.go
- vm_get.go
- vm_list.go
- vm_port_expose.go
- vm_port_list.go
- vm_rm.go
- vm_update_ttl.go
- vm_versions.go
Click to show internal directories.
Click to hide internal directories.