dataaccess

package

v1.6.8 Latest Latest Go to latest Published: May 8, 2026 License: Apache-2.0 Imports: 35 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/omnistrate-oss/omnistrate-ctl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func AdoptHostCluster(ctx context.Context, token string, hostClusterID string, cloudProvider string, ...) (*openapiclientfleet.AdoptHostClusterResult, error)
func AdoptResourceInstance(ctx context.Context, token string, ...) (res *openapiclientfleet.FleetCreateResourceInstanceResult, err error)
func ApplyPendingChangesToHostCluster(ctx context.Context, token string, hostClusterID string) error
func ApproveSubscriptionRequest(ctx context.Context, token string, serviceID, environmentID, requestID string) (err error)
func AskVerifyAccountIfAny(ctx context.Context)
func AskVerifyDomainIfAny(ctx context.Context)
func BuildServiceFromComposeSpec(ctx context.Context, token string, ...) (*openapiclient.BuildServiceFromComposeSpecResult, error)
func BuildServiceFromServicePlanSpec(ctx context.Context, token string, ...) (*openapiclient.BuildServiceFromServicePlanSpecResult, error)
func CheckIfContainerImageAccessible(ctx context.Context, token string, imageRegistry, image string, ...) (res *openapiclient.CheckIfContainerImageAccessibleResult, err error)
func ConfigureNodepool(ctx context.Context, token string, hostClusterID string, nodepoolName string, ...) error
func ConvertToInternalAmenitiesList(data interface{}) ([]model.InternalAmenity, error)
func CopyResourceInstanceSnapshot(ctx context.Context, token string, ...) (res *openapiclientfleet.FleetCopyResourceInstanceSnapshotResult, err error)
func CreateAPIKey(ctx context.Context, token string, name string, roleType string, ...) (*openapiclient.CreateAPIKeyResult, error)
func CreateAccount(ctx context.Context, token string, ...) (string, error)
func CreateDomain(ctx context.Context, ...) error
func CreateInstanceSnapshot(ctx context.Context, token, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.FleetCreateInstanceSnapshotResult, err error)
func CreateResourceInstance(ctx context.Context, token string, serviceProviderId string, serviceKey string, ...) (res *openapiclientfleet.FleetCreateResourceInstanceResult, err error)
func CreateServiceEnvironment(ctx context.Context, token string, name, description, serviceID string, ...) (string, error)
func CreateServicesOrchestration(ctx context.Context, token string, orchestrationCreateDSL string) (res *openapiclientfleet.FleetCreateServicesOrchestrationResult, err error)
func CreateSubscriptionOnBehalf(ctx context.Context, token string, serviceID, environmentID string, ...) (resp *openapiclientfleet.FleetCreateSubscriptionOnBehalfOfCustomerResult, ...)
func CreateUpgradePath(ctx context.Context, ...) (string, error)
func DebugHostCluster(ctx context.Context, token string, hostClusterID string) (*openapiclientfleet.DebugHostClusterResult, error)
func DebugResourceInstance(ctx context.Context, token string, serviceID, environmentID, instanceID string) (res *openapiclientfleet.DebugResourceInstanceResult, err error)
func DeleteAPIKey(ctx context.Context, token, id string) error
func DeleteAccount(ctx context.Context, token, accountConfigID string) error
func DeleteDomain(ctx context.Context, token, environmentType string) error
func DeleteHelmChart(ctx context.Context, token, chartName, chartVersion string) (err error)
func DeleteHostCluster(ctx context.Context, token string, hostClusterID string) error
func DeleteNodepool(ctx context.Context, token string, hostClusterID string, nodepoolName string) error
func DeleteProductTier(ctx context.Context, token, serviceID, productTierID string) (err error)
func DeleteResourceInstance(ctx context.Context, ...) (err error)
func DeleteSecret(ctx context.Context, token, environmentType, name string) error
func DeleteService(ctx context.Context, token, serviceID string) error
func DeleteServiceEnvironment(ctx context.Context, token, serviceID, serviceEnvironmentID string) error
func DeleteServicesOrchestration(ctx context.Context, token, id string) (err error)
func DeleteSnapshot(ctx context.Context, token, serviceID, environmentID, snapshotID string) (err error)
func DenySubscriptionRequest(ctx context.Context, token string, serviceID, environmentID, requestID string) (err error)
func DescribeAPIKey(ctx context.Context, token, id string) (*openapiclient.DescribeAPIKeyResult, error)
func DescribeAccount(ctx context.Context, token string, id string) (*openapiclient.DescribeAccountConfigResult, error)
func DescribeCloudProviderCost(ctx context.Context, token string, opts CostOptions) (res *openapiclientfleet.DescribeCloudProviderCostResult, err error)
func DescribeDeploymentCellCost(ctx context.Context, token string, opts CostOptions) (res *openapiclientfleet.DescribeDeploymentCellCostResult, err error)
func DescribeDeploymentCellWorkflow(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.DescribeDeploymentCellWorkflowResult, err error)
func DescribeHelmChart(ctx context.Context, token, chartName, chartVersion string) (helmPackage *openapiclient.HelmPackage, err error)
func DescribeHostCluster(ctx context.Context, token string, hostClusterID string) (*openapiclientfleet.HostCluster, error)
func DescribeInstanceSnapshot(ctx context.Context, ...) (resp *openapiclientfleet.FleetDescribeInstanceSnapshotResult, err error)
func DescribeLatestVersion(ctx context.Context, token, serviceID, productTierID string) (*openapiclient.TierVersionSet, error)
func DescribeNodepool(ctx context.Context, token string, hostClusterID string, nodepoolName string) (*model.NodepoolDescribeView, *openapiclientfleet.Entity, error)
func DescribePendingChanges(ctx context.Context, token, serviceID, serviceAPIID, productTierID string) (*openapiclientv1.DescribePendingChangesResult, error)
func DescribeProductTier(ctx context.Context, token, serviceID, productTierID string) (productTier *openapiclientv1.DescribeProductTierResult, err error)
func DescribeRegionCost(ctx context.Context, token string, opts CostOptions) (res *openapiclientfleet.DescribeRegionCostResult, err error)
func DescribeResource(ctx context.Context, token, serviceID, resourceID string, ...) (resp *openapiclient.DescribeResourceResult, err error)
func DescribeResourceInstance(ctx context.Context, token string, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.ResourceInstance, err error)
func DescribeResourceInstanceInstaller(ctx context.Context, token string, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.DescribeResourceInstanceInstallerResult, err error)
func DescribeResourceInstanceSnapshot(ctx context.Context, token string, ...) (res *openapiclientfleet.FleetDescribeInstanceSnapshotResult, err error)
func DescribeService(ctx context.Context, token, serviceID string) (*openapiclient.DescribeServiceResult, error)
func DescribeServiceEnvironment(ctx context.Context, token, serviceID, serviceEnvironmentID string) (*openapiclientv1.DescribeServiceEnvironmentResult, error)
func DescribeServiceModel(ctx context.Context, token, serviceID, serviceModelID string) (serviceModel *openapiclient.DescribeServiceModelResult, err error)
func DescribeServiceOffering(ctx context.Context, ...) (res *openapiclientfleet.InventoryDescribeServiceOfferingResult, err error)
func DescribeServiceOfferingResource(ctx context.Context, ...) (res *openapiclientfleet.InventoryDescribeServiceOfferingResourceResult, ...)
func DescribeServiceOfferingResourceV1(ctx context.Context, ...) (res *openapiclientv1.DescribeServiceOfferingResourceResult, err error)
func DescribeServicesOrchestration(ctx context.Context, token string, id string) (resp *openapiclientfleet.FleetDescribeServicesOrchestrationResult, err error)
func DescribeSubscription(ctx context.Context, token string, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.FleetDescribeSubscriptionResult, err error)
func DescribeSubscriptionRequest(ctx context.Context, token string, serviceID, environmentID, requestID string) (resp *openapiclientfleet.DescribeSubscriptionRequestResult, err error)
func DescribeUpgradePath(ctx context.Context, token, serviceID, productTierID, upgradePathID string) (*openapiclientfleet.UpgradePath, error)
func DescribeUser(ctx context.Context, token string) (*openapiclient.DescribeUserResult, error)
func DescribeUserCost(ctx context.Context, token string, opts CostOptions) (res *openapiclientfleet.DescribeUserCostResult, err error)
func DescribeVersionSet(ctx context.Context, token, serviceID, productTierID, version string) (*openapiclient.TierVersionSet, error)
func DescribeWorkflow(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.DescribeServiceWorkflowResult, err error)
func DescribeWorkflowSummary(ctx context.Context, token string, serviceID, environmentID string) (res *openapiclientfleet.DescribeServiceWorkflowSummaryResult, err error)
func DisableServiceModelFeature(ctx context.Context, token, serviceID, serviceModelID, featureName string) (err error)
func EnableServiceModelFeature(ctx context.Context, token, serviceID, serviceModelID, featureName string, ...) (err error)
func EnhanceServicePlansWithAccountInfo(ctx context.Context, token string, ...) error
func EvaluateExpression(ctx context.Context, ...) (result interface{}, err error)
func ExternalDescribeServiceOffering(ctx context.Context, token, serviceID, environmentID, productTierID string) (res *openapiclientv1.DescribeServiceOfferingResult, err error)
func FindEnvironment(ctx context.Context, token, serviceID, environmentType string) (*openapiclientv1.DescribeServiceEnvironmentResult, error)
func FindLatestVersion(ctx context.Context, token, serviceID, productTierID string) (string, error)
func FindPreferredVersion(ctx context.Context, token, serviceID, productTierID string) (string, error)
func FleetCreateCustomNetwork(ctx context.Context, token string, cloudProviderName string, ...) (customNetwork *openapiclientfleet.FleetCustomNetwork, err error)
func FleetDeleteCustomNetwork(ctx context.Context, token string, customNetworkId string) (err error)
func FleetDescribeCustomNetwork(ctx context.Context, token string, id string) (customNetwork *openapiclientfleet.FleetCustomNetwork, err error)
func FleetListCustomNetworks(ctx context.Context, token string, cloudProviderName *string, ...) (customNetworks *openapiclientfleet.FleetListCustomNetworksResult, err error)
func FleetUpdateCustomNetwork(ctx context.Context, token string, id string, updatedName *string) (customNetwork *openapiclientfleet.FleetCustomNetwork, err error)
func GenerateComposeSpecFromContainerImage(ctx context.Context, token string, ...) (res *openapiclient.GenerateComposeSpecFromContainerImageResult, err error)
func GetCloudProviderByName(ctx context.Context, token string, cloudProvider string) (string, error)
func GetComposeSpecHeaders(composeSpecURL string) ([]string, error)
func GetDebugEventsForAllResources(ctx context.Context, token string, serviceID, environmentID, instanceID string, ...) ([]ResourceWorkflowDebugEvents, *WorkflowInfo, error)
func GetDefaultDeploymentConfigID(ctx context.Context, token string) (string, error)
func GetDeploymentCellHealth(ctx context.Context, token string, opts *DeploymentCellHealthOptions) (res *openapiclientfleet.DeploymentCellHealthDetail, err error)
func GetDeploymentCellWorkflowEvents(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.GetDeploymentCellWorkflowEventsResult, err error)
func GetInstanceDeploymentEntity(ctx context.Context, token string, instanceID string, deploymentType string, ...) (output string, err error)
func GetJSONSchema(ctx context.Context, schemaType string) (interface{}, error)
func GetKubeConfigForHostCluster(ctx context.Context, token string, hostClusterID string, role string) (*openapiclientfleet.KubeConfigHostClusterResult, error)
func GetNotificationChannel(ctx context.Context, token, channelID string) (res *openapiclientfleet.Channel, err error)
func GetNotificationChannelEventHistory(ctx context.Context, token, channelID string, startTime, endTime *time.Time) (res *openapiclientfleet.ChannelEventHistoryResult, err error)
func GetOrganizationDeploymentCellTemplate(ctx context.Context, token string, environment string, cloudProvider string) (*model.DeploymentCellTemplate, error)
func GetSecret(ctx context.Context, token, environmentType, name string) (*openapiclientv1.GetSecretResult, error)
func GetServiceHealth(ctx context.Context, token string, serviceID, serviceEnvironmentID string) (res *openapiclientfleet.ServiceHealthSummary, err error)
func GetServiceProviderOrganization(ctx context.Context, token string) (res *openapiclient.DescribeServiceProviderOrganizationResult, err error)
func GetSubscriptionByCustomerEmail(ctx context.Context, token string, serviceID string, planID string, ...) (resp *openapiclientfleet.FleetDescribeSubscriptionResult, err error)
func GetSubscriptionByCustomerEmailInEnvironment(ctx context.Context, token string, serviceID string, environmentID string, ...) (resp *openapiclientfleet.FleetDescribeSubscriptionResult, err error)
func GetWorkflowEvents(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.GetWorkflowEventsResult, err error)
func ListAPIKeys(ctx context.Context, token string) (*openapiclient.ListAPIKeysResult, error)
func ListAccountConfigs(ctx context.Context, token, cloudProviderName string) (*openapiclientfleet.ListAccountConfigsResult, error)
func ListAccounts(ctx context.Context, token string, cloudProvider string) (*openapiclient.ListAccountConfigResult, error)
func ListAllAccountConfigs(ctx context.Context, token string) (*openapiclientfleet.ListAccountConfigsResult, error)
func ListAllSnapshots(ctx context.Context, token, serviceID, environmentID string) (res *openapiclientfleet.FleetListInstanceSnapshotResult, err error)
func ListAuditEvents(ctx context.Context, token string, opts *ListAuditEventsOptions) (resp *openapiclientfleet.FleetAuditEventsResult, err error)
func ListDeploymentCellWorkflows(ctx context.Context, token string, hostClusterID string, ...) (res *openapiclientfleet.ListDeploymentCellWorkflowsResult, err error)
func ListDomains(ctx context.Context, token string) (*openapiclientv1.ListSaaSPortalCustomDomainsResult, error)
func ListEligibleInstancesPerUpgrade(ctx context.Context, token, serviceID, productTierID, upgradePathID string) ([]openapiclientfleet.InstanceUpgrade, error)
func ListHelmChartInstallations(ctx context.Context, token string, hostClusterID string) (...)
func ListHelmCharts(ctx context.Context, token string) (helmPackages *openapiclient.ListHelmPackagesResult, err error)
func ListHostClusters(ctx context.Context, token string, accountConfigID *string, regionID *string) (*openapiclientfleet.ListHostClustersResult, error)
func ListInputParameters(ctx context.Context, ...) (res *openapiclientv1.ListInputParametersResult, err error)
func ListInstanceSnapshots(ctx context.Context, token, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.FleetListInstanceSnapshotResult, err error)
func ListNodepools(ctx context.Context, token string, hostClusterID string) ([]model.NodepoolTableView, []openapiclientfleet.Entity, error)
func ListNotificationChannels(ctx context.Context, token string) (res *openapiclientfleet.ListNotificationChannelsResult, err error)
func ListOperationsEvents(ctx context.Context, token string, opts *ListEventsOptions) (res *openapiclientfleet.ListServiceProviderEventsResult, err error)
func ListResourceInstance(ctx context.Context, token string, serviceID, environmentID string, ...) (res *openapiclientfleet.ListFleetResourceInstancesResultInternal, err error)
func ListResourceInstanceSnapshots(ctx context.Context, token string, serviceID, environmentID, instanceID string) (res *openapiclientfleet.FleetListInstanceSnapshotResult, err error)
func ListResources(ctx context.Context, token, serviceID string, productTierID string, ...) (resp *openapiclient.ListResourcesResult, err error)
func ListSecrets(ctx context.Context, token, environmentType string) (*openapiclientv1.ListSecretsResult, error)
func ListServiceEnvironments(ctx context.Context, token, serviceID string) (*openapiclientv1.ListServiceEnvironmentsResult, error)
func ListServiceOfferings(ctx context.Context, token string) (inventory *openapiclientfleet.InventoryListServiceOfferingsResult, err error)
func ListServicePlans(ctx context.Context, token, serviceID, serviceEnvironmentID string) (*openapiclient.ListServicePlansResult, error)
func ListServices(ctx context.Context, token string) (*openapiclient.ListServiceResult, error)
func ListServicesOrchestration(ctx context.Context, token string, environmentType string) (resp []openapiclientfleet.FleetDescribeServicesOrchestrationResult, err error)
func ListSubscriptionRequests(ctx context.Context, token string, serviceID, environmentID string) (resp *openapiclientfleet.ListSubscriptionRequestsResult, err error)
func ListSubscriptions(ctx context.Context, token string, serviceID, environmentID string) (resp *openapiclientfleet.FleetListSubscriptionsResult, err error)
func ListUpgradePaths(ctx context.Context, token, serviceID, productTierID string, ...) (resp *openapiclientfleet.ListUpgradePathsResult, err error)
func ListVersions(ctx context.Context, token, serviceID, productTierID string) (*openapiclient.ListTierVersionSetsResult, error)
func ListWorkflows(ctx context.Context, token string, serviceID, environmentID string, ...) (res *openapiclientfleet.ListServiceWorkflowsResult, err error)
func ManageLifecycle(ctx context.Context, token, serviceID, productTierID, upgradePathID string, ...) (*openapiclientfleet.UpgradePath, error)
func ManageLifecycleWithPayload(ctx context.Context, token, serviceID, productTierID, upgradePathID string, ...) (*openapiclientfleet.UpgradePath, error)
func ModifyServicesOrchestration(ctx context.Context, token string, id string, orchestrationModifyDSL string) (err error)
func NewK8sClientForDeploymentCell(ctx context.Context, token, deploymentCellID, role string) (*kubernetes.Clientset, error)
func NewK8sClientFromHostClusterKubeConfig(kubeConfig *openapiclientfleet.KubeConfigHostClusterResult) (*kubernetes.Clientset, error)
func OneOffPatchResourceInstance(ctx context.Context, token string, serviceID, environmentID, instanceID string, ...) (err error)
func PatchInstanceDeploymentEntity(ctx context.Context, token string, instanceID string, deploymentType string, ...) (err error)
func PauseInstanceDeploymentEntity(ctx context.Context, token string, instanceID string, deploymentType string, ...) (err error)
func PrepareServiceFromServicePlanSpec(ctx context.Context, token string, ...) (*openapiclient.PrepareServiceFromServicePlanSpecResult, error)
func PrintAccountNotVerifiedWarning(account *openapiclient.DescribeAccountConfigResult)
func PrintDomainNotVerifiedWarningMsg(domain, clusterEndpoint string)
func PrintNextStepVerifyAccountMsg(account *openapiclient.DescribeAccountConfigResult)
func PrintNextStepVerifyDomainMsg(clusterEndpoint string)
func PrintNextStepsAfterBuildMsg()
func PromoteServiceEnvironment(ctx context.Context, token, serviceID, serviceEnvironmentID string) error
func PromoteServiceEnvironmentStatus(ctx context.Context, token, serviceID, serviceEnvironmentID string) (resp []openapiclientv1.EnvironmentPromotionStatus, err error)
func ReleaseServicePlan(ctx context.Context, token, serviceID, serviceAPIID, productTierID string, ...) error
func ReplayNotificationEvent(ctx context.Context, token, eventID string) (err error)
func RestartResourceInstance(ctx context.Context, token string, ...) (err error)
func RestoreResourceInstanceSnapshot(ctx context.Context, token string, serviceID, environmentID, snapshotID string, ...) (res *openapiclientfleet.FleetRestoreResourceInstanceResult, err error)
func RestoreSnapshot(ctx context.Context, token, serviceID, environmentID, snapshotID string, ...) (res *openapiclientfleet.FleetRestoreResourceInstanceResult, err error)
func ResumeDeploymentCellWorkflow(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.DeploymentCellWorkflow, err error)
func ResumeInstanceDeploymentEntity(ctx context.Context, token string, instanceID string, deploymentType string, ...) (err error)
func ResumeSubscription(ctx context.Context, token string, ...) (err error)
func ResumeWorkflow(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.ServiceWorkflow, err error)
func RetryDeploymentCellWorkflow(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.DeploymentCellWorkflow, err error)
func RetryWorkflow(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.ServiceWorkflow, err error)
func RevokeAPIKey(ctx context.Context, token, id string) error
func RevokeToken(ctx context.Context, refreshToken string) error
func SaveHelmChart(ctx context.Context, token string, chartName string, chartVersion string, ...) (helmPackage openapiclient.HelmPackage, err error)
func SearchInventory(ctx context.Context, token, query string) (*openapiclientfleet.SearchInventoryResult, error)
func SetDefaultServicePlan(ctx context.Context, token, serviceID, productTierID, version string) (*openapiclient.TierVersionSet, error)
func SetSecret(ctx context.Context, token, environmentType, name, value string) error
func StartResourceInstance(ctx context.Context, token string, ...) (err error)
func StopResourceInstance(ctx context.Context, token string, ...) (err error)
func SuspendSubscription(ctx context.Context, token string, ...) (err error)
func TerminateDeploymentCellWorkflow(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.DeploymentCellWorkflow, err error)
func TerminateSubscription(ctx context.Context, token string, ...) (err error)
func TerminateWorkflow(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.ServiceWorkflow, err error)
func TriggerResourceInstanceAutoBackup(ctx context.Context, token string, serviceID, environmentID, instanceID string) (res *openapiclientfleet.FleetAutomaticInstanceSnapshotCreationResult, ...)
func UpdateAPIKeyMetadata(ctx context.Context, token string, id string, name *string, ...) (*openapiclient.UpdateAPIKeyMetadataResult, error)
func UpdateAccount(ctx context.Context, token string, params UpdateAccountParams) (string, error)
func UpdateHostCluster(ctx context.Context, token string, hostClusterID string, ...) error
func UpdateResourceInstance(ctx context.Context, token string, serviceID, environmentID, instanceID string, ...) (err error)
func UpdateResourceInstanceDebugMode(ctx context.Context, token string, serviceID, environmentID, instanceID string, ...) (err error)
func UpdateServiceProviderOrganization(ctx context.Context, token string, ...) (err error)
func UpdateVersionSetName(ctx context.Context, token, serviceID, productTierID, version, newName string) (*openapiclient.TierVersionSet, error)
type AccountsByCloudProviderAndPlan
type ArtifactDescribeResult
- func DescribeArtifact(ctx context.Context, token string, artifactID string) (*ArtifactDescribeResult, error)
type ArtifactUploadResult
- func UploadArtifact(ctx context.Context, token string, base64Content string, artifactPath string, ...) (*ArtifactUploadResult, error)
type ComposeSpecAvailableTag
- func ListComposeSpecSections() ([]ComposeSpecAvailableTag, error)
type ComposeSpecResult
- func SearchComposeSpecSections(tag string) ([]ComposeSpecResult, error)
type CostOptions
type CreateSubscriptionOnBehalfOptions
type DashboardCatalog
- func (c *DashboardCatalog) PreferredFeature() *DashboardFeatureInfo
type DashboardDefinition
type DashboardFeatureInfo
- func (f *DashboardFeatureInfo) HasAccessCredentials() bool
type DashboardInfo
type DashboardRef
type DashboardService
- func NewDashboardService() *DashboardService
- func (d *DashboardService) GetDashboardCatalog(instance *openapiclientfleet.ResourceInstance) (*DashboardCatalog, error)
- func (d *DashboardService) GetDashboardInfo(instance *openapiclientfleet.ResourceInstance) (*DashboardInfo, error)
- func (d *DashboardService) IsMetricsEnabled(instance *openapiclientfleet.ResourceInstance) bool
type DebugEvent
type DebugEventsByWorkflowSteps
type DeploymentCellHealthOptions
type Document
type DocumentationResult
- func PerformDocumentationSearch(query string, limit int) ([]DocumentationResult, error)
type InspectAZItem
type InspectPVCItem
type InspectPVItem
type InspectPodItem
type InspectStorageClassItem
type InspectVMItem
type InspectWorkloadItem
type K8sClientConfig
type K8sInspectClient
- func NewK8sInspectClient(config K8sClientConfig) K8sInspectClient
type K8sInspectClientImpl
- func (k *K8sInspectClientImpl) GetClusterData(ctx context.Context, namespace string) ([]InspectWorkloadItem, []InspectAZItem, []InspectStorageClassItem, error)
- func (k *K8sInspectClientImpl) GetSampleData(instanceID string) ([]InspectWorkloadItem, []InspectAZItem, []InspectStorageClassItem)
type LeveledLogger
- func NewLeveledLogger() *LeveledLogger
- func (l *LeveledLogger) Debug(msg string, keysAndValues ...interface{})
- func (l *LeveledLogger) Error(msg string, keysAndValues ...interface{})
- func (l *LeveledLogger) Info(msg string, keysAndValues ...interface{})
- func (l *LeveledLogger) Warn(msg string, keysAndValues ...interface{})
type ListAuditEventsOptions
type ListDeploymentCellWorkflowsOptions
type ListEventsOptions
type ListResourceInstanceOptions
type ListUpgradePathsOptions
type ListWorkflowsOptions
type LogStreamConnection
- func (lsc *LogStreamConnection) Close() error
- func (lsc *LogStreamConnection) Done() <-chan struct{}
- func (lsc *LogStreamConnection) ReadLogs() (string, error)
type LoginResult
- func LoginWithAPIKey(ctx context.Context, apiKey string) (LoginResult, error)
- func LoginWithIdentityProvider(ctx context.Context, deviceCode, identityProviderName string) (LoginResult, error)
- func LoginWithPassword(ctx context.Context, email string, pass string) (LoginResult, error)
- func RefreshToken(ctx context.Context, refreshToken string) (LoginResult, error)
type LogsConfig
type LogsService
- func NewLogsService() *LogsService
- func (ls *LogsService) BuildLogStreams(instance *openapiclientfleet.ResourceInstance, instanceID string, ...) ([]LogsStream, error)
- func (ls *LogsService) ConnectToLogStream(logsURL string) (*LogStreamConnection, error)
- func (ls *LogsService) GetAllLogStreamsForInstance(instance *openapiclientfleet.ResourceInstance, instanceID string) (map[string][]LogsStream, error)
- func (ls *LogsService) GetLogsConfig(instance *openapiclientfleet.ResourceInstance) (*LogsConfig, error)
- func (ls *LogsService) IsLogsEnabled(instance *openapiclientfleet.ResourceInstance) bool
type LogsStream
type MarkupSection
- func ParseH3Sections(content string) ([]MarkupSection, error)
type PlanSpecAvailableTag
- func ListPlanSpecSections() ([]PlanSpecAvailableTag, error)
type PlanSpecResult
- func SearchPlanSpecSections(tag string) ([]PlanSpecResult, error)
type PlanWithAccounts
type RawWorkflowStep
type ResourceList
type ResourceRequirements
type ResourceWorkflowDebugEvents
type ServiceAccountInfo
- func GetServiceAccountInfo(ctx context.Context, token string, ...) (*ServiceAccountInfo, error)
type UpdateAccountParams
type WorkflowInfo

