cmd

Documentation

Index

• Constants
• Variables
• func Execute() error
• func ShowUsage(cmd *cobra.Command, _ []string)
• type APIGroups
• type ConfigHandler
  • func (h *ConfigHandler) CRDs() ([]*pkg.SchemaType, error)
• type FileHandler
  • func (h *FileHandler) CRDs() ([]*pkg.SchemaType, error)
• type FolderHandler
  • func (h *FolderHandler) CRDs() ([]*pkg.SchemaType, error)
• type GITUrls
• type GitHandler
  • func (g *GitHandler) CRDs() ([]*pkg.SchemaType, error)
• type Handler
• type KindVersionGroup
• type KubeHandler
  • func (h *KubeHandler) CRDs() ([]*pkg.SchemaType, error)
• type RenderConfig
• type Schema
• type StdInHandler
  • func (s *StdInHandler) CRDs() ([]*pkg.SchemaType, error)
• type URLHandler
  • func (h *URLHandler) CRDs() ([]*pkg.SchemaType, error)
• type URLs

Constants

const (
	FormatHTML = "html"
	FormatYAML = "yaml"
)

Variables

var Version = "v0.0.0-dev"

Functions

func Execute

func Execute() error

Execute runs the main krok command.

func ShowUsage

func ShowUsage(cmd *cobra.Command, _ []string)

ShowUsage shows usage of the given command on stdout.

Types

type APIGroups

type APIGroups struct {
	Name        string    `json:"name"`
	Description string    `json:"description,omitempty"`
	Files       []string  `json:"files,omitempty"`
	Folders     []string  `json:"folders,omitempty"`
	URLs        []URLs    `json:"urls,omitempty"`
	GitURLs     []GITUrls `json:"gitUrls,omitempty"`
}

APIGroups defines groups by which grouping will happen in the resulting HTML output.

type ConfigHandler

type ConfigHandler struct {
	// contains filtered or unexported fields
}

func (*ConfigHandler) CRDs

func (h *ConfigHandler) CRDs() ([]*pkg.SchemaType, error)

type FileHandler

type FileHandler struct {
	// contains filtered or unexported fields
}

func (*FileHandler) CRDs

func (h *FileHandler) CRDs() ([]*pkg.SchemaType, error)

type FolderHandler

type FolderHandler struct {
	// contains filtered or unexported fields
}

func (*FolderHandler) CRDs

func (h *FolderHandler) CRDs() ([]*pkg.SchemaType, error)

type GITUrls

type GITUrls struct {
	URL         string `json:"url"`
	Username    string `json:"username,omitempty"`
	Password    string `json:"password,omitempty"`
	Token       string `json:"token,omitempty"`
	Tag         string `json:"tag,omitempty"`
	PrivateKey  string `json:"privateKey,omitempty"`
	UseSSHAgent bool   `json:"useSSHAgent,omitempty"`
}

type GitHandler

type GitHandler struct {
	URL      string
	Username string
	Password string
	Token    string
	Tag      string
	// contains filtered or unexported fields
}

func (*GitHandler) CRDs

func (g *GitHandler) CRDs() ([]*pkg.SchemaType, error)

type Handler

type Handler interface {
	CRDs() ([]*pkg.SchemaType, error)
}

type KindVersionGroup

type KindVersionGroup struct {
	Kind    string `json:"kind"`
	Version string `json:"version"`
	Group   string `json:"group"`
}

type KubeHandler

type KubeHandler struct {
	// contains filtered or unexported fields
}

func (*KubeHandler) CRDs

func (h *KubeHandler) CRDs() ([]*pkg.SchemaType, error)

type RenderConfig

type RenderConfig struct {
	APIGroups []APIGroups `json:"apiGroups"`
}

RenderConfig defines a configuration for the resulting rendered HTML content.

type Schema

type Schema struct {
	*v1beta1.JSONSchemaProps       `json:",inline"`
	KubernetesGroupVersionKindList []KindVersionGroup `json:"x-kubernetes-group-version-kind"`
}

type StdInHandler

type StdInHandler struct {
	// contains filtered or unexported fields
}

func (*StdInHandler) CRDs

func (s *StdInHandler) CRDs() ([]*pkg.SchemaType, error)

type URLHandler

type URLHandler struct {
	// contains filtered or unexported fields
}

func (*URLHandler) CRDs

func (h *URLHandler) CRDs() ([]*pkg.SchemaType, error)

type URLs

type URLs struct {
	URL      string `json:"url"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	Token    string `json:"token,omitempty"`
}