v1alpha1

package
v0.0.1-rc.2 Latest Latest
Warning

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

Go to latest
Published: Feb 3, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Merge

func Merge(base, overrides any) error

func MergeCastingSpecAndStatus

func MergeCastingSpecAndStatus(base *Casting) error

Types

type Casting

type Casting struct {
	TypeVersion `json:",inline" yaml:",inline"`

	// Metadata of the casting configuration.
	Metadata TypeMetadata `json:"metadata" yaml:"metadata" description:"Metadata of the casting configuration"`

	// Specification for the casting.
	Spec CastingSpec `json:"spec" yaml:"spec" description:"Specification for the casting"`

	// Status of the casting.
	Status CastingStatus `json:"status,omitzero" yaml:"status,omitempty" description:"Status of the casting"`
}

func DefaultCasting

func DefaultCasting() Casting

func ExampleCasting

func ExampleCasting() Casting

type CastingSpec

type CastingSpec struct {
	// Mode platform in which the platform will run.
	Deployment TypeDeployment `json:"deployment" yaml:"deployment" description:"Deployment configuration for the platform"`

	// The configuration for the signoz molding.
	Signoz SigNoz `json:"signoz,omitzero" yaml:"signoz,omitempty" description:"The configuration for the SigNoz molding"`

	// The configuration for the telemetry store molding.
	TelemetryStore TelemetryStore `` /* 126-byte string literal not displayed */

	// The configuration for the telemetry keeper molding.
	TelemetryKeeper TelemetryKeeper `` /* 129-byte string literal not displayed */

	// The configuration for the meta store molding.
	MetaStore MetaStore `json:"metastore,omitzero" yaml:"metastore,omitempty" description:"The configuration for the meta store molding"`

	// The configuration for the ingester molding.
	Ingester Ingester `json:"ingester,omitzero" yaml:"ingester,omitempty" description:"The configuration for the ingester molding"`
}

type CastingStatus

type CastingStatus struct {
	// Checksum of the casting file.
	Checksum string `json:"checksum" yaml:"checksum" description:"Checksum of the casting file"`
}

type Ingester

type Ingester struct {
	// Specification for the ingester.
	Spec MoldingSpec `json:"spec" yaml:"spec" jsonschema:"description=Specification for the ingester"`

	// Status of the ingester.
	Status IngesterStatus `json:"status" yaml:"status,omitempty" jsonschema:"description=Status of the ingester"`
}

func DefaultIngester

func DefaultIngester() Ingester

type IngesterStatus

type IngesterStatus struct {
	MoldingStatus `json:",inline" yaml:",inline"`

	Addresses IngesterStatusAddresses `json:"addresses" yaml:"addresses,omitempty" jsonschema:"description=Addresses of the ingester"`
}

type IngesterStatusAddresses

type IngesterStatusAddresses struct {
	OTLP []string `json:"otlp" yaml:"otlp" jsonschema:"description=OTLP addresses"`
}

type MetaStore

type MetaStore struct {
	// Kind of the meta store to use.
	Kind MetaStoreKind `json:"kind,omitzero" yaml:"kind,omitempty" description:"Kind of the meta store to use" examples:"[\"postgres\",\"sqlite\"]"`

	// Specification for the meta store.
	Spec MoldingSpec `json:"spec" yaml:"spec" description:"Specification for the meta store"`

	// Status of the meta store.
	Status MetaStoreStatus `json:"status" yaml:"status,omitempty" description:"Status of the meta store"`
}

func DefaultMetaStore

func DefaultMetaStore() MetaStore

type MetaStoreKind

type MetaStoreKind struct {
	// contains filtered or unexported fields
}
var (
	MetaStoreKindPostgres MetaStoreKind = MetaStoreKind{/* contains filtered or unexported fields */}
	MetaStoreKindSQLite   MetaStoreKind = MetaStoreKind{/* contains filtered or unexported fields */}
)

func MetaStoreKinds

func MetaStoreKinds() []MetaStoreKind