Constants ¶

View Source

const (
	AccountNotVerifiedWarningMsgTemplateAWS = `` /* 380-byte string literal not displayed */

	AccountNotVerifiedWarningMsgTemplateGCP = `` /* 367-byte string literal not displayed */

	AccountNotVerifiedWarningMsgTemplateAzure = `` /* 335-byte string literal not displayed */

	NextStepVerifyAccountMsgTemplateAWS = `` /* 320-byte string literal not displayed */

	NextStepVerifyAccountMsgTemplateGCP = `` /* 250-byte string literal not displayed */

	NextStepVerifyAccountMsgTemplateAzure = `` /* 217-byte string literal not displayed */

	NextStepVerifyAccountMsgTemplateNebius = `` /* 211-byte string literal not displayed */

	AwsCloudFormationGuideURL = "https://youtu.be/Mu-4jppldwk"
	AwsGcpTerraformScriptsURL = "https://github.com/omnistrate-oss/account-setup"
	AwsGcpTerraformGuideURL   = "https://youtu.be/eKktc4QKgaA"
)

View Source

const (
	DomainNotVerifiedWarningMsgTemplate = `` /* 247-byte string literal not displayed */

	NextStepVerifyDomainMsgTemplate = `` /* 211-byte string literal not displayed */

)

