Skip to content

Commit

Permalink
Update kubeconfig file location in docs
Browse files Browse the repository at this point in the history 
Fixes: ansible-collections#57

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
  • Loading branch information
@Akasurde
Akasurde committed Apr 19, 2021
1 parent b68bf7c commit 2b1b2e0
Show file tree
Hide file tree
Showing 14 changed files with 15 additions and 13 deletions.
2 changes: 2 additions & 0 deletions changelogs/fragments/53_kubeconfig_docs.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- kubeconfig - update ``kubeconfig`` file location in the documentation (https://github.com/ansible-collections/kubernetes.core/issues/53).
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_cluster_info_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_exec_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_info_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_inventory.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the OpenShift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the OpenShift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_log_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_lookup.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_rollback_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_scale_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes.core.k8s_service_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ Parameters
<td>
</td>
<td>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config.json</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion plugins/doc_fragments/k8s_auth_options.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ModuleDocFragment(object):
description:
- Path to an existing Kubernetes config file. If not provided, and no other connection
options are provided, the openshift client will attempt to load the default
configuration file from I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG environment
configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG environment
variable.
type: path
context:
Expand Down
2 changes: 1 addition & 1 deletion plugins/inventory/k8s.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- Path to an existing Kubernetes config file. If not provided, and no other connection
options are provided, the OpenShift client will attempt to load the default
configuration file from I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG
configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG
environment variable.
context:
description:
Expand Down
2 changes: 1 addition & 1 deletion plugins/lookup/k8s.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
description:
- Path to an existing Kubernetes config file. If not provided, and no other connection
options are provided, the openshift client will attempt to load the default
configuration file from I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG environment
configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG environment
variable.
context:
description:
Expand Down

0 comments on commit 2b1b2e0

Please sign in to comment.