diff --git a/doc/docs/packages/generator/labels/labelStructs.md b/doc/docs/packages/generator/labels/labelStructs.md deleted file mode 100644 index 3ac1643..0000000 --- a/doc/docs/packages/generator/labels/labelStructs.md +++ /dev/null @@ -1,246 +0,0 @@ - - -# labelStructs - -```go -import "katenary/generator/labels/labelStructs" -``` - -labelStructs is a package that contains the structs used to represent the labels in the yaml files. - -## type [ConfigMapFile]() - - - -```go -type ConfigMapFile []string -``` - - -### func [ConfigMapFileFrom]() - -```go -func ConfigMapFileFrom(data string) (ConfigMapFile, error) -``` - - - - -## type [CronJob]() - - - -```go -type CronJob struct { - Image string `yaml:"image,omitempty" json:"image,omitempty"` - Command string `yaml:"command" json:"command,omitempty"` - Schedule string `yaml:"schedule" json:"schedule,omitempty"` - Rbac bool `yaml:"rbac" json:"rbac,omitempty"` -} -``` - - -### func [CronJobFrom]() - -```go -func CronJobFrom(data string) (*CronJob, error) -``` - - - - -## type [Dependency]() - -Dependency is a dependency of a chart to other charts. - -```go -type Dependency struct { - Values map[string]any `yaml:"-" json:"values,omitempty"` - Name string `yaml:"name" json:"name"` - Version string `yaml:"version" json:"version"` - Repository string `yaml:"repository" json:"repository"` - Alias string `yaml:"alias,omitempty" json:"alias,omitempty"` -} -``` - - -### func [DependenciesFrom]() - -```go -func DependenciesFrom(data string) ([]Dependency, error) -``` - -DependenciesFrom returns a slice of dependencies from the given string. - - -## type [EnvFrom]() - - - -```go -type EnvFrom []string -``` - - -### func [EnvFromFrom]() - -```go -func EnvFromFrom(data string) (EnvFrom, error) -``` - -EnvFromFrom returns a EnvFrom from the given string. - - -## type [ExchangeVolume]() - - - -```go -type ExchangeVolume struct { - Name string `yaml:"name" json:"name"` - MountPath string `yaml:"mountPath" json:"mountPath"` - Type string `yaml:"type,omitempty" json:"type,omitempty"` - Init string `yaml:"init,omitempty" json:"init,omitempty"` -} -``` - - -### func [NewExchangeVolumes]() - -```go -func NewExchangeVolumes(data string) ([]*ExchangeVolume, error) -``` - - - - -## type [HealthCheck]() - - - -```go -type HealthCheck struct { - LivenessProbe *corev1.Probe `yaml:"livenessProbe,omitempty" json:"livenessProbe,omitempty"` - ReadinessProbe *corev1.Probe `yaml:"readinessProbe,omitempty" json:"readinessProbe,omitempty"` -} -``` - - -### func [ProbeFrom]() - -```go -func ProbeFrom(data string) (*HealthCheck, error) -``` - - - - -## type [Ingress]() - - - -```go -type Ingress struct { - Port *int32 `yaml:"port,omitempty" json:"port,omitempty"` - Annotations map[string]string `yaml:"annotations,omitempty" jsonschema:"nullable" json:"annotations,omitempty"` - Hostname string `yaml:"hostname" json:"hostname,omitempty"` - Path *string `yaml:"path,omitempty" json:"path,omitempty"` - Class *string `yaml:"class,omitempty" json:"class,omitempty" jsonschema:"default:-"` - Enabled bool `yaml:"enabled" json:"enabled,omitempty"` - TLS *TLS `yaml:"tls,omitempty" json:"tls,omitempty"` -} -``` - - -### func [IngressFrom]() - -```go -func IngressFrom(data string) (*Ingress, error) -``` - -IngressFrom creates a new Ingress from a compose service. - - -## type [MapEnv]() - - - -```go -type MapEnv map[string]string -``` - - -### func [MapEnvFrom]() - -```go -func MapEnvFrom(data string) (MapEnv, error) -``` - -MapEnvFrom returns a MapEnv from the given string. - - -## type [Ports]() - - - -```go -type Ports []uint32 -``` - - -### func [PortsFrom]() - -```go -func PortsFrom(data string) (Ports, error) -``` - -PortsFrom returns a Ports from the given string. - - -## type [Secrets]() - - - -```go -type Secrets []string -``` - - -### func [SecretsFrom]() - -```go -func SecretsFrom(data string) (Secrets, error) -``` - - - - -## type [TLS]() - - - -```go -type TLS struct { - Enabled bool `yaml:"enabled" json:"enabled,omitempty"` -} -``` - - -## type [ValueFrom]() - - - -```go -type ValueFrom map[string]string -``` - - -### func [GetValueFrom]() - -```go -func GetValueFrom(data string) (*ValueFrom, error) -``` - - - -Generated by [gomarkdoc]() diff --git a/doc/mkdocs.yml b/doc/mkdocs.yml index cb24c58..80925d3 100644 --- a/doc/mkdocs.yml +++ b/doc/mkdocs.yml @@ -1,6 +1,6 @@ site_name: Katenary documentation docs_dir: ./docs -plugins: +plugins: - search - inline-svg theme: @@ -48,18 +48,17 @@ nav: - usage.md - labels.md - Behind the scene: - - coding.md - - dependencies.md + - coding.md + - dependencies.md - FAQ: faq.md - Go Packages: - - packages/cmd/katenary.md - - packages/parser.md - - packages/utils.md - - Generator: - - Index: packages/generator.md - - ExtraFiles: packages/generator/extrafiles.md - - labels: - - packages/generator/labels.md - - LabelStructs: packages/generator/labels/labelStructs.md - - KatenaryFile: packages/generator/katenaryfile.md - + - packages/cmd/katenary.md + - packages/parser.md + - packages/utils.md + - Generator: + - Index: packages/generator.md + - ExtraFiles: packages/generator/extrafiles.md + - labels: + - packages/generator/labels.md + - Labelstructs: packages/generator/labels/labelstructs.md + - KatenaryFile: packages/generator/katenaryfile.md