View Source

const APIKeySigninEmail = "apikey@apikeys.invalid"

APIKeySigninEmail is the sentinel email value the signin endpoint recognizes to route a request into the api-key signin-exchange path. Uses the RFC 5321-shaped form so it passes Goa's email format validation. Mirrors security.APIKeySigninEmail in omnistrate/commons.

View Source

const (
	NextStepsAfterBuildMsgTemplate = `` /* 170-byte string literal not displayed */

)

Variables ¶

View Source

var (
	ErrEnvironmentNotFound = errors.New("environment not found")
)

Functions ¶

func AdoptHostCluster ¶

func AdoptHostCluster(ctx context.Context, token string, hostClusterID string, cloudProvider string, region string, description string, userEmail *string) (*openapiclientfleet.AdoptHostClusterResult, error)

func AdoptResourceInstance ¶ added in v0.13.37

func AdoptResourceInstance(ctx context.Context, token string, serviceID, servicePlanID, hostClusterID, primaryResourceKey string, request openapiclientfleet.AdoptResourceInstanceRequest2, servicePlanVersion, subscriptionID *string) (res *openapiclientfleet.FleetCreateResourceInstanceResult, err error)

func ApplyPendingChangesToHostCluster ¶ added in v0.14.18

func ApplyPendingChangesToHostCluster(ctx context.Context, token string, hostClusterID string) error

func ApproveSubscriptionRequest ¶ added in v0.14.47

func ApproveSubscriptionRequest(ctx context.Context, token string, serviceID, environmentID, requestID string) (err error)

func AskVerifyAccountIfAny ¶

func AskVerifyAccountIfAny(ctx context.Context)

func AskVerifyDomainIfAny ¶

func AskVerifyDomainIfAny(ctx context.Context)

func BuildServiceFromComposeSpec ¶

func BuildServiceFromComposeSpec(ctx context.Context, token string, request openapiclient.BuildServiceFromComposeSpecRequest2) (*openapiclient.BuildServiceFromComposeSpecResult, error)

func BuildServiceFromServicePlanSpec ¶

func BuildServiceFromServicePlanSpec(ctx context.Context, token string, request openapiclient.BuildServiceFromServicePlanSpecRequest2) (*openapiclient.BuildServiceFromServicePlanSpecResult, error)

func CheckIfContainerImageAccessible ¶

func CheckIfContainerImageAccessible(ctx context.Context, token string, imageRegistry, image string, userName, password *string) (res *openapiclient.CheckIfContainerImageAccessibleResult, err error)

func ConfigureNodepool ¶ added in v1.0.34

func ConfigureNodepool(ctx context.Context, token string, hostClusterID string, nodepoolName string, maxSize int64) error

ConfigureNodepool configures a nodepool in a deployment cell

func ConvertToInternalAmenitiesList ¶ added in v0.14.18

func ConvertToInternalAmenitiesList(data interface{}) ([]model.InternalAmenity, error)

func CopyResourceInstanceSnapshot ¶ added in v1.0.30

func CopyResourceInstanceSnapshot(ctx context.Context, token string, serviceID, environmentID, instanceID, sourceSnapshotID, targetRegion string) (res *openapiclientfleet.FleetCopyResourceInstanceSnapshotResult, err error)

func CreateAPIKey ¶ added in v1.4.16

func CreateAPIKey(
	ctx context.Context,
	token string,
	name string,
	roleType string,
	description *string,
	expiresAt *time.Time,
) (*openapiclient.CreateAPIKeyResult, error)

CreateAPIKey provisions a new org-bounded API key with the supplied display name and role and returns the plaintext value (returned by the platform exactly once) together with the persisted metadata.

description and expiresAt are optional; pass nil when they should be omitted from the request.

func CreateAccount ¶

func CreateAccount(ctx context.Context, token string, accountConfig openapiclient.CreateAccountConfigRequest2) (string, error)

func CreateDomain ¶

func CreateDomain(ctx context.Context, token, name, description, environmentType, customDomain string) error

func CreateInstanceSnapshot ¶ added in v0.14.47

func CreateInstanceSnapshot(ctx context.Context, token, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.FleetCreateInstanceSnapshotResult, err error)

func CreateResourceInstance ¶

func CreateResourceInstance(ctx context.Context, token string,
	serviceProviderId string, serviceKey string, serviceAPIVersion string, serviceEnvironmentKey string, serviceModelKey string, productTierKey string, resourceKey string,
	request openapiclientfleet.FleetCreateResourceInstanceRequest2) (res *openapiclientfleet.FleetCreateResourceInstanceResult, err error)

func CreateServiceEnvironment ¶

func CreateServiceEnvironment(ctx context.Context,
	token string,
	name, description, serviceID string,
	visibility, environmentType string,
	sourceEnvID *string,
	deploymentConfigID string,
	autoApproveSubscription bool,
	serviceAuthPublicKey *string,
) (string, error)

func CreateServicesOrchestration ¶

func CreateServicesOrchestration(
	ctx context.Context,
	token string,
	orchestrationCreateDSL string,
) (
	res *openapiclientfleet.FleetCreateServicesOrchestrationResult,
	err error,
)

func CreateSubscriptionOnBehalf ¶ added in v0.14.47

