Commit 2fc529e
committed
docs: list the fields CacheRuntime can update in place, and stop enumerating the rest
The spec update doc listed `replicas` under "Unsupported Update Fields" and told
readers a redeploy was required. It is in fact synced on every reconcile:
syncRuntimeSpec passes it into ComponentSpec for Master and Worker, and
SyncComponentSpec applies it through updateReplicas before image and resources.
Give `replicas` its own subsection in section 3, alongside runtimeVersion and
resources, and record the two things worth knowing before scaling: cache on a
removed Worker is discarded rather than migrated, and scaling writes no
RuntimeCondition and emits no Event, so the controller log is the only place to
observe it.
Section 4 used to enumerate the unsupported fields. Keeping that list correct
meant remembering, every time a field became syncable, to delete a line from a
section unrelated to the change, with nothing in the code or CI to prompt for
it — which is how the `replicas` entry survived. It was also labelled
"including but not limited to", so it could not be authoritative anyway.
Section 4 now refers to section 3 instead of repeating it, leaving one place
where a supported field is recorded.
Also drop the TODO above the syncRuntimeSpec call asking for the replica
scaling that the call already does.
Signed-off-by: btxu-db <btxu-db@outlook.com>1 parent f2785f8 commit 2fc529e
3 files changed
Lines changed: 76 additions & 40 deletions
File tree
- docs
- en/samples/cacheruntime
- zh/samples/cacheruntime
- pkg/ddc/cache/engine
Lines changed: 38 additions & 19 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
10 | 11 | | |
11 | 12 | | |
12 | 13 | | |
| |||
16 | 17 | | |
17 | 18 | | |
18 | 19 | | |
19 | | - | |
20 | | - | |
| 20 | + | |
| 21 | + | |
21 | 22 | | |
22 | 23 | | |
23 | 24 | | |
24 | | - | |
| 25 | + | |
25 | 26 | | |
26 | 27 | | |
27 | 28 | | |
| |||
104 | 105 | | |
105 | 106 | | |
106 | 107 | | |
107 | | - | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
108 | 124 | | |
109 | | - | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
110 | 136 | | |
111 | | - | |
112 | | - | |
113 | | - | |
114 | | - | |
115 | | - | |
116 | | - | |
117 | | - | |
118 | | - | |
119 | | - | |
| 137 | + | |
120 | 138 | | |
121 | 139 | | |
122 | | - | |
123 | | - | |
| 140 | + | |
| 141 | + | |
124 | 142 | | |
125 | 143 | | |
126 | 144 | | |
| |||
130 | 148 | | |
131 | 149 | | |
132 | 150 | | |
| 151 | + | |
133 | 152 | | |
134 | 153 | | |
135 | 154 | | |
136 | | - | |
137 | | - | |
| 155 | + | |
| 156 | + | |
138 | 157 | | |
Lines changed: 38 additions & 19 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
10 | 11 | | |
11 | 12 | | |
12 | 13 | | |
| |||
16 | 17 | | |
17 | 18 | | |
18 | 19 | | |
19 | | - | |
20 | | - | |
| 20 | + | |
| 21 | + | |
21 | 22 | | |
22 | 23 | | |
23 | 24 | | |
24 | | - | |
| 25 | + | |
25 | 26 | | |
26 | 27 | | |
27 | 28 | | |
| |||
103 | 104 | | |
104 | 105 | | |
105 | 106 | | |
106 | | - | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
107 | 123 | | |
108 | | - | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
109 | 135 | | |
110 | | - | |
111 | | - | |
112 | | - | |
113 | | - | |
114 | | - | |
115 | | - | |
116 | | - | |
117 | | - | |
118 | | - | |
| 136 | + | |
119 | 137 | | |
120 | 138 | | |
121 | | - | |
122 | | - | |
| 139 | + | |
| 140 | + | |
123 | 141 | | |
124 | 142 | | |
125 | 143 | | |
| |||
129 | 147 | | |
130 | 148 | | |
131 | 149 | | |
| 150 | + | |
132 | 151 | | |
133 | 152 | | |
134 | 153 | | |
135 | | - | |
136 | | - | |
| 154 | + | |
| 155 | + | |
137 | 156 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
67 | | - | |
68 | | - | |
69 | 67 | | |
70 | 68 | | |
71 | 69 | | |
| |||
0 commit comments