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

docs: add documentation for configuring notifications in GCP #5545

Merged
merged 4 commits into from
Aug 9, 2024

Conversation

desihsu
Copy link
Contributor

@desihsu desihsu commented Jul 9, 2024

What changes were proposed in this pull request?

This adds documentation for existing functionality for notifications in GCP.

How was this patch tested?

make docs succeeds.

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Docs link

https://flyte--5545.org.readthedocs.build/en/5545/deployment/configuration/notifications.html#gcp-config

GCP Config section added.

Copy link

welcome bot commented Jul 9, 2024

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

  • Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
  • Sign off your commits (Reference: DCO Guide).

desihsu added 3 commits July 9, 2024 05:34
Signed-off-by: Desi Hsu <[email protected]>
Signed-off-by: Desi Hsu <[email protected]>
Signed-off-by: Desi Hsu <[email protected]>
@desihsu desihsu force-pushed the desi/notifications_gcp branch from 97fd088 to 7d40635 Compare July 9, 2024 05:34
Signed-off-by: Desi Hsu <[email protected]>
@desihsu desihsu marked this pull request as ready for review July 9, 2024 05:55
@desihsu desihsu requested review from neverett and ppiegaze as code owners July 9, 2024 05:55
@davidmirror-ops
Copy link
Contributor

@desihsu Thanks so much!

@davidmirror-ops davidmirror-ops self-requested a review July 10, 2024 20:47
Copy link

codecov bot commented Jul 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.98%. Comparing base (b7e6959) to head (bbc2389).
Report is 175 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5545   +/-   ##
=======================================
  Coverage   60.98%   60.98%           
=======================================
  Files         796      796           
  Lines       51647    51647           
=======================================
  Hits        31498    31498           
  Misses      17249    17249           
  Partials     2900     2900           
Flag Coverage Δ
unittests-datacatalog 69.31% <ø> (ø)
unittests-flyteadmin 58.73% <ø> (ø)
unittests-flytecopilot 17.79% <ø> (ø)
unittests-flytectl 67.44% <ø> (ø)
unittests-flyteidl 79.06% <ø> (ø)
unittests-flyteplugins 61.85% <ø> (ø)
unittests-flytepropeller 57.42% <ø> (ø)
unittests-flytestdlib 65.68% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@davidmirror-ops davidmirror-ops merged commit 5be4545 into flyteorg:master Aug 9, 2024
50 checks passed
Copy link

welcome bot commented Aug 9, 2024

Congrats on merging your first pull request! 🎉

bgedik pushed a commit to bgedik/flyte that referenced this pull request Aug 15, 2024
…g#5545)

* update

Signed-off-by: Desi Hsu <[email protected]>

* dco

Signed-off-by: Desi Hsu <[email protected]>

* dco

Signed-off-by: Desi Hsu <[email protected]>

* typo

Signed-off-by: Desi Hsu <[email protected]>

---------

Signed-off-by: Desi Hsu <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>
vlibov pushed a commit to vlibov/flyte that referenced this pull request Aug 16, 2024
…g#5545)

* update

Signed-off-by: Desi Hsu <[email protected]>

* dco

Signed-off-by: Desi Hsu <[email protected]>

* dco

Signed-off-by: Desi Hsu <[email protected]>

* typo

Signed-off-by: Desi Hsu <[email protected]>

---------

