catalog

Documentation

Overview

Copyright (C) 2021-2023, Kubefirst

This program is licensed under MIT. See the LICENSE file for more details.

Index

• Constants
• func NewGitHub() *git.Client
• func ReadActiveApplications() (apiTypes.GitopsCatalogApps, error)
• func ValidateCatalogApps(catalogApps string) (bool, []apiTypes.GitopsCatalogApp, error)
• type GitHubClient
  • func (gh *GitHubClient) ReadGitopsCatalogIndex(contents []*git.RepositoryContent) ([]byte, error)
  • func (gh *GitHubClient) ReadGitopsCatalogRepoContents() ([]*git.RepositoryContent, error)

Constants

const (
	KubefirstGitHubOrganization      = "kubefirst"
	KubefirstGitopsCatalogRepository = "gitops-catalog"
)

Functions

func NewGitHub

func NewGitHub() *git.Client

NewGitHub instantiates an unauthenticated GitHub client

func ReadActiveApplications

func ReadActiveApplications() (apiTypes.GitopsCatalogApps, error)

func ValidateCatalogApps

func ValidateCatalogApps(catalogApps string) (bool, []apiTypes.GitopsCatalogApp, error)

Types

type GitHubClient

type GitHubClient struct {
	Client *git.Client
}

func (*GitHubClient) ReadGitopsCatalogIndex

func (gh *GitHubClient) ReadGitopsCatalogIndex(contents []*git.RepositoryContent) ([]byte, error)

ReadGitopsCatalogIndex reads the gitops catalog repository index

func (*GitHubClient) ReadGitopsCatalogRepoContents

func (gh *GitHubClient) ReadGitopsCatalogRepoContents() ([]*git.RepositoryContent, error)