qliksense

Documentation

Index

• Constants
• func DownloadFromGitRepoToTmpDir(gitUrl, gitRef string) (string, error)
• func ExecuteKustomizeBuild(directory string) ([]byte, error)
• func GetYamlsFromMultiDoc(multiYaml string, kind string) string
• func IsQliksenseInstalled(crName string) bool
• type CrdCommandOptions
• type InstallCommandOptions
• type LsRemoteCmdOptions
• type Qliksense
  • func New(qliksenseHome string) *Qliksense
  • func (q *Qliksense) About(gitRef, profile string) (*VersionOutput, error)
  • func (q *Qliksense) AboutDir(configDirectory, profile string) (*VersionOutput, error)
  • func (q *Qliksense) ApplyCRFromReader(r io.Reader, opts *InstallCommandOptions, ...) error
  • func (q *Qliksense) ConfigApplyQK8s() error
  • func (q *Qliksense) ConfigViewCR() error
  • func (q *Qliksense) DeleteContextConfig(args []string) error
  • func (q *Qliksense) DiscardAllUnstagedChangesFromGitRepo(qConfig *qapi.QliksenseConfig) error
  • func (q *Qliksense) EditCR(contextName string) error
  • func (q *Qliksense) FetchQK8s(version string) error
  • func (q *Qliksense) GetInstallableVersions(opts *LsRemoteCmdOptions) error
  • func (q *Qliksense) GetOperatorCRDString() string
  • func (q *Qliksense) GetOperatorControllerString() string
  • func (q *Qliksense) InstallCrds(opts *CrdCommandOptions) error
  • func (q *Qliksense) InstallQK8s(version string, opts *InstallCommandOptions, keepPatchFiles bool) error
  • func (q *Qliksense) IsEulaAcceptedInCrFile(reader io.Reader) (bool, error)
  • func (q *Qliksense) ListContextConfigs() error
  • func (q *Qliksense) LoadCr(reader io.Reader, overwriteExistingContext bool) error
  • func (q *Qliksense) PrepareK8sSecret(targetFile string) (string, error)
  • func (q *Qliksense) PullImages(version, profile string) error
  • func (q *Qliksense) PullImagesForCurrentCR() error
  • func (q *Qliksense) PushImagesForCurrentCR() error
  • func (q *Qliksense) SetConfigs(args []string) error
  • func (q *Qliksense) SetContextConfig(args []string) error
  • func (q *Qliksense) SetEulaAccepted() error
  • func (q *Qliksense) SetImageRegistry(registry, pushUsername, pushPassword, pullUsername, pullPassword string) error
  • func (q *Qliksense) SetOtherConfigs(args []string) error
  • func (q *Qliksense) SetSecrets(args []string, isSecretSet bool) error
  • func (q *Qliksense) SetUpQliksenseContext(contextName string) error
  • func (q *Qliksense) SetUpQliksenseDefaultContext() error
  • func (q *Qliksense) UninstallQK8s(contextName string) error
  • func (q *Qliksense) UpgradeQK8s(keepPatchFiles bool) error
  • func (q *Qliksense) ViewCrds(opts *CrdCommandOptions) error
  • func (q *Qliksense) ViewOperator() error
  • func (q *Qliksense) ViewOperatorController() error
• type VersionOutput

Constants

const (
	// Below are some constants to support qliksense context setup
	QliksenseConfigFile     = "config.yaml"
	QliksenseContextsDir    = "contexts"
	DefaultQliksenseContext = "qlik-default"
	MaxContextNameLength    = 17
	QliksenseSecretsDir     = "secrets"
)

const (
	QLIK_GIT_REPO = "https://github.com/qlik-oss/qliksense-k8s"
)

const (
	Q_INIT_CRD_PATH = "manifests/base/manifests/qliksense-init"
)

Functions

func DownloadFromGitRepoToTmpDir

func DownloadFromGitRepoToTmpDir(gitUrl, gitRef string) (string, error)

DownloadFromGitRepoToTmpDir download git repo to a temporary directory

func ExecuteKustomizeBuild

func ExecuteKustomizeBuild(directory string) ([]byte, error)

ExecuteKustomizeBuild execute kustomize to the directory and return manifest as byte array

func GetYamlsFromMultiDoc

func GetYamlsFromMultiDoc(multiYaml string, kind string) string

GetYamlsFromMultiDoc filter yaml docs from multiyaml based on kind

func IsQliksenseInstalled

func IsQliksenseInstalled(crName string) bool

Types

type CrdCommandOptions

type CrdCommandOptions struct {
	All bool
}

type InstallCommandOptions

type InstallCommandOptions struct {
	StorageClass string
	MongoDbUri   string
	RotateKeys   string
}

type LsRemoteCmdOptions

type LsRemoteCmdOptions struct {
	IncludeBranches bool
	Limit           int
}

type Qliksense

type Qliksense struct {
	QliksenseHome string
	CrdBox        *packr.Box ``
}

Qliksense is the logic behind the qliksense client

func New

func New(qliksenseHome string) *Qliksense

