api

Documentation

Overview

Package api provides types for Preflight reports and some common helpers.

Index

• Constants
• type AgentMetadata
• type DataReading
• type DataReadingsPost
• type GatheredResource
  • func (v GatheredResource) MarshalJSON() ([]byte, error)
• type Time
  • func (t Time) MarshalJSON() ([]byte, error)
  • func (t Time) String() string

Constants

const TimeFormat = time.RFC3339

TimeFormat defines the format used for timestamps across all this API.

Types

type AgentMetadata

type AgentMetadata struct {
	Version string `json:"version"`
	// ClusterID is the name of the cluster or host where the agent is running.
	// It may send data for other clusters in its datareadings.
	ClusterID string `json:"cluster_id"`
}

AgentMetadata is metadata about the agent.

type DataReading

type DataReading struct {
	// ClusterID is optional as it can be inferred from the agent
	// token when using basic authentication.
	ClusterID     string      `json:"cluster_id,omitempty"`
	DataGatherer  string      `json:"data-gatherer"`
	Timestamp     Time        `json:"timestamp"`
	Data          interface{} `json:"data"`
	SchemaVersion string      `json:"schema_version"`
}

DataReading is the output of a DataGatherer.

type DataReadingsPost

type DataReadingsPost struct {
	AgentMetadata *AgentMetadata `json:"agent_metadata"`
	// DataGatherTime represents the time that the data readings were gathered
	DataGatherTime time.Time      `json:"data_gather_time"`
	DataReadings   []*DataReading `json:"data_readings"`
}

DataReadingsPost is the payload in the upload request.

type GatheredResource

type GatheredResource struct {
	// Resource is a reference to a k8s object that was found by the informer
	// should be of type unstructured.Unstructured, raw Object
	Resource  interface{}
	DeletedAt Time
}

GatheredResource wraps the raw k8s resource that is sent to the jetstack secure backend

func (GatheredResource) MarshalJSON

func (v GatheredResource) MarshalJSON() ([]byte, error)

type Time

type Time struct {
	time.Time
}

Time is a wrapper around time.Time that overrides how it is marshaled into JSON

func (Time) MarshalJSON

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON marshals the timestamp with RFC3339 format

func (Time) String

func (t Time) String() string

String returns a string representation of the timestamp