Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix airflow connections #3805

Merged
merged 4 commits into from
Feb 20, 2024
Merged

Fix airflow connections #3805

merged 4 commits into from
Feb 20, 2024

Conversation

stacimc
Copy link
Collaborator

@stacimc stacimc commented Feb 17, 2024

Fixes

Locally, most of our Airflow connections are set via environment variables in catalog/.env. In production they are generally set through the Airflow Admin UI. This caused the following issue to be missed in local testing:

We have a script in entrypoint.sh which reformats all airflow connection environment variables (containing the string http) by urlencoding them and prepending 'http://'. The purpose of this was for convenience with setting up the Slack connections locally (otherwise you have to urlencode part of the Slack uri).

It is not necessary for any of our other connection strings and in fact was causing issues with the Elasticsearch connections -- the reformatted string was not parsed correctly, parsing the entire uri as the host.

Description

This PR:

  • modifies the entrypoint script to only modify Slack connection strings, so that they will continue to work
  • updates the get_es_host logic for connecting to Elasticsearch to correctly return the entire URI, rather than just the host (which was previously a workaround for the buggy local behavior, that is not compatible with the connections set in the Admin UI). This should now work for connections set in .env AND in the Airflow UI.
  • adds some extra logs to slack notifications

Testing Instructions

Check out this branch and first verify that the connections as currently set in your local environment still work:

  • Run a data refresh. This will test the data_refresh and elasticsearch_http_production connections
  • Run staging_elasticsearch_cluster_healthcheck to test the elasticsearch_http_staging connection
  • Raise an error in a provider DAG somewhere and test that the Slack connections still work

Now re-test, setting the connection variables through the Admin UI. You can delete them from your .env and rebuild, or more simply just edit the code in elasticsearch_cluster/shared.py and common/ingestion_server.py to use new conn_ids (elasticsearch_test and ingestion_server_test. Then in the airflow UI, navigate to Admin > Connections and add two new connections:

  • ingestion_server_test (or data_refresh if you deleted the local environment variable)
    • Connection Type = HTTP
    • Host = ingestion_server
    • Schema = http
    • Port = 8001
  • elasticsearch_test (or elasticsearch_http_staging if you deleted the local environment variable)
    • Connection Type = HTTP
    • Host = es
    • Schema = leave this blank
    • Port = 9200
  • If you deleted the environment variables locally rather than updating the conn_ids to the test connections, you'll have to create an identical connection for elasticsearch_http_production as well

Then re-run the data refresh and the staging_elasticsearch_cluster_healthcheck and ensure they still work.

Note that when we merge this we need to drop the 'schema' configuration for the two elasticsearch http connections in productiotn.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@stacimc stacimc added 🟥 priority: critical Must be addressed ASAP 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🧱 stack: catalog Related to the catalog and Airflow DAGs labels Feb 17, 2024
@stacimc stacimc self-assigned this Feb 17, 2024
@stacimc stacimc requested a review from a team as a code owner February 17, 2024 00:47
@stacimc stacimc requested review from krysal and obulat February 17, 2024 00:47
@stacimc stacimc mentioned this pull request Feb 17, 2024
8 tasks
Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works as expected locally, thanks for making all these small but impactful changes!

catalog/dags/common/slack.py Outdated Show resolved Hide resolved
Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works as expected 👍 Great improvement!

Co-authored-by: Madison Swain-Bowden <[email protected]>
@stacimc stacimc merged commit 1cf6c6a into main Feb 20, 2024
39 checks passed
@stacimc stacimc deleted the fix/airflow-connections branch February 20, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP 🧱 stack: catalog Related to the catalog and Airflow DAGs
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants