Gerenciar APIs e bibliotecas do Cloud no Cloud Code para IntelliJ

Acesse os produtos e serviços do Google Cloud pelo seu código usando as APIs do Cloud. Essas APIs do Cloud expõem uma interface REST JSON simples que podem ser chamadas por meio de bibliotecas de cliente.

Neste documento, descrevemos como ativar as APIs do Cloud e adicionar bibliotecas de cliente do Cloud ao seu projeto.

Observação: para projetos que não usam Java e Maven, o Cloud Code não adiciona as bibliotecas de cliente do Cloud automaticamente à sua compilação, mas é compatível com os outros recursos descritos aqui e fornece snippets de build para seu sistema de build.

Navegar pelas APIs do Cloud

Observação: a lista de APIs e bibliotecas do Cloud Code abrange a maioria, mas não todas as APIs.

Para explorar todas as APIs do Google Cloud disponíveis no seu ambiente de desenvolvimento integrado, siga estas etapas:

1. Acesse Ferramentas > Google Cloud Code > APIs do Cloud.

2. A janela Gerenciar APIs do Google Cloud agrupa as APIs do Cloud por categoria. Você também pode usar a barra de pesquisa das APIs de pesquisa para encontrar APIs específicas.

   

3. Clique em uma API para conferir mais detalhes, como status e idioma instruções de instalação das bibliotecas de cliente correspondentes e recursos na documentação do Google Cloud.

Ativar Cloud APIs

Para ativar as APIs do Cloud em um projeto usando os detalhes da API, siga estas etapas:

1. Na visualização de detalhes da API Cloud, selecione um projeto do Google Cloud para o qual você quer ativar a API Cloud.

2. Clique em Ativar API.

   Quando a API está ativada, uma mensagem é exibida para confirmar a mudança.

Adicionar as bibliotecas de cliente do Cloud

Para adicionar bibliotecas ao seu projeto no IntelliJ, siga estas etapas:

Para projetos Java Maven

1. Acesse Ferramentas > Google Cloud Code > APIs do Cloud.

A seção Instalar biblioteca de cliente no Manage Google A caixa de diálogo "APIs do Cloud" exibe as bibliotecas compatíveis.

2. Selecione o tipo de biblioteca que você quer como Google Biblioteca de cliente do Cloud (recomendada para a maioria dos projetos) ou Java Spring Google Cloud (recomendado se o projeto usar Java Spring).
3. Siga as outras instruções na documentação do Install Client Library no seu ambiente de desenvolvimento integrado, se aplicável.
Observação:o Google Cloud Java resolve a versão conflitos entre bibliotecas, adicionando o Lista de materiais (BOM, na sigla em inglês) do Google Cloud para o arquivo pom.xml dos seus projetos.
4. Quando terminar, clique em Fechar.

Para todos os outros projetos

1. Acesse Ferramentas > Google Cloud Code > Google Cloud APIs do Google.

A seção Instalar biblioteca de cliente no Manage Google A caixa de diálogo "APIs do Cloud" exibe as bibliotecas compatíveis.

2. Para instalar a API, siga as instruções de instalação listadas na página de detalhes da API para o idioma de sua preferência.

   Se você está desenvolvendo um aplicativo Java, é necessário para também especificar sua preferência de biblioteca como Cliente do Google Cloud Library (recomendado) ou Java Spring Google Cloud.

3. Quando terminar, clique em Fechar.

Usar exemplos de código de API

Para pesquisar e usar amostras de código para cada API no Explorador de APIs, siga estas etapas:

1. Acesse Ferramentas > Google Cloud Code > APIs do Cloud.

2. Para abrir a visualização de detalhes, clique no nome de uma API.

3. Para ver exemplos de código para a API, clique na guia Exemplos de código.

4. Para filtrar a lista de amostras, digite o texto que você deve pesquisar ou selecione uma linguagem de programação no menu suspenso Language.

Configurar a autenticação

Depois de ativar as APIs necessárias e adicionar as bibliotecas de cliente necessárias, configure o aplicativo para que ele seja autenticado com sucesso. A configuração depende do seu tipo de desenvolvimento e da plataforma em que você está executando.

Depois de concluir as etapas de autenticação relevantes, seu aplicativo poderá se autenticar e estar pronto para ser implantado.

Desenvolvimento local

Máquina local

O Cloud Code garante que as configurações padrão do seu aplicativo Credenciais (ADC) definidas se você fez login no Google Cloud usando o ambiente de desenvolvimento integrado. Se você não estiver fazendo login com o Cloud Code, execute gcloud auth application-default login manualmente.

minikube

