Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add cdc types #2338

Merged
merged 14 commits into from
May 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions docs/api-references/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -734,6 +734,20 @@ TiFlashSpec
</tr>
<tr>
<td>
<code>ticdc</code></br>
<em>
<a href="#ticdcspec">
TiCDCSpec
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>TiCDC cluster spec</p>
</td>
</tr>
<tr>
<td>
<code>pump</code></br>
<em>
<a href="#pumpspec">
Expand Down Expand Up @@ -2624,6 +2638,7 @@ and component-level overrides</p>
(<em>Appears on:</em>
<a href="#pdspec">PDSpec</a>,
<a href="#pumpspec">PumpSpec</a>,
<a href="#ticdcspec">TiCDCSpec</a>,
<a href="#tidbspec">TiDBSpec</a>,
<a href="#tiflashspec">TiFlashSpec</a>,
<a href="#tikvspec">TiKVSpec</a>)
Expand Down Expand Up @@ -8056,6 +8071,88 @@ Same for other components.</p>
</tr>
</tbody>
</table>
<h3 id="ticdcspec">TiCDCSpec</h3>
<p>
(<em>Appears on:</em>
<a href="#tidbclusterspec">TidbClusterSpec</a>)
</p>
<p>
<p>TiCDCSpec contains details of TiCDC members</p>
</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>ComponentSpec</code></br>
<em>
<a href="#componentspec">
ComponentSpec
</a>
</em>
</td>
<td>
<p>
(Members of <code>ComponentSpec</code> are embedded into this type.)
</p>
</td>
</tr>
<tr>
<td>
<code>ResourceRequirements</code></br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#resourcerequirements-v1-core">
Kubernetes core/v1.ResourceRequirements
</a>
</em>
</td>
<td>
<p>
(Members of <code>ResourceRequirements</code> are embedded into this type.)
</p>
</td>
</tr>
<tr>
<td>
<code>serviceAccount</code></br>
<em>
string
</em>
</td>
<td>
<p>Specify a Service Account for TiCDC</p>
</td>
</tr>
<tr>
<td>
<code>replicas</code></br>
<em>
int32
</em>
</td>
<td>
<p>The desired ready replicas</p>
</td>
</tr>
<tr>
<td>
<code>baseImage</code></br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>Base image of the component, image tag is now allowed during validation</p>
</td>
</tr>
</tbody>
</table>
<h3 id="tidbaccessconfig">TiDBAccessConfig</h3>
<p>
(<em>Appears on:</em>
Expand Down Expand Up @@ -13846,6 +13943,20 @@ TiFlashSpec
</tr>
<tr>
<td>
<code>ticdc</code></br>
<em>
<a href="#ticdcspec">
TiCDCSpec
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>TiCDC cluster spec</p>
</td>
</tr>
<tr>
<td>
<code>pump</code></br>
<em>
<a href="#pumpspec">
Expand Down
Loading