Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redesign interface of configPatch in plugin configurations #5994

Open
2 of 5 tasks
randmonkey opened this issue May 9, 2024 · 0 comments
Open
2 of 5 tasks

Redesign interface of configPatch in plugin configurations #5994

randmonkey opened this issue May 9, 2024 · 0 comments
Labels
area/CRD Changes in existing CRDs or introduction of new ones area/debt

Comments

@randmonkey
Copy link
Contributor

randmonkey commented May 9, 2024

Is there an existing issue for this?

  • I have searched the existing issues

Does this enhancement require public documentation?

  • I have added an Acceptance Criteria item for adding and/or adjusting public documentation (if applicable)

Problem Statement

Continuing of #5687.
The current interface of configPatches in KongPlugin and KongClusterPlugin accepts raw JSON value in the value field. This format requires string values in the secrets to be quoted in double quotation marks, so the secrets have to be defined like

apiVersion: v1
kind: Secret
metadata:
  name: rate-limit-redis
stringData:
  password: '\"PASSWORD\"' 
type: Opaque

This is not user friendly. We need to define a more user friendly interface to let users to use configPatches easier.

Proposed Solution

  • Redesign the user interface of configPatches in KongPlugins and KongClusterPlugins to make unquoted strings in secrets to be parsed and filled into Kong plugins' config correctly
  • Make the interface to break existing interface in the least amount.

Additional information

No response

Acceptance Criteria

  • Users can refer values in unquoted string format in secrets in configPatches of KongPlugin and KongClusterPlugin
  • Do not break the existing interface if possible
  • The guide page in the document is updated to include how to refer to values stored in secrets in Kong plugin config by configPatches
@randmonkey randmonkey added area/debt area/CRD Changes in existing CRDs or introduction of new ones labels May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/CRD Changes in existing CRDs or introduction of new ones area/debt
Projects
None yet
Development

No branches or pull requests

1 participant