report

Documentation

Index

• func ToMarkdown(charts []*NamespaceReleases) (string, error)
• func WriteChart(w io.StringWriter, ch *ReleaseInfo)
• func WriteNamespaceCharts(w io.StringWriter, ns *NamespaceReleases)
• type IngressInfo
• type NamespaceReleases
• type Options
  • func NewCmdHelmfileReport() (*cobra.Command, *Options)
  • func (o *Options) AddFlags(cmd *cobra.Command, prefix string)
  • func (o *Options) Run() error
  • func (o *Options) Validate() error
• type ReleaseInfo
  • func (i *ReleaseInfo) String() string

Functions

func ToMarkdown

func ToMarkdown(charts []*NamespaceReleases) (string, error)

ToMarkdown converts the charts to markdown

func WriteChart

func WriteChart(w io.StringWriter, ch *ReleaseInfo)

func WriteNamespaceCharts

func WriteNamespaceCharts(w io.StringWriter, ns *NamespaceReleases)

Types

type IngressInfo

type IngressInfo struct {
	Name string `json:"name,omitempty"`
	URL  string `json:"url,omitempty"`
}

type NamespaceReleases

type NamespaceReleases struct {
	Path      string         `json:"path,omitempty"`
	Namespace string         `json:"namespace,omitempty"`
	Releases  []*ReleaseInfo `json:"releases,omitempty"`
}

type Options

type Options struct {
	options.BaseOptions
	Dir              string
	OutDir           string
	ConfigRootPath   string
	Namespace        string
	GitCommitMessage string
	Helmfile         string
	Helmfiles        []helmfiles.Helmfile
	HelmBinary       string
	DoGitCommit      bool
	Gitter           gitclient.Interface
	CommandRunner    cmdrunner.CommandRunner
	HelmClient       helmer.Helmer
	NamespaceCharts  []*NamespaceReleases
}

Options the options for the command

func NewCmdHelmfileReport

func NewCmdHelmfileReport() (*cobra.Command, *Options)

NewCmdHelmfileReport creates a command object for the command

func (*Options) AddFlags

func (o *Options) AddFlags(cmd *cobra.Command, prefix string)

func (*Options) Run

func (o *Options) Run() error

Run implements the command

func (*Options) Validate

func (o *Options) Validate() error

Validate validates the options and populates any missing values

type ReleaseInfo

type ReleaseInfo struct {
	chart.Metadata

	// RepositoryName the chart repository name used in the fully qualified chart name
	RepositoryName string `json:"repositoryName,omitempty"`
	// RepositoryURL the chart repository URL
	RepositoryURL string `json:"repositoryUrl,omitempty"`
	// ApplicationURL the ingress URL for the application if available
	ApplicationURL string `json:"applicationUrl,omitempty"`

	// ResourcesPath the relative path to the kubernetes resources
	ResourcesPath string `json:"resourcePath,omitempty"`

	// Ingresses the ingress URLs
	Ingresses []IngressInfo `json:"ingresses,omitempty"`
}

ReleaseInfo information about the release

func (*ReleaseInfo) String

func (i *ReleaseInfo) String() string