1. O Cloud Code garante que seu Application Default Credentials (ADC) esteja definido se você tiver feito login no Google Cloud pelo seu ambiente de desenvolvimento integrado. Se você não estiver fazendo login com o Cloud Code, execute gcloud auth application-default login manualmente.
2. Inicie o minikube com minikube start --addons gcp-auth. Isso ativará o ADC nos pods. Para um guia detalhado sobre a autenticação do minikube no Google Cloud, consulte os documentos do minikube gcp-auth.

Outros clusters do K8s locais

1. O Cloud Code garante que as configurações padrão do seu aplicativo Credenciais (ADC) definidas se você fez login no Google Cloud usando o ambiente de desenvolvimento integrado. Se você não estiver fazendo login com o Cloud Code, execute gcloud auth application-default login manualmente.
2. Monte o diretório gcloud local nos pods do Kubernetes editando a especificação do pod nos manifestos dele ou da implantação, para que as bibliotecas de cliente do Google Cloud possam encontrar suas credenciais. Exemplo de configuração de pod do Kubernetes:

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-app
     labels:
       name: my-app
   spec:
     containers:
     - name: my-app
       image: gcr.io/google-containers/busybox
       ports:
         - containerPort: 8080
       volumeMounts:
         - mountPath: /root/.config/gcloud
           name: gcloud-volume
     volumes:
       - name: gcloud-volume
         hostPath:
           path: /path/to/home/.config/gcloud

Cloud Run

O Cloud Code garante que as configurações padrão do seu aplicativo Credenciais (ADC) definidas se você fez login no Google Cloud usando o ambiente de desenvolvimento integrado. Se você não estiver fazendo login com o Cloud Code, execute gcloud auth application-default login manualmente.

Desenvolvimento remoto

Google Kubernetes Engine

Dependendo do escopo do seu projeto, é possível escolher como autenticar os serviços do Google Cloud no GKE:

• (Somente desenvolvimento)
  Observação: as configurações de conta de serviço e de escopo de acesso do cluster do GKE são permanentes. Depois da criação do cluster, essas configurações não podem ser alteradas. Especifique as configurações conforme recomendado abaixo.
  1. Crie um cluster do GKE com as seguintes configurações:
     • Verifique se você está usando a conta de serviço que o GKE usa por padrão e a conta de serviço padrão do Compute Engine. Confira também se os Escopos de acesso estão definidos como Permitir acesso total a todas as APIs do Cloud, ambas as configurações acessíveis na seção Pools de nós > Segurança.
       Como a conta de serviço do Compute Engine é compartilhada por todas as cargas de trabalho implantadas no nó, esse método provisiona um excesso de permissões e só deve ser usado para desenvolvimento.
     • Verifique se a Identidade da carga de trabalho não está ativada no cluster (na seção Cluster > Segurança).
  2. Atribua os papéis necessários à conta de serviço padrão do Compute Engine:
     • Se você estiver tentando acessar um secret, siga estas etapas específicas do Gerenciador de secrets para configurar os papéis necessários na sua conta de serviço.
     • Se a conta de serviço padrão do Compute Engine estiver em uso, os papéis corretos do IAM talvez já estejam aplicados.

     • Para ver a lista de tipos de papel do IAM e papéis predefinidos que você pode conceder a identidades, consulte o Guia Noções básicas sobre papéis.

       Para ver as etapas de concessão de papéis, consulte Como conceder, alterar e revogar o acesso a recursos.

• (Recomendado para produção)
  1. Configure seu cluster e aplicativo do GKE com a Identidade da carga de trabalho para autenticar os serviços do Google Cloud no GKE. Isso associa sua conta de serviço do Kubernetes à sua conta de serviço do Google.
  2. Configure a implantação do Kubernetes para referenciar a conta de serviço do Kubernetes definindo o campo .spec.serviceAccountName no arquivo YAML de implantação do Kubernetes.
     Se você estiver trabalhando em um aplicativo criado a partir de um modelo do Cloud Code, esse arquivo estará localizado na pasta kubernetes-manifests.
  3. Se o serviço do Google Cloud que você está tentando acessar exigir papéis adicionais, conceda-os à conta de serviço do Google que você está usando para desenvolver seu app:
     • Se você estiver tentando acessar um secret, siga estas etapas específicas do Gerenciador de secrets para configurar os papéis necessários na sua conta de serviço.

     • Para ver a lista de tipos de papel do IAM e papéis predefinidos que você pode conceder a identidades, consulte o Guia Noções básicas sobre papéis.

       Para ver as etapas de concessão de papéis, consulte Como conceder, alterar e revogar o acesso a recursos.

Cloud Run

1. Para criar uma nova conta de serviço exclusiva para implantar seu aplicativo Cloud Run, na página "Contas de serviço", selecione o projeto em que o secret está armazenado.
   

   Acessar a página Contas de serviço.

