Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history 
Signed-off-by: ShutingZhao <[email protected]>
  • Loading branch information
@realshuting
realshuting committed Aug 18, 2024
1 parent bb0d9d6 commit a51d913
Show file tree
Hide file tree
Showing 2 changed files with 454 additions and 82 deletions.
204 changes: 163 additions & 41 deletions docs/user/crd/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,7 @@ <h3 id="kyverno.io/v1.AnyAllConditions">AnyAllConditions
<p>
(<em>Appears on:</em>
<a href="#kyverno.io/v1.Attestation">Attestation</a>,
<a href="#kyverno.io/v1.ForEachGeneration">ForEachGeneration</a>,
<a href="#kyverno.io/v1.ForEachMutation">ForEachMutation</a>,
<a href="#kyverno.io/v1.ForEachValidation">ForEachValidation</a>)
</p>
Expand Down Expand Up @@ -1200,7 +1201,7 @@ <h3 id="kyverno.io/v1.CloneFrom">CloneFrom
</h3>
<p>
(<em>Appears on:</em>
<a href="#kyverno.io/v1.Generation">Generation</a>)
<a href="#kyverno.io/v1.GeneratePatterns">GeneratePatterns</a>)
</p>
<p>
<p>CloneFrom provides the location of the source resource used to generate target resources.
Expand Down Expand Up @@ -1453,6 +1454,7 @@ <h3 id="kyverno.io/v1.ContextEntry">ContextEntry
</h3>
<p>
(<em>Appears on:</em>
<a href="#kyverno.io/v1.ForEachGeneration">ForEachGeneration</a>,
<a href="#kyverno.io/v1.ForEachMutation">ForEachMutation</a>,
<a href="#kyverno.io/v1.ForEachValidation">ForEachValidation</a>,
<a href="#kyverno.io/v1.Rule">Rule</a>,
Expand Down Expand Up @@ -1645,6 +1647,79 @@ <h3 id="kyverno.io/v1.FailurePolicyType">FailurePolicyType
<p>
<p>FailurePolicyType specifies a failure policy that defines how unrecognized errors from the admission endpoint are handled.</p>
</p>
<h3 id="kyverno.io/v1.ForEachGeneration">ForEachGeneration
</h3>
<p>
(<em>Appears on:</em>
<a href="#kyverno.io/v1.Generation">Generation</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>list</code><br/>
<em>
string
</em>
</td>
<td>
<p>List specifies a JMESPath expression that results in one or more elements
to which the validation logic is applied.</p>
</td>
</tr>
<tr>
<td>
<code>context</code><br/>
<em>
<a href="#kyverno.io/v1.ContextEntry">
[]ContextEntry
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Context defines variables and data sources that can be used during rule execution.</p>
</td>
</tr>
<tr>
<td>
<code>preconditions</code><br/>
<em>
<a href="#kyverno.io/v1.AnyAllConditions">
AnyAllConditions
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>AnyAllConditions are used to determine if a policy rule should be applied by evaluating a
set of conditions. The declaration can contain nested <code>any</code> or <code>all</code> statements.
See: <a href="https://kyverno.io/docs/writing-policies/preconditions/">https://kyverno.io/docs/writing-policies/preconditions/</a></p>
</td>
</tr>
<tr>
<td>
<code>GeneratePatterns</code><br/>
<em>
<a href="#kyverno.io/v1.GeneratePatterns">
GeneratePatterns
</a>
</em>
</td>
<td>
</td>
</tr>
</tbody>
</table>
<hr />
<h3 id="kyverno.io/v1.ForEachMutation">ForEachMutation
</h3>
<p>
Expand Down Expand Up @@ -1976,6 +2051,85 @@ <h3 id="kyverno.io/v1.ForeachOrder">ForeachOrder
<p>
<p>ForeachOrder specifies the iteration order in foreach statements.</p>
</p>
<h3 id="kyverno.io/v1.GeneratePatterns">GeneratePatterns
</h3>
<p>
(<em>Appears on:</em>
<a href="#kyverno.io/v1.ForEachGeneration">ForEachGeneration</a>,
<a href="#kyverno.io/v1.Generation">Generation</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>ResourceSpec</code><br/>
<em>
<a href="#kyverno.io/v1.ResourceSpec">
ResourceSpec
</a>
</em>
</td>
<td>
<p>ResourceSpec contains information to select the resource.</p>
</td>
</tr>
<tr>
<td>
<code>data</code><br/>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions">
Kubernetes apiextensions/v1.JSON
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Data provides the resource declaration used to populate each generated resource.
At most one of Data or Clone must be specified. If neither are provided, the generated
resource will be created with default data only.</p>
</td>
</tr>
<tr>
<td>
<code>clone</code><br/>
<em>
<a href="#kyverno.io/v1.CloneFrom">
CloneFrom
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Clone specifies the source resource used to populate each generated resource.
At most one of Data or Clone can be specified. If neither are provided, the generated
resource will be created with default data only.</p>
</td>
</tr>
<tr>
<td>
<code>cloneList</code><br/>
<em>
<a href="#kyverno.io/v1.CloneList">
CloneList
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>CloneList specifies the list of source resource used to populate each generated resource.</p>
</td>
</tr>
</tbody>
</table>
<hr />
<h3 id="kyverno.io/v1.GenerateType">GenerateType
(<code>string</code> alias)</p></h3>
<p>
Expand Down Expand Up @@ -2013,19 +2167,6 @@ <h3 id="kyverno.io/v1.Generation">Generation
</tr>
<tr>
<td>
<code>ResourceSpec</code><br/>
<em>
<a href="#kyverno.io/v1.ResourceSpec">
ResourceSpec
</a>
</em>
</td>
<td>
<p>ResourceSpec contains information to select the resource.</p>
</td>
</tr>
<tr>
<td>
<code>synchronize</code><br/>
<em>
bool
Expand Down Expand Up @@ -2056,48 +2197,29 @@ <h3 id="kyverno.io/v1.Generation">Generation
</tr>
<tr>
<td>
<code>data</code><br/>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions">
Kubernetes apiextensions/v1.JSON
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Data provides the resource declaration used to populate each generated resource.
At most one of Data or Clone must be specified. If neither are provided, the generated
resource will be created with default data only.</p>
</td>
</tr>
<tr>
<td>
<code>clone</code><br/>
<code>GeneratePatterns</code><br/>
<em>
<a href="#kyverno.io/v1.CloneFrom">
CloneFrom
<a href="#kyverno.io/v1.GeneratePatterns">
GeneratePatterns
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Clone specifies the source resource used to populate each generated resource.
At most one of Data or Clone can be specified. If neither are provided, the generated
resource will be created with default data only.</p>
</td>
</tr>
<tr>
<td>
<code>cloneList</code><br/>
<code>foreach</code><br/>
<em>
<a href="#kyverno.io/v1.CloneList">
CloneList
<a href="#kyverno.io/v1.ForEachGeneration">
[]ForEachGeneration
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>CloneList specifies the list of source resource used to populate each generated resource.</p>
<p>ForEach applies generate rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -3577,7 +3699,7 @@ <h3 id="kyverno.io/v1.ResourceSpec">ResourceSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#kyverno.io/v1.Generation">Generation</a>,
<a href="#kyverno.io/v1.GeneratePatterns">GeneratePatterns</a>,
<a href="#kyverno.io/v1.TargetResourceSpec">TargetResourceSpec</a>,
<a href="#kyverno.io/v1beta1.UpdateRequestSpec">UpdateRequestSpec</a>,
<a href="#kyverno.io/v1beta1.UpdateRequestStatus">UpdateRequestStatus</a>,
Expand Down
Loading

0 comments on commit a51d913

Please sign in to comment.