YAML da ação “Implantar no cluster do Kubernetes” - Amazon CodeCatalyst

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

YAML da ação “Implantar no cluster do Kubernetes”

Confira a seguir a definição de YAML da ação Implantar no cluster do Kubernetes. Para saber como usar essa ação, consulte Implantar no Amazon EKS com um fluxo de trabalho.

Essa definição de ação existe como uma seção dentro de um arquivo de definição de fluxo de trabalho mais amplo. Para obter mais informações sobre esse arquivo, consulte Definição do YAML do fluxo de trabalho.

nota

A maioria das propriedades YAML a seguir tem elementos de interface de usuário correspondentes no editor visual. Para pesquisar um elemento de interface, use Ctrl+F. O elemento será listado com a propriedade YAML associada.

# The workflow definition starts here. # See Propriedades de nível superior for details. Name: MyWorkflow SchemaVersion: 1.0 Actions: # The action definition starts here. DeployToKubernetesCluster_nn: Identifier: aws/kubernetes-deploy@v1 DependsOn: - build-action Compute: - Type: EC2 | Lambda - Fleet: fleet-name Timeout: timeout-minutes Environment: Name: environment-name Connections: - Name: account-connection-name Role: DeployToEKS Inputs: # Specify a source or an artifact, but not both. Sources: - source-name-1 Artifacts: - manifest-artifact Configuration: Namespace: namespace Region: us-east-1 Cluster: eks-cluster Manifests: manifest-path

DeployToKubernetesCluster

(Obrigatório)

Especifique o nome da ação. Todos os nomes de ação devem ser exclusivos no fluxo de trabalho. Os nomes de ação são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hifens (-) e sublinhados (_). Não são permitidos espaços. Não é possível usar aspas para habilitar caracteres especiais e espaços nos nomes de ação.

Padrão: DeployToKubernetesCluster_nn.

Interface de usuário correspondente: guia Configuração/Nome de exibição da ação

Identifier

(DeployToKubernetesCluster/Identifier)

(Obrigatório)

Identifica a ação. Não altere essa propriedade, a menos que você queira alterar a versão. Para ter mais informações, consulte Especificação da versão da ação a ser usada.

Padrão: aws/kubernetes-deploy@v1.

Interface de usuário correspondente: Diagrama de fluxo de trabalho/DeployToKubernetesCluster_nn/rótulo aws/kubernetes-deploy@v1

DependsOn

(DeployToKubernetesCluster/DependsOn)

(Opcional)

Especifique uma ação, um grupo de ação ou um portão que deve ser executado com êxito para que essa ação seja executada.

Para ter mais informações sobre a funcionalidade “Depende de”, consulte Sequenciar ações.

Interface de usuário correspondente: guia Entradas/Depende de - opcional

Compute

(DeployToKubernetesCluster/Compute)

(Opcional)

O mecanismo de computação usado para executar as ações de fluxo de trabalho. É possível especificar a computação em nível de fluxo de trabalho ou em nível de ação, mas não em ambos. Quando especificada em nível de fluxo de trabalho, a configuração de computação se aplica a todas as ações definidas no fluxo de trabalho. Em nível de fluxo de trabalho, também é possível realizar várias ações na mesma instância. Para ter mais informações, consulte Compartilhamento de computação entre ações.

Interface de usuário correspondente: nenhuma

Type

(DeployToKubernetesCluster/Compute/Type)

(Obrigatório se Compute for incluído)

O tipo do mecanismo de computação. É possível usar um dos seguintes valores:

  • EC2 (editor visual) ou EC2 (editor YAML)

    Otimizado para flexibilidade durante as execuções de ação.

  • Lambda (editor visual) ou Lambda (editor YAML)

    Velocidades otimizadas de inicialização da ação.

Para obter informações sobre tipos de dados, consulte Tipos de computação.

Interface de usuário correspondente: guia Configuração/Avançado - opcional/Tipo de computação

Fleet

(DeployToKubernetesCluster/Compute/Fleet)

(Opcional)

Especifique a máquina ou a frota que executará o fluxo de trabalho ou as ações de fluxo de trabalho. Com frotas sob demanda, quando uma ação é iniciada, o fluxo de trabalho provisiona os recursos necessários e as máquinas são destruídas quando a ação termina. Exemplos de frota sob demanda: Linux.x86-64.Large, Linux.x86-64.XLarge. Para ter mais informações sobre frotas sob demanda, consulte Propriedades da frota sob demanda.

Com frotas provisionadas, você configura um conjunto de máquinas dedicadas para realizar as ações do fluxo de trabalho. Essas máquinas permanecem ociosas, prontas para processar ações imediatamente. Para ter mais informações sobre frotas provisionadas, consulte Propriedades da frota provisionada.

Se Fleet for omitido, o padrão será Linux.x86-64.Large.

Interface de usuário correspondente: guia Configuração/Avançado - opcional/Frota de computação

Timeout

(DeployToKubernetesCluster/Timeout)

