Skip to content

Commit

Permalink
fix: update cli docs (kyverno#9585)
Browse files Browse the repository at this point in the history
Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
  • Loading branch information
eddycharly authored Feb 1, 2024
1 parent f267d19 commit 0a8d955
Showing 1 changed file with 130 additions and 0 deletions.
130 changes: 130 additions & 0 deletions docs/user/cli/crd/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,19 @@ <h3 id="cli.kyverno.io/v1alpha1.Test">Test
</tr>
<tr>
<td>
<code>checks</code><br/>
<em>
<a href="#cli.kyverno.io/v1alpha1.CheckResult">
[]CheckResult
</a>
</em>
</td>
<td>
<p>Checks are the verifications to be checked in the test</p>
</td>
</tr>
<tr>
<td>
<code>values</code><br/>
<em>
<a href="#cli.kyverno.io/v1alpha1.ValuesSpec">
Expand All @@ -158,6 +171,17 @@ <h3 id="cli.kyverno.io/v1alpha1.Test">Test
<p>Values are the values to be used in the test</p>
</td>
</tr>
<tr>
<td>
<code>exceptions</code><br/>
<em>
[]string
</em>
</td>
<td>
<p>Policy Exceptions are the policy exceptions to be used in the test</p>
</td>
</tr>
</tbody>
</table>
<hr />
Expand Down Expand Up @@ -285,6 +309,112 @@ <h3 id="cli.kyverno.io/v1alpha1.Values">Values
</tbody>
</table>
<hr />
<h3 id="cli.kyverno.io/v1alpha1.CheckMatch">CheckMatch
</h3>
<p>
(<em>Appears on:</em>
<a href="#cli.kyverno.io/v1alpha1.CheckResult">CheckResult</a>)
</p>
<p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>resource</code><br/>
<em>
github.com/kyverno/kyverno-json/pkg/apis/v1alpha1.Any
</em>
</td>
<td>
<p>Resource filters engine responses</p>
</td>
</tr>
<tr>
<td>
<code>policy</code><br/>
<em>
github.com/kyverno/kyverno-json/pkg/apis/v1alpha1.Any
</em>
</td>
<td>
<p>Policy filters engine responses</p>
</td>
</tr>
<tr>
<td>
<code>rule</code><br/>
<em>
github.com/kyverno/kyverno-json/pkg/apis/v1alpha1.Any
</em>
</td>
<td>
<p>Rule filters rule responses</p>
</td>
</tr>
</tbody>
</table>
<hr />
<h3 id="cli.kyverno.io/v1alpha1.CheckResult">CheckResult
</h3>
<p>
(<em>Appears on:</em>
<a href="#cli.kyverno.io/v1alpha1.Test">Test</a>)
</p>
<p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>match</code><br/>
<em>
<a href="#cli.kyverno.io/v1alpha1.CheckMatch">
CheckMatch
</a>
</em>
</td>
<td>
<p>Match tells how to match relevant rule responses</p>
</td>
</tr>
<tr>
<td>
<code>assert</code><br/>
<em>
github.com/kyverno/kyverno-json/pkg/apis/v1alpha1.Any
</em>
</td>
<td>
<p>Assert contains assertion to be performed on the relevant rule responses</p>
</td>
</tr>
<tr>
<td>
<code>error</code><br/>
<em>
github.com/kyverno/kyverno-json/pkg/apis/v1alpha1.Any
</em>
</td>
<td>
<p>Error contains negative assertion to be performed on the relevant rule responses</p>
</td>
</tr>
</tbody>
</table>
<hr />
<h3 id="cli.kyverno.io/v1alpha1.NamespaceSelector">NamespaceSelector
</h3>
<p>
Expand Down

0 comments on commit 0a8d955

Please sign in to comment.