Terraform Explorer introduction - : Central de Documentação do Alibaba Cloud

Visão geral

Terraform Explorer é uma ferramenta fornecida pela Alibaba Cloud para depurar arquivos de configuração do Terraform online, com base no Terraform open source. O Terraform Explorer foi projetado para ajudar os desenvolvedores a simplificar os processos de escrita de arquivos de configuração e operação do Terraform, reduzindo a barreira de entrada para seu uso. Com o Terraform Explorer, os desenvolvedores podem preencher um formulário para gerar e converter automaticamente arquivos de configuração do Terraform, além de utilizar uma interface simples baseada em botões para executar o Terraform online.

Recursos

Arquivo de configuração do Terraform

Os arquivos de configuração do Terraform definem recursos de infraestrutura por meio de código. Escrever um arquivo de configuração do Terraform é o primeiro passo em um fluxo de trabalho de Infraestrutura como Código (IaC). Após definir os recursos necessários da Alibaba Cloud no arquivo de configuração, como instâncias do Elastic Compute Service (ECS) e do ApsaraDB RDS, bem como as dependências entre eles, o Terraform cria e configura automaticamente os recursos definidos com base nesse arquivo. Isso possibilita a implantação e a O&M automatizadas. O Terraform Explorer gera arquivos de configuração automaticamente e permite que os desenvolvedores editem esses arquivos online.

Categoria do recurso

Recurso

Descrição

Escrever um arquivo de configuração

Gerar automaticamente um arquivo de configuração

Após selecionar um serviço de nuvem e um tipo de recurso na página do Terraform Explorer no OpenAPI Explorer, clique em Initiate Debugging. O Terraform Explorer gera automaticamente um arquivo de configuração para o tipo de recurso selecionado. Em seguida, configure alguns ou todos os parâmetros no formulário à esquerda da página do Terraform Explorer para aprimorar continuamente o arquivo de configuração.

Editar um arquivo de configuração online

O Terraform Explorer fornece um ou mais modelos de exemplo para cada tipo de recurso. Caso não queira configurar muitos parâmetros ou deseje criar vários recursos de uma só vez, selecione um tipo de recurso e um modelo de exemplo. Os detalhes do modelo de exemplo serão exibidos. Depois, clique em Initiate Debugging.

Se o modelo de exemplo não atender às suas necessidades, ative a opção Edit no canto superior direito do modelo para adicionar conteúdo ou modificá-lo online. Após salvar o modelo, continue a depuração.

Executar o Terraform online

Em um fluxo de trabalho do Terraform, após escrever um arquivo de configuração, é necessário inicializar o diretório de trabalho do Terraform e, em seguida, visualizar e executar um plano de execução. Na página do Terraform Explorer no OpenAPI Explorer, implemente um fluxo de trabalho do Terraform executando uma tarefa de depuração. Sempre que executar uma tarefa de depuração, realize as etapas de inicialização, visualização e execução em sequência.

Categoria do recurso	Recurso	Descrição
Executar um arquivo de configuração	Inicializar o diretório de trabalho do Terraform online	Antes de visualizar e executar um plano de execução no Terraform Explorer, inicialize o diretório de trabalho do Terraform.
	Visualizar um plano de execução online	Ao clicar em Plan, o Terraform Explorer cria uma tarefa de depuração ou executa os comandos `terraform init` e `terraform plan` em sequência dentro de uma tarefa de depuração existente. Um plano de execução do Terraform é gerado e seus detalhes são exibidos na aba Apply Details. Visualize o plano de execução e, em seguida, execute-o ou aborte sua execução.
	Executar o plano de execução online	Se o plano de execução atender às suas expectativas, clique em Apply para executá-lo. O Terraform Explorer executa o comando `terraform apply` para criar ou alterar o recurso definido no plano de execução. Ao clicar em Plan & Apply, o Terraform Explorer executa automaticamente o plano de execução gerado sem confirmação manual. Ou seja, o Terraform Explorer roda os comandos `terraform init`, `terraform plan` e `terraform apply` em sequência.
	Destruir recursos	Para destruir um recurso após concluir a depuração, clique em Destroy Resources. O Terraform Explorer executa o comando `terraform plan` para gerar um plano de execução destinado à destruição do recurso. Após confirmar que deseja destruir o recurso, o Terraform Explorer executa o comando `terraform apply` para aplicar o plano de execução. Dessa forma, o recurso definido no plano de execução é liberado.

Benefícios

O Terraform Explorer oferece uma plataforma online para gerenciar os principais recursos do Terraform open source. Não requer instalação, codificação ou gerenciamento manual de estado.

Sem necessidade de instalação

O Terraform Explorer disponibiliza um cliente Terraform online gerenciado. Quando um comando do Terraform é executado, o Terraform Explorer acelera o download do provedor Terraform da Alibaba Cloud. Você não precisa se preocupar com questões de ambiente, como instalação e configuração do Terraform ou downloads lentos do provedor.

Sem necessidade de codificação

O Terraform Explorer simplifica implantações de recursos únicos ao gerar automaticamente arquivos de configuração com base nos parâmetros fornecidos pelo usuário, eliminando a complexidade de escrever código Terraform. Além disso, o Terraform Explorer fornece um ou mais modelos de exemplo para cada tipo de recurso. Selecione um modelo de exemplo para executar um plano de execução com apenas alguns cliques.

