Skip to content

Commit

Permalink
Added some CICD best practices to the documentation (#5827)
Browse files Browse the repository at this point in the history
* added the documentation related to CICD best practices

Signed-off-by: Murdock9803 <ayushsahu9803@gmail.com>

* Improved the documentation based on suggestions

Signed-off-by: AYUSH SAHU <ayushsahu9803@gmail.com>

* Update CICD doc for registering and serialyzing

Signed-off-by: AYUSH SAHU <ayushsahu9803@gmail.com>

* removed the line about Go releaser

Signed-off-by: AYUSH SAHU <ayushsahu9803@gmail.com>

* Removed some general point about containerization

Signed-off-by: AYUSH SAHU <ayushsahu9803@gmail.com>

---------

Signed-off-by: Murdock9803 <ayushsahu9803@gmail.com>
Signed-off-by: AYUSH SAHU <ayushsahu9803@gmail.com>
  • Loading branch information
Murdock9803 authored Oct 30, 2024
1 parent 6168643 commit 2b0af2b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/user_guide/flyte_fundamentals/registering_workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,17 @@ two GitHub actions that facilitates this:
of Flyte packages, for example, the `.tgz` archives that are created by
`pyflyte package`.

### Some CI/CD best practices

In case Flyte workflows are registered on each commit in your build pipelines, you can consider the following recommendations and approach:

- **Versioning Strategy** : Determining the version of the build for different types of commits makes them consistent and identifiable. For commits on feature branches, use `<branch-name>-<short-commit-hash>` and for the ones on main branches, use `main-<short-commit-hash>`. Use version numbers for the released (tagged) versions.

- **Workflow Serialization and Registration** : Workflows should be serialized and registered based on the versioning of the build and the container image. Depending on whether the build is for a feature branch or main, the registration domain should be adjusted accordingly. For more context, please visit the [Registering workflows](https://docs.flyte.org/en/latest/user_guide/flyte_fundamentals/registering_workflows.html) page.

- **Container Image Specification** : When managing multiple images across tasks within a Flyte workflow, use the `--image` flag during registration to specify which image to use. This avoids hardcoding the image within the task definition, promoting reusability and flexibility in workflows.


## What's next?

In this guide, you learned about the Flyte demo cluster, Flyte configuration, and
Expand Down

0 comments on commit 2b0af2b

Please sign in to comment.