func CreateSubscriptionOnBehalf(ctx context.Context, token string, serviceID, environmentID string, opts *CreateSubscriptionOnBehalfOptions) (resp *openapiclientfleet.FleetCreateSubscriptionOnBehalfOfCustomerResult, err error)

func CreateUpgradePath ¶

func CreateUpgradePath(ctx context.Context, token, serviceID, productTierID, sourceVersion, targetVersion string, scheduledDate *string, instanceIDs []string, notifyCustomer bool, maxConcurrentUpgrades *int) (string, error)

func DebugHostCluster ¶ added in v0.14.32

func DebugHostCluster(ctx context.Context, token string, hostClusterID string) (*openapiclientfleet.DebugHostClusterResult, error)

func DebugResourceInstance ¶ added in v0.14.3

func DebugResourceInstance(ctx context.Context, token string, serviceID, environmentID, instanceID string) (res *openapiclientfleet.DebugResourceInstanceResult, err error)

func DeleteAPIKey ¶ added in v1.4.16

func DeleteAPIKey(ctx context.Context, token, id string) error

DeleteAPIKey permanently removes the key identified by id and its backing user. This is irreversible.

func DeleteAccount ¶

func DeleteAccount(ctx context.Context, token, accountConfigID string) error

func DeleteDomain ¶

func DeleteDomain(ctx context.Context, token, environmentType string) error

func DeleteHelmChart ¶

func DeleteHelmChart(ctx context.Context, token, chartName, chartVersion string) (err error)

func DeleteHostCluster ¶

func DeleteHostCluster(ctx context.Context, token string, hostClusterID string) error

func DeleteNodepool ¶ added in v1.0.34

func DeleteNodepool(ctx context.Context, token string, hostClusterID string, nodepoolName string) error

DeleteNodepool deletes a nodepool from a deployment cell (can take up to 10 minutes)

func DeleteProductTier ¶

func DeleteProductTier(ctx context.Context, token, serviceID, productTierID string) (err error)

func DeleteResourceInstance ¶

func DeleteResourceInstance(ctx context.Context, token, serviceID, environmentID, resourceID, instanceID string) (err error)

func DeleteSecret ¶ added in v0.13.31

func DeleteSecret(ctx context.Context, token, environmentType, name string) error

DeleteSecret deletes a secret for the given environment type and name

func DeleteService ¶

func DeleteService(ctx context.Context, token, serviceID string) error

func DeleteServiceEnvironment ¶

func DeleteServiceEnvironment(ctx context.Context, token, serviceID, serviceEnvironmentID string) error

func DeleteServicesOrchestration ¶

func DeleteServicesOrchestration(ctx context.Context, token, id string) (err error)

func DeleteSnapshot ¶ added in v1.1.0

func DeleteSnapshot(ctx context.Context, token, serviceID, environmentID, snapshotID string) (err error)

DeleteSnapshot deletes a snapshot (no instance ID required).

func DenySubscriptionRequest ¶ added in v0.14.47

func DenySubscriptionRequest(ctx context.Context, token string, serviceID, environmentID, requestID string) (err error)

func DescribeAPIKey ¶ added in v1.4.16

func DescribeAPIKey(ctx context.Context, token, id string) (*openapiclient.DescribeAPIKeyResult, error)

DescribeAPIKey returns the metadata for the API key identified by id.

func DescribeAccount ¶

func DescribeAccount(ctx context.Context, token string, id string) (*openapiclient.DescribeAccountConfigResult, error)

func DescribeCloudProviderCost ¶ added in v0.14.40

func DescribeCloudProviderCost(ctx context.Context, token string, opts CostOptions) (res *openapiclientfleet.DescribeCloudProviderCostResult, err error)

func DescribeDeploymentCellCost ¶ added in v0.14.40

func DescribeDeploymentCellCost(ctx context.Context, token string, opts CostOptions) (res *openapiclientfleet.DescribeDeploymentCellCostResult, err error)

func DescribeDeploymentCellWorkflow ¶ added in v1.0.48

func DescribeDeploymentCellWorkflow(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.DescribeDeploymentCellWorkflowResult, err error)

DescribeDeploymentCellWorkflow describes a specific deployment cell workflow

func DescribeHelmChart ¶

func DescribeHelmChart(ctx context.Context, token, chartName, chartVersion string) (helmPackage *openapiclient.HelmPackage, err error)

func DescribeHostCluster ¶

func DescribeHostCluster(ctx context.Context, token string, hostClusterID string) (*openapiclientfleet.HostCluster, error)

func DescribeInstanceSnapshot ¶ added in v0.14.47

func DescribeInstanceSnapshot(ctx context.Context, token, serviceID, environmentID, instanceID, snapshotID string) (resp *openapiclientfleet.FleetDescribeInstanceSnapshotResult, err error)

func DescribeLatestVersion ¶

func DescribeLatestVersion(ctx context.Context, token, serviceID, productTierID string) (*openapiclient.TierVersionSet, error)

func DescribeNodepool ¶ added in v1.0.34

func DescribeNodepool(ctx context.Context, token string, hostClusterID string, nodepoolName string) (*model.NodepoolDescribeView, *openapiclientfleet.Entity, error)

DescribeNodepool describes a specific nodepool in a deployment cell

func DescribePendingChanges ¶

func DescribePendingChanges(ctx context.Context, token, serviceID, serviceAPIID, productTierID string) (*openapiclientv1.DescribePendingChangesResult, error)

func DescribeProductTier ¶

func DescribeProductTier(ctx context.Context, token, serviceID, productTierID string) (productTier *openapiclientv1.DescribeProductTierResult, err error)

func DescribeRegionCost ¶ added in v0.14.40

func DescribeRegionCost(ctx context.Context, token string, opts CostOptions) (res *openapiclientfleet.DescribeRegionCostResult, err error)

func DescribeResource ¶

func DescribeResource(ctx context.Context, token, serviceID, resourceID string, productTierID, productTierVersion *string) (resp *openapiclient.DescribeResourceResult, err error)

func DescribeResourceInstance ¶

func DescribeResourceInstance(ctx context.Context, token string, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.ResourceInstance, err error)

func DescribeResourceInstanceInstaller ¶ added in v0.14.37

func DescribeResourceInstanceInstaller(ctx context.Context, token string, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.DescribeResourceInstanceInstallerResult, err error)

func DescribeResourceInstanceSnapshot ¶

func DescribeResourceInstanceSnapshot(ctx context.Context, token string, serviceID, environmentID, instanceID, snapshotID string) (res *openapiclientfleet.FleetDescribeInstanceSnapshotResult, err error)

func DescribeService ¶

func DescribeService(ctx context.Context, token, serviceID string) (*openapiclient.DescribeServiceResult, error)

func DescribeServiceEnvironment ¶

func DescribeServiceEnvironment(ctx context.Context, token, serviceID, serviceEnvironmentID string) (*openapiclientv1.DescribeServiceEnvironmentResult, error)

func DescribeServiceModel ¶

func DescribeServiceModel(ctx context.Context, token, serviceID, serviceModelID string) (serviceModel *openapiclient.DescribeServiceModelResult, err error)

func DescribeServiceOffering ¶

func DescribeServiceOffering(ctx context.Context, token, serviceID, productTierID, productTierVersion string) (res *openapiclientfleet.InventoryDescribeServiceOfferingResult, err error)

func DescribeServiceOfferingResource ¶

func DescribeServiceOfferingResource(ctx context.Context, token, serviceID, resourceID, instanceID, productTierID, productTierVersion string) (res *openapiclientfleet.InventoryDescribeServiceOfferingResourceResult, err error)

func DescribeServiceOfferingResourceV1 ¶ added in v0.14.57

func DescribeServiceOfferingResourceV1(ctx context.Context, token, serviceID, resourceID, instanceID, productTierID, productTierVersion string) (res *openapiclientv1.DescribeServiceOfferingResourceResult, err error)

func DescribeServicesOrchestration ¶

func DescribeServicesOrchestration(ctx context.Context, token string, id string) (resp *openapiclientfleet.FleetDescribeServicesOrchestrationResult, err error)

func DescribeSubscription ¶

func DescribeSubscription(ctx context.Context, token string, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.FleetDescribeSubscriptionResult, err error)

func DescribeSubscriptionRequest ¶ added in v0.14.47

func DescribeSubscriptionRequest(ctx context.Context, token string, serviceID, environmentID, requestID string) (resp *openapiclientfleet.DescribeSubscriptionRequestResult, err error)

func DescribeUpgradePath ¶

func DescribeUpgradePath(ctx context.Context, token, serviceID, productTierID, upgradePathID string) (*openapiclientfleet.UpgradePath, error)

func DescribeUser ¶

func DescribeUser(ctx context.Context, token string) (*openapiclient.DescribeUserResult, error)

func DescribeUserCost ¶ added in v0.14.40

func DescribeUserCost(ctx context.Context, token string, opts CostOptions) (res *openapiclientfleet.DescribeUserCostResult, err error)

func DescribeVersionSet ¶

func DescribeVersionSet(ctx context.Context, token, serviceID, productTierID, version string) (*openapiclient.TierVersionSet, error)

func DescribeWorkflow ¶ added in v0.14.40

func DescribeWorkflow(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.DescribeServiceWorkflowResult, err error)

func DescribeWorkflowSummary ¶ added in v0.14.40

func DescribeWorkflowSummary(ctx context.Context, token string, serviceID, environmentID string) (res *openapiclientfleet.DescribeServiceWorkflowSummaryResult, err error)

func DisableServiceModelFeature ¶

func DisableServiceModelFeature(ctx context.Context, token, serviceID, serviceModelID, featureName string) (err error)

func EnableServiceModelFeature ¶

func EnableServiceModelFeature(ctx context.Context, token, serviceID, serviceModelID, featureName string, featureConfiguration map[string]any) (err error)

func EnhanceServicePlansWithAccountInfo ¶ added in v0.14.52

func EnhanceServicePlansWithAccountInfo(ctx context.Context, token string, service *openapiclient.DescribeServiceResult) error

EnhanceServicePlansWithAccountInfo enhances the existing service plans with detailed account information

func EvaluateExpression ¶ added in v0.14.33

func EvaluateExpression(ctx context.Context, token, serviceID, productTierID, instanceID, resourceKey, expression string, expressionMap map[string]interface{}) (result interface{}, err error)

func ExternalDescribeServiceOffering ¶ added in v1.0.52

func ExternalDescribeServiceOffering(ctx context.Context, token, serviceID, environmentID, productTierID string) (res *openapiclientv1.DescribeServiceOfferingResult, err error)

func FindEnvironment ¶

func FindEnvironment(ctx context.Context, token, serviceID, environmentType string) (*openapiclientv1.DescribeServiceEnvironmentResult, error)

func FindLatestVersion ¶

func FindLatestVersion(ctx context.Context, token, serviceID, productTierID string) (string, error)

func FindPreferredVersion ¶

func FindPreferredVersion(ctx context.Context, token, serviceID, productTierID string) (string, error)

func FleetCreateCustomNetwork ¶

func FleetCreateCustomNetwork(
	ctx context.Context, token string, cloudProviderName string, cloudProviderRegion string, cidr string, name *string) (
	customNetwork *openapiclientfleet.FleetCustomNetwork, err error)

func FleetDeleteCustomNetwork ¶

