[Docs] Add docs to deploy project on Astro Cloud #90
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #90 +/- ##
=======================================
Coverage 97.69% 97.69%
=======================================
Files 5 5
Lines 564 564
=======================================
Hits 551 551
Misses 13 13 ☔ View full report in Codecov by Sentry. |
docs/getting_started/astro_setup.rst
Outdated
| .. code-block:: bash | ||
|
|
||
| export GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/service-account-key.json |
There was a problem hiding this comment.
IMO, we don't need to set this since we're passing the --key-file in the command below & that seems to suffice as I tried.
| --num-nodes 1 \ | ||
| --machine-type e2-standard-4 \ | ||
| --enable-autoscaling --min-nodes=1 --max-nodes=3 \ | ||
| --no-enable-ip-alias |
There was a problem hiding this comment.
| --no-enable-ip-alias | |
| --no-enable-ip-alias --project <YOUR_PROJECT_ID> |
Since we're not setting the project I think it's good to mention this.
There was a problem hiding this comment.
I think otherwise it would be nicer to specify the below command prior to these steps instead of providing --project for each of the commands
gcloud config set project <YOUR_PROJECT_ID>
There was a problem hiding this comment.
Added this command
dev/Dockerfile.ray_google_cloud
Outdated
There was a problem hiding this comment.
where do we specify to use this file in the make target?
There was a problem hiding this comment.
As discussed offline moved content from this file to Dockerfile
docs/getting_started/astro_setup.rst
Outdated
| 2. **Deploy the project on Astro Cloud** | ||
|
|
||
|
|
||
| Please ensure you use `Dockerfile.ray_google_cloud <https://github.com/astronomer/astro-provider-ray/blob/main/dev/Dockerfile.ray_google_cloud>`_ as the default. The command below uses `Dockerfile <https://github.com/astronomer/astro-provider-ray/blob/main/dev/Dockerfile>`_ by default. |
There was a problem hiding this comment.
Can we suggest how to use that Dockerfile.ray_google_cloud or modify the make deploy target to use this Dockerfile by default?
There was a problem hiding this comment.
As discussed offline moved content of Dockerfile.ray_google_cloud file to the Dockerfile
|
|
||
| gcloud components install gke-gcloud-auth-plugin | ||
|
|
||
| 4. **Create a GKE cluster** |
There was a problem hiding this comment.
Let's also add a step suggesting the command on how to terminate this cluster once the usage is done. WDYT?
There was a problem hiding this comment.
Added a command to delete cluster
dev/Dockerfile.ray_google_cloud
Outdated
| @@ -0,0 +1,22 @@ | |||
| FROM quay.io/astronomer/astro-runtime:12.2.0 | |||
|
|
|||
There was a problem hiding this comment.
| #Change path to your service account key here |
There was a problem hiding this comment.
Do we need to mount this key file? Can we specify how to do that?
There was a problem hiding this comment.
As discussed offline moved the content of Dockerfile.ray_google_cloud file to the Dockerfile and deleted this file
Add documentation for deploying the project in the /dev directory on Astro Cloud. I created a Makefile target called "deploy" for this purpose. For this exercise, I set up an Astro deployment on AWS Cloud and a RayCluster on GKE. To deploy on Astro Cloud, run the command make deploy. closes: #88
pankajastro
force-pushed
the
astro-deploy-docs
branch
from
45d847e
to
eca8821
Compare
Add documentation for deploying the project in the /dev directory on Astro Cloud. I created a Makefile target called "deploy" for this purpose.
I set up an Astro deployment on AWS Cloud and a RayCluster on GKE for this exercise.
To deploy on Astro Cloud, run the command make deploy.
Generated Docs
closes: #88