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.

Sign up for GitHub

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

feat: add addon dependent api and doc #8053

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+274 −1
Open

feat: add addon dependent api and doc #8053

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
92d309e
add addon dependent api and doc
skyrise-l Aug 29, 2024
5631d9c
add default addon dependent version
skyrise-l Aug 29, 2024
0f30e07
fix doc
skyrise-l Aug 29, 2024
9a4eda2
fix doc
skyrise-l Aug 29, 2024
df21889
fix test
skyrise-l Aug 29, 2024
a78ff87
fix label
skyrise-l Aug 29, 2024
9bbe455
fix some problems
skyrise-l Sep 23, 2024
5ce0ebb
fix doc
skyrise-l Sep 23, 2024
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
Prev Previous commit
Next Next commit
fix doc
@skyrise-l
skyrise-l committed Aug 29, 2024
commit 9a4eda2f64e3bd6042375fac48dee3a10b01bcdf
7 changes: 4 additions & 3 deletions config/crd/bases/extensions.kubeblocks.io_addons.yaml
View file
Original file line number Diff line number Diff line change
@@ -63,14 +63,15 @@ spec:
description: AddonSpec defines the desired state of an add-on.
properties:
addonDependencies:
description: Specifies all addons that this addon depends on.
description: Specify all addons that this addon depends on.
items:
properties:
name:
description: Specifies the name of the dependent addon.
description: The name of the dependent addon.
type: string
version:
description: All matching versions of the dependent addon. If empty, defaults to the same version as the current addon.
description: All matching versions of the dependent addon. If
empty, defaults to the same version as the current addon.
items:
type: string
type: array
7 changes: 4 additions & 3 deletions deploy/helm/crds/extensions.kubeblocks.io_addons.yaml
View file
Original file line number Diff line number Diff line change
@@ -63,14 +63,15 @@ spec:
description: AddonSpec defines the desired state of an add-on.
properties:
addonDependencies:
description: Specifies all addons that this addon depends on.
description: Specify all addons that this addon depends on.
items:
properties:
name:
description: Specifies the name of the dependent addon.
description: The name of the dependent addon.
type: string
version:
description: All matching versions of the dependent addon. If empty, defaults to the same version as the current addon.
description: All matching versions of the dependent addon. If
empty, defaults to the same version as the current addon.
items:
type: string
type: array
80 changes: 40 additions & 40 deletions docs/developer_docs/api-reference/add-on.md
View file
Original file line number Diff line number Diff line change
@@ -272,6 +272,46 @@ all selectors must evaluate to true.</p>
</tr>
</tbody>
</table>
<h3 id="extensions.kubeblocks.io/v1alpha1.AddonDependency">AddonDependency
</h3>
<p>
(<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonSpec">AddonSpec</a>)
</p>
<div>
</div>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>name</code><br/>
<em>
string
</em>
</td>
<td>
<p>The name of the dependent addon.</p>
</td>
</tr>
<tr>
<td>
<code>version</code><br/>
<em>
[]string
</em>
</td>
<td>
<em>(Optional)</em>
<p>All matching versions of the dependent addon. If empty, defaults to the same version as the current addon.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="extensions.kubeblocks.io/v1alpha1.AddonInstallExtraItem">AddonInstallExtraItem
</h3>
<p>
@@ -783,46 +823,6 @@ string
</tr>
</tbody>
</table>
<h3 id="extensions.kubeblocks.io/v1alpha1.AddonDependency">AddonDependency
</h3>
<p>
(<em>Appears on:</em><a href="#extensions.kubeblocks.io/v1alpha1.AddonSpec">AddonSpec</a>)
</p>
<div>
</div>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>name</code><br/>
<em>
string
</em>
</td>
<td>
<p>Name of the dependent addon.</p>
</td>
</tr>
<tr>
<td>
<code>version</code><br/>
<em>
string[]
</em>
</td>
<td>
<em>(Optional)</em>
<p>All matching versions of the dependent addon. Default to the current addon version</p>
</td>
</tr>
</tbody>
</table>
<h3 id="extensions.kubeblocks.io/v1alpha1.DataObjectKeySelector">DataObjectKeySelector
</h3>
<p>

Unchanged files with check annotations Beta

View file
controllers/extensions/addon_controller_test.go
Context("Addon controller test", func() {
var addon *extensionsv1alpha1.Addon
var depend_addon *extensionsv1alpha1.Addon

Check failure on line 102 in controllers/extensions/addon_controller_test.go

GitHub Actions / push-pre-check (staticcheck) 

should not use underscores in Go names; var depend_addon should be dependAddon (ST1003)
var key types.NamespacedName
var clusterKey types.NamespacedName
BeforeEach(func() {