Documentation
¶
Index ¶
- type Manager
- func (m *Manager) RunInstall(opts ...Option) error
- func (m *Manager) RunRepo(opts ...Option) error
- func (m *Manager) RunTemplate(opts ...Option) error
- func (m *Manager) RunTest(opts ...Option) error
- func (m *Manager) RunUninstall(opts ...Option) error
- func (m *Manager) RunUpgrade(opts ...Option) error
- func (m *Manager) WithPath(path string) *Manager
- type Option
- func WithArgs(args ...string) Option
- func WithChart(chart string) Option
- func WithName(name string) Option
- func WithNamespace(namespace string) Option
- func WithReleaseName(releaseName string) Option
- func WithTimeout(timeout string) Option
- func WithVersion(version string) Option
- func WithWait() Option
- type Opts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
func (*Manager) RunInstall ¶
RunInstall provides a way to install the helm chart either from the local path or using the configured helm repository with a specific chart name.
func (*Manager) RunRepo ¶
RunRepo provides a way to run `helm repo` sub command hierarchies using the right combination of WithArgs to build the suitable repo management sub command structure.
func (*Manager) RunTemplate ¶
RunTemplate provides a way to invoke the `helm template` commands that can be used to perform the basic sanity check on the charts to make sure if the charts can be rendered successfully or not.
func (*Manager) RunTest ¶
RunTest provides a way to perform the `helm test` sub command that can be leveraged to perform a test using the helm infra on the deployed charts.
func (*Manager) RunUninstall ¶ added in v0.0.8
RunUninstall provides a way to uninstall the specified helm chart (useful in teardowns etc...)
func (*Manager) RunUpgrade ¶
RunUpgrade provides a way to invoke the `helm upgrade` sub commands that can be used to perform the chart upgrade operation tests. This can be combined with suitable arguments to even install the charts if they are not already existing in the cluster.
type Option ¶
type Option func(*Opts)
func WithArgs ¶
WithArgs is used to inject additional arguments into the Helm commands. Please pay careful consideration while using this as the current one does not have the ability to de-dup the arguments since options such as -f or --set can be used multiple times with different values, and we wanted the end user to make the decision of how the commands are invoked and not restrict them to a specific way of invoking the commands.
func WithChart ¶
WithChart is used to configure the full path of the .tgz artifact of the Helm chart in case if your tests require you to be able to deploy a packaged helm chart that is available locally as the tarball
func WithNamespace ¶
WithNamespace is used to configure the namespace in which the helm chart identified by WithName will be processed
func WithReleaseName ¶
WithReleaseName is used to configure the name of the release to be used while installing or upgrading the chart identified by WithName into the WithNamespace configured namespace
func WithTimeout ¶
WithTimeout is used to configure the time for which the helm command should be in blocked wait mode for the acceptable state of the resource to be reached
func WithVersion ¶
WithVersion is used to configre helm chart version that should be deployed to the test infrastructure
type Opts ¶
type Opts struct {
// Name is used to indicate the name of the helm chart being processed
Name string
// Namespace is used to indicate the namespace in which the helm chart
// identified by Name will be processed
Namespace string
// ReleaseName is used to indicate the name of the release to be used
// while installing or upgrading the chart identified by Name into the
// Namespace
ReleaseName string
// Version is the helm chart version that should be deployed to the test
// infrastructure
Version string
// Chart is used to indicate the full path of the .tgz artifact of the Helm
// chart in case if your tests require you to be able to deploy a packaged
// helm chart that is available locally as the tarball
Chart string
// Args is used to pass any additional arguments that you might want to pass
// for running the helm command in question
Args []string
// Wait is used to indicate if the helm command should wait for the runtime
// to reach an acceptable state before returning the control back. The duration
// for which this call is blocked is defined by the value set to Timeout
Wait bool
// Timeout is used to indicate the time to wait for any individual Kubernetes ops
Timeout string
// contains filtered or unexported fields
}
Source Files