(Opcional)

Especifique a quantidade de tempo em minutos (editor YAML) ou horas e minutos (editor visual) que a ação pode ser realizada antes que o CodeCatalyst termine a ação. O mínimo é de cinco minutos e o máximo está descrito em Cotas para fluxos de trabalho em CodeCatalyst. O tempo limite padrão é igual ao tempo limite máximo.

Interface de usuário correspondente: guia Configuração/Tempo limite - opcional

Environment

(DeployToKubernetesCluster/Environment)

(Obrigatório)

Especifique o ambiente do CodeCatalyst a ser usado com a ação. A ação se conecta à Conta da AWS e à Amazon VPC opcional especificada no ambiente escolhido. A ação usa o perfil do IAM padrão especificado no ambiente para se conectar à Conta da AWS e usa o perfil do IAM especificado na conexão da Amazon VPC para se conectar à Amazon VPC.

nota

Se o perfil do IAM padrão não tiver as permissões exigidas pela ação, você poderá configurar a ação para usar um perfil diferente. Para ter mais informações, consulte Alteração do perfil do IAM de uma ação.

Para ter mais informações sobre ambientes, consulte Implantação em e Contas da AWS VPCs e Criar um ambiente.

Interface de usuário correspondente: guia Configuração/Ambiente

Name

(DeployToKubernetesCluster/Environment/Name)

(Obrigatório se Environment for incluído)

Especifique o nome de um ambiente existente que deseja associar à ação.

Interface de usuário correspondente: guia Configuração/Ambiente

Connections

(DeployToKubernetesCluster/Environment/Connections)

(Opcional nas versões mais recentes da ação; obrigatório nas versões mais antigas)

Especifique a conexão da conta a ser associada à ação. É possível especificar no máximo uma conexão de conta em Environment.

Se você não especificar uma conexão de conta:

  • A ação usa a conexão da Conta da AWS e o perfil do IAM padrão especificados no ambiente no console do CodeCatalyst. Para ter informações sobre como adicionar uma conexão de conta e um perfil do IAM padrão ao ambiente, consulte Criar um ambiente.

  • O perfil do IAM padrão deve incluir as políticas e as permissões exigidas pela ação. Para determinar quais são essas políticas e permissões, consulte a descrição da propriedade Perfil na documentação de definição de YAML da ação.

Para ter mais informações sobre conexões de conta, consulte Permitindo acesso a AWS recursos com conexão Contas da AWS. Para ter informações sobre como adicionar uma conexão de conta a um ambiente, consulte Criar um ambiente.

Interface de usuário correspondente: uma das seguintes, dependendo da versão da ação:

  • (Versões mais recentes) Guia Configuração/Ambiente/O que há no meu ambiente?/menu de três pontos/Mudar de perfil

  • (Versões mais antigas) Guia Configuração/”Ambiente/conta/perfil”/conexão de conta da AWS

Name

(DeployToKubernetesCluster/Environment/Connections/Name)

(Opcional)

Especifique o nome da conexão da conta.

Interface de usuário correspondente: uma das seguintes, dependendo da versão da ação:

  • (Versões mais recentes) Guia Configuração/Ambiente/O que há no meu ambiente?/menu de três pontos/Mudar de perfil

  • (Versões mais antigas) Guia Configuração/”Ambiente/conta/perfil”/conexão de conta da AWS

Role

(DeployToKubernetesCluster/Environment/Connections/Role)

(Obrigatório se Connections for incluído)

Especifique o nome do perfil do IAM que a ação Implantar no cluster do Kubernetes usa para acessar a AWS. Adicione o perfil ao seu espaço do CodeCatalyst e verifique se o perfil inclui as políticas a seguir.

