synth

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Jul 31, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConvertWorkloadCRToYAML

func ConvertWorkloadCRToYAML(workload *openchoreov1alpha1.Workload) ([]byte, error)

ConvertWorkloadCRToYAML converts a Workload CR to clean YAML bytes with proper field ordering

func ConvertWorkloadDescriptorToWorkloadCR

func ConvertWorkloadDescriptorToWorkloadCR(descriptorPath string, params api.CreateWorkloadParams) (*openchoreov1alpha1.Workload, error)

ConvertWorkloadDescriptorToWorkloadCR converts a workload.yaml descriptor to a Workload CR

func CreateBasicWorkload

func CreateBasicWorkload(params api.CreateWorkloadParams) (*openchoreov1alpha1.Workload, error)

CreateBasicWorkload creates a basic Workload CR without reading from a descriptor file

Types

type ConversionParams

type ConversionParams struct {
	OrganizationName string
	ProjectName      string
	ComponentName    string
	ImageURL         string
}

ConversionParams holds the parameters needed for workload conversion

type WorkloadDescriptor

type WorkloadDescriptor struct {
	APIVersion  string                         `yaml:"apiVersion"`
	Metadata    WorkloadDescriptorMetadata     `yaml:"metadata"`
	Endpoints   []WorkloadDescriptorEndpoint   `yaml:"endpoints,omitempty"`
	Connections []WorkloadDescriptorConnection `yaml:"connections,omitempty"`
}

WorkloadDescriptor represents the structure of a workload.yaml file This is the developer-maintained descriptor alongside source code

type WorkloadDescriptorConnection

type WorkloadDescriptorConnection struct {
	Name   string                             `yaml:"name"`
	Type   string                             `yaml:"type"`
	Params map[string]string                  `yaml:"params,omitempty"`
	Inject WorkloadDescriptorConnectionInject `yaml:"inject"`
}

type WorkloadDescriptorConnectionEnvVar

type WorkloadDescriptorConnectionEnvVar struct {
	Name  string `yaml:"name"`
	Value string `yaml:"value"`
}

type WorkloadDescriptorConnectionInject

type WorkloadDescriptorConnectionInject struct {
	Env []WorkloadDescriptorConnectionEnvVar `yaml:"env"`
}

type WorkloadDescriptorEndpoint

type WorkloadDescriptorEndpoint struct {
	Name       string `yaml:"name"`
	Port       int32  `yaml:"port"`
	Type       string `yaml:"type"`
	SchemaFile string `yaml:"schemaFile,omitempty"`
	Context    string `yaml:"context,omitempty"`
}

type WorkloadDescriptorMetadata

type WorkloadDescriptorMetadata struct {
	Name string `yaml:"name"`
}

Jump to

Keyboard shortcuts

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