astronomer / docs

This repository contains all content and code for Astro and Astronomer Software documentation.
53 stars 60 forks source link

Add note about image deploy includes #3758

Open lzdanski opened 1 month ago

lzdanski commented 1 month ago

Issue Type

Missing content for an existing feature

Links to Affected Docs

https://docs.astronomer.io/astro/deploy-dags

The Issue or Context

The deploy dags doc needs clarification and a note about where to store build dependencies for image deploys, since the /dags folder is not included in the update.

Fix or Proposed Change

Add a note to deploy dags docs making it clear:

astro deploy - will deploy the image and then the dags astro deploy --dags - will deploy only the dags astro deploy --iamge - will deploy only the image

since image deploys will ignore all files in the dags/ dir so any files needed for the build should be placed in an appriopriate dir like include/ (also just for airflow best practice, so the dag parser doesn’t have to scan through all those files looking for dags)

Additional Notes

Required Reviewers

No response

sunkickr commented 1 month ago

All of this is only true if dag deploy is enabled which is the default for hosted but not the default for hybrid. A lot of Hybrid customers have dag deploy enabled and few Hosted customers have it disabled