Se você não especificar um perfil do IAM, a ação usará o perfil padrão listado no ambiente no console do CodeCatalyst. Se você usar o perfil padrão no ambiente, verifique se ele tem as políticas a seguir.

  • A política de permissões a seguir:

    Atenção

    Limite as permissões às exibidas na política a seguir. Usar um perfil com permissões mais amplas pode representar um risco de segurança.

    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "eks:DescribeCluster", "eks:ListClusters" ], "Resource": "*" } ] }
    nota

    Na primeira vez em que o perfil for usado, use o caractere curinga a seguir na declaração de política de recursos e defina o escopo da política com o nome do recurso depois que ele estiver disponível.

    "Resource": "*"
  • A política de confiança personalizada a seguir:

    { "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": [ "codecatalyst-runner.amazonaws.com", "codecatalyst.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] }

Esse perfil deve ser adicionado a:

dica

Consulte também Tutorial: Implantar uma aplicação no Amazon EKS para receber instruções sobre como adicionar um perfil do IAM a uma conexão de conta e ao ConfigMap.

nota

Você pode usar o perfil CodeCatalystWorkflowDevelopmentRole-spaceName com essa ação, se desejar. Para obter mais informações sobre essa função, consulte Criar o perfil CodeCatalystWorkflowDevelopmentRole-spaceName para a conta e o espaço. Entenda que o perfil CodeCatalystWorkflowDevelopmentRole-spaceName tem permissões de acesso completas, o que pode representar um risco de segurança. Recomendamos que você use esse perfil apenas em tutoriais e em cenários em que a segurança seja menos preocupante.

Interface de usuário correspondente: uma das seguintes, dependendo da versão da ação:

  • (Versões mais recentes) Guia Configuração/Ambiente/O que há no meu ambiente?/menu de três pontos/Mudar de perfil

  • (Versões mais antigas) Guia Configuração/“Ambiente/conta/perfil”/Perfil

Inputs

(DeployToKubernetesCluster/Inputs)

(Obrigatório se Connections for incluído)

A seção Inputs define os dados que DeployToKubernetesCluster precisa durante a execução de um fluxo de trabalho.

nota

Somente uma entrada (uma origem ou um artefato) é permitida por ação Implantar no Amazon EKS.

Interface de usuário correspondente: guia Entradas

Sources

(DeployToKubernetesCluster/Inputs/Sources)

(Obrigatório se o arquivo de manifesto estiver armazenado em um repositório de origem)

Se os arquivos de manifesto do Kubernetes estiverem armazenados em um repositório de origem, especifique o rótulo do repositório de origem. Atualmente, o único rótulo compatível é WorkflowSource.

Se os arquivos de manifesto não estiverem em um repositório de origem, eles deverão residir em um artefato gerado por outra ação.

Para obter mais informações sobre fontes, consulte Conectar repositórios de origem aos fluxos de trabalho.

Interface de usuário correspondente: guia Entradas/Origens - opcional

Artifacts - input

(DeployToKubernetesCluster/Inputs/Artifacts)

(Obrigatório se o arquivo de manifesto estiver armazenado em um artefato de saída de uma ação anterior)

Se os arquivos de manifesto do Kubernetes estiverem contidos em um artefato gerado por uma ação anterior, especifique esse artefato aqui. Se os arquivos de manifesto não estiverem em um artefato, eles deverão residir em seu repositório de origem.

Para ter mais informações sobre artefatos, inclusive exemplos, consulte Compartilhar artefatos e arquivos entre ações.

Interface de usuário correspondente: guia Configuração/Artefatos - opcional

Configuration

(DeployToKubernetesCluster/Configuration)

(Obrigatório)

Uma seção na qual você pode definir as propriedades de configuração da ação.

Interface de usuário correspondente: guia Configuração

Namespace

(DeployToKubernetesCluster/Configuration/Namespace)

(Opcional)

Especifique o namespace do Kubernetes no qual a aplicação Kubernetes será implantada. Use default se você não estiver usando namespaces com seu cluster. Para ter mais informações sobre namespaces, consulte Subdivisão do cluster usando namespaces do Kubernetes na documentação do Kubernetes.

Se você omitir o namespace, um valor de default será usado.

Interface de usuário correspondente: guia Configuração/Namespace

Region

(DeployToKubernetesCluster/Configuration/Region)

(Obrigatório)

Especifique a região da AWS em que o cluster e o serviço do Amazon EKS residem. Para ver uma lista de códigos de região, consulte Endpoints regionais na Referência geral da AWS.

Interface de usuário correspondente: guia Configuração/Região

Cluster

(DeployToKubernetesCluster/Configuration/Cluster)

(Obrigatório)

Especifique o nome de um cluster existente do Amazon EKS. A ação Implantar no cluster do Kubernetes implantará a aplicação em contêineres nesse cluster. Para ter informações sobre clusters do Amazon EKS, consulte Clusters no Guia do usuário do Amazon EKS.

Interface de usuário correspondente: guia Configuração/Cluster

Manifests

(DeployToKubernetesCluster/Configuration/Manifests)

(Obrigatório)

Especifique o caminho para seus arquivos de manifesto do Kubernetes formatados em YAML, que são chamados de arquivos de configuração ou, simplesmente, configurações na documentação do Kubernetes.

Se você estiver usando vários arquivos de manifesto, coloque-os em uma única pasta e faça referência a essa pasta. Os arquivos de manifesto são processados alfanumericamente pelo Kubernetes, portanto, prefixe os nomes dos arquivos com números ou letras crescentes para controlar a ordem de processamento. Por exemplo:

00-namespace.yaml

01-deployment.yaml

Se os arquivos de manifesto residirem em seu repositório de origem, o caminho é relativo à pasta raiz do repositório de origem. Se os arquivos residirem em um artefato de uma ação anterior do fluxo de trabalho, o caminho é relativo à pasta raiz do artefato.

Exemplos:

Manifests/

deployment.yaml

my-deployment.yml

Não use curingas (*).

nota

Os charts do Helm e os arquivos de personalização não são aceitos.

Para ter mais informações sobre os arquivos de manifesto, consulte Como organizar as configurações de recursos na documentação do Kubernetes.

Interface de usuário correspondente: guia Configuração/Manifestos