README
¶
The Utils Package
The Utils Package is the Central component of Meshkit. This package encompases different packages that offers a simplified and tailored experience for developers working with Kubernetes and Helm. Developers can easily interact with Kubernetes and Helm without relying on the command line versions by utilizing higher-level functions from the utils package. Here is a brief description of some of the packages embedded in Utils:
Broadcast
The BroadCast package provides a simple and concurrent way to implement a broadcast channel, where messages can be submitted and multiple subscribers can register to receive those messages. It allows for decoupling the provider and subscribers and facilitates pubsub communication between components in a system.
Component
The Component Package genarates a component definition struct which may contain various fields that provide information about the component, such as the component kind, API version, display name, schema, and metadata based on a custom CRD. The Component package also Extracts the JSON schema of the CRD using the provided CUE path configuration.
Kuberentes
The kubernetes package provides functionality for working with Kubernetes clusters .The package defines a Client that encapsulates the necessary components for interacting with the Kubernetes API server.
This package contains certain packages such as describe, expose, Kompose, manifests and walker for interacting with the kubernetes Api Server.
Below are descriptions of each package:
Describe Package is a comprehensive and user-friendly solution for describing Kubernetes objects through the Kubernetes API. With its rich set of functionalities, it contains components for creating and initiaizing a meshclient, allowing users to retrieve information about various Kubernetes resources such as pods, deployments, jobs, services, and more to interact with the kubernetes Api.
Overall, the describe package provides a convenient way to retrieve detailed information about Kubernetes resources in a standardized format.
The Expose Package provides functionality for exposing Kubernetes resources as services.
- The package imports various packages from the standard library and external dependencies.
- It contains fields for specifying the service type, load balancer IP, cluster IP, namespace, session affinity, name, annotations, and a logger.
- The
Expose()is the main function of the package this takes a Kubernetes clientset, REST config, Config object, and a list of resources to expose. - It uses a Traverser to iterate over the resources and generate the corresponding services. Overall, this package provides a way to expose Kubernetes resources as services with customizable configurations.
Kompose Package provides functionality for working with Docker Compose files and converting them to Kubernetes manifests. It provides the following features:
- Validation: The package can validate a Docker Compose file against a provided JSON schema. It ensures that the file adheres to the specified structure and format.
- Conversion: The package can convert a validated Docker Compose file into Kubernetes manifests. It transforms the services, volumes, and other components defined in the Compose file into their equivalent representations in the Kubernetes ecosystem.
- Compatibility Check: The package checks the compatibility of the Docker Compose file version with the "kompose" tool. It verifies if the version exceeds a certain limit and throws an error if it does.
- Formatting: The package performs formatting operations on the Docker Compose and converted Kubernetes manifest files to ensure compatibility and consistency. Overall, the kompose package aims to simplify the process of migrating from Docker Compose to Kubernetes by providing validation, conversion, and compatibility checking capabilities.
Documentation
¶
Index ¶
- Constants
- Variables
- func Cast[K any](val interface{}) (K, error)
- func CombineErrors(errs []error, sep string) error
- func Contains[G []K, K comparable](slice G, ele K) bool
- func CreateDirectory(path string) error
- func CreateFile(contents []byte, filename string, location string) error
- func DownloadFile(filepath string, url string) error
- func ErrCreateDir(err error, filepath string) error
- func ErrCreateFile(err error, filepath string) error
- func ErrCueLookup(err error) error
- func ErrDecodeYaml(err error) error
- func ErrExpectedTypeMismatch(err error, expectedType string) error
- func ErrExtractTarXZ(err error, path string) error
- func ErrExtractZip(err error, path string) error
- func ErrGetBool(key string, err error) error
- func ErrGettingLatestReleaseTag(err error) error
- func ErrJsonSchemaToCue(err error) error
- func ErrJsonToCue(err error) error
- func ErrMarshal(err error) error
- func ErrMissingField(err error, missingFieldName string) error
- func ErrReadDir(err error, dirPath string) error
- func ErrReadFile(err error, filepath string) error
- func ErrReadingLocalFile(err error) error
- func ErrReadingRemoteFile(err error) error
- func ErrRemoteFileNotFound(url string) error
- func ErrTypeCast(err error) error
- func ErrUnmarshal(err error) error
- func ErrUnmarshalInvalid(err error, typ reflect.Type) error
- func ErrUnmarshalSyntax(err error, offset int64) error
- func ErrUnmarshalType(err error, value string) error
- func ErrUnmarshalUnsupportedType(err error, typ reflect.Type) error
- func ErrUnmarshalUnsupportedValue(err error, value reflect.Value) error
- func ErrWriteFile(err error, filepath string) error
- func ErrYamlToCue(err error) error
- func ExtractDomainFromURL(location string) string
- func ExtractTarGz(path, downloadfilePath string) error
- func ExtractZip(path, artifactPath string) error
- func Filepath() string
- func FormatName(input string) string
- func GetBool(key string) (bool, error)
- func GetHome() string
- func GetLatestReleaseTagsSorted(org string, repo string) ([]string, error)
- func GetNonConcreteFields(val cue.Value) []string
- func GetRandomAlphabetsOfDigit(length int) (s string)
- func Git() (version, commitHead string)
- func IsClosed[K any](ch chan K) bool
- func IsInterfaceNil(val interface{}) bool
- func IsTarGz(name string) bool
- func IsYaml(name string) bool
- func IsZip(name string) bool
- func JsonSchemaToCue(value string) (cue.Value, error)
- func JsonToCue(value []byte) (cue.Value, error)
- func Lookup(rootVal cue.Value, path string) (cue.Value, error)
- func Marshal(obj interface{}) (string, error)
- func MarshalAndUnmarshal[fromType any, toType any](val fromType) (unmarshalledvalue toType, err error)
- func MergeMaps(mergeInto, toMerge map[string]interface{}) map[string]interface{}
- func MergeToTemplate(tpl []byte, data interface{}) ([]byte, error)
- func NewSheetSRV(cred string) (*sheets.Service, error)
- func NewUUID() (string, error)
- func ProcessContent(filePath string, f func(path string) error) error
- func ReadFileSource(uri string) (string, error)
- func ReadLocalFile(location string) (string, error)
- func ReadRemoteFile(url string) (string, error)
- func ReplaceSpacesAndConvertToLowercase(s string) string
- func SortDottedStringsByDigits(s []string) []string
- func StrConcat(s ...string) string
- func TcpCheck(hp *HostPort, mock *MockOptions) bool
- func TransformMapKeys(input map[string]interface{}, transformFunc func(string) string) map[string]interface{}
- func Unmarshal(obj string, result interface{}) error
- func UpdateSVGString(svgStr string, width, height int) (string, error)
- func Validate(schema cue.Value, value cue.Value) (bool, []errors.Error)
- func WriteJSONToFile[K any](outputPath string, data K) error
- func WriteToFile(path string, content string) error
- func YamlToCue(value string) (cue.Value, error)
- type Endpoint
- type HostPort
- type MockOptions
Constants ¶
const XMLTAG = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><!DOCTYPE svg>"
Variables ¶
var ( ErrUnmarshalCode = "meshkit-11159" ErrUnmarshalInvalidCode = "meshkit-11160" ErrUnmarshalSyntaxCode = "meshkit-11161" ErrUnmarshalTypeCode = "meshkit-11162" ErrUnmarshalUnsupportedTypeCode = "meshkit-11163" ErrUnmarshalUnsupportedValueCode = "meshkit-11164" ErrMarshalCode = "meshkit-11165" ErrGetBoolCode = "meshkit-11166" ErrInvalidProtocolCode = "meshkit-11167" ErrRemoteFileNotFoundCode = "meshkit-11168" ErrReadingRemoteFileCode = "meshkit-11169" ErrReadingLocalFileCode = "meshkit-11170" ErrReadFileCode = "meshkit-11171" ErrWriteFileCode = "meshkit-11172" ErrGettingLatestReleaseTagCode = "meshkit-11173" ErrInvalidProtocol = errors.New(ErrInvalidProtocolCode, errors.Alert, []string{"invalid protocol: only http, https and file are valid protocols"}, []string{}, []string{"Network protocol is incorrect"}, []string{"Make sure to specify the right network protocol"}) ErrMissingFieldCode = "meshkit-11174" ErrExpectedTypeMismatchCode = "meshkit-11175" ErrJsonToCueCode = "meshkit-11176" ErrYamlToCueCode = "meshkit-11177" ErrJsonSchemaToCueCode = "meshkit-11178" ErrCueLookupCode = "meshkit-11179" ErrTypeCastCode = "meshkit-11180" ErrCreateFileCode = "meshkit-11181" ErrCreateDirCode = "meshkit-11182" // ErrDecodeYamlCode represents the error which is generated when yaml // decode process fails ErrDecodeYamlCode = "meshkit-11183" ErrExtractTarXZCode = "meshkit-11184" ErrExtractZipCode = "meshkit-11185" ErrReadDirCode = "meshkit-11186" )
var (
GoogleSpreadSheetURL = "https://docs.google.com/spreadsheets/d/"
)
Functions ¶
func CombineErrors ¶
combineErrors merges a slice of error into one error separated by the given separator
func Contains ¶
func Contains[G []K, K comparable](slice G, ele K) bool
func CreateDirectory ¶
func CreateFile ¶
CreateFile creates a file with the given content on the given location with the given filename
func DownloadFile ¶
func ErrCreateDir ¶
func ErrCreateFile ¶
func ErrCueLookup ¶
func ErrDecodeYaml ¶
ErrDecodeYaml is the error when the yaml unmarshal fails
func ErrExpectedTypeMismatch ¶
func ErrExtractTarXZ ¶
ErrExtractTarXVZ is the error for unzipping the targz file
func ErrExtractZip ¶
ErrExtractZip is the error for unzipping the zip file
func ErrGetBool ¶
func ErrJsonSchemaToCue ¶
func ErrJsonToCue ¶
func ErrMarshal ¶
func ErrMissingField ¶
func ErrReadDir ¶
func ErrReadFile ¶
func ErrReadingLocalFile ¶
func ErrReadingRemoteFile ¶
func ErrRemoteFileNotFound ¶
func ErrTypeCast ¶
func ErrUnmarshal ¶
func ErrUnmarshalSyntax ¶
func ErrUnmarshalType ¶
func ErrWriteFile ¶
func ErrYamlToCue ¶
func ExtractDomainFromURL ¶
func ExtractTarGz ¶
func ExtractZip ¶
func FormatName ¶
FormatName formats the given string to by replacing " " with "-"
func GetLatestReleaseTagsSorted ¶
Gets the latest stable release tags from github for a given org name and repo name(in that org) in sorted order
func GetNonConcreteFields ¶
func Git ¶
func Git() (version, commitHead string)
git method which allows fetch the git HEAD tag version and commit number
func IsInterfaceNil ¶
func IsInterfaceNil(val interface{}) bool
func MarshalAndUnmarshal ¶
func MergeToTemplate ¶
MergeToTemplate merges data into the template tpl and returns the result.
func NewSheetSRV ¶
func ReadFileSource ¶
ReadFileSource supports "http", "https" and "file" protocols. it takes in the location as a uri and returns the contents of file as a string.
func ReadLocalFile ¶
ReadLocalFile takes in the location of a local file in the format `file://location/of/file` and returns the content of the file if the path is valid and no error occurs
func ReadRemoteFile ¶
ReadRemoteFile takes in the location of a remote file in the format 'http://location/of/file' or 'https://location/file' and returns the content of the file if the location is valid and no error occurs
func SortDottedStringsByDigits ¶
SortDottedStringsByDigits takes version-like dot separated digits in string format and returns them in sorted normalized form. Takes [v1.4.3,0.9.3,v0.0.0]=> returns [v0.0.0,0.9.3,v1.4.3] This function ignores all letters except for: - numeric digits - alpha, beta, rc, stable For the same version, stable is preferred over edge
func TcpCheck ¶
func TcpCheck(hp *HostPort, mock *MockOptions) bool
func TransformMapKeys ¶
func TransformMapKeys(input map[string]interface{}, transformFunc func(string) string) map[string]interface{}
transforms the keys of a Map recursively with the given transform function
func Unmarshal ¶
unmarshal returns parses the JSON config data and stores the value in the reference to result
func UpdateSVGString ¶
UpdateSVGString updates the width and height attributes of an SVG file and returns the modified SVG as a string.
func WriteJSONToFile ¶
func WriteToFile ¶
WriteToFile writes the given content to the given file path
Types ¶
type MockOptions ¶
type MockOptions struct {
DesiredEndpoint string
}
Source Files
Directories