backplane

package
v0.0.0-...-c83e5b9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 10, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package backplane provides helper functions for interacting with the backplane-api SDK

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cleaner

type Cleaner interface {
	Clean() error
}

type CleanerFunc

type CleanerFunc func() error

func (CleanerFunc) Clean

func (f CleanerFunc) Clean() error

type Client

type Client interface {
	// CreateReport creates a new cluster report
	CreateReport(ctx context.Context, clusterId string, summary string, reportData string) (*bpapi.Report, error)
	// GetRestConfig creates a remediation and returns a rest.Config for connecting to the cluster's API server through the backplane proxy
	GetRestConfig(ctx context.Context, clusterId string, remediationName string, isManagementCluster bool) (*RestConfig, error)
}

Client provides methods for interacting with the backplane API

func NewClient

func NewClient(config Config) (Client, error)

NewClient creates a new backplane client

type ClientImpl

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

ClientImpl implements the Client interface

func (*ClientImpl) CreateReport

func (c *ClientImpl) CreateReport(ctx context.Context, clusterId string, summary string, reportData string) (*bpapi.Report, error)

CreateReport creates a new investigation report for a cluster using the backplane API

func (*ClientImpl) GetRestConfig

func (c *ClientImpl) GetRestConfig(ctx context.Context, clusterId string, remediationName string, isManagementCluster bool) (*RestConfig, error)

type Config

type Config struct {
	BaseURL   string
	OcmClient ocm.Client
	ProxyURL  string
}

type RestConfig

type RestConfig struct {
	rest.Config
	Cleaner
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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