OpenShift Auth

7 min

Resumo

Este módulo lida com a autenticação em clusters OpenShift que requerem procedimentos de autenticação explícitos , ou seja, aqueles em que um cliente efetua login (obtém um token de autenticação), realiza operações de API usando o referido token e, em seguida, efetua logout (revoga o token).
Por outro lado, uma configuração popular para autenticação de nome de usuário + senha é aquela que utiliza HTTP Basic Auth, que não envolve nenhuma etapa adicional de login / logout (em vez disso, as credenciais de login podem ser anexadas a cada chamada de API realizada) e, como tal, é tratada diretamente pelo k8s módulo (e outros módulos específicos de recursos) utilizando os parâmetros host, username e password. Consulte a documentação do seu módulo preferido para obter mais detalhes.

Requisitos

Os requisitos abaixo são necessários no host que executa este módulo.

urllib3
solicitações de
request-oauthlib

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
api_key	string		Quando state está definido como absent , especifica o token a ser revogado.
ca_cert aliases: ssl_ca_cert	path		Caminho para um arquivo de certificado CA usado para verificar a conexão com o servidor API. A cadeia de certificação completa deve ser fornecida para evitar erros de validação de certificado.
host - required	string		Forneça um URL para acessar o servidor API.
password	string		Forneça uma senha para autenticação no servidor API.
state	string	Escolhas: - present - absent	Se configurado para apresentar, conecte-se ao servidor API usando a URL especificada em host e tente fazer login. Se definido como absent, tente fazer logout revogando o token de autenticação especificado em api_key.
username	string		Forneça um nome de usuário para autenticação no servidor API.
validate_certs aliases: verify_ssl	boolean	Escolhas: - false(default) - true	Se deve ou não verificar os certificados SSL do servidor API.

Exemplos

- hosts: localhost
  module_defaults:
    group/k8s:
      host: https://k8s.example.com/
      ca_cert: ca.pem
  tasks:
  - block:
    # É uma boa prática armazenar as credenciais de login em um cofre seguro e não diretamente nos manuais.
    - include_vars: openshift_passwords.yml
    - name: Faça login (obtenha o token de acesso)
      community.okd.openshift_auth:
        username: admin
        password: "{{ openshift_admin_password }}"
      register: openshift_auth_results
      
      
    # A tarefa anterior fornece o token / api_key, enquanto todos os outros parâmetros são obtidos de module_defaults
    - name: Obtenha uma lista de todos os pods de qualquer namespace
      kubernetes.core.k8s_info:
        api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
        kind: Pod
      register: pod_list
    always:
    - name: Se o login for bem-sucedido, tente sair (revogar o token de acesso)
      when: openshift_auth_results.openshift_auth.api_key está definido
      community.okd.openshift_auth:
        state: absent
        api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"

Valores Retornados

Chave	Tipo	Retornado quando	Descrição
k8s_auth	complex	sucesso	O mesmo que o openshift_auth retornado. Mantido apenas para compatibilidade com versões anteriores
openshift_auth	complex	sucesso	Fatos de autenticação do OpenShift.

Subcampos da chave de retorno k8s_auth

Chave	Tipo	Retornado quando	Descrição
api_key	string	sucesso	Token de autenticação.
ca_cert	string	sucesso	Caminho para um arquivo de certificado CA usado para verificar a conexão com o servidor API.
host	string	sucesso	URL para acessar o servidor API.
username	string	sucesso	Nome de usuário para autenticação no servidor API.
validate_certs	boolean	sucesso	Se deve ou não verificar os certificados SSL do servidor API.

Subcampos da chave de retorno openshift_auth

Chave	Tipo	Retornado quando	Descrição
api_key	string	sucesso	Token de autenticação.
ca_cert	string	sucesso	Caminho para um arquivo de certificado CA usado para verificar a conexão com o servidor API.
host	string	sucesso	URL para acessar o servidor API.
username	string	sucesso	Nome de usuário para autenticação no servidor API.
validate_certs	boolean	sucesso	Se deve ou não verificar os certificados SSL do servidor API.

OpenShift Auth

Resumo

Requisitos

Parâmetros

﻿Exemplos﻿﻿﻿

Valores Retornados

Subcampos da chave de retorno k8s_auth

Subcampos da chave de retorno openshift_auth

Exemplos