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

fix: secret reference indentation in EMQX definition #497

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

ppawlowski
Copy link
Contributor

Description

This pull request fixes the indentation in EMQX's BootstrapAPIKey definition (source).

Related Issue(s)

Checklist

  • I have read the contribution guidelines
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
    • Upgrade instructions
    • Configuration details
    • Concepts
  • Changes flowforge.yml?
    • Issue/PR raised on FlowFuse/helm to update ConfigMap Template
    • Issue/PR raised on FlowFuse/CloudProject to update values for Staging/Production

Labels

  • Includes a DB migration? -> add the area:migration label

@ppawlowski ppawlowski requested a review from hardillb November 8, 2024 17:12
@hardillb
Copy link
Contributor

hardillb commented Nov 8, 2024

This is a lint only change? that indent should work

@ppawlowski
Copy link
Contributor Author

This is a lint only change? that indent should work

This change makes sure, that bootstrap API key and value is read correctly from the kubernetes secret object.
With previous config, during helm chart installation, helm was complaining about unknown fields:

W1108 17:45:54.010467   24497 warnings.go:70] unknown field "spec.bootstrapAPIKeys[0].key.secretKey"
W1108 17:45:54.010489   24497 warnings.go:70] unknown field "spec.bootstrapAPIKeys[0].key.secretName"
W1108 17:45:54.010492   24497 warnings.go:70] unknown field "spec.bootstrapAPIKeys[0].secret.secretKey"
W1108 17:45:54.010495   24497 warnings.go:70] unknown field "spec.bootstrapAPIKeys[0].secret.secretName"

Based on the bootstrapAPIKeys documentation, keys spec.bootstrapApiKeys.key and spec.bootstrapApiKeys.secret should contain string only and it is used to provide bootstrap API key as a plain text values.

If we want to use kubernetes secrets object to store this data, we should reference it using spec.bootstrapApiKeys.secretRef with common secretRef layout .

@hardillb hardillb merged commit 1a003df into main Nov 12, 2024
6 checks passed
@hardillb hardillb deleted the ppawlowski-patch-1 branch November 12, 2024 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants