diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md deleted file mode 100644 index 62bd790a96..0000000000 --- a/docs/CHANGELOG.md +++ /dev/null @@ -1,179 +0,0 @@ -# Changelog - -## [5.0.0-21](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-20...docs-v5.0.0-21) (2023-12-18) - - -### Bug Fixes - -* prepare for 5.0.0-21 release ([cee44ca](https://github.com/GluuFederation/flex/commit/cee44ca8f5e66e5d1861fe499665f9dac40183ce)) - -## [5.0.0-20](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-19...docs-v5.0.0-20) (2023-11-16) - - -### Features - -* aio chart ([#1436](https://github.com/GluuFederation/flex/issues/1436)) ([a20a695](https://github.com/GluuFederation/flex/commit/a20a695e913faca0b5033d5bc532449ce5c11ade)) - - -### Bug Fixes - -* **docs:** update casa base URI ([#1440](https://github.com/GluuFederation/flex/issues/1440)) ([495536c](https://github.com/GluuFederation/flex/commit/495536cefedfe27116df174c3c73ac05369f90a1)) -* prepare for 5.0.0-20 release ([f74643c](https://github.com/GluuFederation/flex/commit/f74643c6aa0aee9d4c218b90fb1f9237171324f8)) - -## [5.0.0-19](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-18...docs-v5.0.0-19) (2023-10-12) - - -### Features - -* **docs:** remove Casa files from Flex ([a5b7fcd](https://github.com/GluuFederation/flex/commit/a5b7fcd302924c5f77df89a074de98e6ae78b888)) - - -### Bug Fixes - -* **docs:** remove Casa image assets ([0b9f0b4](https://github.com/GluuFederation/flex/commit/0b9f0b4cc467ef61b66707cd4b8d8b3bf7ae354f)) -* **docs:** update docs w.r.t casa move to Jans ([5b7d3fd](https://github.com/GluuFederation/flex/commit/5b7d3fd5fd04d0853b2f3339c283db5948f1c84c)) -* **docs:** update docs w.r.t casa move to Jans ([16f647c](https://github.com/GluuFederation/flex/commit/16f647c78ecfac33317ae108c0283782c0354eaa)) -* prepare for 5.0.0-19 release ([2d8e13d](https://github.com/GluuFederation/flex/commit/2d8e13deb4364063ffc7270d617697eb0994ead7)) - -## [5.0.0-18](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-16...docs-v5.0.0-18)(2023-09-23) - - -### Features - -* adding configuration and logs details ([d136f3d](https://github.com/GluuFederation/flex/commit/d136f3d7d0572b6a3efde3357372f9d28ce0fdda)) -* updating configuration docs ([a1933e3](https://github.com/GluuFederation/flex/commit/a1933e379af56345a599d9965aaa784b93247cca)) - - -### Bug Fixes - -* prepare for 5.0.0-18 release ([29f822f](https://github.com/GluuFederation/flex/commit/29f822fb9071d64bef9f05f05d34e62991253c8e)) -* prepare for 5.0.0-18 release ([4af69cb](https://github.com/GluuFederation/flex/commit/4af69cbd7d900d889f15a341368b4bfa2a3552e9)) -* versioning ([1abf437](https://github.com/GluuFederation/flex/commit/1abf437211cbaef6052d5d4eeeac9e54b1de61eb)) - -## [5.0.0-16](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-15...docs-v5.0.0-16) (2023-08-14) - - -### Bug Fixes - -* prepare for 5.0.0-16 release ([699d534](https://github.com/GluuFederation/flex/commit/699d53480c98ab0cb4562097757b64fcbd17d9c9)) - -## [5.0.0-15](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-14...docs-v5.0.0-15) (2023-07-14) - - -### Features - -* adding tags ([7841e03](https://github.com/GluuFederation/flex/commit/7841e03f6f626c29e353011332a7d9ac1fcf87bf)) -* documentation of admin-ui [#1063](https://github.com/GluuFederation/flex/issues/1063) ([3cf1e7b](https://github.com/GluuFederation/flex/commit/3cf1e7bd870f5f78628388fb4376c61594051d6b)) -* documentation of admin-ui [#1063](https://github.com/GluuFederation/flex/issues/1063) ([48233d3](https://github.com/GluuFederation/flex/commit/48233d38086d1982e8b59d2ba14fefd86e158438)) -* edit flex license contents ([8d7f749](https://github.com/GluuFederation/flex/commit/8d7f7499774f1a67aca902e3484b06b9cdbc7e96)) -* making changes as per review comments ([1bcd39b](https://github.com/GluuFederation/flex/commit/1bcd39b83bb8b4ebbd152ea1155c8946a572ec9e)) -* making changes as per review comments ([5c636fb](https://github.com/GluuFederation/flex/commit/5c636fbc05ef2f0a1d02a77e451ed268914fcec7)) - - -### Bug Fixes - -* **doc:** added How to configure SuperGluu in Flex ([6b7beef](https://github.com/GluuFederation/flex/commit/6b7beefacecd54bad75f7705b4b43a9ca4e6e59c)) -* **doc:** adding SG screenshot - 2 ([e06bd79](https://github.com/GluuFederation/flex/commit/e06bd79e2f7050faa1be25223e3c0d7a44a62b89)) -* **doc:** adding SG screenshot-1 ([b581a03](https://github.com/GluuFederation/flex/commit/b581a032586bed688af7428cea2b3508a6405cb0)) -* **doc:** enable SG - 2 ([d86ec85](https://github.com/GluuFederation/flex/commit/d86ec85556c8c170f9185dd789e259c0cc12fc11)) -* **doc:** Flex SG doc review - How to Use SuperGluu ([f564dd1](https://github.com/GluuFederation/flex/commit/f564dd1a96d46d26d3b443f232ff48d41736a77c)) -* **doc:** hiding ad removal related doc ([5354e84](https://github.com/GluuFederation/flex/commit/5354e846c0840f98d5ae1ff1e7f2c83d3841d7b6)) -* **doc:** how to enable SG in Flex-UI ([4851205](https://github.com/GluuFederation/flex/commit/48512055c34827b6268f887e652c17bed003b5a3)) -* **doc:** index page flex ([7d48422](https://github.com/GluuFederation/flex/commit/7d4842288159d356feec84bddb7dfb4881d96be4)) -* **doc:** removing key list from user record info ([01b671a](https://github.com/GluuFederation/flex/commit/01b671aeaa48de46c0152609b42b84e92a76e0fb)) -* **docs:** flex-ui SG -- Compatability ([f78c46a](https://github.com/GluuFederation/flex/commit/f78c46a462fd58120c35c29592a9f0698f237f88)) -* **doc:** SG flex - How to use Super Gluu-1 ([e07641c](https://github.com/GluuFederation/flex/commit/e07641cf7b1af4ebfbffcdf16f8b48b166efdb5c)) -* **doc:** sg flex - how to use Super Gluu-screenshot location ([7798023](https://github.com/GluuFederation/flex/commit/77980232e29f63e4273dc5b94d625691d2f3bd88)) -* **doc:** sg workflows ([601b237](https://github.com/GluuFederation/flex/commit/601b237fa19c64534e25ec9c6b76bfe6c9fbf514)) -* **docs:** test SG authentication ([32f6b24](https://github.com/GluuFederation/flex/commit/32f6b2475eed8fbbbae37629de065dcfdd9c1404)) -* **doc:** test authentication SG ([6d0f550](https://github.com/GluuFederation/flex/commit/6d0f5507e42cd3b13f384db7036d07fa28865a89)) -* **doc:** Test authentication user guide ([a554646](https://github.com/GluuFederation/flex/commit/a554646d6972f7409dc2751a02f1d623db895532)) -* **doc:** uploading modified screenshot ([0e9e0cf](https://github.com/GluuFederation/flex/commit/0e9e0cf1e1b66e15f4773552da8459b6e3fc8342)) -* prepare for 5.0.0-15 release ([664553a](https://github.com/GluuFederation/flex/commit/664553ab80e24a44fd68837e1d3998a730bd778c)) - -## [5.0.0-14](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-13...docs-v5.0.0-14) (2023-06-12) - - -### Bug Fixes - -* prepare for 5.0.0-14 release ([9481f55](https://github.com/GluuFederation/flex/commit/9481f55a380091501cf912778955e2ebba23e30c)) - -## [5.0.0-13](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-12...docs-v5.0.0-13) (2023-05-12) - - -### Bug Fixes - -* **admin-ui:** add apply button ([d334103](https://github.com/GluuFederation/flex/commit/d3341031c9b198bf7849ad2f88193c99b7f74c80)) -* blockUI converted to functional component ([4b8e7bd](https://github.com/GluuFederation/flex/commit/4b8e7bd35331512f1181614fd692da923bd48a34)) -* email_2fa_core/install.bat has been removed; ([f27e461](https://github.com/GluuFederation/flex/commit/f27e4613c23a7243a3adb6c433cd7a422facc851)) -* prepare for 5.0.13 release ([8578827](https://github.com/GluuFederation/flex/commit/85788276444c5015378120b5801a8848d225b02f)) -* profile details is distorted when multiple roles assigned to the user ([e4603d8](https://github.com/GluuFederation/flex/commit/e4603d862a5728faa283ee4b3e60866face5b8db)) -* revert prod webpack config of static & fonts files ([96fa135](https://github.com/GluuFederation/flex/commit/96fa1354790e17467231d3931f9887a93d1f2b90)) - -## [5.0.0-12](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-11...docs-v5.0.0-12) (2023-04-18) - - -### Bug Fixes - -* prepare for 5.0.12 release ([994c985](https://github.com/GluuFederation/flex/commit/994c9855cf34c3c805f87943f9203cf58c5810e7)) - -## [5.0.0-11](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-10...docs-v5.0.0-11) (2023-04-06) - - -### Bug Fixes - -* prepare for 5.0.11 release ([d3cc35a](https://github.com/GluuFederation/flex/commit/d3cc35a70437f4298dadc0f779d190af7370c75b)) - -## [5.0.0-10](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-9...docs-v5.0.0-10) (2023-03-16) - - -### Bug Fixes - -* add cn license enforcment to chart ([55fb0c9](https://github.com/GluuFederation/flex/commit/55fb0c97428a3ec704e80558679a7e9d7f88c42c)) -* prepare for 5.0.10 release ([1ffcbc7](https://github.com/GluuFederation/flex/commit/1ffcbc74d837e7a037d6cff71d990573d04bba7b)) - -## [5.0.0-9](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-8...docs-v5.0.0-9) (2023-03-09) - - -### Bug Fixes - -* **docs:** ubuntu install download location ([bb3a5cd](https://github.com/GluuFederation/flex/commit/bb3a5cdc282c6089edb326675061e72d20bd8431)) -* prepare for 5.0.0-9 release ([716d309](https://github.com/GluuFederation/flex/commit/716d309350f5713b96f482dde9e0a543e5e62286)) - -## [5.0.0-8](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-7...docs-v5.0.0-8) (2023-03-02) - - -### Bug Fixes - -* prepare for 5.0.0-8 release ([29e0cbb](https://github.com/GluuFederation/flex/commit/29e0cbb5166d83268ab9c3ee3c5f3e2bc4dd1489)) - -## [5.0.0-7](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-4...docs-v5.0.0-7) (2023-02-22) - - -### Bug Fixes - -* prepare for 5.0.0-7 release ([7f96937](https://github.com/GluuFederation/flex/commit/7f9693729156b04367b85d0d44a4022a52d53417)) - -## [5.0.0-4](https://github.com/GluuFederation/flex/compare/docs-v5.0.0-3...docs-v5.0.0-4) (2022-12-08) - - -### Bug Fixes - -* getting ready for a release ([a0de091](https://github.com/GluuFederation/flex/commit/a0de091ca26f2c38378e5b0252ab680cb1e3cd88)) - -## 5.0.0-3 (2022-11-08) - - -### Features - -* **admin-ui:** reviewed previously updated dependencies [#416](https://github.com/GluuFederation/flex/issues/416) ([ab81760](https://github.com/GluuFederation/flex/commit/ab81760457727c7a5890d89c2f2ec3dabdeb12eb)) - - -### Bug Fixes - -* getting ready to release 5.0.0-3 ([e8f3ecc](https://github.com/GluuFederation/flex/commit/e8f3eccc3804a0bcc6075d755dad209b188db444)) - - -### Miscellaneous Chores - -* release 5.0.0-2 ([06c6e64](https://github.com/GluuFederation/flex/commit/06c6e64f43a7c98bcb04ba1d48ec97044c19d75d)) diff --git a/docs/install/eol.md b/docs/install/eol.md new file mode 100644 index 0000000000..231f1c1a90 --- /dev/null +++ b/docs/install/eol.md @@ -0,0 +1,70 @@ +--- +tags: + - EOL + - Supported versions + - Version lifecycle +--- + +# Version EOL Policy + +## 1. Lifecycle Overview + +Our End of Life (EOL) policy is designed to provide a predictable schedule for support and upgrades. The lifecycle of any major version is calculated based on its original **General Availability (GA)** date. + +### Key Milestones + +The table below shows general cadense of the key release milestones. Applicable from version `6.0.0` onwards. + +| Milestone | Calculation | Description | +|-------------------------------|-------------------|---------------------------------------------------------------------| +| **General Availability (GA)** | $T_0$ | The date the version was publicly released. | +| **End of Maintenance (EOM)** | $T_0 + 12$ Months | Final date for bug fixes and security patches. | +| **End of Life (EOL)** | $T_0 + 24$ Months | Support is no longer provided; documentation moved to archives. | + +--- + +## 2. Version Status + +Use the table below to determine the current status of your installed version. + +| Version | Release Date (GA) | End of Maintenance | End of Life (Support) | Status | +|------------|-------------------|--------------------|-----------------------|-----------------------| +| **v6.0.0** | 2026-05-01 | 2027-05-01 | 2028-05-01 | **Under development** | +| **v5.x.x** | 2024-03-15 | 2025-03-15 | 2026-11-01 | **Active** | +| **v5.0.x** | 2022-03-15 | 2023-03-15 | 2024-09-15 | **EOL** | + +--- + +## 3. Support Scope During Transition + +As a version approaches its EOL date, the level of support shifts: + +* **Full Support:** Covers "How-to" questions, bug fixes, and security vulnerabilities. +* **Maintenance Support:** No new features. Only critical security patches and high-severity bug fixes are provided. + +--- + +## 4. Upgrade & Migration Guidance + +To maintain system integrity and security, we recommend upgrading to the latest Stable Release at least **six months prior** to your current version's EOL date. + +### Migration Resources: + +* **Breaking Changes Log:** Review our [Changelog](https://github.com/GluuFederation/flex/releases) for API or configuration changes. +* **Compatibility Matrix:** Ensure your OS and hardware meet the system requirements for your deployment platform for the new version. Refer to the [installation](./README.md) section for more details. +* **Automated Upgrade Scripts:** Available for the last three releases to simplify upgrades. + For example, upgrading from 5.14.0 to 6.0.0 should follow: 5.14.0 → 5.15.0 → 5.16.0 → 6.0.0. + +> **Warning:** Running software past its EOL date may result in compatibility issues with newer OS updates and increased exposure to security threats. + +--- + +## 5. Documentation Archiving + +Once a version reaches its EOL date: + +1. Online documentation will be moved to the **Legacy Archive**. +2. Knowledge Base articles will remain searchable but will no longer be updated. +3. Community forums for that version will be set to **Read-Only**. + +--- diff --git a/mkdocs.yml b/mkdocs.yml index 838c9c9d07..476afb007e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -133,6 +133,7 @@ nav: - 'Ubuntu': 'install/vm-install/ubuntu.md' - 'RHEL': 'install/vm-install/rhel.md' - 'SUSE': 'install/vm-install/suse.md' + - 'Version Support Policy': 'install/eol.md' - 'Administration': - 'admin/README.md' - 'Configuration': 'admin/config.md'