func FleetDeleteCustomNetwork(
	ctx context.Context, token string, customNetworkId string) (
	err error)

func FleetDescribeCustomNetwork ¶

func FleetDescribeCustomNetwork(
	ctx context.Context, token string, id string) (
	customNetwork *openapiclientfleet.FleetCustomNetwork, err error)

func FleetListCustomNetworks ¶

func FleetListCustomNetworks(
	ctx context.Context, token string, cloudProviderName *string, cloudProviderRegion *string) (
	customNetworks *openapiclientfleet.FleetListCustomNetworksResult, err error)

func FleetUpdateCustomNetwork ¶

func FleetUpdateCustomNetwork(
	ctx context.Context, token string, id string, updatedName *string) (
	customNetwork *openapiclientfleet.FleetCustomNetwork, err error)

func GenerateComposeSpecFromContainerImage ¶

func GenerateComposeSpecFromContainerImage(ctx context.Context, token string, request openapiclient.GenerateComposeSpecFromContainerImageRequest2) (res *openapiclient.GenerateComposeSpecFromContainerImageResult, err error)

func GetCloudProviderByName ¶

func GetCloudProviderByName(ctx context.Context, token string, cloudProvider string) (string, error)

func GetComposeSpecHeaders ¶ added in v1.0.5

func GetComposeSpecHeaders(composeSpecURL string) ([]string, error)

GetComposeSpecHeaders returns all H3 headers from the compose spec documentation

func GetDebugEventsForAllResources ¶ added in v0.14.34

func GetDebugEventsForAllResources(ctx context.Context, token string, serviceID, environmentID, instanceID string, fetchResourceStatus bool, expectedAction ...string) ([]ResourceWorkflowDebugEvents, *WorkflowInfo, error)

GetDebugEventsForAllResources gets workflow events for all resources in an instance, organized by resource and workflow step. If fetchResourceStatus is true, also fetches and sets workflow status from DescribeWorkflow.

func GetDefaultDeploymentConfigID ¶

func GetDefaultDeploymentConfigID(ctx context.Context, token string) (string, error)

func GetDeploymentCellHealth ¶ added in v0.14.47

func GetDeploymentCellHealth(ctx context.Context, token string, opts *DeploymentCellHealthOptions) (res *openapiclientfleet.DeploymentCellHealthDetail, err error)

func GetDeploymentCellWorkflowEvents ¶ added in v1.0.48

func GetDeploymentCellWorkflowEvents(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.GetDeploymentCellWorkflowEventsResult, err error)

GetDeploymentCellWorkflowEvents gets events for a deployment cell workflow

func GetInstanceDeploymentEntity ¶

func GetInstanceDeploymentEntity(ctx context.Context, token string, instanceID string, deploymentType string, deploymentName string) (output string, err error)

func GetJSONSchema ¶ added in v1.0.28

func GetJSONSchema(ctx context.Context, schemaType string) (interface{}, error)

GetJSONSchema retrieves the JSON schema for a specific type

func GetKubeConfigForHostCluster ¶ added in v0.13.37

func GetKubeConfigForHostCluster(
	ctx context.Context,
	token string,
	hostClusterID string,
	role string,
) (
	*openapiclientfleet.KubeConfigHostClusterResult,
	error,
)

func GetNotificationChannel ¶ added in v0.14.9

func GetNotificationChannel(ctx context.Context, token, channelID string) (res *openapiclientfleet.Channel, err error)

func GetNotificationChannelEventHistory ¶ added in v0.14.9

func GetNotificationChannelEventHistory(ctx context.Context, token, channelID string, startTime, endTime *time.Time) (res *openapiclientfleet.ChannelEventHistoryResult, err error)

func GetOrganizationDeploymentCellTemplate ¶ added in v0.14.18

func GetOrganizationDeploymentCellTemplate(ctx context.Context, token string, environment string, cloudProvider string) (*model.DeploymentCellTemplate, error)

GetOrganizationDeploymentCellTemplate retrieves the organization template for a specific environment and cloud provider

func GetSecret ¶ added in v0.13.31

func GetSecret(ctx context.Context, token, environmentType, name string) (*openapiclientv1.GetSecretResult, error)

GetSecret retrieves a secret for the given environment type and name

func GetServiceHealth ¶ added in v0.14.47

func GetServiceHealth(ctx context.Context, token string, serviceID, serviceEnvironmentID string) (res *openapiclientfleet.ServiceHealthSummary, err error)

func GetServiceProviderOrganization ¶ added in v0.14.18

func GetServiceProviderOrganization(ctx context.Context, token string) (res *openapiclient.DescribeServiceProviderOrganizationResult, err error)

func GetSubscriptionByCustomerEmail ¶ added in v0.14.5

func GetSubscriptionByCustomerEmail(ctx context.Context, token string, serviceID string, planID string, customerEmail string) (resp *openapiclientfleet.FleetDescribeSubscriptionResult, err error)

func GetSubscriptionByCustomerEmailInEnvironment ¶ added in v1.4.3

func GetSubscriptionByCustomerEmailInEnvironment(
	ctx context.Context,
	token string,
	serviceID string,
	environmentID string,
	planID string,
	customerEmail string,
) (resp *openapiclientfleet.FleetDescribeSubscriptionResult, err error)

func GetWorkflowEvents ¶ added in v0.14.34

func GetWorkflowEvents(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.GetWorkflowEventsResult, err error)

func ListAPIKeys ¶ added in v1.4.16

func ListAPIKeys(ctx context.Context, token string) (*openapiclient.ListAPIKeysResult, error)

ListAPIKeys returns the metadata for every API key visible to the caller's org. Plaintext is never included.

func ListAccountConfigs ¶ added in v0.14.52

func ListAccountConfigs(ctx context.Context, token, cloudProviderName string) (*openapiclientfleet.ListAccountConfigsResult, error)

func ListAccounts ¶

func ListAccounts(ctx context.Context, token string, cloudProvider string) (*openapiclient.ListAccountConfigResult, error)

func ListAllAccountConfigs ¶ added in v0.14.52

func ListAllAccountConfigs(ctx context.Context, token string) (*openapiclientfleet.ListAccountConfigsResult, error)

func ListAllSnapshots ¶ added in v1.1.0

func ListAllSnapshots(ctx context.Context, token, serviceID, environmentID string) (res *openapiclientfleet.FleetListInstanceSnapshotResult, err error)

ListAllSnapshots lists all snapshots for a service environment (no instance ID required).

func ListAuditEvents ¶ added in v0.14.47

func ListAuditEvents(ctx context.Context, token string, opts *ListAuditEventsOptions) (resp *openapiclientfleet.FleetAuditEventsResult, err error)

func ListDeploymentCellWorkflows ¶ added in v1.0.48

func ListDeploymentCellWorkflows(ctx context.Context, token string, hostClusterID string, opts *ListDeploymentCellWorkflowsOptions) (res *openapiclientfleet.ListDeploymentCellWorkflowsResult, err error)

ListDeploymentCellWorkflows lists workflows for a deployment cell

func ListDomains ¶

func ListDomains(ctx context.Context, token string) (*openapiclientv1.ListSaaSPortalCustomDomainsResult, error)

func ListEligibleInstancesPerUpgrade ¶

func ListEligibleInstancesPerUpgrade(ctx context.Context, token, serviceID, productTierID, upgradePathID string) ([]openapiclientfleet.InstanceUpgrade, error)

func ListHelmChartInstallations ¶

func ListHelmChartInstallations(ctx context.Context, token string, hostClusterID string) (helmPackageInstallations *openapiclientfleet.ListHelmPackageInstallationsResult, err error)

func ListHelmCharts ¶

func ListHelmCharts(ctx context.Context, token string) (helmPackages *openapiclient.ListHelmPackagesResult, err error)

func ListHostClusters ¶

func ListHostClusters(ctx context.Context, token string, accountConfigID *string, regionID *string) (*openapiclientfleet.ListHostClustersResult, error)

func ListInputParameters ¶ added in v0.14.57

func ListInputParameters(ctx context.Context, token, serviceID, resourceID, productTierID, productTierVersion string) (res *openapiclientv1.ListInputParametersResult, err error)

func ListInstanceSnapshots ¶ added in v0.14.47

func ListInstanceSnapshots(ctx context.Context, token, serviceID, environmentID, instanceID string) (resp *openapiclientfleet.FleetListInstanceSnapshotResult, err error)

func ListNodepools ¶ added in v1.0.34

func ListNodepools(ctx context.Context, token string, hostClusterID string) ([]model.NodepoolTableView, []openapiclientfleet.Entity, error)

ListNodepools lists all nodepools in a deployment cell

func ListNotificationChannels ¶ added in v0.14.9

func ListNotificationChannels(ctx context.Context, token string) (res *openapiclientfleet.ListNotificationChannelsResult, err error)

func ListOperationsEvents ¶ added in v0.14.47

func ListOperationsEvents(ctx context.Context, token string, opts *ListEventsOptions) (res *openapiclientfleet.ListServiceProviderEventsResult, err error)

func ListResourceInstance ¶ added in v1.0.31

func ListResourceInstance(ctx context.Context, token string, serviceID, environmentID string, options *ListResourceInstanceOptions) (res *openapiclientfleet.ListFleetResourceInstancesResultInternal, err error)

func ListResourceInstanceSnapshots ¶

func ListResourceInstanceSnapshots(ctx context.Context, token string, serviceID, environmentID, instanceID string) (res *openapiclientfleet.FleetListInstanceSnapshotResult, err error)

func ListResources ¶ added in v0.14.5

func ListResources(ctx context.Context, token, serviceID string, productTierID string, productTierVersion *string) (resp *openapiclient.ListResourcesResult, err error)

func ListSecrets ¶ added in v0.13.31

func ListSecrets(ctx context.Context, token, environmentType string) (*openapiclientv1.ListSecretsResult, error)

ListSecrets lists all secrets for the given environment type

func ListServiceEnvironments ¶

func ListServiceEnvironments(ctx context.Context, token, serviceID string) (*openapiclientv1.ListServiceEnvironmentsResult, error)

func ListServiceOfferings ¶

func ListServiceOfferings(ctx context.Context, token string) (inventory *openapiclientfleet.InventoryListServiceOfferingsResult, err error)

func ListServicePlans ¶ added in v0.14.52

func ListServicePlans(ctx context.Context, token, serviceID, serviceEnvironmentID string) (*openapiclient.ListServicePlansResult, error)

func ListServices ¶

func ListServices(ctx context.Context, token string) (*openapiclient.ListServiceResult, error)

func ListServicesOrchestration ¶

func ListServicesOrchestration(ctx context.Context, token string, environmentType string) (resp []openapiclientfleet.FleetDescribeServicesOrchestrationResult, err error)

func ListSubscriptionRequests ¶ added in v0.14.47

func ListSubscriptionRequests(ctx context.Context, token string, serviceID, environmentID string) (resp *openapiclientfleet.ListSubscriptionRequestsResult, err error)

func ListSubscriptions ¶ added in v0.14.47

func ListSubscriptions(ctx context.Context, token string, serviceID, environmentID string) (resp *openapiclientfleet.FleetListSubscriptionsResult, err error)

func ListUpgradePaths ¶ added in v0.14.47

