mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-11-21 22:50:20 +00:00
* Support for metadata-only fetches in k8s_info module
* Fix integration test assert
* Add missing changelog fragment
* Fix linters and sanity checks
* Fix linters
* Apply suggestion from @abikouo
* fix: resolve linter errors after rebase
Fix import sorting and apply black formatting to k8s_info.py and
args_common.py to pass tox -e linters.
---------
(cherry picked from commit 08a761fc17)
Co-authored-by: Federico Chiacchiaretta <federico.chia@gmail.com>
Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>
Co-authored-by: aubin bikouo <abikouo@redhat.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
162 lines
4.7 KiB
Python
162 lines
4.7 KiB
Python
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
import warnings
|
|
|
|
|
|
def list_dict_str(value):
|
|
if isinstance(value, (list, dict, str)):
|
|
return value
|
|
raise TypeError
|
|
|
|
|
|
def extract_sensitive_values_from_kubeconfig(kubeconfig_data):
|
|
"""
|
|
Extract only sensitive string values from kubeconfig data for no_log_values.
|
|
|
|
:arg kubeconfig_data: Dictionary containing kubeconfig data
|
|
:returns: Set of sensitive string values to be added to no_log_values
|
|
"""
|
|
values = set()
|
|
sensitive_fields = {
|
|
"token",
|
|
"password",
|
|
"secret",
|
|
"client-key-data",
|
|
"client-certificate-data",
|
|
"certificate-authority-data",
|
|
"api_key",
|
|
"access-token",
|
|
"refresh-token",
|
|
}
|
|
|
|
# Check API version and warn if not v1
|
|
if isinstance(kubeconfig_data, dict):
|
|
api_version = kubeconfig_data.get("apiVersion", "v1")
|
|
if api_version != "v1":
|
|
warnings.warn(
|
|
f"Kubeconfig API version '{api_version}' is not 'v1'. "
|
|
f"Sensitive field redaction is only guaranteed for API version 'v1'. "
|
|
f"Some sensitive data may not be properly redacted from the logs.",
|
|
UserWarning,
|
|
)
|
|
|
|
def _extract_recursive(data, current_path=""):
|
|
if isinstance(data, dict):
|
|
for key, value in data.items():
|
|
path = f"{current_path}.{key}" if current_path else key
|
|
if key in sensitive_fields:
|
|
if isinstance(value, str):
|
|
values.add(value)
|
|
else:
|
|
_extract_recursive(value, path)
|
|
elif isinstance(data, list):
|
|
for i, item in enumerate(data):
|
|
_extract_recursive(item, f"{current_path}[{i}]")
|
|
|
|
_extract_recursive(kubeconfig_data)
|
|
return values
|
|
|
|
|
|
AUTH_PROXY_HEADERS_SPEC = dict(
|
|
proxy_basic_auth=dict(type="str", no_log=True),
|
|
basic_auth=dict(type="str", no_log=True),
|
|
user_agent=dict(type="str"),
|
|
)
|
|
|
|
AUTH_ARG_SPEC = {
|
|
"kubeconfig": {"type": "raw"},
|
|
"context": {},
|
|
"host": {},
|
|
"api_key": {"no_log": True},
|
|
"username": {},
|
|
"password": {"no_log": True},
|
|
"validate_certs": {"type": "bool", "aliases": ["verify_ssl"]},
|
|
"ca_cert": {"type": "path", "aliases": ["ssl_ca_cert"]},
|
|
"client_cert": {"type": "path", "aliases": ["cert_file"]},
|
|
"client_key": {"type": "path", "aliases": ["key_file"]},
|
|
"proxy": {"type": "str"},
|
|
"no_proxy": {"type": "str"},
|
|
"proxy_headers": {"type": "dict", "options": AUTH_PROXY_HEADERS_SPEC},
|
|
"persist_config": {"type": "bool"},
|
|
"impersonate_user": {},
|
|
"impersonate_groups": {"type": "list", "elements": "str"},
|
|
}
|
|
|
|
WAIT_ARG_SPEC = dict(
|
|
wait=dict(type="bool", default=False),
|
|
wait_sleep=dict(type="int", default=5),
|
|
wait_timeout=dict(type="int", default=120),
|
|
wait_condition=dict(
|
|
type="dict",
|
|
default=None,
|
|
options=dict(
|
|
type=dict(),
|
|
status=dict(default=True, choices=[True, False, "Unknown"]),
|
|
reason=dict(),
|
|
),
|
|
),
|
|
)
|
|
|
|
# Map kubernetes-client parameters to ansible parameters
|
|
AUTH_ARG_MAP = {
|
|
"kubeconfig": "kubeconfig",
|
|
"context": "context",
|
|
"host": "host",
|
|
"api_key": "api_key",
|
|
"username": "username",
|
|
"password": "password",
|
|
"verify_ssl": "validate_certs",
|
|
"ssl_ca_cert": "ca_cert",
|
|
"cert_file": "client_cert",
|
|
"key_file": "client_key",
|
|
"proxy": "proxy",
|
|
"no_proxy": "no_proxy",
|
|
"proxy_headers": "proxy_headers",
|
|
"persist_config": "persist_config",
|
|
}
|
|
|
|
NAME_ARG_SPEC = {
|
|
"kind": {},
|
|
"name": {},
|
|
"namespace": {},
|
|
"api_version": {"default": "v1", "aliases": ["api", "version"]},
|
|
}
|
|
|
|
COMMON_ARG_SPEC = {
|
|
"state": {"default": "present", "choices": ["present", "absent"]},
|
|
"force": {"type": "bool", "default": False},
|
|
}
|
|
|
|
RESOURCE_ARG_SPEC = {
|
|
"resource_definition": {"type": list_dict_str, "aliases": ["definition", "inline"]},
|
|
"src": {"type": "path"},
|
|
}
|
|
|
|
ARG_ATTRIBUTES_BLACKLIST = ("property_path",)
|
|
|
|
DELETE_OPTS_ARG_SPEC = {
|
|
"propagationPolicy": {"choices": ["Foreground", "Background", "Orphan"]},
|
|
"gracePeriodSeconds": {"type": "int"},
|
|
"preconditions": {
|
|
"type": "dict",
|
|
"options": {"resourceVersion": {"type": "str"}, "uid": {"type": "str"}},
|
|
},
|
|
}
|
|
|
|
METADATA_ONLY_HEADERS_SPEC = {
|
|
"accept": {"type": "str"},
|
|
}
|
|
|
|
METADATA_ONLY_HEADER_VALUES = {
|
|
"partial_object": (
|
|
"application/json;as=PartialObjectMetadata;g=meta.k8s.io;v=v1,"
|
|
"application/json;q=0.9"
|
|
),
|
|
"partial_object_list": (
|
|
"application/json;as=PartialObjectMetadataList;g=meta.k8s.io;v=v1,"
|
|
"application/json;q=0.9"
|
|
),
|
|
}
|