Terraform:Managing existing resources

import {
  to = alicloud_oss_bucket.example
  id = "oss-bucket-import"
}

# Optional
# resource "alicloud_oss_bucket" "example" {
#   # (other resource arguments...)
# }

Pré-requisitos

1. Baixe e instale o Terraformer

   O Terraformer está disponível como pacote para todos os provedores ou pacotes individuais por provedor. Os exemplos a seguir mostram a instalação no Linux e macOS. Opções adicionais estão no guia de Instalação.

   • Usuários Linux

   export PROVIDER=all
   curl -LO "https://github.com/GoogleCloudPlatform/terraformer/releases/download/$(curl -s https://api.github.com/repos/GoogleCloudPlatform/terraformer/releases/latest | grep tag_name | cut -d '"' -f 4)/terraformer-${PROVIDER}-linux-amd64"
   chmod +x terraformer-${PROVIDER}-linux-amd64
   sudo mv terraformer-${PROVIDER}-linux-amd64 /usr/local/bin/terraformer

   • Usuários macOS

   export PROVIDER=all
   curl -LO "https://github.com/GoogleCloudPlatform/terraformer/releases/download/$(curl -s https://api.github.com/repos/GoogleCloudPlatform/terraformer/releases/latest | grep tag_name | cut -d '"' -f 4)/terraformer-${PROVIDER}-darwin-amd64"
   chmod +x terraformer-${PROVIDER}-darwin-amd64
   sudo mv terraformer-${PROVIDER}-darwin-amd64 /usr/local/bin/terraformer

2. Dependências

   1. Conceda à conta atual permissões de somente leitura para os recursos relevantes.

   2. Instale o Terraform

      Nota

      Você pode pular esta etapa se executar o comando no Cloud Shell.

      Para mais informações, consulte Instalar e configurar o Terraform.

   3. Baixe o provedor relevante. Configure o provedor de uma das duas maneiras a seguir:

      • Inicialize o provedor no diretório onde você executa o comando do Terraformer.

      • Baixe o provedor para o caminho ~/.terraform.d/plugins/.

   4. Configure as credenciais de acesso. Atualmente, o Terraformer suporta autenticação apenas pela leitura de um perfil local. Por padrão, a primeira credencial no perfil é usada para a importação. Para mais informações sobre como configurar credenciais de acesso da Alibaba Cloud, consulte Configurar e gerenciar credenciais.

Uso

O exemplo a seguir usa terraformer-all-darwin-amd64 v0.8.24.

O Terraformer suporta quatro comandos: help, import, plan, and version.

1. help: Exibe detalhes sobre um comando.

   

2. version: Exibe o número da versão atual.

   

3. import: Importa recursos para um provedor especificado.

   

4. plan: Visualiza os recursos a serem importados para um provedor especificado.

Exemplo

O exemplo a seguir importa todas as VPCs da Alibaba Cloud na região China (Hangzhou).

1. Crie um diretório para armazenar os modelos importados e os arquivos de estado.

   mkdir example && cd example

2. Execute o seguinte comando:

   terraformer-all-darwin-arm64 import alicloud --resources=vpc --regions=cn-hangzhou --path-pattern={output} --path-output=./     

   • --resources: Especifica a coleção de recursos a importar.

   • --regions: Especifica a região onde os recursos estão localizados.

   • --path-pattern: Especifica o padrão para a estrutura de diretórios gerada.

   • --path-output: Especifica o caminho de saída para os arquivos gerados.

4. Os arquivos de modelo gerados são os seguintes. Por padrão, as informações da região são adicionadas ao caminho do diretório. Para consolidar todos os modelos de recursos em um único arquivo, use o parâmetro --compact, que envia todos os recursos para resources.tf.

   └── cn-hangzhou
       ├── outputs.tf
       ├── provider.tf
       ├── terraform.tfstate
       ├── variables.tf
       ├── vpc.tf
       └── vswitch.tf
   
   2 directories, 6 files

5. Para Terraform >=0.13.0, execute o seguinte comando para atualizar o arquivo de estado visando compatibilidade de versão.

   terraform state replace-provider -auto-approve "registry.terraform.io/-/alicloud" "aliyun/alicloud"

Alibaba Cloud Terraformer - aliterraformer (Recomendado)

O aliterraformer estende o Terraformer de código aberto com maior cobertura de recursos, configuração aprimorada de credenciais e dimensões adicionais de filtragem de importação.

