ibm

package

v1.121.3 Latest Latest Go to latest Published: Sep 16, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

View Source

const APIKeyAuthorizerType = "IBMAPIKey"

This section is empty.

This section is empty.

type APIKey struct {
	Key string `json:"apiKey"`
}

APIKey authenticates to IBM Cloud IAM with an API key. The key may belong to a user or service ID with billing.usage-report.read.

func (a *APIKey) CreateAuthenticator() (core.Authenticator, error)

func (a *APIKey) Equals(config cloud.Config) bool

func (a *APIKey) MarshalJSON() ([]byte, error)

func (a *APIKey) Sanitize() cloud.Config

func (a *APIKey) Validate() error

type Authorizer interface {
	cloud.Authorizer
	CreateAuthenticator() (core.Authenticator, error)
}

Authorizer creates IBM Cloud SDK authenticators for Usage Reports clients.

func SelectAuthorizerByType(typeStr string) (Authorizer, error)

SelectAuthorizerByType registers supported IBM authorizer types.

type UsageConfiguration struct {
	AccountID  string     `json:"accountID"`
	Authorizer Authorizer `json:"authorizer"`
}

UsageConfiguration connects OpenCost to the IBM Cloud Usage Reports API (account cost and usage / CUR-style billing data).

func (c *UsageConfiguration) Equals(config cloud.Config) bool

func (c *UsageConfiguration) GetUsageReportsClient() (*usagereportsv4.UsageReportsV4, error)

func (c *UsageConfiguration) Key() string

Key identifies the integration for storage paths. Account IDs are normalized to bare hex so "a/<hex>" cannot create an extra path segment.

func (c *UsageConfiguration) Provider() string

func (c *UsageConfiguration) Sanitize() cloud.Config

func (c *UsageConfiguration) UnmarshalJSON(b []byte) error

func (c *UsageConfiguration) Validate() error

type UsageIntegration struct {
	UsageConfiguration
	ConnectionStatus cloud.ConnectionStatus
	// contains filtered or unexported fields
}

UsageIntegration ingests IBM Cloud Usage Reports into CloudCost.

func (ui *UsageIntegration) GetCloudCost(start, end time.Time) (*opencost.CloudCostSetRange, error)

func (ui *UsageIntegration) GetStatus() cloud.ConnectionStatus

func (ui *UsageIntegration) RefreshStatus() cloud.ConnectionStatus