Documentation
¶
Index ¶
- Variables
- func ConvertDockerComposeToKubernetesManifest(file IdentifiedFile) (string, error)
- func ConvertHelmChartToKubernetesManifest(file IdentifiedFile) (string, error)
- func ConvertKustomizeToKubernetesManifest(file IdentifiedFile) (string, error)
- func ErrDecodePattern(err error) error
- func ErrEmptyModel() error
- func ErrEmptyOCIImage(err error) error
- func ErrFailedToExtractArchive(fileName string, err error) error
- func ErrFailedToIdentifyFile(fileName string, fileExt string, ...) error
- func ErrFileRead(err error) error
- func ErrInvalidDockerCompose(fileName string, err error) error
- func ErrInvalidHelmChart(fileName string, err error) error
- func ErrInvalidJson(fileName string, err error) error
- func ErrInvalidKubernetesManifest(fileName string, err error) error
- func ErrInvalidKustomization(fileName string, err error) error
- func ErrInvalidModel(operation string, filename string, err error) error
- func ErrInvalidModelArchive(fileName string, err error) error
- func ErrInvalidYaml(fileName string, err error) error
- func ErrNoTarInsideOCi() error
- func ErrUnCompressOCIArtifact(err error) error
- func ErrUnsupportedExtension(fileName string, fileExt string, supportedExtensionsMap map[string]bool) error
- func ErrUnsupportedExtensionForOperation(operation string, fileName string, fileExt string, ...) error
- func ErrUnsupportedFileTypeForConversionToDesign(fileName string, fileType string) error
- func ErrWaklingLocalDirectory(err error) error
- func ExtractTar(reader io.Reader, archiveFile string, outputDir string) error
- func ExtractZipFromBytes(data []byte, outputDir string) error
- func FindChartDir(root string) (string, error)
- func GetFirstTopLevelDir(extractedPath string) (string, error)
- func IsValidJson(data []byte) error
- func IsValidYaml(data []byte) error
- func ParseCompressedOCIArtifactIntoDesign(artifact []byte) (*pattern.PatternFile, error)
- func ParseFileAsDockerComposeStrict(file SanitizedFile) (*dockerTypes.Config, error)
- func ParseFileAsHelmChart(file SanitizedFile) (*chart.Chart, error)
- func ParseFileAsKubernetesManifest(file SanitizedFile) ([]runtime.Object, error)
- func ParseFileAsKustomization(file SanitizedFile) (resmap.ResMap, error)
- func ParseFileAsMesheryDesign(file SanitizedFile) (pattern.PatternFile, error)
- type IdentifiedFile
- type ParsedCompose
- type SanitizedFile
Constants ¶
This section is empty.
Variables ¶
var ( // Error code ErrUnsupportedExtensionCode = "meshkit-11282" ErrUnsupportedExtensionForOperationCode = "meshkit-11283" ErrFailedToIdentifyFileCode = "meshkit-11284" ErrSanitizingFileCode = "meshkit-11285" ErrInvalidYamlCode = "meshkit-11286" ErrInvalidJsonCode = "meshkit-11287" ErrFailedToExtractTarCode = "meshkit-11288" ErrUnsupportedFileTypeCode = "meshkit-11289" ErrInvalidKubernetesManifestCode = "meshkit-11290" ErrInvalidMesheryDesignCode = "meshkit-11291" ErrInvalidHelmChartCode = "meshkit-11292" ErrInvalidDockerComposeCode = "meshkit-11293" ErrInvalidKustomizationCode = "meshkit-11294" ErrFileTypeNotSupportedForDesignConversionCode = "meshkit-11300" )
var ( ErrNoTarInsideOCICode = "meshkit-11295" ErrEmptyOCIImageCode = "meshkit-11296" ErrUnCompressOCIArtifactCode = "meshkit-11297" ErrWaklingLocalDirectoryCode = "meshkit-11298" ErrDecodePatternCode = "meshkit-11299" )
var ( ErrInvalidModelCode = "meshkit-11301" ErrInvalidModelArchiveCode = "meshkit-11302" ErrEmptyModelCode = "meshkit-11303" )
var (
ErrFileReadCode = "meshkit-11304"
)
var ValidHelmChartFileExtensions = map[string]bool{ ".tar": true, ".tgz": true, ".gz": true, ".tar.gz": true, ".zip": true, }
Functions ¶
func ConvertDockerComposeToKubernetesManifest ¶
func ConvertDockerComposeToKubernetesManifest(file IdentifiedFile) (string, error)
func ConvertHelmChartToKubernetesManifest ¶
func ConvertHelmChartToKubernetesManifest(file IdentifiedFile) (string, error)
func ConvertKustomizeToKubernetesManifest ¶
func ConvertKustomizeToKubernetesManifest(file IdentifiedFile) (string, error)
func ErrDecodePattern ¶
func ErrEmptyModel ¶
func ErrEmptyModel() error
func ErrEmptyOCIImage ¶
func ErrFailedToIdentifyFile ¶
func ErrFileRead ¶
func ErrInvalidDockerCompose ¶
func ErrInvalidHelmChart ¶
func ErrInvalidJson ¶
func ErrInvalidKustomization ¶
func ErrInvalidModelArchive ¶
func ErrInvalidYaml ¶
func ErrNoTarInsideOCi ¶
func ErrNoTarInsideOCi() error
func ErrUnsupportedExtension ¶
func ExtractTar ¶
ExtractTar extracts a .tar, .tar.gz, or .tgz file into a temporary directory and returns the directory.
func ExtractZipFromBytes ¶
ExtractZipFromBytes takes a []byte representing a ZIP file and extracts it to the specified output directory.
func FindChartDir ¶
findChartDir uses filepath.Glob to locate Chart.yaml in nested directories
func GetFirstTopLevelDir ¶
get the root dir from the extractedPath if multiple entries are found in the extractedPath then treat extractedPath as root
func IsValidJson ¶
func IsValidYaml ¶
func ParseCompressedOCIArtifactIntoDesign ¶
func ParseCompressedOCIArtifactIntoDesign(artifact []byte) (*pattern.PatternFile, error)
func ParseFileAsDockerComposeStrict ¶
func ParseFileAsDockerComposeStrict(file SanitizedFile) (*dockerTypes.Config, error)
ParseFileAsDockerCompose parses a Docker Compose file into a types.Config struct.
func ParseFileAsHelmChart ¶
func ParseFileAsHelmChart(file SanitizedFile) (*chart.Chart, error)
ParseFileAsHelmChart loads a Helm chart from the extracted directory.
func ParseFileAsKubernetesManifest ¶
func ParseFileAsKubernetesManifest(file SanitizedFile) ([]runtime.Object, error)
func ParseFileAsKustomization ¶
func ParseFileAsKustomization(file SanitizedFile) (resmap.ResMap, error)
ParseFileAsKustomization processes a sanitized file and returns a Kustomize ResMap
func ParseFileAsMesheryDesign ¶
func ParseFileAsMesheryDesign(file SanitizedFile) (pattern.PatternFile, error)
we are allowing unknown fields to keep compabitibilty with old designs when we make unversioned changes to schema
Types ¶
type IdentifiedFile ¶
type IdentifiedFile struct {
Type coreV1.IaCFileTypes
// pattern.PatternFile (meshery-design),
// []runtime.Object (k8s manifest) ,
// *chart.Chart (helm-chart),
// resmap.ResMap (kustomize),
// dockerTypes.Config (docker-compose) etc
ParsedFile interface{}
}
func IdentifyFile ¶
func IdentifyFile(sanitizedFile SanitizedFile) (IdentifiedFile, error)
type ParsedCompose ¶
type ParsedCompose struct {
// contains filtered or unexported fields
}
func ParseFileAsDockerCompose ¶
func ParseFileAsDockerCompose(file SanitizedFile) (ParsedCompose, error)
ParseFileAsDockerCompose parses a Docker Compose file into a types.Config struct.
type SanitizedFile ¶
type SanitizedFile struct {
FileExt string
FileName string
RawData []byte
// incase of bundle like tar
ExtractedContentPath string
}