Pré-requisitos

1. Baixe e instale

   Baixe o aliterraformer do Alibaba Cloud OSS:

   macOS

   # amd64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_darwin_amd64.zip
   
   # arm64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_darwin_arm64.zip

   Linux

   # amd64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_linux_amd64.zip
   
   # arm
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_linux_arm.zip
   
   # arm64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_linux_arm64.zip

   Windows

   # amd64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_windows_amd64.zip
   
   # 386
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_windows_386.zip

   Por exemplo, no macOS, descompacte o arquivo após o download:

   unzip aliterraformer_darwin_amd64.zip
   chmod +x aliterraformer
   sudo mv aliterraformer /usr/local/bin/aliterraformer

2. Dependências

   Assim como no Terraformer de código aberto, você precisa dos binários terraform e terraform-provider-alicloud, além de credenciais de acesso configuradas.

   1. Conceda permissões de somente leitura para os recursos relevantes à conta do Resource Access Management (RAM).

   2. Instale o Terraform

      Para mais informações, consulte Instalar e configurar o Terraform. Você pode pular esta etapa se executar o comando no Cloud Shell.

   3. Baixe o terraform-provider-alicloud

      É possível especificar a versão do provedor para importação. A estrutura do diretório de cache difere entre versões anteriores à v0.13.0 e v0.13.0+. Os caminhos a seguir aplicam-se à v0.13.0+:

      # 1. Set using the TF_DATA_TFER_DIR environment variable
      <$TF_DATA_TFER_DIR>/providers/registry.terraform.io/aliyun/alicloud/1.239.0/darwin_arm64/terraform-provider-alicloud_v1.239.0
      
      # 2. Set in the hidden directory of the current working directory
      .terraform/providers/registry.terraform.io/aliyun/alicloud/1.239.0/darwin_arm64/terraform-provider-alicloud_v1.239.0
      
      # 3. Set in the hidden directory of the user's root directory
      <HOME>/.terraform.d/plugins/registry.terraform.io/aliyun/alicloud/1.239.0/darwin_arm64/terraform-provider-alicloud_v1.239.0

   4. Configure as credenciais de acesso

      Além de usar perfis, você pode definir credenciais de acesso no aliterraformer usando variáveis de ambiente e parâmetros de comando:

      # 1. Using the ALICLOUD_ACCESS_KEY and ALICLOUD_SECRET_KEY environment variables
      $ export ALICLOUD_ACCESS_KEY=xxxx
      $ export ALICLOUD_SECRET_KEY=xxxxx
      
      # 2. By passing the --access-key and --secret-key command parameters
      $ aliterraformer import alicloud --access-key=xxxx --secret-key=xxx ...
      
      # 3. By setting and passing the AK through the profile mechanism
      $ aliterraformer import alicloud --profile=default ...

Uso

O aliterraformer suporta cinco comandos: help, version, products, resources, import. Os comandos products, resources são adições ao Terraformer de código aberto.

1. help: Visualize detalhes sobre os comandos suportados.

   aliterraformer help

   

2. version: Visualize a versão atual do Terraformer.

   aliterraformer version

3. products: Liste os produtos suportados para importação na versão atual.

   aliterraformer products

   

4. resources: Liste os tipos de recursos importáveis para um produto. Use -p para especificar o produto.

   aliterraformer resources -p <productName>

   

   

