OpenShift Process
Resumo
- Processa um template OpenShift especificado com o template fornecido.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
name | string | | O nome do modelo a ser processado. O modelo deve estar presente no cluster. Quando fornecido, o namespace é obrigatório. Mutualmente exclusivo com resource_definition ou src. |
namespace | string | | Namespace em que o modelo pode ser encontrado. |
namespace_target | string | | Namespace em que os recursos devem ser criados, atualizados ou excluídos. Usado somente quando o estado está presente ou absent. |
parameter_file | string | | Um caminho para um arquivo contendo valores de parâmetro de modelo para substituir / definir valores em Template. Corresponds ao argumento --param-file para o processo oc. |
parameters | dictionary | | Um conjunto de pares chave: valor que será usado para definir / substituir valores no Template. Corresponds ao argumento --param para o processo oc. |
state | string | Escolhas: - absent - present - rendered (default) | Determina o que fazer com o Template renderizado. O estado renderizado renderizará o Template com base nos parâmetros fornecidos e retornará os objetos renderizados no campo de recursos. Eles podem ser referenciados em tarefas futuras. O estado present fará com que os recursos no modelo renderizado sejam criados, se ainda não existirem, e corrigidos, se existirem. O estado absent excluirá os recursos no modelo renderizado. |
Extende fragmentos da documentação dos módulos k8s_auth_options, k8s_wait_options e k8s_resource_options.
Exemplos
# Exemplo: Processe um template no cluster
- openshift_process:
name: nginx-example
namespace: openshift # only needed if using a template already on the server
parameters:
NAMESPACE: openshift
NAME: test123
state: rendered
register: result
# Exemplo: Crie os recursos renderizados usando aplicar
- k8s:
namespace: default
definition: '{{ item }}'
wait: yes
apply: yes
loop: '{{ result.resources }}'
# Exemplo: Processe um template com parâmetros de um arquivo env e crie os recursos
- openshift_process:
name: nginx-example
namespace: openshift
namespace_target: default
parameter_file: 'files/nginx.env'
state: present
wait: yes
# Exemplo: Processe um template local e crie os recursos
- openshift_process:
src: files/example-template.yaml
parameter_file: files/example.env
namespace_target: default
state: present
# Exemplo: Processe um template local, exclua os recursos e espere que eles sejam encerrados
- openshift_process:
src: files/example-template.yaml
parameter_file: files/example.env
namespace_target: default
state: absent
wait: yes
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
resources | complex | Sucesso quando o estado é rendered | Recursos renderizados definidos no template. |
result | complex | Sucesso quando o estado está present ou absent | Objeto criado, corrigido ou presente de outra forma. Estará vazio no caso de exclusão. |
Subcampos da chave de retorno resources
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
apiVersion | string | Sucesso | Esquema com versão desta representação de um objeto. |
kind | string | Sucesso | Representa o recurso REST que este objeto representa. |
metadata | complex | Sucesso | Metadados de objeto padrão. Inclui nome, namespace, anotações, rótulos, etc. |
spec | dictionary | Sucesso | Atributos específicos do objeto. Irá variar com base na api_version e no tipo. |
status | dictionary | Sucesso | Detalhes do status atual do objeto. |
Subcampos da chave de retorno result
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
apiVersion | string | Sucesso | Esquema com versão desta representação de um objeto. |
duration | integer | Quando wait é true | Tempo decorrido da tarefa em segundos. |
items | list / elements=string | Quando resource_definition ou src contém uma lista de objetos | Retornado apenas quando vários documentos yaml são passados para src ou resource_definition |
kind | string | Sucesso | Representa o recurso REST que este objeto representa. |
metadata | complex | Sucesso | Metadados de objeto padrão. Inclui nome, namespace, anotações, rótulos, etc. |
spec | dictionary | Sucesso | Atributos específicos do objeto. Irá variar com base na api_version e no tipo. |
status | complex | Sucesso | Detalhes do status atual do objeto. |