From e01f4c75e73c89f1a316f86384a7a1efc64ad225 Mon Sep 17 00:00:00 2001 From: Akash Jain <15995028+akash-jain-10@users.noreply.github.com> Date: Tue, 2 Jul 2024 12:08:00 +0530 Subject: [PATCH] docs: Ingestion Version Tagging system update for `1.5.0` (#16879) --- .../upgrade/upgrade-prerequisites.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/openmetadata-docs/content/partials/v1.5/deployment/upgrade/upgrade-prerequisites.md b/openmetadata-docs/content/partials/v1.5/deployment/upgrade/upgrade-prerequisites.md index 3e4df15011c..708f98f78be 100644 --- a/openmetadata-docs/content/partials/v1.5/deployment/upgrade/upgrade-prerequisites.md +++ b/openmetadata-docs/content/partials/v1.5/deployment/upgrade/upgrade-prerequisites.md @@ -84,6 +84,33 @@ during the migration after bumping this value, you can increase them further. After the migration is finished, you can revert this changes. +# New Versioning System for Ingestion Docker Image + +We are excited to announce a recent change in our version tagging system for our Ingestion Docker images. This update aims to improve consistency and clarity in our versioning, aligning our Docker image tags with our Python PyPi package versions. + +### Ingestion Docker Image Tags + +To maintain consistency, our Docker images will now follow the same 4-digit versioning system as of Python Package versions. For example, a Docker image version might look like `1.0.0.0`. + +Additionally, we will continue to provide a 3-digit version tag (e.g., `1.0.0`) that will always point to the latest corresponding 4-digit image tag. This ensures ease of use for those who prefer a simpler version tag while still having access to the most recent updates. + +### Benefits + +**Consistency**: Both Python applications and Docker images will have the same versioning format, making it easier to track and manage versions. +**Clarity**: The 4-digit system provides a clear and detailed versioning structure, helping users understand the nature and scope of changes. +**Non-Breaking Change**: This update is designed to be non-disruptive. Existing Ingestions and dependencies will remain unaffected. + +#### Example + +Here’s an example of how the new versioning works: + +**Python Application Version**: `1.5.0.0` +**Docker Image Tags**: +- `1.5.0.0` (specific version) +- `1.5.0` (latest version in the 1.5.0.x series) + +We believe this update will bring greater consistency and clarity to our versioning system. As always, we value your feedback and welcome any questions or comments you may have. + # Backward Incompatible Changes ## 1.4.0