--- title: Kubervirt Auth Options slug: homologacao-atmosphere/kubervirt-auth-options description: This document outlines essential parameters for accessing an API, covering host URL, API key, authentication details, certificate paths, SSL validation, proxy settings, and kube configuration persistence. It also delves into subfields like proxy headers, docTags: createdAt: 2021-09-17T18:35:24.000Z --- ## ## Parâmetros | **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários** | | ----------------------------------------------- | -------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | host | string | | Forneça um URL para acessar a API. Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_HOST. | | api\_key | string | | Token usado para autenticação com a API. Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_API\_KEY. | | kubeconfig | path | | Caminho para um arquivo de configuração Kubernetes existente.

Se não for fornecido, e nenhuma outra conexão opções forem fornecidas, o cliente Kubernetes tentará carregar o padrão arquivo de configuração de I (\~/.kube/config).

Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_KUBECONFIG. | | context | string | | O nome de um contexto encontrado no arquivo de configuração.

Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_CONTEXT. | | username | string | | Forneça um nome de usuário para autenticação com a API. Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_USERNAME.

Observe que isso só funciona com clusters configurados para usar HTTP Basic Auth. Se seu cluster tiver uma forma diferente de autenticação (por exemplo, OAuth2 em OpenShift), esta opção não funcionará como esperado e você deve olhar para o módulo M (community.okd.k8s\_auth), pois ele pode fazer o que você precisa. | | password | string | | - Forneça uma senha para autenticação com a API. Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_PASSWORD.

- Leia a descrição da opção C (username) para ver uma discussão sobre quando essa opção é aplicável. | | client\_cert

aliases: cert\_file | path | | Caminho para um certificado usado para autenticação com a API. Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_CERT\_FILE. | | client\_key

aliases: key\_file | path | | Caminho para um arquivo de chave usado para autenticação com a API. Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_KEY\_FILE. | | ca\_cert

aliases: ssl\_ca\_cert | path | | Path para um certificado CA usado para autenticar com a API. A cadeia de certificação completa deve ser fornecida para evitar erros de validação de certificado. Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_SSL\_CA\_CERT. | | validate\_certs

aliases: verify\_ssl | boolean | Escolhas:
- true
- false | Se deve ou não verificar os certificados SSL do servidor API. Também pode ser especificado por meio da variável de ambiente K8S\_AUTH VERIFY\_SSL. | | proxy | string | | O URL de um proxy HTTP a ser usado para a conexão. Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_PROXY.

Observe que este módulo não coleta configurações de proxy típicas do ambiente (por exemplo, HTTP\_PROXY). | | proxy\_headers | dict | | O cabeçalho usado para o proxy HTTP. | | persist\_config | boolean | Escolhas:
- true
- false(default) | Se deve ou não salvar os tokens de atualização de configuração do kube.

Também pode ser especificado por meio da variável de ambiente K8S\_AUTH\_PERSIST\_CONFIG.

Quando o contexto k8s está usando credenciais de usuário com tokens de atualização (como oidc ou gke / gcloud auth), o token é atualizado pela biblioteca cliente python k8s, mas não é salvo por padrão. Portanto, o token de atualização antigo pode expirar e a próxima autenticação pode falhar. Definir este sinalizador como verdadeiro dirá ao cliente python k8s para salvar o novo token de atualização no arquivo de configuração do kube.

- Observe que a versão atual da biblioteca cliente python k8s ainda não suporta a configuração deste sinalizador como Verdadeiro.

- "A correção para esta biblioteca python k8s está aqui: https\://github.com/kubernetes-client/python-base/pull/169" | ### Subcampos da opção proxy\_headers | **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários** | | ------------------ | -------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | proxy\_basic\_auth | string | | Nome de usuário separado por dois pontos: senha para o cabeçalho de autenticação básica do proxy.

Também pode ser especificado por meio do ambiente K8S\_AUTH\_PROXY\_HEADERS\_PROXY\_BASIC\_AUTH. | | basic\_auth | string | | Nome de usuário separado por dois pontos: senha para cabeçalho de autenticação básica.

Também pode ser especificado por meio do ambiente K8S\_AUTH\_PROXY\_HEADERS\_BASIC\_AUTH. | | user\_agent | string | | String que representa o agente do usuário que você deseja, como foo / 1.0.

Também pode ser especificado por meio do ambiente K8S\_AUTH\_PROXY\_HEADERS\_USER\_AGENT. |