artifacthub

Documentation

Index

• Constants
• Variables
• func ErrChartUrlEmpty(modelName string, registrantName string) error
• func ErrComponentGenerate(err error) error
• func ErrGetAhPackage(err error) error
• func ErrGetAllHelmPackages(err error) error
• func ErrGetChartUrl(err error) error
• func ErrNoPackageFound(modelName string, registrantName string) error
• type AhPackage
  • func FilterPackageWithGivenSourceURL(pkgs []AhPackage, url string) []AhPackage
  • func FilterPackagesWithCrds(pkgs []AhPackage) []AhPackage
  • func GetAhPackagesWithName(name string) ([]AhPackage, error)
  • func GetAllAhHelmPackages() ([]AhPackage, error)
  • func SortPackagesWithScore(pkgs []AhPackage) []AhPackage
  • func (pkg AhPackage) GenerateComponents() ([]_component.ComponentDefinition, error)
  • func (pkg AhPackage) GetVersion() string
  • func (pkg *AhPackage) UpdatePackageData() error
  • func (pkg *AhPackage) Validator()
• type ArtifactHubPackageManager
  • func (ahpm ArtifactHubPackageManager) GetPackage() (models.Package, error)

Constants

const AhHelmExporterEndpoint = ArtifactHubAPIEndpoint + "/helm-exporter"

const AhTextSearchQueryFieldName = "ts_query_web"

const (
	ArtifactHub = "artifacthub"
)

const ArtifactHubAPIEndpoint = "https://artifacthub.io/api/v1"

const ArtifactHubChartUrlFieldName = "content_url"

Variables

var (
	ErrGetChartUrlCode        = "meshkit-11134"
	ErrGetAhPackageCode       = "meshkit-11135"
	ErrComponentGenerateCode  = "meshkit-11136"
	ErrGetAllHelmPackagesCode = "meshkit-11137"
	ErrChartUrlEmptyCode      = "replace_me"
	ErrNoPackageFoundCode     = "replace_me"
)

var AhApiSearchParams = map[string]string{
	"offset": "0",
	"limit":  "10",
	"facets": "false",
	"kind":   "0",
	"sort":   "relevance",
}

var RankingParameterWeightage = map[string]int{
	"official":          5,
	"verifiedPublisher": 10,
}

Functions

func ErrChartUrlEmpty

func ErrChartUrlEmpty(modelName string, registrantName string) error

func ErrComponentGenerate

func ErrComponentGenerate(err error) error

func ErrGetAhPackage

func ErrGetAhPackage(err error) error

func ErrGetAllHelmPackages

func ErrGetAllHelmPackages(err error) error

func ErrGetChartUrl

func ErrGetChartUrl(err error) error

func ErrNoPackageFound

func ErrNoPackageFound(modelName string, registrantName string) error

Types

type AhPackage

type AhPackage struct {
	Name              string `yaml:"name"`
	Repository        string `yaml:"repository"`
	Organization      string `yaml:"organization"`
	RepoUrl           string `yaml:"repo_url"`
	ChartUrl          string `yaml:"chart_url"`
	Official          bool   `yaml:"official"`
	VerifiedPublisher bool   `yaml:"verified_publisher"`
	CNCF              bool   `yaml:"cncf"`
	Version           string `yaml:"version"`
}

internal representation of artifacthub package it contains information we need to identify a package using ArtifactHub API

func FilterPackageWithGivenSourceURL

func FilterPackageWithGivenSourceURL(pkgs []AhPackage, url string) []AhPackage

func FilterPackagesWithCrds

func FilterPackagesWithCrds(pkgs []AhPackage) []AhPackage

func GetAhPackagesWithName

func GetAhPackagesWithName(name string) ([]AhPackage, error)

func GetAllAhHelmPackages

func GetAllAhHelmPackages() ([]AhPackage, error)

GetAllAhHelmPackages returns a list of all AhPackages and is super slow to avoid rate limits.

func SortPackagesWithScore

func SortPackagesWithScore(pkgs []AhPackage) []AhPackage

func (AhPackage) GenerateComponents

func (pkg AhPackage) GenerateComponents() ([]_component.ComponentDefinition, error)

func (AhPackage) GetVersion

func (pkg AhPackage) GetVersion() string

func (*AhPackage) UpdatePackageData

func (pkg *AhPackage) UpdatePackageData() error

function that will take the AhPackage as input and give the helm chart url for that package

func (*AhPackage) Validator

func (pkg *AhPackage) Validator()

type ArtifactHubPackageManager

type ArtifactHubPackageManager struct {
	PackageName string
	SourceURL   string
}

func (ArtifactHubPackageManager) GetPackage

func (ahpm ArtifactHubPackageManager) GetPackage() (models.Package, error)