artifacthub

Documentation

Index

• Constants
• Variables
• func ErrComponentGenerate(err error) error
• func ErrGetAhPackage(err error) error
• func ErrGetChartUrl(err error) error
• type AhPackage
  • func FilterPackagesWithCrds(pkgs []AhPackage) []AhPackage
  • func GetAhPackagesWithName(name string) ([]AhPackage, error)
  • func SortPackagesWithScore(pkgs []AhPackage) []AhPackage
  • func (pkg AhPackage) GenerateComponents() ([]v1alpha1.Component, error)
  • func (pkg *AhPackage) UpdatePackageData() error

Constants

const AhTextSearchQueryFieldName = "ts_query_web"

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

const ArtifactHubChartUrlFieldName = "content_url"

Variables

var (
	ErrGetChartUrlCode       = "11092"
	ErrGetAhPackageCode      = "1093"
	ErrComponentGenerateCode = "11094"
)

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 ErrComponentGenerate

func ErrComponentGenerate(err error) error

func ErrGetAhPackage

func ErrGetAhPackage(err error) error

func ErrGetChartUrl

func ErrGetChartUrl(err error) error

Types

type AhPackage

type AhPackage struct {
	Name              string
	Repository        string
	Organization      string
	Url               string
	Official          bool
	VerifiedPublisher bool
	Version           string
}

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

func FilterPackagesWithCrds

func FilterPackagesWithCrds(pkgs []AhPackage) []AhPackage

func GetAhPackagesWithName

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

func SortPackagesWithScore

func SortPackagesWithScore(pkgs []AhPackage) []AhPackage

func (AhPackage) GenerateComponents

func (pkg AhPackage) GenerateComponents() ([]v1alpha1.Component, error)

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