func ListUpgradePaths(ctx context.Context, token, serviceID, productTierID string, opts *ListUpgradePathsOptions) (resp *openapiclientfleet.ListUpgradePathsResult, err error)

func ListVersions ¶

func ListVersions(ctx context.Context, token, serviceID, productTierID string) (*openapiclient.ListTierVersionSetsResult, error)

func ListWorkflows ¶ added in v0.14.34

func ListWorkflows(ctx context.Context, token string, serviceID, environmentID string, opts *ListWorkflowsOptions) (res *openapiclientfleet.ListServiceWorkflowsResult, err error)

func ManageLifecycle ¶

func ManageLifecycle(ctx context.Context, token, serviceID, productTierID, upgradePathID string, action model.UpgradeMaintenanceAction) (*openapiclientfleet.UpgradePath, error)

func ManageLifecycleWithPayload ¶

func ManageLifecycleWithPayload(ctx context.Context, token, serviceID, productTierID, upgradePathID string, action model.UpgradeMaintenanceAction, actionPayload map[string]interface{}) (*openapiclientfleet.UpgradePath, error)

func ModifyServicesOrchestration ¶

func ModifyServicesOrchestration(
	ctx context.Context,
	token string,
	id string,
	orchestrationModifyDSL string,
) (
	err error,
)

func NewK8sClientForDeploymentCell ¶ added in v1.1.1

func NewK8sClientForDeploymentCell(ctx context.Context, token, deploymentCellID, role string) (*kubernetes.Clientset, error)

NewK8sClientForDeploymentCell creates a Kubernetes client for a deployment cell using the Fleet API kubeconfig.

func NewK8sClientFromHostClusterKubeConfig ¶ added in v1.1.1

func NewK8sClientFromHostClusterKubeConfig(kubeConfig *openapiclientfleet.KubeConfigHostClusterResult) (*kubernetes.Clientset, error)

NewK8sClientFromHostClusterKubeConfig builds a Kubernetes client from a Host Cluster kubeconfig result.

func OneOffPatchResourceInstance ¶ added in v0.13.37

func OneOffPatchResourceInstance(ctx context.Context, token string, serviceID, environmentID, instanceID string, resourceOverrideConfig map[string]openapiclientfleet.ResourceOneOffPatchConfigurationOverride, targetTierVersion string) (err error)

func PatchInstanceDeploymentEntity ¶

func PatchInstanceDeploymentEntity(ctx context.Context, token string, instanceID string, deploymentType string, deploymentName string, patchedFilePath string, deploymentAction string) (err error)

func PauseInstanceDeploymentEntity ¶

func PauseInstanceDeploymentEntity(ctx context.Context, token string, instanceID string, deploymentType string, deploymentName string) (err error)

func PrepareServiceFromServicePlanSpec ¶ added in v1.2.8

func PrepareServiceFromServicePlanSpec(ctx context.Context, token string, request openapiclient.PrepareServiceFromServicePlanSpecRequest2) (*openapiclient.PrepareServiceFromServicePlanSpecResult, error)

func PrintAccountNotVerifiedWarning ¶

func PrintAccountNotVerifiedWarning(account *openapiclient.DescribeAccountConfigResult)

func PrintDomainNotVerifiedWarningMsg ¶

func PrintDomainNotVerifiedWarningMsg(domain, clusterEndpoint string)

func PrintNextStepVerifyAccountMsg ¶

func PrintNextStepVerifyAccountMsg(account *openapiclient.DescribeAccountConfigResult)

func PrintNextStepVerifyDomainMsg ¶

func PrintNextStepVerifyDomainMsg(clusterEndpoint string)

func PrintNextStepsAfterBuildMsg ¶

func PrintNextStepsAfterBuildMsg()

func PromoteServiceEnvironment ¶

func PromoteServiceEnvironment(ctx context.Context, token, serviceID, serviceEnvironmentID string) error

func PromoteServiceEnvironmentStatus ¶

func PromoteServiceEnvironmentStatus(ctx context.Context, token, serviceID, serviceEnvironmentID string) (resp []openapiclientv1.EnvironmentPromotionStatus, err error)

func ReleaseServicePlan ¶

func ReleaseServicePlan(ctx context.Context, token, serviceID, serviceAPIID, productTierID string, versionSetName *string, isPreferred, dryrun bool) error

func ReplayNotificationEvent ¶ added in v0.14.9

func ReplayNotificationEvent(ctx context.Context, token, eventID string) (err error)

func RestartResourceInstance ¶

func RestartResourceInstance(ctx context.Context, token string, serviceID, environmentID, resourceID, instanceID string) (err error)

func RestoreResourceInstanceSnapshot ¶

func RestoreResourceInstanceSnapshot(ctx context.Context, token string, serviceID, environmentID, snapshotID string, formattedParams map[string]any, tierVersionOverride string, networkType string) (res *openapiclientfleet.FleetRestoreResourceInstanceResult, err error)

func RestoreSnapshot ¶ added in v1.1.0

func RestoreSnapshot(ctx context.Context, token, serviceID, environmentID, snapshotID string, formattedParams map[string]any, tierVersionOverride string, networkType string, restoreToSource bool) (res *openapiclientfleet.FleetRestoreResourceInstanceResult, err error)

RestoreSnapshot restores a snapshot either to a new instance or, when restoreToSource is true, to the original source instance.

func ResumeDeploymentCellWorkflow ¶ added in v1.4.7

func ResumeDeploymentCellWorkflow(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.DeploymentCellWorkflow, err error)

ResumeDeploymentCellWorkflow resumes a paused deployment cell workflow

func ResumeInstanceDeploymentEntity ¶

func ResumeInstanceDeploymentEntity(ctx context.Context, token string, instanceID string, deploymentType string, deploymentName string, deploymentAction string) (err error)

func ResumeSubscription ¶ added in v0.14.47

func ResumeSubscription(ctx context.Context, token string, serviceID, environmentID, subscriptionID string) (err error)

func ResumeWorkflow ¶ added in v1.2.12

func ResumeWorkflow(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.ServiceWorkflow, err error)

func RetryDeploymentCellWorkflow ¶ added in v1.4.7

func RetryDeploymentCellWorkflow(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.DeploymentCellWorkflow, err error)

RetryDeploymentCellWorkflow retries a failed deployment cell workflow

func RetryWorkflow ¶ added in v1.2.12

func RetryWorkflow(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.ServiceWorkflow, err error)

func RevokeAPIKey ¶ added in v1.4.16

func RevokeAPIKey(ctx context.Context, token, id string) error

RevokeAPIKey marks the key identified by id as revoked. The key remains in the org listing with status=revoked until DeleteAPIKey is called.

func RevokeToken ¶ added in v1.5.0

func RevokeToken(ctx context.Context, refreshToken string) error

RevokeToken invalidates the given refresh token server-side. The backend deletes the token hash so it can never be used again.

func SaveHelmChart ¶

func SaveHelmChart(
	ctx context.Context,
	token string,
	chartName string,
	chartVersion string,
	namespace string,
	repoName string,
	repoURL string,
	values map[string]any,
) (
	helmPackage openapiclient.HelmPackage,
	err error,
)

func SearchInventory ¶

func SearchInventory(ctx context.Context, token, query string) (*openapiclientfleet.SearchInventoryResult, error)

func SetDefaultServicePlan ¶

func SetDefaultServicePlan(ctx context.Context, token, serviceID, productTierID, version string) (*openapiclient.TierVersionSet, error)

func SetSecret ¶ added in v0.13.31

func SetSecret(ctx context.Context, token, environmentType, name, value string) error

SetSecret sets a secret for the given environment type

func StartResourceInstance ¶

func StartResourceInstance(ctx context.Context, token string, serviceID, environmentID, resourceID, instanceID string) (err error)

func StopResourceInstance ¶

func StopResourceInstance(ctx context.Context, token string, serviceID, environmentID, resourceID, instanceID string) (err error)

func SuspendSubscription ¶ added in v0.14.47

func SuspendSubscription(ctx context.Context, token string, serviceID, environmentID, subscriptionID string) (err error)

func TerminateDeploymentCellWorkflow ¶ added in v1.4.7

func TerminateDeploymentCellWorkflow(ctx context.Context, token string, hostClusterID, workflowID string) (res *openapiclientfleet.DeploymentCellWorkflow, err error)

TerminateDeploymentCellWorkflow terminates a deployment cell workflow

func TerminateSubscription ¶ added in v0.14.47

func TerminateSubscription(ctx context.Context, token string, serviceID, environmentID, subscriptionID string) (err error)

func TerminateWorkflow ¶ added in v0.14.40

func TerminateWorkflow(ctx context.Context, token string, serviceID, environmentID, workflowID string) (res *openapiclientfleet.ServiceWorkflow, err error)

func TriggerResourceInstanceAutoBackup ¶

func TriggerResourceInstanceAutoBackup(ctx context.Context, token string, serviceID, environmentID, instanceID string) (res *openapiclientfleet.FleetAutomaticInstanceSnapshotCreationResult, err error)

func UpdateAPIKeyMetadata ¶ added in v1.4.16

func UpdateAPIKeyMetadata(
	ctx context.Context,
	token string,
	id string,
	name *string,
	description *string,
) (*openapiclient.UpdateAPIKeyMetadataResult, error)

UpdateAPIKeyMetadata edits the mutable metadata (name, description) of the key identified by id. Either pointer may be nil to leave the corresponding field unchanged.

func UpdateAccount ¶ added in v1.4.3

func UpdateAccount(ctx context.Context, token string, params UpdateAccountParams) (string, error)

func UpdateHostCluster ¶ added in v0.14.18

func UpdateHostCluster(ctx context.Context, token string, hostClusterID string, pendingAmenities []openapiclientfleet.Amenity, syncWithOrgTemplate *bool) error

func UpdateResourceInstance ¶

func UpdateResourceInstance(
	ctx context.Context,
	token string,
	serviceID, environmentID, instanceID string,
	resourceId string,
	networkType *string,
	requestParameters map[string]any,
	customTags []openapiclientfleet.CustomTag,
) (err error)

func UpdateResourceInstanceDebugMode ¶

func UpdateResourceInstanceDebugMode(ctx context.Context, token string, serviceID, environmentID, instanceID string, enable bool) (err error)

func UpdateServiceProviderOrganization ¶ added in v0.14.18

func UpdateServiceProviderOrganization(ctx context.Context, token string, deploymentConfig model.DeploymentCellTemplate, envType string, cloudProvider string) (err error)

func UpdateVersionSetName ¶ added in v0.13.38

func UpdateVersionSetName(ctx context.Context, token, serviceID, productTierID, version, newName string) (*openapiclient.TierVersionSet, error)

Types ¶

type AccountsByCloudProviderAndPlan ¶ added in v0.14.52

type AccountsByCloudProviderAndPlan struct {
	CloudProvider string             `json:"cloudProvider"`
	Plans         []PlanWithAccounts `json:"plans"`
}

AccountsByCloudProviderAndPlan holds account configuration information grouped by cloud provider and plan

type ArtifactDescribeResult ¶ added in v1.2.8

type ArtifactDescribeResult struct {
	// Unique identifier for the artifact
	ArtifactID string
	// Status of the artifact
	Status string
}

ArtifactDescribeResult represents the result of describing an artifact

func DescribeArtifact ¶ added in v1.2.8

