kubernetes / kubernetes.core / 3.0.1 / module / k8s_json_patch Apply JSON patch operations to existing objects | "added in version" 2.0.0 of kubernetes.core" Authors: Mike Graves (@gravesm)kubernetes.core.k8s_json_patch (3.0.1) — module
Install with ansible-galaxy collection install kubernetes.core:==3.0.1
collections: - name: kubernetes.core version: 3.0.1
This module is used to apply RFC 6902 JSON patch operations only.
Use the M(kubernetes.core.k8s) module for strategic merge or JSON merge operations.
The jsonpatch library is required for check mode.
- name: Apply multiple patch operations to an existing Pod kubernetes.core.k8s_json_patch: kind: Pod namespace: testing name: mypod patch: - op: add path: /metadata/labels/app value: myapp - op: replace path: /spec/containers/0/image value: nginx
host: description: - Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. type: str kind: description: - Use to specify an object model. - Use in conjunction with I(api_version), I(name), and I(namespace) to identify a specific object. required: true type: str name: description: - Use to specify an object name. - Use in conjunction with I(api_version), I(kind), and I(namespace) to identify a specific object. required: true type: str wait: default: false description: - Whether to wait for certain resource kinds to end up in the desired state. - By default the module exits once Kubernetes has received the request. - Implemented for C(state=present) for C(Deployment), C(DaemonSet) and C(Pod), and for C(state=absent) for all resource kinds. - For resource kinds without an implementation, C(wait) returns immediately unless C(wait_condition) is set. type: bool patch: description: - List of JSON patch operations. elements: dict required: true type: list proxy: description: - The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable. - Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY). type: str api_key: description: - Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable. type: str ca_cert: aliases: - ssl_ca_cert description: - Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable. type: path context: description: - The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable. type: str no_proxy: description: - The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable. - Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY). - This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct. - example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16" type: str version_added: 2.3.0 version_added_collection: kubernetes.core password: description: - Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. - Please read the description of the C(username) option for a discussion of when this option is applicable. type: str username: description: - Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable. - Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the M(community.okd.k8s_auth) module, as that might do what you need. type: str namespace: description: - Use to specify an object namespace. - Use in conjunction with I(api_version), I(kind), and I(name) to identify a specific object. type: str client_key: aliases: - key_file description: - Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable. type: path kubeconfig: description: - Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG environment variable. - Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms. - The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0. type: raw wait_sleep: default: 5 description: - Number of seconds to sleep between checks. type: int api_version: aliases: - api - version default: v1 description: - Use to specify the API version. - Use in conjunction with I(kind), I(name), and I(namespace) to identify a specific object. type: str client_cert: aliases: - cert_file description: - Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable. type: path wait_timeout: default: 120 description: - How long in seconds to wait for the resource to end up in the desired state. - Ignored if C(wait) is not set. type: int proxy_headers: description: - The Header used for the HTTP proxy. - Documentation can be found here U(https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers). suboptions: basic_auth: description: - Colon-separated username:password for basic authentication header. - Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment. type: str proxy_basic_auth: description: - Colon-separated username:password for proxy basic authentication header. - Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment. type: str user_agent: description: - String representing the user-agent you want, such as foo/1.0. - Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment. type: str type: dict version_added: 2.0.0 version_added_collection: kubernetes.core persist_config: description: - Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable. - When the k8s context is using a user credentials with refresh tokens (like oidc or gke/gcloud auth), the token is refreshed by the k8s python client library but not saved by default. So the old refresh token can expire and the next auth might fail. Setting this flag to true will tell the k8s python client to save the new refresh token to the kube config file. - Default to false. - Please note that the current version of the k8s python client library does not support setting this flag to True yet. - 'The fix for this k8s python library is here: https://github.com/kubernetes-client/python-base/pull/169' type: bool validate_certs: aliases: - verify_ssl description: - Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable. type: bool wait_condition: description: - Specifies a custom condition on the status to wait for. - Ignored if C(wait) is not set or is set to False. suboptions: reason: description: - The value of the reason field in your desired condition - For example, if a C(Deployment) is paused, The C(Progressing) C(type) will have the C(DeploymentPaused) reason. - The possible reasons in a condition are specific to each resource type in Kubernetes. - See the API documentation of the status field for a given resource to see possible choices. type: str status: choices: - 'True' - 'False' - Unknown default: 'True' description: - The value of the status field in your desired condition. - For example, if a C(Deployment) is paused, the C(Progressing) C(type) will have the C(Unknown) status. type: str type: description: - The type of condition to wait for. - For example, the C(Pod) resource will set the C(Ready) condition (among others). - Required if you are specifying a C(wait_condition). - If left empty, the C(wait_condition) field will be ignored. - The possible types for a condition are specific to each resource type in Kubernetes. - See the API documentation of the status field for a given resource to see possible choices. type: str type: dict impersonate_user: description: - Username to impersonate for the operation. - Can also be specified via K8S_AUTH_IMPERSONATE_USER environment. type: str version_added: 2.3.0 version_added_collection: kubernetes.core impersonate_groups: description: - Group(s) to impersonate for the operation. - 'Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2' elements: str type: list version_added: 2.3.0 version_added_collection: kubernetes.core
duration: description: Elapsed time of task in seconds. returned: when C(wait) is true sample: 48 type: int error: description: The error when patching the object. returned: error sample: exception: 'Traceback (most recent call last): ...' msg: Failed to import the required Python library (jsonpatch) ... type: dict result: contains: api_version: description: The versioned schema of this representation of an object. returned: success type: str kind: description: The REST resource this object represents. returned: success type: str metadata: description: Standard object metadata. Includes name, namespace, annotations, labels, etc. returned: success type: dict spec: description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind). returned: success type: dict status: description: Current status details for the object. returned: success type: dict description: The modified object. returned: success type: dict