Skip to content

Commit

Permalink
Wrap yaml comments in structured logos
Browse files Browse the repository at this point in the history 
Signed-off-by: LiZhenCheng9527 <lizhencheng6@huawei.com>
  • Loading branch information
@LiZhenCheng9527
LiZhenCheng9527 committed Dec 19, 2023
1 parent 70e6ea9 commit 696bb98
Show file tree
Hide file tree
Showing 3 changed files with 137 additions and 93 deletions.
106 changes: 60 additions & 46 deletions docs/content/en/references/fleet_v1alpha1_types.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,11 @@ <h3 id="fleet.kurator.dev/v1alpha1.BackupConfig">BackupConfig
<em>(Optional)</em>
<p>Chart defines the helm chart configuration of the backup engine.
The default value is:</p>
<p>chart:
repository: <a href="https://vmware-tanzu.github.io/helm-charts">https://vmware-tanzu.github.io/helm-charts</a>
<pre><code class="language-yaml">chart:
repository: https://vmware-tanzu.github.io/helm-charts
name: velero
version: 5.0.2</p>
version: 5.0.2
</code></pre>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -173,11 +174,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.BackupConfig">BackupConfig
<em>(Optional)</em>
<p>ExtraArgs provides the extra chart values for the backup engine chart.
For example, use the following configuration to change the image tag or pull policy:</p>
<p>extraArgs:
<pre><code class="language-yaml">extraArgs:
image:
repository: velero/velero
tag: v1.11.1
pullPolicy: IfNotPresent</p>
pullPolicy: IfNotPresent
</code></pre>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -548,10 +550,11 @@ <h3 id="fleet.kurator.dev/v1alpha1.DistributedStorageConfig">DistributedStorageC
<em>(Optional)</em>
<p>Chart defines the helm chart configuration of the distributed storage engine.
The default value is:</p>
<p>chart:
repository: <a href="https://charts.rook.io/release">https://charts.rook.io/release</a>
<pre><code class="language-yaml">chart:
repository: https://charts.rook.io/release
name: rook
version: 1.11.11</p>
version: 1.11.11
</code></pre>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -580,9 +583,10 @@ <h3 id="fleet.kurator.dev/v1alpha1.DistributedStorageConfig">DistributedStorageC
<em>(Optional)</em>
<p>ExtraArgs provides the extra chart values for rook chart.
For example, use the following configuration to change the pull policy:</p>
<p>extraArgs:
<pre><code class="language-yaml">extraArgs:
image:
pullPolicy: Always</p>
pullPolicy: Always
</code></pre>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -623,11 +627,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.FlaggerConfig">FlaggerConfig
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the flagger.
default values is</p>
<p>chart:
default value is</p>
<pre><code class="language-yaml">chart:
repository: oci://ghcr.io/fluxcd/charts
name: flagger
version: 1.x</p>
version: 1.x
</code></pre>
</td>
</tr>
<tr>
Expand All @@ -641,11 +646,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.FlaggerConfig">FlaggerConfig
</td>
<td>
<em>(Optional)</em>
<p>ExtraArgs is the set of extra arguments for flagger chart.</p>
<p>For Example, using following configuration to change replica count.
extraArgs:
<p>ExtraArgs is the set of extra arguments for flagger chart.
For Example, using following configuration to change replica count.</p>
<pre><code class="language-yaml">extraArgs:
flagger:
replicaCount: 2</p>
replicaCount: 2
</code></pre>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -843,11 +849,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.GrafanaConfig">GrafanaConfig
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the grafana.
default values is</p>
<p>chart:
default value is</p>
<pre><code class="language-yaml">chart:
repository: oci://registry-1.docker.io/bitnamicharts
name: grafana
version: 8.2.33</p>
version: 8.2.33
</code></pre>
</td>
</tr>
<tr>
Expand All @@ -861,11 +868,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.GrafanaConfig">GrafanaConfig
</td>
<td>
<em>(Optional)</em>
<p>ExtraArgs is the set of extra arguments for Grafana chart.</p>
<p>For Example, using following configuration to change replica count.
extraArgs:
<p>ExtraArgs is the set of extra arguments for Grafana chart.
For Example, using following configuration to change replica count.</p>
<pre><code class="language-yaml">extraArgs:
grafana:
replicaCount: 2</p>
replicaCount: 2
</code></pre>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -900,11 +908,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.KyvernoConfig">KyvernoConfig
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the kyverno.
default values is
chart:
repository: <a href="https://kyverno.github.io/kyverno/">https://kyverno.github.io/kyverno/</a>
default value is</p>
<pre><code class="language-yaml">chart:
repository: https://kyverno.github.io/kyverno/
name: kyverno
version: 3.0.0</p>
version: 3.0.0
</code></pre>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -932,11 +941,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.KyvernoConfig">KyvernoConfig
</td>
<td>
<em>(Optional)</em>
<p>ExtraArgs is the set of extra arguments for Grafana chart.</p>
<p>For Example, using following configuration to change image pull policy.
extraArgs:
<p>ExtraArgs is the set of extra arguments for Grafana chart.
For Example, using following configuration to change image pull policy.</p>
<pre><code class="language-yaml">extraArgs:
image:
pullPolicy: Always</p>
pullPolicy: Always
</code></pre>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -1530,11 +1540,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.PrometheusConfig">PrometheusConfig
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the prometheus.
default values is</p>
<p>chart:
default value is</p>
<pre><code class="language-yaml">chart:
repository: oci://registry-1.docker.io/bitnamicharts
name: kube-prometheus
version: 8.9.1</p>
version: 8.9.1
</code></pre>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1576,12 +1587,13 @@ <h3 id="fleet.kurator.dev/v1alpha1.PrometheusConfig">PrometheusConfig
</td>
<td>
<em>(Optional)</em>
<p>ExtraArgs is the set of extra arguments for Prometheus chart.</p>
<p>For Example, using following configuration to create a ServiceMonitor to monitor prometheus itself.
extraArgs:
<p>ExtraArgs is the set of extra arguments for Prometheus chart.
For Example, using following configuration to create a ServiceMonitor to monitor prometheus itself.</p>
<pre><code class="language-yaml">extraArgs:
prometheus:
serviceMonitor:
enabled: true</p>
enabled: true
</code></pre>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -1746,11 +1758,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.ThanosConfig">ThanosConfig
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the thanos.
default values is</p>
<p>chart:
default value is</p>
<pre><code class="language-yaml">chart:
repository: oci://registry-1.docker.io/bitnamicharts
name: thanos
version: 12.5.1</p>
version: 12.5.1
</code></pre>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1778,11 +1791,12 @@ <h3 id="fleet.kurator.dev/v1alpha1.ThanosConfig">ThanosConfig
</td>
<td>
<em>(Optional)</em>
<p>ExtraArgs is the set of extra arguments for Thanos chart.</p>
<p>For Example, using following configuration to enable query frontend.
extraArgs:
<p>ExtraArgs is the set of extra arguments for Thanos chart.
For Example, using following configuration to enable query frontend.</p>
<pre><code class="language-yaml">extraArgs:
queryFrontend:
enabled: true</p>
enabled: true
</code></pre>
</td>
</tr>
</tbody>
Expand Down
74 changes: 38 additions & 36 deletions manifests/charts/fleet-manager/crds/fleet.kurator.dev_fleet.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,9 @@ spec:
properties:
chart:
description: "Chart defines the helm chart configuration of
the backup engine. The default value is: \n chart: repository:
https://vmware-tanzu.github.io/helm-charts name: velero
version: 5.0.2"
the backup engine. The default value is: \n ```yaml chart:
repository: https://vmware-tanzu.github.io/helm-charts name:
velero version: 5.0.2 ```"
properties:
name:
description: Name defines the name of the chart. Default
Expand All @@ -137,8 +137,8 @@ spec:
description: "ExtraArgs provides the extra chart values for
the backup engine chart. For example, use the following
configuration to change the image tag or pull policy: \n
extraArgs: image: repository: velero/velero tag: v1.11.1
pullPolicy: IfNotPresent"
```yaml extraArgs: image: repository: velero/velero tag:
v1.11.1 pullPolicy: IfNotPresent ```"
x-kubernetes-preserve-unknown-fields: true
storage:
description: Storage provides details on where the backup
Expand Down Expand Up @@ -212,8 +212,8 @@ spec:
chart:
description: "Chart defines the helm chart configuration of
the distributed storage engine. The default value is: \n
chart: repository: https://charts.rook.io/release name:
rook version: 1.11.11"
```yaml chart: repository: https://charts.rook.io/release
name: rook version: 1.11.11 ```"
properties:
name:
description: Name defines the name of the chart. Default
Expand All @@ -231,8 +231,8 @@ spec:
extraArgs:
description: "ExtraArgs provides the extra chart values for
rook chart. For example, use the following configuration
to change the pull policy: \n extraArgs: image: pullPolicy:
Always"
to change the pull policy: \n ```yaml extraArgs: image:
pullPolicy: Always ```"
x-kubernetes-preserve-unknown-fields: true
storage:
description: Storage provides detailed settings for unified
Expand Down Expand Up @@ -3005,8 +3005,8 @@ spec:
properties:
chart:
description: "Chart defines the helm chart config of the flagger.
default values is \n chart: repository: oci://ghcr.io/fluxcd/charts
name: flagger version: 1.x"
default value is \n ```yaml chart: repository: oci://ghcr.io/fluxcd/charts
name: flagger version: 1.x ```"
properties:
name:
description: Name defines the name of the chart. Default
Expand All @@ -3023,9 +3023,9 @@ spec:
type: object
extraArgs:
description: "ExtraArgs is the set of extra arguments for
flagger chart. \n For Example, using following configuration
to change replica count. extraArgs: flagger: replicaCount:
2"
flagger chart. For Example, using following configuration
to change replica count. \n ```yaml extraArgs: flagger:
replicaCount: 2 ```"
x-kubernetes-preserve-unknown-fields: true
publicTestloader:
description: PublicTestloader defines whether to install the
Expand All @@ -3040,8 +3040,8 @@ spec:
properties:
chart:
description: "Chart defines the helm chart config of the grafana.
default values is \n chart: repository: oci://registry-1.docker.io/bitnamicharts
name: grafana version: 8.2.33"
default value is \n ```yaml chart: repository: oci://registry-1.docker.io/bitnamicharts
name: grafana version: 8.2.33 ```"
properties:
name:
description: Name defines the name of the chart. Default
Expand All @@ -3058,9 +3058,9 @@ spec:
type: object
extraArgs:
description: "ExtraArgs is the set of extra arguments for
Grafana chart. \n For Example, using following configuration
to change replica count. extraArgs: grafana: replicaCount:
2"
Grafana chart. For Example, using following configuration
to change replica count. \n ```yaml extraArgs: grafana:
replicaCount: 2 ```"
x-kubernetes-preserve-unknown-fields: true
type: object
metric:
Expand All @@ -3075,9 +3075,9 @@ spec:
properties:
chart:
description: "Chart defines the helm chart config of the
prometheus. default values is \n chart: repository:
prometheus. default value is \n ```yaml chart: repository:
oci://registry-1.docker.io/bitnamicharts name: kube-prometheus
version: 8.9.1"
version: 8.9.1 ```"
properties:
name:
description: Name defines the name of the chart. Default
Expand All @@ -3095,10 +3095,10 @@ spec:
type: object
extraArgs:
description: "ExtraArgs is the set of extra arguments
for Prometheus chart. \n For Example, using following
configuration to create a ServiceMonitor to monitor
prometheus itself. extraArgs: prometheus: serviceMonitor:
enabled: true"
for Prometheus chart. For Example, using following configuration
to create a ServiceMonitor to monitor prometheus itself.
\n ```yaml extraArgs: prometheus: serviceMonitor: enabled:
true ```"
x-kubernetes-preserve-unknown-fields: true
kubeStateMetrics:
description: KubeStateMetrics defines the configuration
Expand All @@ -3125,8 +3125,9 @@ spec:
properties:
chart:
description: "Chart defines the helm chart config of the
thanos. default values is \n chart: repository: oci://registry-1.docker.io/bitnamicharts
name: thanos version: 12.5.1"
thanos. default value is \n ```yaml chart: repository:
oci://registry-1.docker.io/bitnamicharts name: thanos
version: 12.5.1 ```"
properties:
name:
description: Name defines the name of the chart. Default
Expand All @@ -3144,9 +3145,9 @@ spec:
type: object
extraArgs:
description: "ExtraArgs is the set of extra arguments
for Thanos chart. \n For Example, using following configuration
to enable query frontend. extraArgs: queryFrontend:
enabled: true"
for Thanos chart. For Example, using following configuration
to enable query frontend. \n ```yaml extraArgs: queryFrontend:
enabled: true ```"
x-kubernetes-preserve-unknown-fields: true
objectStoreConfig:
description: 'ObjectStoreConfig is the secret reference
Expand All @@ -3173,9 +3174,10 @@ spec:
installation and policy management.
properties:
chart:
description: 'Chart defines the helm chart config of the
kyverno. default values is chart: repository: https://kyverno.github.io/kyverno/
name: kyverno version: 3.0.0'
description: "Chart defines the helm chart config of the
kyverno. default value is \n ```yaml chart: repository:
https://kyverno.github.io/kyverno/ name: kyverno version:
3.0.0 ```"
properties:
name:
description: Name defines the name of the chart. Default
Expand All @@ -3193,9 +3195,9 @@ spec:
type: object
extraArgs:
description: "ExtraArgs is the set of extra arguments
for Grafana chart. \n For Example, using following configuration
to change image pull policy. extraArgs: image: pullPolicy:
Always"
for Grafana chart. For Example, using following configuration
to change image pull policy. \n ```yaml extraArgs: image:
pullPolicy: Always ```"
x-kubernetes-preserve-unknown-fields: true
podSecurity:
description: PodSecurity defines the pod security configuration
Expand Down
Loading

0 comments on commit 696bb98

Please sign in to comment.