New qliksense client, initialized with useful defaults.

func (*Qliksense) About

func (q *Qliksense) About(gitRef, profile string) (*VersionOutput, error)

func (*Qliksense) AboutDir

func (q *Qliksense) AboutDir(configDirectory, profile string) (*VersionOutput, error)

func (*Qliksense) ApplyCRFromReader

func (q *Qliksense) ApplyCRFromReader(r io.Reader, opts *InstallCommandOptions, keepPatchFiles, overwriteExistingContext bool) error

func (*Qliksense) ConfigApplyQK8s

func (q *Qliksense) ConfigApplyQK8s() error

func (*Qliksense) ConfigViewCR

func (q *Qliksense) ConfigViewCR() error

func (*Qliksense) DeleteContextConfig

func (q *Qliksense) DeleteContextConfig(args []string) error

func (*Qliksense) DiscardAllUnstagedChangesFromGitRepo

func (q *Qliksense) DiscardAllUnstagedChangesFromGitRepo(qConfig *qapi.QliksenseConfig) error

func (*Qliksense) EditCR

func (q *Qliksense) EditCR(contextName string) error

func (*Qliksense) FetchQK8s

func (q *Qliksense) FetchQK8s(version string) error

func (*Qliksense) GetInstallableVersions

func (q *Qliksense) GetInstallableVersions(opts *LsRemoteCmdOptions) error

func (*Qliksense) GetOperatorCRDString

func (q *Qliksense) GetOperatorCRDString() string

this will return crd,deployment,role, rolebinding,serviceaccount for operator

func (*Qliksense) GetOperatorControllerString

func (q *Qliksense) GetOperatorControllerString() string

func (*Qliksense) InstallCrds

func (q *Qliksense) InstallCrds(opts *CrdCommandOptions) error

func (*Qliksense) InstallQK8s

func (q *Qliksense) InstallQK8s(version string, opts *InstallCommandOptions, keepPatchFiles bool) error

func (*Qliksense) IsEulaAcceptedInCrFile

func (q *Qliksense) IsEulaAcceptedInCrFile(reader io.Reader) (bool, error)

func (*Qliksense) ListContextConfigs

func (q *Qliksense) ListContextConfigs() error

func (*Qliksense) LoadCr

func (q *Qliksense) LoadCr(reader io.Reader, overwriteExistingContext bool) error

func (*Qliksense) PrepareK8sSecret

func (q *Qliksense) PrepareK8sSecret(targetFile string) (string, error)

PrepareK8sSecret decodes and decrypts the secret value in the secret.yaml file and returns a B64encoded string

func (*Qliksense) PullImages

func (q *Qliksense) PullImages(version, profile string) error

func (*Qliksense) PullImagesForCurrentCR

func (q *Qliksense) PullImagesForCurrentCR() error

PullImages ...

func (*Qliksense) PushImagesForCurrentCR

func (q *Qliksense) PushImagesForCurrentCR() error

TagAndPushImages ...

func (*Qliksense) SetConfigs

func (q *Qliksense) SetConfigs(args []string) error

SetConfigs - set-configs <key>=<value> commands

func (*Qliksense) SetContextConfig

func (q *Qliksense) SetContextConfig(args []string) error

SetContextConfig - set the context for qliksense kubernetes resources to live in

func (*Qliksense) SetEulaAccepted

func (q *Qliksense) SetEulaAccepted() error

func (*Qliksense) SetImageRegistry

func (q *Qliksense) SetImageRegistry(registry, pushUsername, pushPassword, pullUsername, pullPassword string) error

func (*Qliksense) SetOtherConfigs

func (q *Qliksense) SetOtherConfigs(args []string) error

SetOtherConfigs - set profile/storageclassname/git.repository/manifestRoot commands

func (*Qliksense) SetSecrets

func (q *Qliksense) SetSecrets(args []string, isSecretSet bool) error

SetSecrets - set-secrets <key>=<value> commands

func (*Qliksense) SetUpQliksenseContext

func (q *Qliksense) SetUpQliksenseContext(contextName string) error

SetUpQliksenseContext - to setup qliksense context

func (*Qliksense) SetUpQliksenseDefaultContext

func (q *Qliksense) SetUpQliksenseDefaultContext() error

SetUpQliksenseDefaultContext - to setup dir structure for default qliksense context

func (*Qliksense) UninstallQK8s

func (q *Qliksense) UninstallQK8s(contextName string) error

func (*Qliksense) UpgradeQK8s

func (q *Qliksense) UpgradeQK8s(keepPatchFiles bool) error

func (*Qliksense) ViewCrds

func (q *Qliksense) ViewCrds(opts *CrdCommandOptions) error

func (*Qliksense) ViewOperator

func (q *Qliksense) ViewOperator() error

func (*Qliksense) ViewOperatorController

func (q *Qliksense) ViewOperatorController() error

type VersionOutput

type VersionOutput struct {
	QliksenseVersion string   `yaml:"qlikSenseVersion"`
	Images           []string `yaml:"images"`
}