utils

Documentation

Overview

Copyright 2024 Flant JSC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. nolint:revive

Index

• Variables
• func EnableModule(downloadedModulesDir, oldSymlinkPath, newSymlinkPath, modulePath string) error
• func EnsureModuleDocumentation(ctx context.Context, cli client.Client, ...) error
• func GenerateRegistryOptions(ri *RegistryConfig, logger *log.Logger) []cr.Option
• func GenerateRegistryOptionsFromModuleSource(ms *v1alpha1.ModuleSource, clusterUUID string, logger *log.Logger) []cr.Option
• func GetClusterUUID(ctx context.Context, cli client.Client) string
• func GetModuleSymlink(rootPath, moduleName string) (string, error)
• func GetModuleVersion(moduleSymlink string) (string, error)
• func GetNotificationConfig(ctx context.Context, cli client.Client) (releaseUpdater.NotificationConfig, error)
• func ModulePullOverrideExists(ctx context.Context, cli client.Client, moduleName string) (bool, error)
• func SyncModuleRegistrySpec(downloadedModulesDir, moduleName, moduleVersion string, ...) error
• func Update[Object client.Object](ctx context.Context, cli client.Client, object Object, ...) error
• func UpdatePolicy(ctx context.Context, cli client.Client, ...) (*v1alpha2.ModuleUpdatePolicy, error)
• func UpdateStatus[Object client.Object](ctx context.Context, cli client.Client, object Object, ...) error
• type DeckhouseRegistrySecret
  • func ParseDeckhouseRegistrySecret(data map[string][]byte) (*DeckhouseRegistrySecret, error)
• type FakeLayer
  • func (fl FakeLayer) Size() (int64, error)
  • func (fl FakeLayer) Uncompressed() (io.ReadCloser, error)
• type RegistryConfig

Variables

var ErrAddressFieldIsNotFound = errors.New("secret has no address field")

var ErrCAFieldIsNotFound = errors.New("secret has no ca field")

var ErrClusterIsBootstrappedFieldIsNotFound = errors.New("secret has no clusterIsBootstrapped field")

var ErrDockerConfigFieldIsNotFound = errors.New("secret has no .dockerconfigjson field")

var ErrImageRegistryFieldIsNotFound = errors.New("secret has no imagesRegistry field")

var ErrPathFieldIsNotFound = errors.New("secret has no path field")

var ErrSchemeFieldIsNotFound = errors.New("secret has no scheme field")

Functions

func EnableModule

func EnableModule(downloadedModulesDir, oldSymlinkPath, newSymlinkPath, modulePath string) error

EnableModule deletes old symlinks and creates a new one

func EnsureModuleDocumentation

func EnsureModuleDocumentation(
	ctx context.Context,
	cli client.Client,
	moduleName, moduleSource, moduleChecksum, moduleVersion, modulePath string,
	ownerRef metav1.OwnerReference,
) error

EnsureModuleDocumentation creates or updates module documentation

func GenerateRegistryOptions

func GenerateRegistryOptions(ri *RegistryConfig, logger *log.Logger) []cr.Option

func GenerateRegistryOptionsFromModuleSource

func GenerateRegistryOptionsFromModuleSource(ms *v1alpha1.ModuleSource, clusterUUID string, logger *log.Logger) []cr.Option

GenerateRegistryOptionsFromModuleSource fetches settings from ModuleSource and generate registry options from them

func GetClusterUUID

func GetClusterUUID(ctx context.Context, cli client.Client) string

GetClusterUUID gets uuid from the secret or generate a new one

func GetModuleSymlink

func GetModuleSymlink(rootPath, moduleName string) (string, error)

GetModuleSymlink walks over the root dir to find a module symlink by regexp

func GetModuleVersion

func GetModuleVersion(moduleSymlink string) (string, error)

GetModuleVersion gets version of the module by symlink(/downloaded/modules/{moduleName})

func GetNotificationConfig

func GetNotificationConfig(ctx context.Context, cli client.Client) (releaseUpdater.NotificationConfig, error)

GetNotificationConfig gets config from discovery secret

func ModulePullOverrideExists

func ModulePullOverrideExists(ctx context.Context, cli client.Client, moduleName string) (bool, error)

ModulePullOverrideExists checks if module pull override for the module exists

func SyncModuleRegistrySpec

func SyncModuleRegistrySpec(downloadedModulesDir, moduleName, moduleVersion string, moduleSource *v1alpha1.ModuleSource) error

SyncModuleRegistrySpec compares and updates current registry settings of a deployed module (in the ./openapi/values.yaml file) and the registry settings set in the related module source

func Update

func Update[Object client.Object](ctx context.Context, cli client.Client, object Object, updater func(obj Object) bool) error

Update updates object with retryOnConflict to avoid conflict

func UpdatePolicy

func UpdatePolicy(ctx context.Context, cli client.Client, embeddedPolicy *helpers.ModuleUpdatePolicySpecContainer, moduleName string) (*v1alpha2.ModuleUpdatePolicy, error)

UpdatePolicy returns policy for the module, if no policy, embeddedPolicy is returned

func UpdateStatus

func UpdateStatus[Object client.Object](ctx context.Context, cli client.Client, object Object, updater func(obj Object) bool) error

UpdateStatus updates object status with retryOnConflict to avoid conflict

Types

type DeckhouseRegistrySecret

type DeckhouseRegistrySecret struct {
	DockerConfig          string
	Address               string
	ClusterIsBootstrapped bool
	ImageRegistry         string
	Path                  string
	Scheme                string
	CA                    string
}

func ParseDeckhouseRegistrySecret

func ParseDeckhouseRegistrySecret(data map[string][]byte) (*DeckhouseRegistrySecret, error)

type FakeLayer

type FakeLayer struct {
	v1.Layer

	FilesContent map[string]string // pair: filename - file content
}

func (FakeLayer) Size

func (fl FakeLayer) Size() (int64, error)

func (FakeLayer) Uncompressed

func (fl FakeLayer) Uncompressed() (io.ReadCloser, error)

type RegistryConfig

type RegistryConfig struct {
	DockerConfig string
	CA           string
	Scheme       string
	UserAgent    string
}