Pular para o conteúdo principal

Configure a execução do aplicativo Databricks com app.yaml

O arquivo app.yaml em um aplicativo Databricks define como a execução do seu aplicativo deve ser feita. Se o seu aplicativo exigir um ponto de entrada diferente ou uma configuração específica do ambiente, você pode incluir este arquivo opcional em seu projeto para substituir o comportamento default .

Você pode usar a extensão de arquivo .yaml ou .yml. Esse arquivo deve estar localizado na raiz do diretório do seu projeto.

Configurações suportadas​

O arquivo app.yaml suporta as seguintes configurações.

Contexto

Tipo

Descrição

command

sequence

Use esta configuração quando você precisar de um comando personalizado para a execução do seu aplicativo. Por default, o Databricks faz a execução de aplicativos Python usando o comando python <my-app.py>, onde <my-app.py> é o primeiro arquivo .py (em ordem alfabética) no diretório raiz do aplicativo. Se o seu aplicativo incluir um package.json com um script start, o comando default é npm run start. Consulte Lógica de implantação.

Como Databricks não executa o comando em um shell, as variáveis de ambiente definidas fora da configuração do aplicativo não estão disponíveis para o seu aplicativo. A única exceção é DATABRICKS_APP_PORT, que é substituído pelo número da porta real no comando em tempo de execução. Se seu aplicativo exigir parâmetros adicionais para execução, use a estrutura env .

Essa configuração é opcional.

env

list

Databricks define automaticamente várias default variáveis de ambiente no ambiente de tempo de execução do aplicativo. Esse site de nível superior key define uma lista opcional de variáveis de ambiente adicionais a serem transmitidas ao seu aplicativo. Cada variável pode usar um valor codificado ou fazer referência a uma fonte externa, como uma entrada secreta ou de banco de dados.

Os itens válidos na lista são:

  • name: O nome da variável de ambiente.
  • Um de:

Essa configuração é opcional.

health_check

map

Define um endpoint HTTP que o Databricks verifica antes de marcar uma implantação como bem-sucedida. As key válidas são:

  • path: O caminho a ser solicitado, como /health. Deve começar com /.
  • timeout_seconds: Quanto tempo aguardar para o endpoint responder com sucesso, em segundos. O valor default e máximo é 300.

Consulte Configurar uma verificação de integridade de implantação.

Essa configuração é opcional.

Contexto

Tipo

Descrição

command

sequence

Use esta configuração quando você precisar de um comando personalizado para a execução do seu aplicativo. Por default, o Databricks faz a execução de aplicativos Python usando o comando python <my-app.py>, onde <my-app.py> é o primeiro arquivo .py (em ordem alfabética) no diretório raiz do aplicativo. Se o seu aplicativo incluir um package.json com um script start, o comando default é npm run start. Consulte Lógica de implantação.

Como Databricks não executa o comando em um shell, as variáveis de ambiente definidas fora da configuração do aplicativo não estão disponíveis para o seu aplicativo. A única exceção é DATABRICKS_APP_PORT, que é substituído pelo número da porta real no comando em tempo de execução. Se seu aplicativo exigir parâmetros adicionais para execução, use a estrutura env .

Essa configuração é opcional.

env

list

Databricks define automaticamente várias default variáveis de ambiente no ambiente de tempo de execução do aplicativo. Esse site de nível superior key define uma lista opcional de variáveis de ambiente adicionais a serem transmitidas ao seu aplicativo. Cada variável pode usar um valor codificado ou fazer referência a uma fonte externa, como uma entrada secreta ou de banco de dados.

Os itens válidos na lista são:

  • name: O nome da variável de ambiente.
  • Um de:

Essa configuração é opcional.

health_check

map

Define um endpoint HTTP que o Databricks verifica antes de marcar uma implantação como bem-sucedida. As key válidas são:

  • path: O caminho a ser solicitado, como /health. Deve começar com /.
  • timeout_seconds: Quanto tempo aguardar para o endpoint responder com sucesso, em segundos. O valor default e máximo é 300.

Consulte Configurar uma verificação de integridade de implantação.

Essa configuração é opcional.

Configurar uma verificação de integridade da implantação​

Por default, o Databricks marca uma implantação como bem-sucedida assim que o processo do seu aplicativo começa, mesmo que o aplicativo ainda não esteja pronto para atender às solicitações. Adicione uma configuração health_check para que o Databricks aguarde até que seu aplicativo esteja pronto antes de concluir a implantação.

Quando uma verificação de integridade é configurada, o Databricks envia solicitações HTTP GET para path em seu aplicativo após o aplicativo começar, e as repete até que o endpoint retorne um código de status 2xx ou timeout_seconds decorra. A verificação de integridade é executada sempre que o aplicativo é implantado ou iniciado.

  • Se o endpoint retornar um código de status 2xx, a implantação será bem-sucedida e a nova versão começará a servir tráfego.
  • Se o endpoint não retornar um código de status 2xx antes do tempo limite, ou se o processo do aplicativo for encerrado, a implantação falhará. Os logs de implantação incluem o último código de status ou erro recebido pela verificação de integridade.

O que acontece com a versão anterior após uma verificação de integridade falha depende do tipo de aplicativo:

  • Aplicativos com escala horizontal : a versão anterior continua servindo o tráfego. Consulte Escala horizontal para aplicativos do Databricks.
  • Apps padrão : o Databricks interrompe a versão anterior antes de começar a nova, para que o app pare após uma verificação de integridade com falha. Corrija o problema e implante novamente.

O exemplo a seguir aguarda até 60 segundos para que o endpoint /health retorne um código de status 2xx:

YAML
command: ['python', 'app.py']
health_check:
path: '/health'
timeout_seconds: 60

Exemplo app.yaml para um aplicativo Streamlit​

O arquivo app.yaml a seguir mostra como configurar um aplicativo Streamlit. Ele usa um comando personalizado para iniciar o aplicativo com streamlit run, lê o ID do SQL Warehouse de um recurso do aplicativo e define um sinalizador de acompanhamento de uso. O campo valueFrom requer um recurso de SQL warehouse com o key sql-warehouse. Consulte Adicionar um recurso de SQL warehouse a um aplicativo Databricks.

YAML
command: ['streamlit', 'run', 'app.py']
env:
- name: 'DATABRICKS_WAREHOUSE_ID'
valueFrom: 'sql-warehouse'
- name: 'STREAMLIT_GATHER_USAGE_STATS'
value: 'false'

Use uma configuração como essa se o seu aplicativo depender de um recurso compute específico, como um SQL warehouse, ou se precisar de determinadas variáveis de ambiente para controlar o comportamento do tempo de execução.

Exemplo app.yaml para um aplicativo Flask​

Este exemplo mostra como configurar um aplicativo Flask usando o servidor Gunicorn. A configuração command especifica os parâmetros do Gunicorn startup e a seção env define o caminho para um volume Unity Catalog como uma variável de ambiente.

YAML
command:
- gunicorn
- app:app
- -w
- 4
env:
- name: 'VOLUME_URI'
value: '/Volumes/catalog-name/schema-name/dir-name'

Use essa abordagem quando seu aplicativo precisar de um servidor WSGI pronto para produção, como o Gunicorn, e quando ele depender de dados armazenados em um volume do Unity Catalog ou em outro caminho específico do ambiente.

Recursos adicionais​