Adicionalmente, o Terraform Explorer salva automaticamente o modelo e os parâmetros usados em cada execução do Terraform. Ao iniciar uma nova tarefa de depuração, selecione um modelo e parâmetros utilizados anteriormente.

Sem gerenciamento manual de estado

O Terraform suporta gerenciamento de estado local e remoto. O Terraform Explorer também permite gerenciar estados locais e remotos. Por padrão, o Terraform Explorer utiliza o gerenciamento de estado local. No entanto, ele armazena um histórico do estado de cada execução do Terraform. Isso garante a segurança do estado em aplicações repetidas do mesmo arquivo de configuração, mantendo o mecanismo nativo de gerenciamento de estado do Terraform.

Termos

Termo	Descrição
version	A versão do provedor Terraform da Alibaba Cloud. A versão mínima suportada é 1.202.0.
service	Os serviços de nuvem suportados por cada versão do provedor. Buscas aproximadas por palavra-chave são suportadas.
resource type	Os tipos de recurso suportados pelo serviço de nuvem selecionado em cada versão do provedor. Buscas aproximadas por palavra-chave são suportadas.
template	Um arquivo de configuração do Terraform no formato HashiCorp Configuration Language (HCL). O arquivo é codificado em UTF-8. Configure parâmetros para gerar um modelo automaticamente ou referencie um modelo de exemplo fornecido para um tipo de recurso.
template version	A versão de um modelo. Cada vez que uma tarefa de depuração é executada, uma nova versão do modelo utilizado é salva. Visualize os detalhes de cada versão do modelo.
task	Uma tarefa de depuração. Ao iniciar a depuração clicando em Initiate Debugging, o Terraform Explorer cria uma tarefa de depuração. Cada tarefa de depuração corresponde a um arquivo de estado exclusivo. Portanto, visualize ou execute apenas um plano de execução por vez.
debugging record	Um registro de depuração. Sempre que uma tarefa de depuração é executada clicando em Plan ou Plan & Apply, um registro de depuração é gerado. Para cada novo registro de depuração, um plano de execução é gerado e executado com base no registro de depuração anterior.
debugging history	O histórico de depuração. Todas as tarefas de depuração de cada tipo de recurso são registradas no histórico de depuração. Selecione uma tarefa histórica e continue a depuração com base no registro de depuração mais recente.

Controle de acesso

Para acessar o Terraform Explorer e utilizar determinados recursos, conceda as permissões necessárias. Tais recursos incluem criar tarefas de depuração, visualizar planos de execução, visualizar e executar planos de execução, destruir recursos, visualizar o histórico de depuração e visualizar detalhes de recursos. A tabela a seguir lista as operações de API que exigem autorização no Terraform Explorer.

Operação	Descrição	Recurso envolvido
CreateExplorerModule	Salva um modelo.	Visualizar um plano de execução e visualizar e executar o plano de execução.
GetExplorerModule	Consulta os detalhes de um modelo.	Visualizar um modelo.
CreateExplorerModuleVersion	Salva o conteúdo do modelo como uma nova versão sempre que a depuração continua.	Visualizar um plano de execução, visualizar e executar o plano de execução e continuar a depuração.
CreateExplorerTask	Cria uma tarefa de depuração.	Visualizar um plano de execução e visualizar e executar o plano de execução.
GetExplorerTask	Consulta os detalhes de uma tarefa de depuração.	Visualizar resultados de depuração.
UpdateExplorerTaskAttribute	Atualiza uma tarefa de depuração.	Destruir recursos.
CreateJob	Cria e executa uma tarefa de depuração.	Visualizar um plano de execução, visualizar e executar o plano de execução e destruir recursos.
GetJob	Consulta os detalhes de execução de uma tarefa de depuração.	Visualizar resultados de depuração.
OperateJob	Opera uma tarefa de depuração. Após visualizar um plano de execução, execute a tarefa de depuração.	Visualizar e executar um plano de execução, executar o plano de execução e destruir recursos.
ListJobs	Consulta os registros de execução de uma tarefa de depuração.	Visualizar registros de depuração.
CreateExplorerHistory	Registra todas as tarefas de depuração.	Visualizar o histórico de depuração.
ListExplorerHistory	Consulta o histórico de depuração e parâmetros históricos.	Visualizar o histórico de depuração e usar parâmetros históricos.
ListResources	Consulta os recursos criados e seus detalhes.	Visualizar detalhes de recursos.

Antes de usar o Terraform Explorer, utilize as operações de API acima para implementar controle de acesso refinado. Também é possível usar a seguinte política para conceder as permissões necessárias:

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "iacservice:CreateExplorerModuleVersion",
        "iacservice:GetExplorerModule",
        "iacservice:CreateExplorerModule"
      ],
      "Resource": "acs:iacservice:*:*:explorermodule/*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "iacservice:CreateExplorerTask",
        "iacservice:UpdateExplorerTaskAttribute",
        "iacservice:GetExplorerTask"
      ],
      "Resource": "acs:iacservice:*:*:explorertask/*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "iacservice:CreateJob",
        "iacservice:GetJob",
        "iacservice:listJobs",
        "iacservice:OperateJob"
      ],
      "Resource": "acs:iacservice:*:*:task/*/job/*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "iacservice:ListResources",
        "iacservice:ListExplorerHistories",
        "iacservice:CreateExplorerHistory"
      ],
      "Resource": "*"
    }
  ]
}