Skip to content

Commit

Permalink
Fix generated config API for API server encryption
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
tengqm committed May 9, 2023
1 parent 7bdcd3d commit f8d4d5e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions content/en/docs/reference/config-api/apiserver-encryption.v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ auto_generated: true

<p>EncryptionConfiguration stores the complete configuration for encryption providers.
It also allows the use of wildcards to specify the resources that should be encrypted.
Use '<em>.<!-- raw HTML omitted -->' to encrypt all resources within a group or '</em>.<em>' to encrypt all resources.
'</em>.' can be used to encrypt all resource in the core group. '<em>.</em>' will encrypt all
Use <code>&ast;.&lt;group&gt;</code> to encrypt all resources within a group or <code>&ast;.&ast;</code> to encrypt all resources.
<code>&ast;.</code> can be used to encrypt all resource in the core group. <code>&ast;.&ast;</code> will encrypt all
resources, even custom resources that are added after API server start.
Use of wildcards that overlap within the same resource list or across multiple
entries are not allowed since part of the configuration would be ineffective.
Expand Down Expand Up @@ -282,10 +282,10 @@ Set to a negative value to disable caching. This field is only allowed for KMS v
</td>
<td>
<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.
eg: pandas.awesome.bears.example is a custom resource with 'group': awesome.bears.example, 'resource': pandas.
Use '<em>.</em>' to encrypt all resources and '<em>.<!-- raw HTML omitted -->' to encrypt all resources in a specific group.
eg: '</em>.awesome.bears.example' will encrypt all resources in the group 'awesome.bears.example'.
eg: '*.' will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
eg: <code>pandas.awesome.bears.example</code> is a custom resource with 'group': <code>awesome.bears.example</code>, 'resource': <code>pandas</code>.
Use <code>&ast;.&ast;</code> to encrypt all resources and <code>&ast;.&lt;group&gt;</code>' to encrypt all resources in a specific group.
eg: <code>&ast;.awesome.bears.example</code> will encrypt all resources in the group <code>awesome.bears.example</code>.
eg: <code>&ast;.</code> will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
</td>
</tr>
<tr><td><code>providers</code> <B>[Required]</B><br/>
Expand Down Expand Up @@ -325,4 +325,4 @@ Each key has to be 32 bytes long.</p>
</tr>
</tbody>
</table>


0 comments on commit f8d4d5e

Please sign in to comment.