func (MetaStoreKind) MarshalJSON

func (kind MetaStoreKind) MarshalJSON() ([]byte, error)

func (MetaStoreKind) MarshalText

func (kind MetaStoreKind) MarshalText() ([]byte, error)

func (MetaStoreKind) MarshalYAML

func (kind MetaStoreKind) MarshalYAML() (any, error)

func (MetaStoreKind) String

func (kind MetaStoreKind) String() string

func (*MetaStoreKind) UnmarshalJSON

func (kind *MetaStoreKind) UnmarshalJSON(text []byte) error

func (*MetaStoreKind) UnmarshalText

func (kind *MetaStoreKind) UnmarshalText(text []byte) error

func (*MetaStoreKind) UnmarshalYAML

func (kind *MetaStoreKind) UnmarshalYAML(node *yaml.Node) error

type MetaStoreStatus

type MetaStoreStatus struct {
	MoldingStatus `json:",inline" yaml:",inline"`

	Addresses MetaStoreStatusAddresses `json:"addresses" yaml:"addresses,omitempty" description:"Addresses of the meta store"`
}

type MetaStoreStatusAddresses

type MetaStoreStatusAddresses struct {
	// DSN addresses.
	DSN []string `json:"dsn" yaml:"dsn" description:"DSN addresses"`
}

type MoldingKind

type MoldingKind struct {
	// contains filtered or unexported fields
}
var (
	MoldingKindIngester        MoldingKind = MoldingKind{/* contains filtered or unexported fields */}
	MoldingKindTelemetryStore  MoldingKind = MoldingKind{/* contains filtered or unexported fields */}
	MoldingKindTelemetryKeeper MoldingKind = MoldingKind{/* contains filtered or unexported fields */}
	MoldingKindMetaStore       MoldingKind = MoldingKind{/* contains filtered or unexported fields */}
	MoldingKindSignoz          MoldingKind = MoldingKind{/* contains filtered or unexported fields */}
)

func MoldingKinds

func MoldingKinds() []MoldingKind

func (MoldingKind) MarshalText

func (kind MoldingKind) MarshalText() ([]byte, error)

func (MoldingKind) MarshalYAML

func (kind MoldingKind) MarshalYAML() (any, error)

func (MoldingKind) String

func (kind MoldingKind) String() string

func (*MoldingKind) UnmarshalText

func (kind *MoldingKind) UnmarshalText(text []byte) error

func (*MoldingKind) UnmarshalYAML

func (kind *MoldingKind) UnmarshalYAML(node *yaml.Node) error

type MoldingSpec

type MoldingSpec struct {
	// Whether the molding is enabled
	Enabled bool `json:"enabled,omitempty" yaml:"enabled,omitempty" description:"Whether the molding is enabled" default:"true"`

	// Cluster configuration for the molding
	Cluster TypeCluster `json:"cluster" yaml:"cluster,omitempty" description:"Cluster configuration for the molding"`

	// The version of the molding to use
	Version string `json:"version,omitempty" yaml:"version,omitempty" description:"The version of the molding to use" example:"latest"`

	// Image of the molding
	Image string `json:"image,omitempty" yaml:"image,omitempty" description:"Container image of the molding" example:"signoz/signoz:latest"`

	// Environment variables for the molding
	Env map[string]string `json:"env,omitempty" yaml:"env,omitempty" description:"Environment variables for the molding"`

	// Configuration for the molding
	Config TypeConfig `json:"config" yaml:"config,omitempty" description:"Configuration for the molding"`
}

func (*MoldingSpec) MergeStatus

func (spec *MoldingSpec) MergeStatus(status MoldingStatus) error

type MoldingStatus

type MoldingStatus struct {
	// Extra information about the molding
	Extras map[string]string `json:"extras,omitempty" yaml:"extras,omitempty" description:"Extra information about the molding"`

	// Environment variables for the molding
	Env map[string]string `json:"env,omitempty" yaml:"env,omitempty" description:"Environment variables for the molding"`

	// Configuration for the molding
	Config TypeConfig `json:"config" yaml:"config,omitempty" description:"Configuration for the molding"`
}

