Skip to content

Commit

Permalink
Fix: Key Auth Encrypted note and "not applicable" konnect labels (#7635)
Browse files Browse the repository at this point in the history
* add more context to the Key Auth Encrypted plugin's compatibility note

* change wording of 'not applicable' to 'not available in konnect'
  • Loading branch information
lena-larionova authored Jul 12, 2024
1 parent bb22a36 commit 84036bf
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
6 changes: 5 additions & 1 deletion app/_hub/kong-inc/key-auth-enc/_metadata/_index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ enterprise: true
konnect: false
network_config_opts: Self-managed traditional, DB-less, and hybrid
notes: |
The time-to-live (ttl) does not work in Konnect or hybrid mode. This setting
This plugin is not available in Konnect, and has limitations in hybrid mode:
- Konnect automatically encrypts key authentication credentials at rest, so
encryption via this plugin is not necessary.
Use the regular [Key Auth](/hub/kong-inc/key-auth/) plugin instead.
- The time-to-live (ttl) does not work in hybrid mode. This setting
determines the length of time a credential remains valid.
categories:
- authentication
Expand Down
2 changes: 1 addition & 1 deletion app/hub/plugins/compatibility/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ data plane roles. Kong provides and hosts the control plane and a database with
{% endif %}
</td>
<td>
{{ plugin.notes }}
{{ plugin.notes | markdownify }}
</td>
</tr>
{% endfor %}
Expand Down
8 changes: 4 additions & 4 deletions app/konnect/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,14 @@ See the following table for details on each plugin.
</td>
<td style="text-align: center">
{% if plugin.konnect == false %}
<span>Not Applicable</span>
<span></span>
{% elsif plugin.free == true %}
<i class="fa fa-check"></i>
{% endif %}
</td>
<td style="text-align: center">
{% unless plugin.konnect %}
<span>Not Applicable</span>
<span>Not available in {{site.konnect_short_name}}</span>
{% else %}
{% unless plugin.free %}
{% unless plugin.premium %}
Expand All @@ -111,7 +111,7 @@ See the following table for details on each plugin.
</td>
<td style="text-align: center">
{% unless plugin.konnect %}
<span>Not Applicable</span>
<span></span>
{% else %}
{% unless plugin.free %}
{% unless plugin.paid %}
Expand All @@ -124,7 +124,7 @@ See the following table for details on each plugin.
</td>

<td>
{{ plugin.notes }}
{{ plugin.notes | markdownify }}
</td>
</tr>

Expand Down

0 comments on commit 84036bf

Please sign in to comment.