Deprecate kubeconfig variable

Signed-off-by: Raul Sevilla <[email protected]>
rsevilla87 · Sep 21, 2021 · 3e2aa05 · 3e2aa05
1 parent e5dc853
commit 3e2aa05
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -18,14 +18,19 @@ In this section is described global job configuration, it holds the following pa
 
 | Option           | Description                                                                                              | Type           | Example        | Default     |
 |------------------|----------------------------------------------------------------------------------------------------------|----------------|----------------|-------------|
-| kubeconfig       | Points to a valid kubeconfig file. Can be omitted if using the KUBECONFIG environment variable, or running from a pod | String  | ~/mykubeconfig | in-cluster |             |
 | writeToFile      | Whether to dump collected metrics to files                                                               | Boolean        | true           | true        |
 | createTarball    | Create metrics tarball, it has no effect if `writeToFile` is not enabled                                 | Boolean        | true           | false       |
 | metricsDirectory | Directory where collected metrics will be dumped into. It will be created if it doesn't exist previously | String         | ./metrics      | ./collected-metrics |
 | measurements     | List of measurements. Detailed in the [measurements section]                                             | List           | -              | []          |
 | indexerConfig    | Holds the indexer configuration. Detailed in the [indexers section]                                      | Object         | -              | -           |
 | requestTimeout   | Client-go request timeout                                                                                | Duration       | 5s             | 15s         |
 
+kube-burner connects to the k8s cluster using the following methods in this order:
+
+- KUBECONFIG environment variable
+- $HOME/.kube/config
+- In-cluster config (Used when kube-burner runs inside a pod)
+
 ## Jobs
 
 This section contains the list of jobs `kube-burner` will execute. Each job can hold the following parameters.

diff --git a/pkg/config/types.go b/pkg/config/types.go
@@ -56,8 +56,6 @@ type IndexerConfig struct {
 
 // GlobalConfig holds the global configuration
 type GlobalConfig struct {
-	// Kubeconfig path to a valid kubeconfig file
-	Kubeconfig string `yaml:"kubeconfig"`
 	// IndexerConfig contains a IndexerConfig definition
 	IndexerConfig IndexerConfig `yaml:"indexerConfig"`
 	// Write prometheus metrics to a file