type SigNoz

type SigNoz struct {
	// Specification for signoz.
	Spec MoldingSpec `json:"spec" yaml:"spec" jsonschema:"description=Specification for SigNoz"`

	// Status of signoz.
	Status SigNozStatus `json:"status" yaml:"status,omitempty" jsonschema:"description=Status of SigNoz"`
}

func DefaultSigNoz

func DefaultSigNoz() SigNoz

type SigNozStatus

type SigNozStatus struct {
	MoldingStatus `json:",inline" yaml:",inline"`

	Addresses SigNozStatusAddresses `json:"addresses" yaml:"addresses,omitempty" jsonschema:"description=Addresses of SigNoz"`
}

type SigNozStatusAddresses

type SigNozStatusAddresses struct {
	// API server addresses.
	APIServer []string `json:"apiserver" yaml:"apiserver" jsonschema:"description=API server addresses"`

	// Opamp server addresses.
	Opamp []string `json:"opamp" yaml:"opamp" jsonschema:"description=Opamp server addresses"`
}

type TelemetryKeeper

type TelemetryKeeper struct {
	// Kind of the telemetry keeper to use.
	Kind TelemetryKeeperKind `` /* 126-byte string literal not displayed */

	// Specification for the telemetry keeper.
	Spec MoldingSpec `json:"spec" yaml:"spec" description:"Specification for the telemetry keeper"`

	// Status of the telemetry keeper.
	Status TelemetryKeeperStatus `json:"status" yaml:"status,omitempty" description:"Status of the telemetry keeper"`
}

func DefaultTelemetryKeeper

func DefaultTelemetryKeeper() TelemetryKeeper

type TelemetryKeeperKind

type TelemetryKeeperKind struct {
	// contains filtered or unexported fields
}
var (
	TelemetryKeeperKindClickhouseKeeper TelemetryKeeperKind = TelemetryKeeperKind{/* contains filtered or unexported fields */}
)

func TelemetryKeeperKinds

func TelemetryKeeperKinds() []TelemetryKeeperKind

func (TelemetryKeeperKind) MarshalJSON

func (kind TelemetryKeeperKind) MarshalJSON() ([]byte, error)

func (TelemetryKeeperKind) MarshalText

func (kind TelemetryKeeperKind) MarshalText() ([]byte, error)

func (TelemetryKeeperKind) MarshalYAML

func (kind TelemetryKeeperKind) MarshalYAML() (any, error)

func (TelemetryKeeperKind) String

func (kind TelemetryKeeperKind) String() string

func (*TelemetryKeeperKind) UnmarshalJSON

func (kind *TelemetryKeeperKind) UnmarshalJSON(text []byte) error

func (*TelemetryKeeperKind) UnmarshalText

func (kind *TelemetryKeeperKind) UnmarshalText(text []byte) error

func (*TelemetryKeeperKind) UnmarshalYAML

func (kind *TelemetryKeeperKind) UnmarshalYAML(node *yaml.Node) error

type TelemetryKeeperStatus

type TelemetryKeeperStatus struct {
	MoldingStatus `json:",inline" yaml:",inline"`

	// Addresses of the telemetry keeper.
	Addresses TelemetryKeeperStatusAddresses `json:"addresses" yaml:"addresses,omitempty" description:"Addresses of the telemetry keeper"`
}

type TelemetryKeeperStatusAddresses

type TelemetryKeeperStatusAddresses struct {
	// Raft addresses.
	Raft []string `json:"raft" yaml:"raft,omitempty" description:"Raft addresses"`

	// Client addresses.
	Client []string `json:"client" yaml:"client,omitempty" description:"Client addresses"`
}

type TelemetryStore