5. import: Importe recursos. Especifique alicloud para Alibaba Cloud. Execute o seguinte comando para visualizar os parâmetros disponíveis:

   aliterraformer import alicloud -h

   

   Defina a coleção de recursos a importar e, opcionalmente, filtre recursos e extraia propriedades como variáveis.

   • Construa uma coleção de recursos:

     Quatro flags definem o escopo da importação: <--products>, <--resources>, <--excludes-products> e <--excludes>. Combine-as para construir uma coleção de recursos:

     • Importe recursos específicos

       # Import a VPC, a vSwitch, and an ECS instance
       aliterraformer import alicloud -r=vpc,vswitch,instance

     • Importe produtos específicos

       # Import all resources under the ACK and ALB products
       aliterraformer import alicloud --products=ACK,ALB

     • Importe produtos e recursos específicos

       # Import all resources under the ACK and ECS products, and all VPCs and vSwitches
       aliterraformer import alicloud --products=ACK,ECS -r=vpc,vswitch

     • Importe produtos específicos, mas exclua alguns recursos dentro desses produtos

       # Import all resources under ACK except alicloud_cs_kubernetes
       aliterraformer import alicloud --products=ACK --excludes=cs_kubernetes

     • Importe todos os recursos de todos os produtos

       # Entering ALL for products means all products
       aliterraformer import alicloud --products=ALL

     • Importe todos os recursos de todos os produtos, mas exclua produtos específicos

       # Import all products except VPNGateway and WAF
       aliterraformer import alicloud --products=ALL --excludes-products=VPNGateway,WAF

     • Importe todos os recursos de todos os produtos, mas exclua produtos e recursos específicos

       # Import all products except VPNGateway and WAF, and exclude the alicloud_cs_kubernetes resource
       aliterraformer import alicloud --products=ALL --excludes-products=VPNGateway,WAF --excludes=cs_kubernetes

   • Filtre recursos

     Formato: --filter=Type1.AttrKey=AttrValue1;AttrValue2,Type2.AttrKey=AttrValue1;AttrValue2. Omitir Type aplica o filtro a todos os recursos.

     • Importe uma VPC com o ID vpc-123

       # To specify multiple values, separate them with semicolons: --filter="vpc.id=vpc-123;vpc-456"
       aliterraformer import alicloud -r=vpc --filter="vpc.id=vpc-123"

     • Importe uma VPC e um vSwitch que tenham o nome tf-example

       aliterraformer import alicloud -r=vpc,vswitch --filter="vpc.vpc_name=tf-example,vswitch.vswitch_name=tf-example"

     • Importe uma VPC e uma instância ECS que pertençam ao grupo de recursos rg-12345

       aliterraformer import alicloud -r=vpc,instance --filter="resource_group_id=rg-12345"

   • Extraia propriedades como variáveis usando output-variables

     Formato: r1:attr1,attr2;r2:attr1,attr2,attr3.

     • Extraia vpc_id e vswitch_id de uma instância ECS como variáveis

       aliterraformer import alicloud -r=instance --output-variables="instance:vpc_id,vswitch_id"

   Exemplo

   Este exemplo importa uma VPC, um vSwitch e uma instância ECS com ID de VPC vpc-12345 em China (Hangzhou), extraindo o zone_id do vSwitch como variável:

   1. Crie um diretório para armazenar os modelos importados e os arquivos de estado.

      mkdir example && cd example

   2. Construa o comando de importação.

      aliterraformer import alicloud \
          --regions=cn-hangzhou \
          -r=vpc,vswitch,instance \
          --filter="vpc.id=vpc-12345,vswitch.vpc_id=vpc-12345,instance.vpc_id=vpc-12345" \
          --output-variables="vswitch:zone_id" \
          --path-output=example               \
          --path-pattern={output}            \
          --compact

      • --path-output: Especifica a pasta de importação.

      • --path-pattern: Estrutura de diretórios para modelos importados. Padrão: {output}/{provider}/{service}/. Alternativas: {output}/{provider}/ e {output}/. Usar --path-pattern={output} coloca todos os modelos em uma única pasta.

      • --compact: Consolida todos os recursos em um único arquivo resources.tf em vez de arquivos separados {service}.tf.

   3. Após a importação, os seguintes arquivos são gerados no diretório example:

      .
      ├── outputs.tf
      ├── provider.tf
      ├── resources.tf
      ├── terraform.tfstate
      └── variables.tf

      Sem --path-pattern={output}, a estrutura de diretórios é:

      .
      └── alicloud
          ├── instance
          │   ├── provider.tf
          │   ├── terraform.tfstate
          │   └── variables.tf
          ├── vpc
          │   ├── outputs.tf
          │   ├── provider.tf
          │   ├── terraform.tfstate
          │   ├── variables.tf
          │   └── vpc.tf
          └── vswitch
              ├── outputs.tf
              ├── provider.tf
              ├── terraform.tfstate
              ├── variables.tf
              └── vswitch.tf

   4. Para Terraform >=0.13.0, execute o seguinte comando para atualizar o arquivo de estado visando compatibilidade de versão.

      terraform state replace-provider -auto-approve "registry.terraform.io/-/alicloud" "aliyun/alicloud"

   Feedback e sugestões

   Para dúvidas ou sugestões, participe do grupo DingTalk (ID do Grupo: 34240022836) ou abra uma issue na página do Terraform Provider da Alibaba Cloud no GitHub.