Document helm.Config's struct fields more clearly [#9]
This commit is contained in:
parent
4755f502b5
commit
ad5baea3e6
|
@ -14,31 +14,27 @@ type Config struct {
|
||||||
// Configuration for drone-helm itself
|
// Configuration for drone-helm itself
|
||||||
Command helmCommand `envconfig:"HELM_COMMAND"` // Helm command to run
|
Command helmCommand `envconfig:"HELM_COMMAND"` // Helm command to run
|
||||||
DroneEvent string `envconfig:"DRONE_BUILD_EVENT"` // Drone event that invoked this plugin.
|
DroneEvent string `envconfig:"DRONE_BUILD_EVENT"` // Drone event that invoked this plugin.
|
||||||
UpdateDependencies bool `split_words:"true"` // call `helm dependency update` before the main command
|
UpdateDependencies bool `split_words:"true"` // Call `helm dependency update` before the main command
|
||||||
Repos []string `envconfig:"HELM_REPOS"` // call `helm repo add` before the main command
|
Repos []string `envconfig:"HELM_REPOS"` // Call `helm repo add` before the main command
|
||||||
Prefix string `` // Prefix to use when looking up secret env vars
|
Prefix string `` // Prefix to use when looking up secret env vars
|
||||||
|
Debug bool `` // Generate debug output and pass --debug to all helm commands
|
||||||
// Global helm config
|
Values string `` // Argument to pass to --set in applicable helm commands
|
||||||
Debug bool `` // global helm flag (also applies to drone-helm itself)
|
StringValues string `split_words:"true"` // Argument to pass to --set-string in applicable helm commands
|
||||||
Values string ``
|
ValuesFiles []string `split_words:"true"` // Arguments to pass to --values in applicable helm commands
|
||||||
StringValues string `split_words:"true"`
|
Namespace string `` // Kubernetes namespace for all helm commands
|
||||||
ValuesFiles []string `split_words:"true"`
|
KubeToken string `envconfig:"KUBERNETES_TOKEN"` // Kubernetes authentication token to put in .kube/config
|
||||||
Namespace string ``
|
SkipTLSVerify bool `envconfig:"SKIP_TLS_VERIFY"` // Put insecure-skip-tls-verify in .kube/config
|
||||||
KubeToken string `envconfig:"KUBERNETES_TOKEN"`
|
Certificate string `envconfig:"KUBERNETES_CERTIFICATE"` // The Kubernetes cluster CA's self-signed certificate (must be base64-encoded)
|
||||||
SkipTLSVerify bool `envconfig:"SKIP_TLS_VERIFY"`
|
APIServer string `envconfig:"API_SERVER"` // The Kubernetes cluster's API endpoint
|
||||||
Certificate string `envconfig:"KUBERNETES_CERTIFICATE"`
|
ServiceAccount string `envconfig:"SERVICE_ACCOUNT"` // Account to use for connecting to the Kubernetes cluster
|
||||||
APIServer string `envconfig:"API_SERVER"`
|
ChartVersion string `split_words:"true"` // Specific chart version to use in `helm upgrade`
|
||||||
ServiceAccount string `envconfig:"SERVICE_ACCOUNT"` // Can't just use split_words; need envconfig to find the non-prefixed form
|
DryRun bool `split_words:"true"` // Pass --dry-run to applicable helm commands
|
||||||
|
Wait bool `` // Pass --wait to applicable helm commands
|
||||||
// Config specifically for `helm upgrade`
|
ReuseValues bool `split_words:"true"` // Pass --reuse-values to `helm upgrade`
|
||||||
ChartVersion string `split_words:"true"` //
|
Timeout string `` // Argument to pass to --timeout in applicable helm commands
|
||||||
DryRun bool `split_words:"true"` // also available for `delete`
|
Chart string `` // Chart argument to use in applicable helm commands
|
||||||
Wait bool `` //
|
Release string `` // Release argument to use in applicable helm commands
|
||||||
ReuseValues bool `split_words:"true"` //
|
Force bool `` // Pass --force to applicable helm commands
|
||||||
Timeout string `` //
|
|
||||||
Chart string `` // Also available for `lint`, in which case it must be a path to a chart directory
|
|
||||||
Release string ``
|
|
||||||
Force bool `` //
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type helmCommand string
|
type helmCommand string
|
||||||
|
|
Loading…
Reference in a new issue