| Summary: | Routing data structure is backward incompatible | ||
|---|---|---|---|
| Product: | OKD | Reporter: | Rajat Chopra <rchopra> |
| Component: | Documentation | Assignee: | Vikram Goyal <vigoyal> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Vikram Goyal <vigoyal> |
| Severity: | high | Docs Contact: | Vikram Goyal <vigoyal> |
| Priority: | unspecified | ||
| Version: | 3.x | CC: | aos-bugs, bmeng, eparis, jliggitt, mmccomas |
| Target Milestone: | --- | Keywords: | Documentation |
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | All | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2017-05-30 12:49:03 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
|
Description
Rajat Chopra
2016-08-19 19:48:47 UTC
While we investigate how to make the template backwards compatible. This document describes the differences that exist, why they exist and how can one make changes to an older template by understanding the new data structure. https://github.com/rajatchopra/routing_data_structure_changes/blob/master/README.md The struct fed into the template needs to contain identical fields to 1.2 It can contain additional fields, which new templates can use This is what it would entail in response to Jordan's suggestion(Comment#2), primarily because we removed some fields from the original struct (if we do, then we will have to populate that field too - precisely its a map of routes that exist for a service). 1. Create duplicate structures for services/routes 2. Maintain two sets of watch/populate/delete functions to manage the two structures 3. Have the top level template point to the two sets simultaneously 4. Change the current template to start using the new structures only The decision at this point is to allow the incompatibility and mention it conspicuously in the Release Notes. You are going to mention the incompatibility in the release note and point to a longer form document discussing the incompatibility and what users should do about it. The longer document will be in openshift-docs. You have until this morning, your time, to get an openshift-docs PR opened. Docs PR: https://github.com/openshift/openshift-docs/pull/2784 Release Note update comment: https://github.com/openshift/openshift-docs/pull/2774#issuecomment-244440648 Kind help needed from the docs team to get this to closure. The docs look good to me. |