func DescribeArtifact(
	ctx context.Context,
	token string,
	artifactID string,
) (*ArtifactDescribeResult, error)

DescribeArtifact retrieves information about an uploaded artifact

type ArtifactUploadResult ¶ added in v1.2.8

type ArtifactUploadResult struct {
	// Unique identifier for the uploaded artifact
	ArtifactID string
}

ArtifactUploadResult represents the result of uploading an artifact

func UploadArtifact ¶ added in v1.2.8

func UploadArtifact(
	ctx context.Context,
	token string,
	base64Content string,
	artifactPath string,
	serviceName string,
	productTierName string,
	accountConfigID string,
	environmentType string,
) (*ArtifactUploadResult, error)

UploadArtifact uploads a base64 encoded tar.gz artifact to Omnistrate base64Content is the base64 encoded tar.gz content artifactPath is the path to the deployment artifact serviceName is the name of the service productTierName is the name of the product tier accountConfigID is the account config ID associated with the deployment artifact environmentType is the type of environment (e.g., "DEV", "PROD")

type ComposeSpecAvailableTag ¶ added in v1.0.9

type ComposeSpecAvailableTag struct {
	AvailableTag string `json:"available_tag"`
}

ComposeSpecAvailableTag represents a tag that is available in the compose spec documentation

func ListComposeSpecSections ¶ added in v1.0.9

func ListComposeSpecSections() ([]ComposeSpecAvailableTag, error)

ListComposeSpecSections retrieves all compose spec tag sections

type ComposeSpecResult ¶ added in v1.0.5

type ComposeSpecResult struct {
	Tag        string      `json:"tag"`
	URL        string      `json:"url"`
	Content    string      `json:"content,omitempty"`
	JSONSchema interface{} `json:"json_schema,omitempty"`
}

ComposeSpecResult represents a compose spec search result

func SearchComposeSpecSections ¶ added in v1.0.5

func SearchComposeSpecSections(tag string) ([]ComposeSpecResult, error)

SearchComposeSpecSections retrieves all compose spec tag sections

type CostOptions ¶ added in v0.14.40

type CostOptions struct {
	StartDate                time.Time
	EndDate                  time.Time
	EnvironmentType          string
	Frequency                string
	IncludeCloudProviderIDs  *string
	ExcludeCloudProviderIDs  *string
	IncludeRegionIDs         *string
	ExcludeRegionIDs         *string
	IncludeDeploymentCellIDs *string
	ExcludeDeploymentCellIDs *string
	IncludeInstanceIDs       *string
	ExcludeInstanceIDs       *string
	IncludeUserIDs           *string
	ExcludeUserIDs           *string
	TopNInstances            *int64
	TopNUsers                *int64
}

type CreateSubscriptionOnBehalfOptions ¶ added in v0.14.47

type CreateSubscriptionOnBehalfOptions struct {
	ProductTierID                        string
	OnBehalfOfCustomerUserID             string
	OnBehalfOfCustomerEmail              string
	AllowCreatesWhenPaymentNotConfigured *bool
	BillingProvider                      string
	CustomPrice                          *bool
	CustomPricePerUnit                   map[string]interface{}
	ExternalPayerID                      string
	MaxNumberOfInstances                 *int64
	PriceEffectiveDate                   string
}

type DashboardCatalog ¶ added in v1.4.5

type DashboardCatalog struct {
	InstanceID          string                 `json:"instanceId,omitempty"`
	PreferredFeatureKey string                 `json:"preferredFeatureKey,omitempty"`
	Features            []DashboardFeatureInfo `json:"features,omitempty"`
}

func (*DashboardCatalog) PreferredFeature ¶ added in v1.4.5

func (c *DashboardCatalog) PreferredFeature() *DashboardFeatureInfo

type DashboardDefinition ¶ added in v1.4.5

type DashboardDefinition struct {
	Source string `json:"source,omitempty"`
	Name   string `json:"name,omitempty"`
	Title  string `json:"title,omitempty"`
}

type DashboardFeatureInfo ¶ added in v1.4.5

type DashboardFeatureInfo struct {
	Key                  string                `json:"key,omitempty"`
	Label                string                `json:"label,omitempty"`
	GrafanaEndpoint      string                `json:"grafanaEndpoint,omitempty"`
	GrafanaUIUsername    string                `json:"grafanaUiUsername,omitempty"`
	GrafanaUIPassword    string                `json:"grafanaUiPassword,omitempty"`
	GrafanaUILoginScope  string                `json:"grafanaUiLoginScope,omitempty"`
	ServiceAccountName   string                `json:"serviceAccountUsername,omitempty"`
	ServiceAccountToken  string                `json:"serviceAccountToken,omitempty"`
	Dashboards           []DashboardRef        `json:"dashboards,omitempty"`
	DashboardDefinitions []DashboardDefinition `json:"dashboardDefinitions,omitempty"`
}

func (*DashboardFeatureInfo) HasAccessCredentials ¶ added in v1.4.5

func (f *DashboardFeatureInfo) HasAccessCredentials() bool

type DashboardInfo ¶ added in v1.4.5

type DashboardInfo struct {
	InstanceID           string                `json:"instanceId,omitempty"`
	MetricsFeatureKey    string                `json:"metricsFeatureKey,omitempty"`
	MetricsFeatureLabel  string                `json:"metricsFeatureLabel,omitempty"`
	GrafanaEndpoint      string                `json:"grafanaEndpoint,omitempty"`
	GrafanaLoginUsername string                `json:"grafanaLoginUsername,omitempty"`
	GrafanaLoginPassword string                `json:"grafanaLoginPassword,omitempty"`
	GrafanaLoginScope    string                `json:"grafanaLoginScope,omitempty"`
	ServiceAccountName   string                `json:"serviceAccountName,omitempty"`
	ServiceAccountToken  string                `json:"serviceAccountToken,omitempty"`
	Dashboards           []DashboardRef        `json:"dashboards,omitempty"`
	DashboardDefinitions []DashboardDefinition `json:"dashboardDefinitions,omitempty"`
}

type DashboardRef ¶ added in v1.4.5

type DashboardRef struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	URL         string `json:"url,omitempty"`
}

type DashboardService ¶ added in v1.4.5

type DashboardService struct{}

func NewDashboardService ¶ added in v1.4.5

func NewDashboardService() *DashboardService

func (*DashboardService) GetDashboardCatalog ¶ added in v1.4.5

func (d *DashboardService) GetDashboardCatalog(instance *openapiclientfleet.ResourceInstance) (*DashboardCatalog, error)

func (*DashboardService) GetDashboardInfo ¶ added in v1.4.5

func (d *DashboardService) GetDashboardInfo(instance *openapiclientfleet.ResourceInstance) (*DashboardInfo, error)

func (*DashboardService) IsMetricsEnabled ¶ added in v1.4.5

func (d *DashboardService) IsMetricsEnabled(instance *openapiclientfleet.ResourceInstance) bool

type DebugEvent ¶ added in v1.0.17

type DebugEvent struct {
	EventTime string `json:"eventTime"`
	EventType string `json:"eventType"`
	Message   string `json:"message"`
}

DebugEvent represents a workflow debug event with known field names

type DebugEventsByWorkflowSteps ¶ added in v1.0.17

type DebugEventsByWorkflowSteps struct {
	Bootstrap  []DebugEvent `json:"bootstrap"`
	Storage    []DebugEvent `json:"storage"`
	Network    []DebugEvent `json:"network"`
	Compute    []DebugEvent `json:"compute"`
	Deployment []DebugEvent `json:"deployment"`
	Monitoring []DebugEvent `json:"monitoring"`
	Unknown    []DebugEvent `json:"unknown"`
}

DebugEventsByWorkflowSteps represents workflow debug events organized by workflow step

type DeploymentCellHealthOptions ¶ added in v0.14.47

type DeploymentCellHealthOptions struct {
	HostClusterID        string
	ServiceID            string
	ServiceEnvironmentID string
}

type Document ¶ added in v0.14.59

type Document struct {
	ID          string `json:"id"`
	Title       string `json:"title"`
	URL         string `json:"url"`
	Description string `json:"description"`
	Section     string `json:"section"`
	Subtitle    string `json:"subtitle"`
	Content     string `json:"content"`
}

Document represents a document to be indexed by Bleve

type DocumentationResult ¶ added in v0.14.49

type DocumentationResult struct {
	Title       string  `json:"title"`
	URL         string  `json:"url"`
	Description string  `json:"description"`
	Section     string  `json:"section"`
	Subtitle    string  `json:"subtitle,omitempty"`
	Content     string  `json:"content"`
	Score       float64 `json:"score,omitempty"`
}

DocumentationResult represents a search result

func PerformDocumentationSearch ¶ added in v0.14.49

func PerformDocumentationSearch(query string, limit int) ([]DocumentationResult, error)

type InspectAZItem ¶

type InspectAZItem struct {
	Name string
	VMs  []InspectVMItem
}

InspectAZItem represents an availability zone

type InspectPVCItem ¶

type InspectPVCItem struct {
	Name         string
	Size         string
	Status       string
	PVName       string
	StorageClass string
	AccessModes  []string
}

InspectPVCItem represents a persistent volume claim

type InspectPVItem ¶

type InspectPVItem struct {
	Name         string
	Size         string
	Status       string
	StorageClass string
	AccessModes  []string
	VolumeType   string
	PVCName      string
	PVCNamespace string
}

InspectPVItem represents a persistent volume

type InspectPodItem ¶

type InspectPodItem struct {
	Name      string
	Status    string
	NodeName  string
	Namespace string
	PVCs      []InspectPVCItem // PVCs attached to this pod
	Labels    map[string]string
	Resources ResourceRequirements
}

InspectPodItem represents a pod

type InspectStorageClassItem ¶

type InspectStorageClassItem struct {
	Name        string
	Provisioner string
	Parameters  map[string]string
	PVs         []InspectPVItem
}

InspectStorageClassItem represents a storage class

type InspectVMItem ¶

type InspectVMItem struct {
	Name         string
	InstanceType string
	VCPUs        int
	MemoryGB     float64
	Pods         []InspectPodItem
}

InspectVMItem represents a node in the cluster

type InspectWorkloadItem ¶

type InspectWorkloadItem struct {
	Type string // StatefulSet or Deployment
	Name string
	AZs  map[string][]InspectPodItem
}

InspectWorkloadItem represents a workload (StatefulSet or Deployment)

type K8sClientConfig ¶

type K8sClientConfig struct {
	Kubeconfig  string
	KubeContext string
}

K8sClientConfig contains configuration for the K8s client

type K8sInspectClient ¶

type K8sInspectClient interface {
	// GetClusterData returns detailed information about workloads, AZs, and storage in a namespace
	GetClusterData(ctx context.Context, namespace string) ([]InspectWorkloadItem, []InspectAZItem, []InspectStorageClassItem, error)

	// GetSampleData returns sample data for demonstration purposes
	GetSampleData(instanceID string) ([]InspectWorkloadItem, []InspectAZItem, []InspectStorageClassItem)
}

K8sInspectClient provides methods for retrieving inspect data

func NewK8sInspectClient ¶

func NewK8sInspectClient(config K8sClientConfig) K8sInspectClient

NewK8sInspectClient creates a new K8s inspection client

type K8sInspectClientImpl ¶

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