type TelemetryStore struct {
	// Kind of the telemetry store to use.
	Kind TelemetryStoreKind `json:"kind,omitzero" yaml:"kind,omitempty" description:"Kind of the telemetry store to use" examples:"[\"clickhouse\"]"`

	// Specification for the telemetry store.
	Spec MoldingSpec `json:"spec" yaml:"spec" description:"Specification for the telemetry store"`

	// Status of the telemetry store.
	Status TelemetryStoreStatus `json:"status" yaml:"status,omitempty" description:"Status of the telemetry store"`
}

func DefaultTelemetryStore

func DefaultTelemetryStore() TelemetryStore

type TelemetryStoreKind

type TelemetryStoreKind struct {
	// contains filtered or unexported fields
}
var (
	TelemetryStoreKindClickhouse TelemetryStoreKind = TelemetryStoreKind{/* contains filtered or unexported fields */}
)

func TelemetryStoreKinds

func TelemetryStoreKinds() []TelemetryStoreKind

func (TelemetryStoreKind) MarshalJSON

func (kind TelemetryStoreKind) MarshalJSON() ([]byte, error)

func (TelemetryStoreKind) MarshalText

func (kind TelemetryStoreKind) MarshalText() ([]byte, error)

func (TelemetryStoreKind) MarshalYAML

func (kind TelemetryStoreKind) MarshalYAML() (any, error)

func (TelemetryStoreKind) String

func (kind TelemetryStoreKind) String() string

func (*TelemetryStoreKind) UnmarshalJSON

func (kind *TelemetryStoreKind) UnmarshalJSON(text []byte) error

func (*TelemetryStoreKind) UnmarshalText

func (kind *TelemetryStoreKind) UnmarshalText(text []byte) error

func (*TelemetryStoreKind) UnmarshalYAML

func (kind *TelemetryStoreKind) UnmarshalYAML(node *yaml.Node) error

type TelemetryStoreStatus

type TelemetryStoreStatus struct {
	MoldingStatus `json:",inline" yaml:",inline"`

	Addresses TelemetryStoreStatusAddresses `json:"addresses" yaml:"addresses,omitempty" description:"Addresses of the telemetry store"`
}

type TelemetryStoreStatusAddresses

type TelemetryStoreStatusAddresses struct {
	// TCP addresses.
	TCP []string `json:"tcp" yaml:"tcp" description:"TCP addresses"`
}

type TypeCluster

type TypeCluster struct {
	// Number of replicas for the component
	Replicas *int `json:"replicas,omitempty" yaml:"replicas,omitempty" description:"Number of replicas for the component" example:"1"`

	// Number of shards for the component
	Shards *int `json:"shards,omitempty" yaml:"shards,omitempty" description:"Number of shards for the component" example:"1"`
}

type TypeConfig

type TypeConfig struct {
	// Data contains the configuration data.
	Data map[string]string `json:"data,omitempty" yaml:"data,omitempty" description:"Configuration data as key-value pairs"`
}

type TypeDeployment

type TypeDeployment struct {
	// Platform: Provider where an installation runs on using various cloud vendors
	// Example values: aws|gcp|azure|digitalocean|railway
	Platform string `` /* 193-byte string literal not displayed */

	// Mode: Type of installation method that we support, currently identifies the engine or technology behind a deployment
	Mode string `` /* 180-byte string literal not displayed */

	// Flavor: Defines the flavor of mode for the deployment, allows the user the pattern to deploy on
	Flavor string `` /* 208-byte string literal not displayed */
}

type TypeMetadata

type TypeMetadata struct {
	// The name of this installation. This name can be used to identify the installation.
	Name string `json:"name,omitempty" yaml:"name,omitempty" description:"The name of this installation" example:"signoz-dev"`

	// Annotations is an unstructured key-value map for arbitrary metadata.
	// Can be used to specify deployment-specific settings.
	Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty" description:"Unstructured key-value map for arbitrary metadata"`
}

type TypeVersion

type TypeVersion struct {
	// API Version of the casting configuration schema.
	APIVersion string `` /* 136-byte string literal not displayed */
}

Jump to

Keyboard shortcuts

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