ocm

Documentation

Index

• type AddOnStatusGetRequest
• type AddOnStatusPatchRequest
• type AddOnStatusPostRequest
• type AddOnStatusResponse
• type Client
  • func NewClient(ctx context.Context, opts ...Option) (*Client, error)
  • func (c *Client) GetAddOnStatus(ctx context.Context, addonID string) (AddOnStatusResponse, error)
  • func (c *Client) GetCluster(ctx context.Context, req ClusterGetRequest) (res ClusterGetResponse, err error)
  • func (c *Client) GetClusterIDAndName() (string, string)
  • func (c *Client) GetUpgradePolicy(ctx context.Context, req UpgradePolicyGetRequest) (res UpgradePolicyGetResponse, err error)
  • func (c *Client) PatchAddOnStatus(ctx context.Context, addonID string, payload AddOnStatusPatchRequest) (AddOnStatusResponse, error)
  • func (c *Client) PatchUpgradePolicy(ctx context.Context, req UpgradePolicyPatchRequest) (res UpgradePolicyPatchResponse, err error)
  • func (c *Client) PostAddOnStatus(ctx context.Context, payload AddOnStatusPostRequest) (AddOnStatusResponse, error)
• type ClientOptions
• type Cluster
• type ClusterGetRequest
• type ClusterGetResponse
• type OCMError
  • func (e OCMError) Error() string
• type Option
  • func WithAccessToken(accessToken string) Option
  • func WithClusterExternalID(clusterExternalID string) Option
  • func WithEndpoint(endpoint string) Option
• type UpgradePolicyGetRequest
• type UpgradePolicyGetResponse
• type UpgradePolicyPatchRequest
• type UpgradePolicyPatchResponse
• type UpgradePolicyValue

Types

type AddOnStatusGetRequest

type AddOnStatusGetRequest struct{}

type AddOnStatusPatchRequest

type AddOnStatusPatchRequest struct {
	// Correlation ID for co-relating current AddonCR revision and reported status.
	CorrelationID string `json:"correlation_id"`
	// Reported addon status conditions
	StatusConditions []addonsv1alpha1.AddOnStatusCondition `json:"status_conditions"`
}

type AddOnStatusPostRequest

type AddOnStatusPostRequest struct {
	AddonID string `json:"addon_id"`
	// Correlation ID for co-relating current AddonCR revision and reported status.
	CorrelationID string `json:"correlation_id"`
	// Reported addon status conditions
	StatusConditions []addonsv1alpha1.AddOnStatusCondition `json:"status_conditions"`
}

type AddOnStatusResponse

type AddOnStatusResponse struct {
	Kind    string `json:"kind"`
	AddonID string `json:"addon_id"`
	// Correlation ID for co-relating current AddonCR revision and reported status.
	CorrelationID string `json:"correlation_id"`
	// Reported addon status conditions
	StatusConditions []addonsv1alpha1.AddOnStatusCondition `json:"status_conditions"`
}

type Client

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

func NewClient

func NewClient(ctx context.Context, opts ...Option) (*Client, error)

Creates a new OCM client with the given options.

func (*Client) GetAddOnStatus

func (c *Client) GetAddOnStatus(ctx context.Context, addonID string) (AddOnStatusResponse, error)

func (*Client) GetCluster

func (c *Client) GetCluster(
	ctx context.Context,
	req ClusterGetRequest,
) (res ClusterGetResponse, err error)

func (*Client) GetClusterIDAndName

func (c *Client) GetClusterIDAndName() (string, string)

func (*Client) GetUpgradePolicy

func (c *Client) GetUpgradePolicy(
	ctx context.Context,
	req UpgradePolicyGetRequest,
) (res UpgradePolicyGetResponse, err error)

func (*Client) PatchAddOnStatus

func (c *Client) PatchAddOnStatus(ctx context.Context, addonID string, payload AddOnStatusPatchRequest) (AddOnStatusResponse, error)

func (*Client) PatchUpgradePolicy

func (c *Client) PatchUpgradePolicy(
	ctx context.Context,
	req UpgradePolicyPatchRequest,
) (res UpgradePolicyPatchResponse, err error)

func (*Client) PostAddOnStatus

func (c *Client) PostAddOnStatus(ctx context.Context, payload AddOnStatusPostRequest) (AddOnStatusResponse, error)

type ClientOptions

type ClientOptions struct {
	Endpoint          string
	ClusterExternalID string
	ClusterID         string
	ClusterName       string
	AccessToken       string
}

type Cluster

type Cluster struct {
	Id         string `json:"id"`
	Name       string `json:"name"`
	ExternalId string `json:"external_id"`
}

type ClusterGetRequest

type ClusterGetRequest struct{}

type ClusterGetResponse

type ClusterGetResponse struct {
	Items []Cluster `json:"items"`
}

type OCMError

type OCMError struct {
	StatusCode int    `json:"-"`
	Code       string `json:"code"`
	Reason     string `json:"reason"`
}

func (OCMError) Error

func (e OCMError) Error() string

type Option

type Option func(o *ClientOptions)

func WithAccessToken

func WithAccessToken(accessToken string) Option

func WithClusterExternalID

func WithClusterExternalID(clusterExternalID string) Option

func WithEndpoint

func WithEndpoint(endpoint string) Option

type UpgradePolicyGetRequest

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

type UpgradePolicyGetResponse

type UpgradePolicyGetResponse struct {
	Value       UpgradePolicyValue `json:"value"`
	Description string             `json:"description"`
}

type UpgradePolicyPatchRequest

type UpgradePolicyPatchRequest struct {
	ID          string             `json:"id"`
	Value       UpgradePolicyValue `json:"value"`
	Description string             `json:"description"`
}

type UpgradePolicyPatchResponse

type UpgradePolicyPatchResponse struct{}

type UpgradePolicyValue

type UpgradePolicyValue string

const (
	UpgradePolicyValueNone      UpgradePolicyValue = ""
	UpgradePolicyValuePending   UpgradePolicyValue = "pending"
	UpgradePolicyValueScheduled UpgradePolicyValue = "scheduled"
	UpgradePolicyValueStarted   UpgradePolicyValue = "started"
	UpgradePolicyValueCompleted UpgradePolicyValue = "completed"
)