Documentation
¶
Index ¶
- Constants
- func NewClusterKubeConfigRenderer(data []byte, writer io.Writer) *clusterKubeConfigRenderer
- func NewClusterNodeRenderer(node *clusterNodeResponse, jsonData []byte, writer io.Writer) *clusterNodeRenderer
- func NewClusterNodesRenderer(nodes *clusterNodesListResponse, jsonData []byte, writer io.Writer, ...) *clusterNodesRenderer
- func NewClusterRenderer(cluster *clusterResponse, jsonData []byte, writer io.Writer) *clusterRenderer
- func NewClustersRenderer(clusters *clusterListResponse, jsonData []byte, writer io.Writer, ...) *clustersRenderer
- type ClusterList
- type ClusterNodesList
- type CreateClusterInput
- type CreateClusterResult
- type DeleteClusterInput
- type DeleteClusterResult
- type GetClusterInput
- type GetClusterKubeConfigInput
- type GetClusterKubeConfigResult
- type GetClusterNodeInput
- type GetClusterNodeResult
- type GetClusterResult
- type ListClusterNodesInput
- type ListClusterNodesResults
- type ListClusterResults
- type ListClustersInput
- type Renderer
- type UpdateClusterInput
- type UpdateClusterResult
Constants ¶
const ( FormatJson = "json" FormatTable = "table" FormatPlain = "plain" )
Variables ¶
This section is empty.
Functions ¶
func NewClusterKubeConfigRenderer ¶ added in v0.7.1
NewClusterKubeConfigRenderer creates a new renderer of a cluster kubeconfig
func NewClusterNodeRenderer ¶ added in v0.6.2
func NewClusterNodeRenderer(node *clusterNodeResponse, jsonData []byte, writer io.Writer) *clusterNodeRenderer
NewClusterNodeRenderer creates a new renderer of a single cluster node
func NewClusterNodesRenderer ¶ added in v0.6.0
func NewClusterNodesRenderer(nodes *clusterNodesListResponse, jsonData []byte, writer io.Writer, noHeaders bool) *clusterNodesRenderer
NewClusterNodesRenderer creates a new renderer for a list of cluster nodes
func NewClusterRenderer ¶
func NewClusterRenderer(cluster *clusterResponse, jsonData []byte, writer io.Writer) *clusterRenderer
NewClusterRenderer creates a new renderer of a single cluster
Types ¶
type ClusterList ¶
type ClusterList struct {
// Included is a list of included items
Included []map[string]any
// Clusters is a list of clusters
Clusters []string
}
ClusterList is a list of clusters
func (*ClusterList) MarshalJSON ¶
func (cl *ClusterList) MarshalJSON() ([]byte, error)
func (*ClusterList) ToResponse ¶
func (cl *ClusterList) ToResponse() *clusterListResponse
type ClusterNodesList ¶ added in v0.6.0
func (*ClusterNodesList) MarshalJSON ¶ added in v0.6.0
func (cl *ClusterNodesList) MarshalJSON() ([]byte, error)
func (*ClusterNodesList) ToResponse ¶ added in v0.6.0
func (cl *ClusterNodesList) ToResponse() *clusterNodesListResponse
type CreateClusterInput ¶
type CreateClusterInput struct {
Logger *slog.Logger
APIClient apiclient.ClientWithResponsesInterface
Name string
Description string
EnvironmentName string
Provider string
Partition string
Region string
ResilienceZone string
SubscriptionID string
InfrastructureProvider string
HasTechnicalOperations bool
HasTechnicalManagement bool
HasApplicationOperations bool
HasApplicationManagement bool
HasCustomOperations bool
CustomOperationsURL string
}
CreateClusterInput is the input used by CreateCluster()
type CreateClusterResult ¶
type CreateClusterResult struct {
ClusterResponse *clusterResponse
JSONResponse []byte
Problem *apiclient.Problem
}
CreateClusterResult is the result of CreateCluster
func CreateCluster ¶
func CreateCluster(ctx context.Context, in CreateClusterInput) (*CreateClusterResult, error)
CreateCluster creates a cluster
type DeleteClusterInput ¶
type DeleteClusterInput struct {
Logger *slog.Logger
APIClient apiclient.ClientWithResponsesInterface
}
DeleteClusterInput is the input used by DeleteCluster()
type DeleteClusterResult ¶
DeleteClusterResult is the result of DeleteCluster
func DeleteCluster ¶
func DeleteCluster(ctx context.Context, clusterID string, in DeleteClusterInput) (*DeleteClusterResult, error)
DeleteCluster deletes a cluster
type GetClusterInput ¶
type GetClusterInput struct {
Logger *slog.Logger
APIClient apiclient.ClientWithResponsesInterface
}
GetClusterInput is the input used by GetCluster()
type GetClusterKubeConfigInput ¶ added in v0.7.1
type GetClusterKubeConfigInput struct {
Logger *slog.Logger
APIClient apiclient.ClientWithResponsesInterface
ClusterID string
}
GetClusterKubeConfigInput is the input used by GetClusterKubeConfig()
type GetClusterKubeConfigResult ¶ added in v0.7.1
GetClusterKubeConfigResult is the result of GetClusterKubeConfig()
func GetClusterKubeConfig ¶ added in v0.7.1
func GetClusterKubeConfig(ctx context.Context, in GetClusterKubeConfigInput) (*GetClusterKubeConfigResult, error)
GetClusterKubeConfig returns kubeconfig for a cluster
type GetClusterNodeInput ¶ added in v0.6.2
type GetClusterNodeInput struct {
Logger *slog.Logger
APIClient apiclient.ClientWithResponsesInterface
ClusterName string
NodeName string
}
GetClusterNodeInput is the input used by GetClusterNode()
type GetClusterNodeResult ¶ added in v0.6.2
type GetClusterNodeResult struct {
ClusterNodeResponse *clusterNodeResponse
JSONResponse []byte
Problem *apiclient.Problem
}
GetClusterNodeResult is the result of GetClusterNode()
func GetClusterNode ¶ added in v0.6.2
func GetClusterNode(ctx context.Context, in GetClusterNodeInput) (*GetClusterNodeResult, error)
GetClusterNode returns information abuot a cluster node
type GetClusterResult ¶
type GetClusterResult struct {
ClusterResponse *clusterResponse
JSONResponse []byte
Problem *apiclient.Problem
}
GetClusterResult is the result of GetCluster
func GetCluster ¶
func GetCluster(ctx context.Context, clusterID string, in GetClusterInput) (*GetClusterResult, error)
GetCluster returns information abuot a cluster
type ListClusterNodesInput ¶ added in v0.6.0
type ListClusterNodesInput struct {
// Logger is a logger
Logger *slog.Logger
// APIClient is the inventory server API client used to make requests
APIClient apiclient.ClientWithResponsesInterface
// Page is the initial page (0-based index)
Page int
// PerPage is the number of items requested for each page
PerPage int
// Filters is a list of search filters to apply
Filters map[string]*qsparser.SearchField
// ClusterName is the name of the cluster
ClusterName string
}
ListClusterNodesInput is the input given to ListClusterNodes()
type ListClusterNodesResults ¶ added in v0.6.0
type ListClusterNodesResults struct {
ClusterNodeListResponse *clusterNodesListResponse
JSONResponse []byte
Problem *apiclient.Problem
}
ListClusterNodesResults is the result of ListClusterNodes()
func ListClusterNodes ¶ added in v0.6.0
func ListClusterNodes(ctx context.Context, in ListClusterNodesInput) (*ListClusterNodesResults, error)
ListClusterNodes returns a non-paginated list of cluster nodes
type ListClusterResults ¶
type ListClusterResults struct {
ClusterListResponse *clusterListResponse
JSONResponse []byte
Problem *apiclient.Problem
}
ListClusterResults is the result of ListClusters
func ListClusters ¶
func ListClusters(ctx context.Context, in ListClustersInput) (*ListClusterResults, error)
ListClusters returns a non-paginated list of clusters
type ListClustersInput ¶
type ListClustersInput struct {
// Logger is a logger
Logger *slog.Logger
// APIClient is the inventory server API client used to make requests
APIClient apiclient.ClientWithResponsesInterface
// Page is the initial page (0-based index)
Page int
// PerPage is the number of items requested for each page
PerPage int
// Filters is a list of search filters to apply
Filters map[string]*qsparser.SearchField
}
ListClustersInput is the input given to ListClusters()
type UpdateClusterInput ¶ added in v0.5.0
type UpdateClusterInput struct {
Logger *slog.Logger
APIClient apiclient.ClientWithResponsesInterface
Description *string
EnvironmentName *string
ResilienceZone *string
SubscriptionID *string
InfrastructureProvider *string
HasTechnicalOperations *bool
HasTechnicalManagement *bool
HasApplicationOperations *bool
HasApplicationManagement *bool
HasCustomOperations *bool
CustomOperationsURL *string
}
UpdateClusterInput is the input used by UpdateCluster()
type UpdateClusterResult ¶ added in v0.5.0
type UpdateClusterResult struct {
ClusterResponse *clusterResponse
JSONResponse []byte
Problem *apiclient.Problem
}
UpdateClusterResult is the result of UpdateCluster
func UpdateCluster ¶ added in v0.5.0
func UpdateCluster(ctx context.Context, clusterID string, in UpdateClusterInput) (*UpdateClusterResult, error)
UpdateCluster creates a cluster