K8sInspectClientImpl is the Kubernetes implementation of K8sInspectClient

func (*K8sInspectClientImpl) GetClusterData ¶

func (k *K8sInspectClientImpl) GetClusterData(ctx context.Context, namespace string) ([]InspectWorkloadItem, []InspectAZItem, []InspectStorageClassItem, error)

GetClusterData fetches real data from a Kubernetes cluster

func (*K8sInspectClientImpl) GetSampleData ¶

func (k *K8sInspectClientImpl) GetSampleData(instanceID string) ([]InspectWorkloadItem, []InspectAZItem, []InspectStorageClassItem)

GetSampleData returns sample data for demonstration

type LeveledLogger ¶

type LeveledLogger struct {
	retryablehttp.LeveledLogger
}

Used to transform the retryablehttp logger to a zerolog logger

func NewLeveledLogger ¶

func NewLeveledLogger() *LeveledLogger

func (*LeveledLogger) Debug ¶

func (l *LeveledLogger) Debug(msg string, keysAndValues ...interface{})

func (*LeveledLogger) Error ¶

func (l *LeveledLogger) Error(msg string, keysAndValues ...interface{})

func (*LeveledLogger) Info ¶

func (l *LeveledLogger) Info(msg string, keysAndValues ...interface{})

func (*LeveledLogger) Warn ¶

func (l *LeveledLogger) Warn(msg string, keysAndValues ...interface{})

type ListAuditEventsOptions ¶ added in v0.14.47

type ListAuditEventsOptions struct {
	NextPageToken    string
	PageSize         *int64
	ServiceID        string
	EnvironmentType  string
	EventSourceTypes []string
	InstanceID       string
	ProductTierID    string
	StartDate        *time.Time
	EndDate          *time.Time
}

type ListDeploymentCellWorkflowsOptions ¶ added in v1.0.48

type ListDeploymentCellWorkflowsOptions struct {
	StartDate     *time.Time
	EndDate       *time.Time
	PageSize      *int64
	NextPageToken string
}

ListDeploymentCellWorkflowsOptions contains options for listing deployment cell workflows

type ListEventsOptions ¶ added in v0.14.47

type ListEventsOptions struct {
	NextPageToken        string
	PageSize             *int64
	EnvironmentType      string
	EventTypes           []string
	ServiceID            string
	ServiceEnvironmentID string
	InstanceID           string
	StartDate            *time.Time
	EndDate              *time.Time
	ProductTierID        string
}

type ListResourceInstanceOptions ¶ added in v1.0.31

type ListResourceInstanceOptions struct {
	Filter        *string
	ProductTierId *string
}

ListResourceInstanceOptions contains all optional parameters for ListResourceInstance

type ListUpgradePathsOptions ¶ added in v0.14.47

type ListUpgradePathsOptions struct {
	SourceProductTierVersion string
	TargetProductTierVersion string
	Status                   string
	Type                     string
	NextPageToken            string
	PageSize                 *int64
}

type ListWorkflowsOptions ¶ added in v0.14.40

type ListWorkflowsOptions struct {
	InstanceID    string
	StartDate     *time.Time
	EndDate       *time.Time
	PageSize      *int64
	NextPageToken string
}

type LogStreamConnection ¶ added in v0.14.22

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

LogStreamConnection represents an active log stream connection

func (*LogStreamConnection) Close ¶ added in v0.14.22

func (lsc *LogStreamConnection) Close() error

Close closes the log stream connection

func (*LogStreamConnection) Done ¶ added in v0.14.22

func (lsc *LogStreamConnection) Done() <-chan struct{}

Done returns a channel that is closed when the connection should be terminated

func (*LogStreamConnection) ReadLogs ¶ added in v0.14.22

func (lsc *LogStreamConnection) ReadLogs() (string, error)

ReadLogs reads log messages from the websocket connection

type LoginResult ¶ added in v1.4.0

type LoginResult struct {
	JWTToken     string //nolint:gosec
	RefreshToken string //nolint:gosec
}

LoginResult holds both the JWT and optional refresh token from a login response.

func LoginWithAPIKey ¶ added in v1.4.16

func LoginWithAPIKey(ctx context.Context, apiKey string) (LoginResult, error)

LoginWithAPIKey exchanges an org-bounded API key plaintext for a JWT session. It uses the same signin endpoint as password login, with the sentinel APIKeySigninEmail in the email field and the API key plaintext in the password field; the platform recognizes the sentinel and routes the request into the api-key signin-exchange path. The returned session is bound to the api-key's backing user and inherits the key's role; the JWT MUST NOT be persisted any longer than the calling session needs it.

func LoginWithIdentityProvider ¶

func LoginWithIdentityProvider(ctx context.Context, deviceCode, identityProviderName string) (LoginResult, error)

func LoginWithPassword ¶

func LoginWithPassword(ctx context.Context, email string, pass string) (LoginResult, error)

func RefreshToken ¶ added in v1.4.0

func RefreshToken(ctx context.Context, refreshToken string) (LoginResult, error)

RefreshToken exchanges a refresh token for a new JWT + refresh token pair.

type LogsConfig ¶ added in v0.14.22

type LogsConfig struct {
	BaseURL    string
	Username   string
	Credential string
}

LogsConfig holds the configuration for log streaming

type LogsService ¶ added in v0.14.22

type LogsService struct {
}

LogsService provides methods for log-related operations

func NewLogsService ¶ added in v0.14.22

func NewLogsService() *LogsService

NewLogsService creates a new LogsService instance

func (*LogsService) BuildLogStreams ¶ added in v0.14.22

func (ls *LogsService) BuildLogStreams(instance *openapiclientfleet.ResourceInstance, instanceID string, resourceKey string) ([]LogsStream, error)

BuildLogStreams creates log stream configurations for a specific resource

func (*LogsService) ConnectToLogStream ¶ added in v0.14.22

func (ls *LogsService) ConnectToLogStream(logsURL string) (*LogStreamConnection, error)

ConnectToLogStream establishes a websocket connection to stream logs

func (*LogsService) GetAllLogStreamsForInstance ¶ added in v0.14.22

func (ls *LogsService) GetAllLogStreamsForInstance(instance *openapiclientfleet.ResourceInstance, instanceID string) (map[string][]LogsStream, error)

GetAllLogStreamsForInstance gets all available log streams for an instance

func (*LogsService) GetLogsConfig ¶ added in v0.14.22

func (ls *LogsService) GetLogsConfig(instance *openapiclientfleet.ResourceInstance) (*LogsConfig, error)

GetLogsConfig extracts the logs configuration from the resource instance topology

func (*LogsService) IsLogsEnabled ¶ added in v0.14.22

func (ls *LogsService) IsLogsEnabled(instance *openapiclientfleet.ResourceInstance) bool

IsLogsEnabled checks if logs are enabled for the given resource instance

type LogsStream ¶ added in v0.14.22

type LogsStream struct {
	PodName string `json:"podName"`
	LogsURL string `json:"logsUrl"`
}

LogsStream represents a log stream configuration

type MarkupSection ¶ added in v1.0.5

type MarkupSection struct {
	Header  string
	Content string
}

MarkupSection represents a section of content under a markup heading

func ParseH3Sections ¶ added in v1.0.5

func ParseH3Sections(content string) ([]MarkupSection, error)

ParseH3Sections parses markdown content and extracts H3 sections

type PlanSpecAvailableTag ¶ added in v1.2.0

type PlanSpecAvailableTag struct {
	AvailableTag string `json:"available_tag"`
}

PlanSpecAvailableTag represents a tag that is available in the plan spec documentation

func ListPlanSpecSections ¶ added in v1.2.0

func ListPlanSpecSections() ([]PlanSpecAvailableTag, error)

ListPlanSpecSections retrieves all plan spec tag sections

type PlanSpecResult ¶ added in v1.2.0

type PlanSpecResult struct {
	Tag     string `json:"tag"`
	URL     string `json:"url"`
	Content string `json:"content,omitempty"`
}

PlanSpecResult represents a plan spec search result

func SearchPlanSpecSections ¶ added in v1.2.0

func SearchPlanSpecSections(tag string) ([]PlanSpecResult, error)

SearchPlanSpecSections retrieves plan spec sections matching the given tag

type PlanWithAccounts ¶ added in v0.14.52

type PlanWithAccounts struct {
	PlanName               string                                                `json:"planName"`
	PlanID                 string                                                `json:"planID"`
	ModelType              string                                                `json:"modelType"`
	ServiceModelId         string                                                `json:"serviceModelId,omitempty"`
	AccountConfigIds       []string                                              `json:"accountConfigIds,omitempty"`
	ActiveAccountConfigIds map[string]string                                     `json:"activeAccountConfigIds,omitempty"`
	Accounts               []openapiclientfleet.FleetDescribeAccountConfigResult `json:"accounts"`
}

type RawWorkflowStep ¶ added in v1.2.4

type RawWorkflowStep struct {
	StepName string       `json:"stepName"`
	Events   []DebugEvent `json:"events"`
}

RawWorkflowStep holds a workflow step name and its events as returned by the API.

type ResourceList ¶

type ResourceList map[string]string

ResourceList is a mapping of resource names to resource quantities

type ResourceRequirements ¶

type ResourceRequirements struct {
	Limits   ResourceList
	Requests ResourceList
}

ResourceRequirements contains resource requirements for a container

type ResourceWorkflowDebugEvents ¶ added in v1.0.17

type ResourceWorkflowDebugEvents struct {
	ResourceID           string                      `json:"resourceId"`
	ResourceKey          string                      `json:"resourceKey"`
	ResourceName         string                      `json:"resourceName"`
	EventsByWorkflowStep *DebugEventsByWorkflowSteps `json:"eventsByWorkflowStep"`
	WorkflowStatus       *string                     `json:"workflowStatus,omitempty"` // From DescribeWorkflow API
	// RawSteps preserves the original step names and events from the SDK response
	RawSteps []RawWorkflowStep `json:"rawSteps,omitempty"`
}

ResourceWorkflowDebugEvents represents workflow debug events for a resource organized by workflow step

type ServiceAccountInfo ¶ added in v0.14.52

type ServiceAccountInfo struct {
	ServiceID          string                           `json:"serviceId"`
	ServiceName        string                           `json:"serviceName"`
	AccountsByProvider []AccountsByCloudProviderAndPlan `json:"accountsByProvider"`
}

func GetServiceAccountInfo ¶ added in v0.14.52

func GetServiceAccountInfo(ctx context.Context, token string, service *openapiclient.DescribeServiceResult) (*ServiceAccountInfo, error)

GetServiceAccountInfo gets account information for Customer hosted plans only, grouped by cloud provider and plan

type UpdateAccountParams ¶ added in v1.4.3

type UpdateAccountParams struct {
	AccountConfigID string
	Name            *string
	Description     *string
	NebiusBindings  []openapiclient.NebiusAccountBindingInput
}

type WorkflowInfo ¶ added in v0.14.34

type WorkflowInfo struct {
	WorkflowID     string `json:"workflowId,omitempty"`
	WorkflowStatus string `json:"workflowStatus,omitempty"`
	StartTime      string `json:"startTime,omitempty"`
	EndTime        string `json:"endTime,omitempty"`
}

WorkflowInfo represents workflow metadata information

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL