Skip to content

Commit f8d4d5e

Browse files
committed
Fix generated config API for API server encryption
There are limitations in the generator when parsing ambiguous strings such as `*`, `<` etc. `*` is used in Markdown for emphasis, but some comments are using the literal '*' without properly escaping it. `<` and `>` are not allowed in Markdown parser. The generated content for this is at best some warning strings. This PR fixes this issue manually. An ideal fix would be proposed to the upstream source code wherever these happen.
1 parent 7bdcd3d commit f8d4d5e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

content/en/docs/reference/config-api/apiserver-encryption.v1.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ auto_generated: true
2020

2121
<p>EncryptionConfiguration stores the complete configuration for encryption providers.
2222
It also allows the use of wildcards to specify the resources that should be encrypted.
23-
Use '<em>.<!-- raw HTML omitted -->' to encrypt all resources within a group or '</em>.<em>' to encrypt all resources.
24-
'</em>.' can be used to encrypt all resource in the core group. '<em>.</em>' will encrypt all
23+
Use <code>&ast;.&lt;group&gt;</code> to encrypt all resources within a group or <code>&ast;.&ast;</code> to encrypt all resources.
24+
<code>&ast;.</code> can be used to encrypt all resource in the core group. <code>&ast;.&ast;</code> will encrypt all
2525
resources, even custom resources that are added after API server start.
2626
Use of wildcards that overlap within the same resource list or across multiple
2727
entries are not allowed since part of the configuration would be ineffective.
@@ -282,10 +282,10 @@ Set to a negative value to disable caching. This field is only allowed for KMS v
282282
</td>
283283
<td>
284284
<p>resources is a list of kubernetes resources which have to be encrypted. The resource names are derived from <code>resource</code> or <code>resource.group</code> of the group/version/resource.
285-
eg: pandas.awesome.bears.example is a custom resource with 'group': awesome.bears.example, 'resource': pandas.
286-
Use '<em>.</em>' to encrypt all resources and '<em>.<!-- raw HTML omitted -->' to encrypt all resources in a specific group.
287-
eg: '</em>.awesome.bears.example' will encrypt all resources in the group 'awesome.bears.example'.
288-
eg: '*.' will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
285+
eg: <code>pandas.awesome.bears.example</code> is a custom resource with 'group': <code>awesome.bears.example</code>, 'resource': <code>pandas</code>.
286+
Use <code>&ast;.&ast;</code> to encrypt all resources and <code>&ast;.&lt;group&gt;</code>' to encrypt all resources in a specific group.
287+
eg: <code>&ast;.awesome.bears.example</code> will encrypt all resources in the group <code>awesome.bears.example</code>.
288+
eg: <code>&ast;.</code> will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
289289
</td>
290290
</tr>
291291
<tr><td><code>providers</code> <B>[Required]</B><br/>
@@ -325,4 +325,4 @@ Each key has to be 32 bytes long.</p>
325325
</tr>
326326
</tbody>
327327
</table>
328-
328+

0 commit comments

Comments
 (0)