Signed-off-by: Desi Hsu <[email protected]>
Signed-off-by: Vladyslav Libov <[email protected]>
eapolinario added a commit that referenced this pull request Aug 20, 2024
…ame (#5616)

* Add environment variable for pod name

Signed-off-by: Bugra Gedik <[email protected]>

* [flyteadmin] Refactor panic recovery into middleware (#5546)

* Refactor panic handling to middleware

Signed-off-by: Jason Parraga <[email protected]>

* Remove registration of old panicCounter

Signed-off-by: Jason Parraga <[email protected]>

* Add test coverage

Signed-off-by: Jason Parraga <[email protected]>

---------

Signed-off-by: Jason Parraga <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Snowflake agent Doc (#5620)

* TEST build

Signed-off-by: Future-Outlier <[email protected]>

* remove emphasize-lines

Signed-off-by: Future-Outlier <[email protected]>

* test build

Signed-off-by: Future-Outlier <[email protected]>

* revert

Signed-off-by: Future-Outlier <[email protected]>

---------

Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* [flytepropeller][compiler] Error Handling when Type is not found (#5612)

* FlytePropeller Compiler Avoid Crash when Type not found

Signed-off-by: Future-Outlier <[email protected]>

* Update pingsu's error message advices

Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: pingsutw  <[email protected]>

* fix lint

Signed-off-by: Future-Outlier <[email protected]>

* Trigger CI

Signed-off-by: Future-Outlier <[email protected]>

* Trigger CI

Signed-off-by: Future-Outlier <[email protected]>

---------

Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: pingsutw <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Fix nil pointer when task plugin load returns error (#5622)

Signed-off-by: Bugra Gedik <[email protected]>

* Log stack trace when refresh cache sync recovers from panic (#5623)

Signed-off-by: Bugra Gedik <[email protected]>

* use private-key (#5626)

Signed-off-by: Bugra Gedik <[email protected]>

* Explain how Agent Secret Works (#5625)

* first version

Signed-off-by: Future-Outlier <[email protected]>

* update

Signed-off-by: Future-Outlier <[email protected]>

---------

Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Fix typo in execution manager (#5619)

Signed-off-by: ddl-rliu <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Amend Admin to use grpc message size (#5628)

* add send arg

Signed-off-by: Yee Hing Tong <[email protected]>

* Add acction to remove cache in gh runner

Signed-off-by: Eduardo Apolinario <[email protected]>

* Use correct checked out path

Signed-off-by: Eduardo Apolinario <[email protected]>

* Path in strings

Signed-off-by: Eduardo Apolinario <[email protected]>

* Checkout repo in root

Signed-off-by: Eduardo Apolinario <[email protected]>

* Use the correct path to new action

Signed-off-by: Eduardo Apolinario <[email protected]>

* Do not use gh var in path to clear-action-cache

Signed-off-by: Eduardo Apolinario <[email protected]>

* Remove wrong invocation of clear-action-cache

Signed-off-by: Eduardo Apolinario <[email protected]>

* GITHUB_WORKSPACE is implicit in the checkout action

Signed-off-by: Eduardo Apolinario <[email protected]>

* Refer to local `flyte` directory

Signed-off-by: Eduardo Apolinario <[email protected]>

---------

Signed-off-by: Yee Hing Tong <[email protected]>
Signed-off-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* document the process of setting ttl for a ray cluster (#5636)

Signed-off-by: Kevin Su <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Add CustomHeaderMatcher to pass additional headers (#5563)

Signed-off-by: Andrew Dye <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Turn flyteidl and flytectl releases into manual gh workflows (#5635)

* Make flyteidl releases go through a manual gh workflow

Signed-off-by: Eduardo Apolinario <[email protected]>

* Make flytectl releases go through a manual gh workflow

Signed-off-by: Eduardo Apolinario <[email protected]>

* Rewrite the documentation for `version` and clarify wording in RELEASE.md

Signed-off-by: Eduardo Apolinario <[email protected]>

---------

Signed-off-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* docs: fix typo (#5643)

* fix CHANGELOG-v0.2.0.md

Signed-off-by: Christina <[email protected]>

* fix CHANGELOG-v1.0.2-b1.md

Signed-off-by: Christina <[email protected]>

* fix CHANGELOG-v1.1.0.md

Signed-off-by: Christina <[email protected]>

* fix CHANGELOG-v1.3.0.md

Signed-off-by: Christina <[email protected]>

---------

Signed-off-by: Christina <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Use enable_deck=True in docs (#5645)

Signed-off-by: Bugra Gedik <[email protected]>

* Fix flyteidl release  checkout all tags (#5646)

* Fetch all tags in flyteidl-release.yml

Signed-off-by: Eduardo Apolinario <[email protected]>

* Fix sed expression for npm job

Signed-off-by: Eduardo Apolinario <[email protected]>

---------

Signed-off-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Install pyarrow in sandbox functional tests (#5647)

Signed-off-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* docs: add documentation for configuring notifications in GCP (#5545)

* update

Signed-off-by: Desi Hsu <[email protected]>

* dco

Signed-off-by: Desi Hsu <[email protected]>

* dco

Signed-off-by: Desi Hsu <[email protected]>

* typo

Signed-off-by: Desi Hsu <[email protected]>

---------

Signed-off-by: Desi Hsu <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Correct "sucessfile" to "successfile" (#5652)

Signed-off-by: Bugra Gedik <[email protected]>

* Fix ordering for custom template values in cluster resource controller (#5648)

Signed-off-by: Katrina Rogan <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Don't error when attempting to trigger schedules for inactive projects (#5649)

* Don't error when attempting to trigger schedules for inactive projects

Signed-off-by: Katrina Rogan <[email protected]>

* regen

Signed-off-by: Katrina Rogan <[email protected]>

---------

Signed-off-by: Katrina Rogan <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* fix tests

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* Fix comment symbol

Signed-off-by: Eduardo Apolinario <[email protected]>

* fix one more test

Signed-off-by: Bugra Gedik <[email protected]>

---------

Signed-off-by: Bugra Gedik <[email protected]>
Signed-off-by: Jason Parraga <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: ddl-rliu <[email protected]>
Signed-off-by: Yee Hing Tong <[email protected]>
Signed-off-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Kevin Su <[email protected]>
Signed-off-by: Andrew Dye <[email protected]>
Signed-off-by: Christina <[email protected]>
Signed-off-by: Desi Hsu <[email protected]>
Signed-off-by: Katrina Rogan <[email protected]>
Co-authored-by: Jason Parraga <[email protected]>
Co-authored-by: Future-Outlier <[email protected]>
Co-authored-by: pingsutw <[email protected]>
Co-authored-by: ddl-rliu <[email protected]>
Co-authored-by: Yee Hing Tong <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Andrew Dye <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Christina <[email protected]>
Co-authored-by: Thomas J. Fan <[email protected]>
Co-authored-by: desihsu <[email protected]>
Co-authored-by: ShengYu <[email protected]>
Co-authored-by: Katrina Rogan <[email protected]>
pmahindrakar-oss pushed a commit that referenced this pull request Sep 9, 2024
…ame (#5616)

* Add environment variable for pod name

Signed-off-by: Bugra Gedik <[email protected]>

* [flyteadmin] Refactor panic recovery into middleware (#5546)

* Refactor panic handling to middleware

Signed-off-by: Jason Parraga <[email protected]>

* Remove registration of old panicCounter

Signed-off-by: Jason Parraga <[email protected]>

* Add test coverage

Signed-off-by: Jason Parraga <[email protected]>

---------

Signed-off-by: Jason Parraga <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Snowflake agent Doc (#5620)

* TEST build

Signed-off-by: Future-Outlier <[email protected]>

* remove emphasize-lines

Signed-off-by: Future-Outlier <[email protected]>

* test build

Signed-off-by: Future-Outlier <[email protected]>

* revert

Signed-off-by: Future-Outlier <[email protected]>

---------

Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* [flytepropeller][compiler] Error Handling when Type is not found (#5612)

* FlytePropeller Compiler Avoid Crash when Type not found

Signed-off-by: Future-Outlier <[email protected]>

* Update pingsu's error message advices

Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: pingsutw  <[email protected]>

* fix lint

Signed-off-by: Future-Outlier <[email protected]>

* Trigger CI

Signed-off-by: Future-Outlier <[email protected]>

* Trigger CI

Signed-off-by: Future-Outlier <[email protected]>

---------

Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: pingsutw <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Fix nil pointer when task plugin load returns error (#5622)

Signed-off-by: Bugra Gedik <[email protected]>

* Log stack trace when refresh cache sync recovers from panic (#5623)

Signed-off-by: Bugra Gedik <[email protected]>

* use private-key (#5626)

Signed-off-by: Bugra Gedik <[email protected]>

* Explain how Agent Secret Works (#5625)

* first version

Signed-off-by: Future-Outlier <[email protected]>

* update

Signed-off-by: Future-Outlier <[email protected]>

---------

Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Fix typo in execution manager (#5619)

Signed-off-by: ddl-rliu <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Amend Admin to use grpc message size (#5628)

* add send arg

Signed-off-by: Yee Hing Tong <[email protected]>

* Add acction to remove cache in gh runner

Signed-off-by: Eduardo Apolinario <[email protected]>

* Use correct checked out path

Signed-off-by: Eduardo Apolinario <[email protected]>

* Path in strings

Signed-off-by: Eduardo Apolinario <[email protected]>

* Checkout repo in root

Signed-off-by: Eduardo Apolinario <[email protected]>

* Use the correct path to new action

Signed-off-by: Eduardo Apolinario <[email protected]>

* Do not use gh var in path to clear-action-cache

Signed-off-by: Eduardo Apolinario <[email protected]>

* Remove wrong invocation of clear-action-cache

Signed-off-by: Eduardo Apolinario <[email protected]>

* GITHUB_WORKSPACE is implicit in the checkout action

Signed-off-by: Eduardo Apolinario <[email protected]>

* Refer to local `flyte` directory

Signed-off-by: Eduardo Apolinario <[email protected]>

---------

Signed-off-by: Yee Hing Tong <[email protected]>
Signed-off-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* document the process of setting ttl for a ray cluster (#5636)

Signed-off-by: Kevin Su <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Add CustomHeaderMatcher to pass additional headers (#5563)

Signed-off-by: Andrew Dye <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Turn flyteidl and flytectl releases into manual gh workflows (#5635)

* Make flyteidl releases go through a manual gh workflow

Signed-off-by: Eduardo Apolinario <[email protected]>

* Make flytectl releases go through a manual gh workflow

Signed-off-by: Eduardo Apolinario <[email protected]>

* Rewrite the documentation for `version` and clarify wording in RELEASE.md

Signed-off-by: Eduardo Apolinario <[email protected]>

---------

Signed-off-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* docs: fix typo (#5643)

* fix CHANGELOG-v0.2.0.md

Signed-off-by: Christina <[email protected]>

* fix CHANGELOG-v1.0.2-b1.md

Signed-off-by: Christina <[email protected]>

* fix CHANGELOG-v1.1.0.md

Signed-off-by: Christina <[email protected]>

* fix CHANGELOG-v1.3.0.md

Signed-off-by: Christina <[email protected]>

---------

Signed-off-by: Christina <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Use enable_deck=True in docs (#5645)

Signed-off-by: Bugra Gedik <[email protected]>

* Fix flyteidl release  checkout all tags (#5646)

* Fetch all tags in flyteidl-release.yml

Signed-off-by: Eduardo Apolinario <[email protected]>

* Fix sed expression for npm job

Signed-off-by: Eduardo Apolinario <[email protected]>

---------

Signed-off-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Install pyarrow in sandbox functional tests (#5647)

Signed-off-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* docs: add documentation for configuring notifications in GCP (#5545)

* update

Signed-off-by: Desi Hsu <[email protected]>

* dco

Signed-off-by: Desi Hsu <[email protected]>

* dco

Signed-off-by: Desi Hsu <[email protected]>

* typo

Signed-off-by: Desi Hsu <[email protected]>

---------

Signed-off-by: Desi Hsu <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Correct "sucessfile" to "successfile" (#5652)

Signed-off-by: Bugra Gedik <[email protected]>

* Fix ordering for custom template values in cluster resource controller (#5648)

Signed-off-by: Katrina Rogan <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* Don't error when attempting to trigger schedules for inactive projects (#5649)

* Don't error when attempting to trigger schedules for inactive projects

Signed-off-by: Katrina Rogan <[email protected]>

* regen

Signed-off-by: Katrina Rogan <[email protected]>

---------

Signed-off-by: Katrina Rogan <[email protected]>
Signed-off-by: Bugra Gedik <[email protected]>

* fix tests

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* change to shorter names

Signed-off-by: Bugra Gedik <[email protected]>

* Fix comment symbol

Signed-off-by: Eduardo Apolinario <[email protected]>

* fix one more test

Signed-off-by: Bugra Gedik <[email protected]>

---------

Signed-off-by: Bugra Gedik <[email protected]>
Signed-off-by: Jason Parraga <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: ddl-rliu <[email protected]>
Signed-off-by: Yee Hing Tong <[email protected]>
Signed-off-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Kevin Su <[email protected]>
Signed-off-by: Andrew Dye <[email protected]>
Signed-off-by: Christina <[email protected]>
Signed-off-by: Desi Hsu <[email protected]>
Signed-off-by: Katrina Rogan <[email protected]>
Co-authored-by: Jason Parraga <[email protected]>
Co-authored-by: Future-Outlier <[email protected]>
Co-authored-by: pingsutw <[email protected]>
Co-authored-by: ddl-rliu <[email protected]>
Co-authored-by: Yee Hing Tong <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Andrew Dye <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Christina <[email protected]>
Co-authored-by: Thomas J. Fan <[email protected]>
Co-authored-by: desihsu <[email protected]>
Co-authored-by: ShengYu <[email protected]>
Co-authored-by: Katrina Rogan <[email protected]>
Signed-off-by: pmahindrakar-oss <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants