Exportar um aplicativo
Nesta página
Visão geral
Você pode baixar um diretório dos arquivos de configuração da aplicação ao exportá-los. Isso permite que você salve a configuração da sua aplicação em controle de origem e para trabalhar localmente com o App Services CLI e seu editor de texto preferido.
O diretório exportado contém arquivos de configuração para a maioria dos componentes do seu aplicativo, incluindo conjunto de dados, funções, Atlas Triggers e outros serviços. Para obter mais informações sobre o conteúdo de uma aplicação exportada, consulte Configuração da aplicação.
A exportação não inclui nenhum segredo. Se você criar uma nova aplicação com base nos arquivos de configuração exportados, deverá adicionar manualmente segredos à nova aplicação. Para mais informações, consulte Copiar uma aplicação.
Antes de começar
Você precisará do seguinte para exportar uma aplicação na IU do Atlas:
Uma conta do MongoDB Atlas com permissões de Proprietário do Projeto. Para saber como se inscrever em uma conta gratuita, consulte Comece a usar o Atlas.
Você precisará do seguinte para exportar uma aplicação na CLI:
Uma conta do MongoDB Atlas com permissões de Proprietário do Projeto. Para saber como criar uma conta gratuita, consulte Comece a usar o Atlas .
Uma admin API do MongoDB Atlas par de chaves pública/privada. A chave da API deve ter permissões do Proprietário do projeto para trabalhar com o App Services Admin API.
Uma cópia da App Services CLI instalada e adicionada ao seu sistema local
PATH. Para saber como, consulte Instalar App Services CLI.O ID do aplicativo do cliente do seu aplicativo. Esta é a string exclusiva que contém o nome do seu aplicativo, por exemplo
"myapp-abcde". Para saber como encontrar sua ID do aplicativo, consulte Obter metadados do aplicativo.
Você precisará do seguinte para exportar um aplicativo com a API de administrador:
Uma conta do MongoDB Atlas com permissões de Proprietário do Projeto. Para saber como criar uma conta gratuita, consulte Comece a usar o Atlas .
Uma admin API do MongoDB Atlas par de chaves pública/privada. A chave da API deve ter permissões do Proprietário do projeto para trabalhar com o App Services Admin API.
A string hexadecimal ObjectId interna do seu aplicativo e o ID do Projeto do Projeto Atlas que contém seu aplicativo. Para saber como encontrá-los, consulte Obter metadados do aplicativo.
Procedimento
Exportar a aplicação
Clique em Deployment na navegação à esquerda.
A partir daqui, existem duas formas de exportar seu aplicativo:
- Para exportar a configuração atual da sua aplicação, clique em
- Export App aba e clique no botão Export App .
- Para exportar a configuração da sua aplicação de um anterior
implantação, clique na guia History e encontre a implantação que deseja exportar.
Após encontrar o sistema, clique no botão Export no final da linha.
Executar o comando de exportação do aplicativo
O comando pull baixa os arquivos de configuração de um aplicativo para um diretório local. Você escolhe qual aplicativo exportar especificando sua ID do aplicativo cliente com o sinalizador --remote .
appservices pull --remote=<Client App ID>
Por padrão, o comando extrai arquivos para o diretório de trabalho atual. Você pode configurar o comando para criar um novo diretório especificando o caminho do diretório com o sinalizador --local .
appservices pull --remote=<App ID> --local=<Output Directory Path>
Dica
O diretório especificado por --local ainda não pode existir, caso contrário, a CLI gerará um erro e não extrairá os arquivos de configuração.
O comando também oferece suporte a sinalizadores adicionais que você pode incluir opcionalmente para personalizar seu aplicativo. A tabela a seguir lista sinalizadores comuns que você pode usar:
| Se especificadas, as dependências externas são exportadas como um arquivo |
| Se especificado, os ativos estáticos hospedados são exportados no diretório |
Autenticar um usuário do MongoDB Atlas
Chame o endpoint de autenticação do usuário administrador com seu par de chaves da API do MongoDB Atlas:
curl -X POST \ https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{ "username": "<Public API Key>", "apiKey": "<Private API Key>" }'
Se a autenticação for bem-sucedida, o corpo da resposta conterá um objeto JSON com um valor access_token :
{ "access_token": "<access_token>", "refresh_token": "<refresh_token>", "user_id": "<user_id>", "device_id": "<device_id>" }
O access_token concede acesso à App Services Admin API. Você deve incluí-lo como um token do portador no cabeçalho Authorization para todas as solicitações de API Admin.
Exportar sua aplicação
Para exportar sua aplicação, envie uma solicitação para o endpoint Exportar uma aplicação .
Certifique-se de incluir sua API Admin access_token, o groupId do projeto Atlas que contém seu aplicativo e a string hexadecimal appId interna do aplicativo:
curl -X GET \ https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/export \ -H 'Authorization: Bearer <access_token>' \ -H 'Content-Type: application/json' \ --output ./exported-app.zip
Você pode exportar a configuração de um sistema específico especificando o sistema _id como um parâmetro de query de URL :
https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/export?deployment={deploymentId}
Se a solicitação for bem-sucedida, o endpoint retornará uma resposta 200 que contém um diretório .zip dos arquivos de configuração atuais do seu aplicativo.
Saída
Uma aplicação exportada contém arquivos de configuração para cada componente da aplicação. Para obter informações detalhadas sobre cada tipo de arquivo de configuração, consulte Configuração da aplicação.
Um diretório de configuração exportado tem a seguinte estrutura:
app/ ├── root_config.json ├── auth/ │ ├── providers.json │ └── custom_user_data.json ├── data_sources/ │ └── <service name>/ │ ├── config.json │ └── <database>/ │ └── <collection>/ │ ├── schema.json │ └── rules.json ├── environments/ │ ├── no-environment.json │ ├── development.json │ ├── testing.json │ ├── qa.json │ └── production.json ├── functions/ │ ├── config.json │ ├── <function>.js │ └── <directory>/ │ └── <function>.js ├── graphql/ │ ├── config.json │ └── custom_resolvers │ └── <resolver name>.json ├── hosting/ │ ├── config.json │ ├── metadata.json │ └── files/ │ └── <files to host> ├── http_endpoints/ │ ├── config.json │ ├── data_api_config.json │ └── [Deprecated] <service name>/ │ ├── config.json │ └── incoming_webhooks/ │ ├── config.json │ └── source.js ├── log_forwarders/ │ └── <name>.json ├── sync/ │ └── config.json ├── triggers/ │ └── <trigger name>.json └── values/ └── <value name>.json