2. Clique em Criar conta de serviço.
3. Na caixa de diálogo Criar conta de serviço, forneça um nome descritivo para a conta.
4. Altere o ID da conta de serviço para um valor exclusivo e reconhecível e, em seguida, clique em Criar.
5. Se o serviço do Google Cloud que você está tentando acessar exigir outros papéis, conceda-os, clique em Continuar e, em seguida, clique em Concluído.
6. Para adicionar a conta de serviço do Kubernetes à configuração de implantação, navegue até Run > Edit Configurations e, em seguida, especifique sua conta de serviço no campo Service Name.

Cloud Run

Dependendo do escopo do seu projeto, é possível escolher como autenticar os serviços do Google Cloud no GKE:

• (Somente desenvolvimento)
  Observação: as configurações de conta de serviço e de escopo de acesso do cluster do GKE são permanentes. Depois da criação do cluster, essas configurações não podem ser alteradas. Especifique as configurações conforme recomendado abaixo.
  1. Crie um cluster do GKE com as seguintes configurações:
     • Verifique se você está usando a conta de serviço que o GKE usa por padrão e a conta de serviço padrão do Compute Engine. Confira também se os Escopos de acesso estão definidos como Permitir acesso total a todas as APIs do Cloud, ambas as configurações acessíveis na seção Pools de nós > Segurança.
       Como a conta de serviço do Compute Engine é compartilhada por todas as cargas de trabalho implantadas no nó, esse método provisiona um excesso de permissões e só deve ser usado para desenvolvimento.
       
     • Verifique se a Identidade da carga de trabalho não está ativada no cluster (na seção Cluster > Segurança).
  2. Atribua os papéis necessários à conta de serviço padrão do Compute Engine:
     • Se você estiver tentando acessar um secret, siga estas etapas específicas do Gerenciador de secrets para configurar os papéis necessários na sua conta de serviço.
     • Se a conta de serviço padrão do Compute Engine estiver em uso, os papéis corretos do IAM talvez já estejam aplicados.

     • Para ver a lista de tipos de papel do IAM e papéis predefinidos que você pode conceder a identidades, consulte o Guia Noções básicas sobre papéis.

       Para ver as etapas de concessão de papéis, consulte Como conceder, alterar e revogar o acesso a recursos.

• (Recomendado para produção)
  1. Configure seu cluster e aplicativo do GKE com a Identidade da carga de trabalho para autenticar os serviços do Google Cloud no GKE. Isso associa sua conta de serviço do Kubernetes à sua conta de serviço do Google.
  2. Para adicionar a conta de serviço do Kubernetes à configuração de implantação, navegue até Run > Edit Configurations e especifique sua conta de serviço do Kubernetes no campo Service Name.
     
  3. Se o serviço do Google Cloud que você está tentando acessar exigir papéis adicionais, conceda-os à conta de serviço do Google que você está usando para desenvolver seu app:
     • Se você estiver tentando acessar um secret, siga estas etapas específicas do Gerenciador de secrets para configurar os papéis necessários na sua conta de serviço.

     • Para ver a lista de tipos de papel do IAM e papéis predefinidos que você pode conceder a identidades, consulte o Guia Noções básicas sobre papéis.

       Para ver as etapas de concessão de papéis, consulte Como conceder, alterar e revogar o acesso a recursos.

Desenvolvimento remoto com permissões do Gerenciador de secrets ativadas

Se você estiver desenvolvendo remotamente, usando uma conta de serviço para autenticação, e seu aplicativo usar secrets, conclua mais algumas etapas além das instruções de desenvolvimento remoto. Essas etapas atribuem à sua conta de serviço do Google o papel necessário para acessar um determinado secret do Gerenciador de secrets:

1. Para abrir a janela de ferramentas do Secret Manager, acesse Ferramentas. > Google Cloud Code > Secret Manager.

2. Selecione o secret que você quer acessar no seu código.

3. Clique na guia Permissões e configure as permissões do secret clicando em Editar Permissão para edição.

   

   O console do Google Cloud é aberto em uma nova janela do navegador da Web, mostrando a página de configuração do Secret Manager do Secret.

4. No console do Google Cloud, clique na guia Permissões e depois em Conceda acesso.

5. No campo Novos principais, insira sua conta de serviço.

6. No campo suspenso Selecionar um papel, selecione o papel Acessador de secrets do Gerenciador de secrets.

7. Quando terminar, clique em Save (Salvar).

   A conta de serviço tem permissão para acessar este secret.

Receber suporte

Para enviar um feedback ou informar um problema no ambiente de desenvolvimento integrado do IntelliJ, acesse Tools > Cloud Code > Help / About > Envie feedback ou informe um problema para informar um problema no GitHub ou faça uma pergunta no Stack Overflow.