Um cluster do Google Kubernetes Engine (GKE) consiste em um plano de controle e máquinas de worker chamadas nós. É possível executar as cargas de trabalho conteinerizadas do Kubernetes em um cluster do GKE. Os nós são as máquinas de worker que executam seus aplicativos conteinerizados e outras cargas de trabalho, e o plano de controle é o endpoint unificado do seu cluster. Para mais informações, consulte Arquitetura de clusters do GKE.
O servidor da API Kubernetes é executado no plano de controle, permitindo que você interaja com os objetos do Kubernetes no cluster por meio de chamadas da API Kubernetes. Os objetos são entidades persistentes no sistema Kubernetes e representam o estado do cluster. Para mais informações, na documentação do Kubernetes, consulte Objetos no Kubernetes e a Visão geral da API, que está vinculada às páginas de "Referência da API Kubernetes".
Neste documento, mostramos como usar o conector da API Kubernetes em um fluxo de trabalho para fazer solicitações ao endpoint de serviço do Kubernetes hospedado no plano de controle de um cluster do GKE. Por exemplo, é possível usar o conector para criar implantações do Kubernetes, executar jobs, gerenciar pods ou acessar aplicativos implantados por meio de um proxy. Para mais informações, consulte a Visão geral do conector da API Kubernetes.
Antes de começar
Antes de prosseguir com as tarefas neste documento, verifique se você concluiu determinados pré-requisitos.
Ativar APIs
Antes de acessar os objetos da API Kubernetes usando o conector da API Kubernetes, é necessário ativar as seguintes APIs:
- API Google Kubernetes Engine: para criar e gerenciar aplicativos baseados em contêineres usando o GKE
APIs Workflows: para gerenciar definições e execuções de fluxo de trabalho. Ativar a API Workflows ativa automaticamente a API Workflow Executions.
Console
Ative as APIs:
gcloud
No Console do Google Cloud, ative o Cloud Shell.
Na parte inferior do Console do Google Cloud, uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.
Ative as APIs:
gcloud services enable container.googleapis.com workflows.googleapis.com
Crie uma conta de serviço
Crie uma conta de serviço gerenciada pelo usuário que
aja como a identidade do seu fluxo de trabalho e conceda a ela o papel
Desenvolvedor do Kubernetes Engine
(roles/container.developer
) para que o fluxo de trabalho possa acessar objetos da API Kubernetes
dentro de clusters.
Console
No console do Google Cloud, acesse a página Contas de serviço.
Selecione um projeto e clique em Criar conta de serviço.
No campo Nome da conta de serviço, insira um nome. O console do Google Cloud preenche o campo ID da conta de serviço com base nesse nome.
No campo Descrição da conta de serviço, insira uma descrição. Por exemplo,
Service account for Kubernetes API
.Clique em Criar e continuar.
Na lista Selecionar um papel, filtre e selecione o papel Desenvolvedor do Kubernetes Engine.
Clique em Continuar.
Para concluir a criação da conta, clique em Concluído.
gcloud
Crie a conta de serviço:
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
Substitua
SERVICE_ACCOUNT_NAME
pelo nome da conta de serviço.Atribua o papel
container.developer
à conta de usuário:gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \ --role=roles/container.developer
Substitua o
PROJECT_ID
pelo ID do projeto do Google Cloud.
Observe que é possível usar o IAM e o controle de acesso baseado em papéis (RBAC, na sigla em inglês) do Kubernetes para controlar o acesso ao cluster do GKE:
O IAM não é específico do Kubernetes. Ele fornece gerenciamento de identidade para vários produtos do Google Cloud e opera principalmente no nível do projeto do Google Cloud.
O RBAC do Kubernetes é um componente principal do Kubernetes e permite criar e conceder papéis (conjuntos de permissões) para qualquer objeto ou tipo de objeto dentro do cluster. Se você usa principalmente o GKE e precisa de permissões refinadas para cada objeto e operação no cluster, o RBAC do Kubernetes é a melhor escolha.
Para mais informações, consulte Controle de acesso.
Crie um cluster do GKE
Para usar o conector da API Kubernetes, você já precisa ter criado um cluster público ou particular do GKE. Em um cluster particular, os nós têm apenas endereços IP internos, o que significa que os nós e os pods são isolados da Internet por padrão. Para mais informações, consulte Clusters particulares.
Também é possível especificar o modo de operação que oferece diferentes níveis de flexibilidade, responsabilidade e controle. Por exemplo, é possível criar um cluster do Autopilot, um modo de operação no GKE em que o Google gerencia a configuração do cluster, incluindo nós, escalonamento, segurança e outras configurações predefinidas. Para mais informações, acesse Escolher um modo de operação do GKE.
Se você ainda não criou um cluster do GKE, é possível implantar um aplicativo conteinerizado de servidor da Web em um cluster do GKE. Ou, para testar as instruções deste documento, crie um cluster do Autopilot seguindo estas instruções.
Console
No Console do Google Cloud, acesse a página de clusters do Kubernetes.
Clique em add_box Criar.
Se for solicitado que você selecione um modo de cluster, escolha Autopilot.
Na seção Princípios básicos do cluster, conclua o seguinte:
- Digite o Nome do cluster, como
hello-cluster
. - Selecione uma região para o
cluster, como
us-central1
.
- Digite o Nome do cluster, como
Clique em Próximo: rede.
Na seção Acesso à rede IPv4, para criar um cluster com um endpoint acessível publicamente, escolha Cluster público.
Para todas as outras configurações, aceite os padrões.
Clique em Criar.
A criação do cluster pode levar vários minutos para ser concluída. Depois que o cluster for criado, uma marca de seleção
indicará que ele está em execução.gcloud
Execute este comando:
gcloud container clusters create-auto CLUSTER_NAME \ --location=LOCATION \ --project=PROJECT_ID
Substitua:
CLUSTER_NAME
: o nome do seu cluster do GKE, comohello-cluster
LOCATION
: a região do cluster, comous-central1
PROJECT_ID
: o ID do projeto do Google Cloud
A criação do cluster pode levar vários minutos para ser concluída. Depois que o cluster é criado, a saída fica mais ou menos assim:
Creating cluster hello-cluster...done.
Created [https://container.googleapis.com/v1/projects/MY_PROJECT
/zones/us-central1/clusters/hello-cluster].
[...]
STATUS: RUNNING
Usar o conector para enviar uma solicitação HTTP
Use o conector da API Kubernetes para enviar uma solicitação HTTP ao
plano de controle de um cluster do GKE. Por exemplo, o fluxo de trabalho a seguir
cria uma implantação chamada nginx-deployment
no cluster do Kubernetes
especificado. A implantação descreve um estado necessário. Neste caso, para executar três pods com a imagem nginx:1.14.2
e expor o serviço na porta 80. Se não
especificado, project
e location
assumem como padrão o fluxo de trabalho.
Para mais informações, consulte a página de referência da função do conector da API Kubernetes, gke.request.
Observações:
- O campo
path
corresponde ao caminho do método da API Kubernetes. Para mais informações, na documentação do Kubernetes, consulte a Visão geral da API, que inclui links para as páginas de referência da API Kubernetes. - É possível identificar e processar erros de solicitação HTTP no seu fluxo de trabalho. Para mais informações, consulte Erros de fluxo de trabalho.
Implantar seu fluxo de trabalho
Antes de executar um fluxo de trabalho, você precisa criá-lo e implantá-lo.
Console
No console do Google Cloud, abra a página Workflows.
Clique em
Criar.Insira um nome para o novo fluxo de trabalho, como
kubernetes-api-request
.Na lista Região, selecione us-central1.
Selecione a conta de serviço que você criou anteriormente.
Clique em Próxima.
No editor de fluxo de trabalho, insira a seguinte definição para seu fluxo de trabalho:
YAML
JSON
Substitua:
CLUSTER_NAME
: o nome do seu cluster do GKE, comohello-cluster
PROJECT_ID
: o ID do projeto do Google CloudLOCATION
: a região do cluster, comous-central1
Selecione Implantar.
gcloud
Crie um arquivo de código-fonte para seu fluxo de trabalho:
touch kubernetes-api-request.JSON_OR_YAML
Substitua
JSON_OR_YAML
poryaml
oujson
, dependendo do formato do seu fluxo de trabalho.Em um editor de texto, copie o fluxo de trabalho a seguir para seu arquivo de código-fonte:
YAML
JSON
Substitua:
CLUSTER_NAME
: o nome do seu cluster do GKE, comohello-cluster
LOCATION
: a região do cluster, comous-central1
Implante o fluxo de trabalho:
gcloud workflows deploy kubernetes-api-request \ --source=kubernetes-api-request.
JSON_OR_YAML
\ --location=LOCATION
\ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Executar o fluxo de trabalho
Depois de implantar seu fluxo de trabalho, é possível executá-lo. A execução de um fluxo de trabalho também executa a definição atual associada a ele.
Console
No console do Google Cloud, abra a página Workflows.
Na página Fluxos de trabalho, selecione seu fluxo de trabalho para acessar a página de detalhes dele.
Na página Detalhes do fluxo de trabalho, clique em play_arrow Executar.
Clique em Executar novamente.
Veja os resultados do fluxo de trabalho no painel Saída.
Se bem-sucedido, o estado de execução será
Succeeded
e o corpo da resposta será retornado.
gcloud
Execute o fluxo de trabalho:
gcloud workflows run kubernetes-api-request \ --location=LOCATION
Se bem-sucedido, o estado será SUCCEEDED
e o corpo da resposta
será retornado.
Usar o conector para executar um job do Kubernetes
É possível usar o conector da API Kubernetes para implantar e executar um job do Kubernetes em um cluster do GKE. O fluxo de trabalho a seguir cria um job do Kubernetes que executa um script Bash que itera por meio de uma sequência de números. O fluxo de trabalho aguarda até 90 segundos para que o job do Kubernetes seja concluído. Caso contrário, será gerado um erro. Se o job for concluído, ele será excluído.
Um job é considerado concluído quando o status inclui um tipo de condição Complete
. Exemplo:
"status": { "conditions": [ { "type": "Complete", "status": "True" } ] }
Se o job falhar, uma tag FailedJobError
será retornada. Exemplo:
{ "tags": ["FailedJobError"] "job": {...} "message":"Kubernetes job failed" }
Para mais informações, consulte as páginas de referência das seguintes funções do conector da API Kubernetes:
Implantar seu fluxo de trabalho
Antes de executar um fluxo de trabalho, você precisa criá-lo e implantá-lo.
Console
No console do Google Cloud, abra a página Workflows.
Clique em
Criar.Insira um nome para o novo fluxo de trabalho, como
kubernetes-api-job
.Na lista Região, selecione us-central1.
Selecione a conta de serviço que você criou anteriormente.
Clique em Próxima.
No editor de fluxo de trabalho, insira a seguinte definição para seu fluxo de trabalho:
YAML
JSON
Substitua:
LOCATION
: a região do cluster, comous-central1
CLUSTER_NAME
: o nome do seu cluster do GKE, comohello-cluster
JOB_NAME
: o nome do job do Kubernetes, comohello-job
Selecione Implantar.
gcloud
Crie um arquivo de código-fonte para seu fluxo de trabalho:
touch kubernetes-api-job.JSON_OR_YAML
Substitua
JSON_OR_YAML
poryaml
oujson
, dependendo do formato do seu fluxo de trabalho.Em um editor de texto, copie o fluxo de trabalho a seguir para seu arquivo de código-fonte:
YAML
JSON
Substitua:
LOCATION
: a região do cluster, comous-central1
CLUSTER_NAME
: o nome do seu cluster do GKE, comohello-cluster
JOB_NAME
: o nome do job do Kubernetes, comohello-job
Implante o fluxo de trabalho:
gcloud workflows deploy kubernetes-api-job \ --source=kubernetes-api-job.
JSON_OR_YAML
\ --location=LOCATION
\ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Executar o fluxo de trabalho
Depois de implantar seu fluxo de trabalho, é possível executá-lo. A execução de um fluxo de trabalho também executa a definição atual associada a ele.
Console
No console do Google Cloud, abra a página Workflows.
Na página Fluxos de trabalho, selecione seu fluxo de trabalho para acessar a página de detalhes dele.
Na página Detalhes do fluxo de trabalho, clique em play_arrow Executar.
Clique em Executar novamente.
A execução do fluxo de trabalho pode levar alguns minutos.
Veja os resultados do fluxo de trabalho no painel Saída.
Os resultados serão semelhantes aos mostrados a seguir:
{ ... }, "status": { "completionTime": "2023-10-31T17:04:32Z", "conditions": [ { "lastProbeTime": "2023-10-31T17:04:33Z", "lastTransitionTime": "2023-10-31T17:04:33Z", "status": "True", "type": "Complete" } ], "ready": 0, "startTime": "2023-10-31T17:04:28Z", "succeeded": 1, "uncountedTerminatedPods": {} } }
gcloud
Execute o fluxo de trabalho:
gcloud workflows run kubernetes-api-job \ --location=LOCATION
A execução do fluxo de trabalho pode levar alguns minutos. Os resultados serão semelhantes aos seguintes:
{
...
},
"status": {
"completionTime": "2023-10-31T17:04:32Z",
"conditions": [
{
"lastProbeTime": "2023-10-31T17:04:33Z",
"lastTransitionTime": "2023-10-31T17:04:33Z",
"status": "True",
"type": "Complete"
}
],
"ready": 0,
"startTime": "2023-10-31T17:04:28Z",
"succeeded": 1,
"uncountedTerminatedPods": {}
}
}