kubernetes.core.kubectl – Execute tasks in pods running on Kubernetes.
Note
This plugin is part of the kubernetes.core collection (version 1.2.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install kubernetes.core
.
To use it in a playbook, specify: kubernetes.core.kubectl
.
Synopsis
Use the kubectl exec command to run tasks in, or put/fetch files to, pods running on the Kubernetes container platform.
Requirements
The below requirements are needed on the local controller node that executes this connection.
kubectl (go binary)
Parameters
Parameter |
Comments |
---|---|
Path to a CA certificate used to authenticate with the API. Default: “” Configuration:
|
|
Path to a certificate used to authenticate with the API. Default: “” Configuration:
|
|
Path to a key file used to authenticate with the API. Default: “” Configuration:
|
|
Container name. Required when a pod contains more than one container. Default: “” Configuration:
|
|
The name of a context found in the K8s config file. Default: “” Configuration:
|
|
Extra arguments to pass to the kubectl command line. Please be aware that this passes information directly on the command line and it could expose sensitive data. Default: “” Configuration:
|
|
URL for accessing the API. Default: “” Configuration:
|
|
Path to a kubectl config file. Defaults to ~/.kube/config Default: “” Configuration:
|
|
The namespace of the pod Default: “” Configuration:
|
|
Provide a password for authenticating with the API. Please be aware that this passes information directly on the command line and it could expose sensitive data. We recommend using the file based authentication options instead. Default: “” Configuration:
|
|
Pod name. Required when the host name does not match pod name. Default: “” Configuration:
|
|
API authentication bearer token. Please be aware that this passes information directly on the command line and it could expose sensitive data. We recommend using the file based authentication options instead. Configuration:
|
|
Provide a username for authenticating with the API. Default: “” Configuration:
|
|
Whether or not to verify the API server’s SSL certificate. Defaults to true. Default: “” Configuration:
|
Authors
xuxinkun