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

HPCC-30711 Add global annotations #17975

Conversation

jakesmith
Copy link
Member

@jakesmith jakesmith commented Oct 31, 2023

Add a global 'componentAnnotations' section, which can be used to define annotations that should apply to all components.

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@github-actions
Copy link

@jakesmith jakesmith requested a review from ghalliday October 31, 2023 09:42
@jakesmith
Copy link
Member Author

@ghalliday - please review.
NB : #17976, is based on this PR and adds a static annotation for all components ("cluster-autoscaler.kubernetes.io/safe-to-evict" false)

Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments on other PR

@jakesmith
Copy link
Member Author

jakesmith commented Oct 31, 2023

@ghalliday - kube-score was failing (in #17976) on an unquoted 'false' annotation value - have changed (in 3rd commit) to quote all annotation values.

@jakesmith jakesmith requested a review from ghalliday October 31, 2023 12:15
@jakesmith
Copy link
Member Author

@ghalliday - please see 2nd and 3rd commits.

Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change looks ok.

@@ -53,6 +53,7 @@ spec:
helmVersion: 9.2.33-closedown0
annotations:
checksum/config: {{ $configSHA }}
{{- include "hpcc.generateAnnotations" $commonCtx | indent 8 }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a bit strange using indent (rather than nindent) in an indented block. It works if the block leads with a newline, but would cause problems if not.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using nindent would result in a newline here in cases where there was no content generated

@ghalliday
Copy link
Member

@jakesmith please squash

Add a global 'componentAnnotations' section, which can be used
to define annotations that should apply to all components.

Signed-off-by: Jake Smith <jake.smith@lexisnexisrisk.com>
@jakesmith jakesmith force-pushed the HPCC-30711-global-annotations branch from ace2d8a to e7d956f Compare November 1, 2023 13:56
@jakesmith
Copy link
Member Author

@ghalliday - squashed

@ghalliday ghalliday merged commit fb5d871 into hpcc-systems:candidate-9.2.x Nov 2, 2023
28 checks passed
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