Nota

Este complemento es parte del colección kubernetes.core (versión 1.1.1).

Para instalarlo use: ansible-galaxy collection install kubernetes.core.

Para usarlo en un libro de jugadas, especifique: kubernetes.core.k8s.

  • Sinopsis
  • Requisitos
  • Parámetros
  • Notas
  • Ejemplos de
  • Valores devueltos

Sinopsis

  • Utiliza el cliente OpenShift Python para buscar un objeto específico por nombre, todos los objetos coincidentes dentro de un espacio de nombres o todos los objetos coincidentes para todos los espacios de nombres, así como información sobre el clúster.
  • Proporciona acceso a la gama completa de API de K8.
  • Habilita la autenticación mediante archivo de configuración, certificados, contraseña o token.

Requisitos

Los siguientes requisitos son necesarios en el nodo del controlador local que ejecuta esta búsqueda.

  • pitón> = 2.7
  • desplazamiento abierto> = 0,6
  • PyYAML> = 3,11

Parámetros

Parámetro Opciones / Valores predeterminados Configuración Comentarios
Clave APIstring Token utilizado para autenticarse con la API. También se puede especificar mediante la variable de entorno K8S_AUTH_API_KEY.
api_versionstring Defecto:
“v1”		 Úselo para especificar la versión de API. Si definición de recurso se proporciona, el apiVersion desde el resource_definition anulará esta opción.
ca_certstring Ruta a un certificado de CA utilizado para autenticarse con la API. También se puede especificar mediante la variable de entorno K8S_AUTH_SSL_CA_CERT.
alias: ssl_ca_cert
client_certstring Ruta a un certificado utilizado para autenticarse con la API. También se puede especificar mediante la variable de entorno K8S_AUTH_CERT_FILE.
alias: cert_file
clave_clientestring Camino a un key archivo utilizado para autenticarse con la API. También se puede especificar mediante la variable de entorno K8S_AUTH_KEY_FILE.
alias: key_file
cluster_infostring Úselo para especificar el tipo de información del clúster que está intentando recuperar. Tendrá prioridad sobre todas las demás opciones.
contextostring El nombre de un contexto que se encuentra en el archivo de configuración. También se puede especificar mediante la variable de entorno K8S_AUTH_CONTEXT.
field_selectorstring Campos específicos sobre los que realizar consultas. Ignorado cuando nombre del recurso está provisto.
anfitriónstring Proporcione una URL para acceder a la API. También se puede especificar mediante la variable de entorno K8S_AUTH_HOST.
amablestring / requerido Úselo para especificar un modelo de objeto. Si definición de recurso se proporciona, el amable a partir de una resource_definition anulará esta opción.
kubeconfigstring Ruta a un archivo de configuración de Kubernetes existente. Si no se proporciona, y no se proporcionan otras opciones de conexión, el cliente openshift intentará cargar el archivo de configuración predeterminado desde ~ / .kube / config.json. También se puede especificar mediante la variable de entorno K8S_AUTH_KUBECONFIG.
label_selectorstring Etiquetas adicionales para incluir en la consulta. Ignorado cuando nombre del recurso está provisto.
espacio de nombresstring Limite los objetos devueltos a un espacio de nombres específico. Si definición de recurso se proporciona, el metadata.namespace valor de la resource_definition anulará esta opción.
contraseñastring Proporcione una contraseña para autenticarse con la API. También se puede especificar mediante la variable de entorno K8S_AUTH_PASSWORD.
resource_definitionstring Proporcione una configuración YAML para un objeto. NOTA: amable, api_version, nombre del recurso, y espacio de nombres se sobrescribirán con los valores correspondientes que se encuentran en el resource_definition.
nombre del recursostring Busca un objeto específico por su nombre. Si definición de recurso se proporciona, el metadata.name valor de la resource_definition anulará esta opción.
srcstring Proporcione una ruta a un archivo que contenga una definición YAML válida de un objeto con fecha. Mutuamente excluyente con resource_definition. NOTA: amable, api_version, nombre del recurso, y espacio de nombres se sobrescribirán con los valores correspondientes que se encuentran en la configuración leída del src archivo. Lee del sistema de archivos local. Para leer desde el sistema de archivos del controlador Ansible, use el complemento de búsqueda de archivos o el complemento de búsqueda de plantillas, combinado con el filtro from_yaml, y pase el resultado a resource_definition. Vea los ejemplos a continuación.
nombre de usuariostring Proporcione un nombre de usuario para autenticarse con la API. También se puede especificar mediante la variable de entorno K8S_AUTH_USERNAME.
validate_certsbooleano
    Opciones:

  • no
  • sí
 Si verificar o no los certificados SSL del servidor API. También se puede especificar mediante la variable de entorno K8S_AUTH_VERIFY_SSL.
alias: verify_ssl

Notas

Nota

  • El cliente OpenShift Python envuelve el cliente Python de K8s, proporcionando acceso completo a todos los APIS y modelos disponibles en ambas plataformas. Para obtener detalles de la versión de API e información adicional, visite https://github.com/openshift/openshift-restclient-python

Ejemplos de

-name: Fetch a list of namespaces
  set_fact:projects:" lookup('kubernetes.core.k8s', api_version='v1', kind='Namespace') "-name: Fetch all deployments
  set_fact:deployments:" lookup('kubernetes.core.k8s', kind='Deployment') "-name: Fetch all deployments in a namespace
  set_fact:deployments:" lookup('kubernetes.core.k8s', kind='Deployment', namespace='testing') "-name: Fetch a specific deployment by name
  set_fact:deployments:" lookup('kubernetes.core.k8s', kind='Deployment', namespace='testing', resource_name='elastic') "-name: Fetch with label selector
  set_fact:service:" lookup('kubernetes.core.k8s', kind='Service', label_selector='app=galaxy') "# Use parameters from a YAML config-name: Load config from the Ansible controller filesystem
  set_fact:config:" lookup('file', 'service.yml') "-name: Using the config (loaded from a file in prior task), fetch the latest version of the object
  set_fact:service:" lookup('kubernetes.core.k8s', resource_definition=config) "-name: Use a config from the local filesystem
  set_fact:service:" lookup('kubernetes.core.k8s', src='service.yml') "

Valores devueltos

Los valores de retorno comunes están documentados aquí, los siguientes son los campos exclusivos de esta búsqueda:

Llave Devuelto Descripción
_listacomplejo éxito Una o más definiciones de objetos devueltas desde la API.
api_versionstring éxito El esquema versionado de esta representación de un objeto.
amablestring éxito Representa el recurso REST que representa este objeto.
metadatoscomplejo éxito Metadatos de objeto estándar. Incluye nombre, espacio de nombres, anotaciones, etiquetas, etc.
Especificacionescomplejo éxito Específico attributes del objeto. Variará según el api_version y amable.
estadocomplejo éxito Detalles del estado actual del objeto.