Rename api key to agent api key #2814
Conversation
WalkthroughThe changes primarily revolve around renaming the Changes
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Files ignored due to filter (6)
- docs/gen/config/extensions/fluxninja/extension-swagger.yaml
- manifests/charts/aperture-agent/crds/fluxninja.com_agents.yaml
- manifests/charts/aperture-agent/templates/agent-deployment.yaml
- manifests/charts/aperture-controller/crds/fluxninja.com_controllers.yaml
- operator/config/crd/bases/fluxninja.com_agents.yaml
- operator/config/crd/bases/fluxninja.com_controllers.yaml
Files selected for processing (17)
- docs/agent.md (1 hunks)
- docs/content/get-started/installation/agent/docker.md (1 hunks)
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md (1 hunks)
- docs/content/get-started/self-hosting/agent.md (1 hunks)
- docs/content/reference/configuration/agent.md (1 hunks)
- docs/content/reference/configuration/controller.md (1 hunks)
- docs/content/reference/fluxninja.md (1 hunks)
- docs/controller.md (1 hunks)
- extensions/fluxninja/extconfig/extconfig.go (2 hunks)
- extensions/fluxninja/heartbeats/heartbeats.go (4 hunks)
- extensions/fluxninja/heartbeats/peers-watcher.go (1 hunks)
- extensions/fluxninja/heartbeats/provide.go (1 hunks)
- extensions/fluxninja/otel/otel_test.go (1 hunks)
- extensions/fluxninja/otel/provide.go (2 hunks)
- operator/controllers/agent/config_test.tpl (1 hunks)
- operator/controllers/utils.go (1 hunks)
- operator/controllers/utils_test.go (1 hunks)
Files skipped from review due to trivial changes (7)
- docs/content/get-started/installation/agent/docker.md
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md
- docs/content/reference/fluxninja.md
- docs/controller.md
- extensions/fluxninja/heartbeats/provide.go
- operator/controllers/agent/config_test.tpl
- operator/controllers/utils.go
Additional comments (Suppressed): 14
docs/content/get-started/self-hosting/agent.md (1)
- 68-71: The
api_keyfield has been renamed toagent_api_key. Ensure that all references to this field in the codebase have been updated to reflect this change. Also, verify that the documentation and instructions have been updated to instruct users to useagent_api_keyinstead ofapi_key.extensions/fluxninja/otel/otel_test.go (1)
- 27-34: The key "api_key" has been renamed to "agent_api_key" in the configuration map. Ensure that all instances where this configuration is used have been updated to reflect this change.
extensions/fluxninja/heartbeats/peers-watcher.go (1)
- 34-43: The logic for checking the API key has been updated to first check for
AgentAPIKeyand then fall back toAPIKeyifAgentAPIKeyis not available. This is a good approach for maintaining backward compatibility. However, ensure that all instances whereAPIKeyis used have been updated to this new logic.docs/agent.md (1)
- 782-788: The renaming of
APIKeytoAgentAPIKeyis reflected correctly in the documentation. Ensure that all references toAPIKeyin the documentation and code comments have been updated toAgentAPIKeyto maintain consistency.extensions/fluxninja/extconfig/extconfig.go (2)
26-35: The
APIKeyfield has been deprecated and replaced withAgentAPIKey. Ensure that all references toAPIKeyin the codebase have been updated toAgentAPIKeywhere necessary. Also, make sure that the new fieldAgentAPIKeyis properly documented and the deprecation ofAPIKeyis communicated to the users.80-95: The logic for retrieving the API key has been updated to check for
AgentAPIKeyfirst and fall back toAPIKeyif not available. This is a good approach to maintain backward compatibility. However, ensure that this fallback logic is consistently applied throughout the codebase.extensions/fluxninja/heartbeats/heartbeats.go (4)
66-66: The
APIKeyfield has been renamed toapiKey. Ensure that all references to this field in the codebase have been updated to match the new name.84-87: The logic for retrieving the API key has been updated to check for
AgentAPIKeyfirst and fall back toAPIKeyif not available. This is a good approach to maintain backward compatibility.263-263: The
apiKeyis being added to the metadata of the outgoing context. Ensure that the receiving end of this context is expecting the key to beapiKeyand notAPIKey.287-287: The
apiKeyis being added to the request header. Ensure that the server is expecting the key to beapiKeyand notAPIKey.docs/content/reference/configuration/agent.md (1)
- 1433-1435: The deprecation of the old
APIKeyfield is clearly mentioned. Ensure that all references to the oldAPIKeyfield in the codebase have been updated toAgentAPIKey. Also, verify that the fallback logic toAPIKeyis correctly implemented wherever necessary.extensions/fluxninja/otel/provide.go (2)
64-69: The function now checks for both
AgentAPIKeyandAPIKeybefore returning. This is a good practice as it ensures that at least one of the keys is present before proceeding. However, ensure that the rest of the codebase is updated to handle the newAgentAPIKeyfield and that it falls back toAPIKeywhenAgentAPIKeyis not available.226-237: The
apiKeyis now set toAgentAPIKeyif it's available, otherwise it falls back toAPIKey. This is a good practice as it provides backward compatibility for systems that still useAPIKey. However, ensure that theauthorizationheader is correctly set in all requests that use this configuration.operator/controllers/utils_test.go (1)
- 637-638: The environment variable "APERTURE_AGENT_FLUXNINJA_API_KEY" has been renamed to "APERTURE_AGENT_FLUXNINJA_AGENT_KEY". Ensure that this change is reflected in all places where this environment variable is used, including documentation, scripts, and configuration files.
|
Please make sure that this change does not break backward compatibility for users upgrading their Aperture installations |
IridiumOxide
force-pushed
the
apikey-rename
branch
from
ee317c0 to
681f7cd
Compare
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Files ignored due to filter (6)
- docs/gen/config/extensions/fluxninja/extension-swagger.yaml
- manifests/charts/aperture-agent/crds/fluxninja.com_agents.yaml
- manifests/charts/aperture-agent/templates/agent-deployment.yaml
- manifests/charts/aperture-controller/crds/fluxninja.com_controllers.yaml
- operator/config/crd/bases/fluxninja.com_agents.yaml
- operator/config/crd/bases/fluxninja.com_controllers.yaml
Files selected for processing (17)
- docs/agent.md (1 hunks)
- docs/content/get-started/installation/agent/docker.md (1 hunks)
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md (1 hunks)
- docs/content/get-started/self-hosting/agent.md (1 hunks)
- docs/content/reference/configuration/agent.md (1 hunks)
- docs/content/reference/configuration/controller.md (1 hunks)
- docs/content/reference/fluxninja.md (1 hunks)
- docs/controller.md (1 hunks)
- extensions/fluxninja/extconfig/extconfig.go (2 hunks)
- extensions/fluxninja/heartbeats/heartbeats.go (4 hunks)
- extensions/fluxninja/heartbeats/peers-watcher.go (1 hunks)
- extensions/fluxninja/heartbeats/provide.go (1 hunks)
- extensions/fluxninja/otel/otel_test.go (1 hunks)
- extensions/fluxninja/otel/provide.go (2 hunks)
- operator/controllers/agent/config_test.tpl (1 hunks)
- operator/controllers/utils.go (1 hunks)
- operator/controllers/utils_test.go (1 hunks)
Files skipped from review due to trivial changes (8)
- docs/content/get-started/installation/agent/docker.md
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md
- docs/content/reference/configuration/agent.md
- docs/content/reference/configuration/controller.md
- docs/content/reference/fluxninja.md
- extensions/fluxninja/otel/otel_test.go
- operator/controllers/agent/config_test.tpl
- operator/controllers/utils.go
Additional comments (Suppressed): 12
docs/controller.md (1)
- 513-513: The
AgentAPIKeyfield has been introduced to replace theAPIKeyfield. Ensure that all references toAPIKeyin the codebase have been updated toAgentAPIKey. Also, verify that the logic for retrieving the API key checksAgentAPIKeyfirst and falls back toAPIKeyfor backward compatibility.operator/controllers/utils_test.go (1)
- 637-637: The environment variable
APERTURE_AGENT_FLUXNINJA_API_KEYhas been renamed toAPERTURE_AGENT_FLUXNINJA_AGENT_API_KEY. Ensure that this change is reflected in all parts of the codebase where this environment variable is used. Also, verify that the new environment variable is set correctly in the deployment environment.extensions/fluxninja/heartbeats/heartbeats.go (4)
66-66: The
apiKeyfield has been renamed fromAPIKey. Ensure that all references to this field in the codebase have been updated to use the new name. This change is consistent with the PR summary, which mentions renamingAPIKeytoAgentAPIKeyacross the codebase.84-88: The logic for retrieving the API key has been updated to check
AgentAPIKeyfirst and fall back toAPIKeyfor backward compatibility. This is a good practice as it ensures that existing functionality will not break while allowing the use of the newAgentAPIKey. However, it's important to ensure that the deprecation ofAPIKeyis clearly communicated to users and developers.264-265: The API key is added to the metadata of the outgoing context using the new
apiKeyfield. Ensure that the server-side logic has been updated to retrieve the API key from the new field.288-288: The API key is added to the request header using the new
apiKeyfield. Ensure that the server-side logic has been updated to retrieve the API key from the new field.docs/content/get-started/self-hosting/agent.md (1)
- 68-71: The
api_keyfield has been replaced withagent_api_key. Ensure that all references to this field in the codebase have been updated accordingly. Also, verify that the documentation and instructions have been updated to reflect this change.extensions/fluxninja/heartbeats/provide.go (1)
- 68-73: The function now checks for both
AgentAPIKeyandAPIKeyfor backward compatibility. Ensure that all calls to this function throughout the codebase have been updated to match the new logic. Also, verify that the fallback mechanism toAPIKeywhenAgentAPIKeyis not available is working as expected.extensions/fluxninja/otel/provide.go (2)
64-70: The new hunk introduces a check for both
AgentAPIKeyandAPIKeyto ensure backward compatibility. This is a good practice as it allows the system to continue functioning with the oldAPIKeyif the newAgentAPIKeyis not available. However, it's important to ensure that the deprecation ofAPIKeyis communicated clearly to users and that a timeline for its removal is provided. This will encourage users to transition to the newAgentAPIKeyand prevent potential issues in the future whenAPIKeyis removed.227-234: The new hunk introduces a fallback mechanism to use the old
APIKeyif the newAgentAPIKeyis not available. This is a good practice for maintaining backward compatibility. However, it's important to ensure that theAgentAPIKeyis prioritized over theAPIKeywhen both are available. This will encourage the use of the newAgentAPIKeyand ensure that the system transitions smoothly to the new key.extensions/fluxninja/extconfig/extconfig.go (2)
26-35: The renaming of
APIKeytoAgentAPIKeyis clear and the deprecation ofAPIKeyis well documented. However, ensure that all instances where this configuration is used have been updated to useAgentAPIKeyinstead ofAPIKey. Also, verify that the validation rules forAgentAPIKeyare correctly set up.80-96: The logic for falling back to
APIKeyifAgentAPIKeyis not set is correctly implemented. However, ensure that this fallback logic is consistently applied across all instances where the API key is used. Also, consider adding a warning log message when the deprecatedAPIKeyis used to encourage users to switch toAgentAPIKey.Suggested change:
func provideEtcdConfigOverride(extensionConfig *FluxNinjaExtensionConfig) *etcdclient.ConfigOverride { if extensionConfig.EnableCloudController { apiKey := extensionConfig.AgentAPIKey if apiKey == "" { //nolint:staticcheck // SA1019 read APIKey config for backward compatibility apiKey = extensionConfig.APIKey + log.Warn("APIKey is deprecated, please use AgentAPIKey instead.") } return &etcdclient.ConfigOverride{ Namespace: "", Endpoints: []string{extensionConfig.Endpoint}, PerRPCCredentials: perRPCHeaders{ headers: map[string]string{ "apiKey": apiKey, }, }, OverriderName: "fluxninja extension",
@tanveergill The extension config reads the old |
IridiumOxide
force-pushed
the
apikey-rename
branch
from
681f7cd to
b55bb14
Compare
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Files ignored due to filter (6)
- docs/gen/config/extensions/fluxninja/extension-swagger.yaml
- manifests/charts/aperture-agent/crds/fluxninja.com_agents.yaml
- manifests/charts/aperture-agent/templates/agent-deployment.yaml
- manifests/charts/aperture-controller/crds/fluxninja.com_controllers.yaml
- operator/config/crd/bases/fluxninja.com_agents.yaml
- operator/config/crd/bases/fluxninja.com_controllers.yaml
Files selected for processing (18)
- docs/agent.md (1 hunks)
- docs/content/get-started/installation/agent/docker.md (1 hunks)
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md (1 hunks)
- docs/content/get-started/self-hosting/agent.md (1 hunks)
- docs/content/reference/configuration/agent.md (1 hunks)
- docs/content/reference/configuration/controller.md (1 hunks)
- docs/content/reference/fluxninja.md (1 hunks)
- docs/controller.md (1 hunks)
- extensions/fluxninja/extconfig/extconfig.go (2 hunks)
- extensions/fluxninja/heartbeats/heartbeats.go (4 hunks)
- extensions/fluxninja/heartbeats/peers-watcher.go (1 hunks)
- extensions/fluxninja/heartbeats/provide.go (1 hunks)
- extensions/fluxninja/otel/otel_test.go (1 hunks)
- extensions/fluxninja/otel/provide.go (2 hunks)
- operator/controllers/agent/config_test.tpl (1 hunks)
- operator/controllers/controller/config_test.tpl (1 hunks)
- operator/controllers/utils.go (1 hunks)
- operator/controllers/utils_test.go (1 hunks)
Files skipped from review due to trivial changes (9)
- docs/content/get-started/installation/agent/docker.md
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md
- docs/content/reference/configuration/agent.md
- docs/content/reference/configuration/controller.md
- docs/content/reference/fluxninja.md
- extensions/fluxninja/otel/otel_test.go
- operator/controllers/agent/config_test.tpl
- operator/controllers/controller/config_test.tpl
- operator/controllers/utils.go
Additional comments (Suppressed): 13
docs/content/get-started/self-hosting/agent.md (1)
- 68-71: The
api_keyfield has been replaced withagent_api_key. Ensure that all references to this field in the codebase have been updated to reflect this change. Also, verify that the users of the documentation are informed about this change to avoid confusion.docs/controller.md (1)
- 513-513: The
APIKeyfield has been renamed toAgentAPIKey. Ensure that all references to this field in the codebase have been updated to reflect this change. Also, verify that the new environment variable "APERTURE_AGENT_FLUXNINJA_AGENT_API_KEY" is being set correctly in the deployment environment.docs/agent.md (1)
- 782-788: The
APIKeyfield has been renamed toAgentAPIKeyin the documentation as well. Ensure that all references toAPIKeyin the documentation have been updated toAgentAPIKeyto maintain consistency. Also, verify that the example usage and any code snippets in the documentation have been updated to reflect this change.extensions/fluxninja/otel/provide.go (2)
64-70: The new hunk checks for both
AgentAPIKeyandAPIKeyto ensure backward compatibility. This is a good practice as it allows the system to function correctly even if theAgentAPIKeyis not provided. However, it's important to ensure that the deprecation ofAPIKeyis communicated clearly to the users and a timeline for its complete removal is provided. This will encourage users to switch toAgentAPIKeyand prevent potential issues in the future.227-234: The new hunk first checks if
AgentAPIKeyis available and uses it if it is. IfAgentAPIKeyis not available, it falls back to usingAPIKey. This is a good practice for maintaining backward compatibility. However, it's important to ensure that the system behaves correctly when bothAgentAPIKeyandAPIKeyare provided. It might be a good idea to add a check for this scenario and decide which key should be used in such cases.extensions/fluxninja/heartbeats/peers-watcher.go (1)
- 34-44: The new code checks for the presence of
AgentAPIKeyand uses it if available, otherwise it falls back to using theAPIKey. This is a good approach for maintaining backward compatibility. However, it's important to ensure that the deprecation ofAPIKeyis clearly communicated to users and that a plan is in place for eventually removing this fallback logic. Also, make sure that all parts of the code that use this function are updated to handle the newAgentAPIKeyfield.- apiKey := extensionConfig.AgentAPIKey - if apiKey == "" { - //nolint:staticcheck // SA1019 read APIKey config for backward compatibility - apiKey = extensionConfig.APIKey - } + apiKey, ok := extensionConfig.AgentAPIKey + if !ok { + //nolint:staticcheck // SA1019 read APIKey config for backward compatibility + apiKey, ok = extensionConfig.APIKey + if !ok { + return PeersOut{}, nil + } + }operator/controllers/utils_test.go (1)
- 637-637: The environment variable "APERTURE_AGENT_FLUXNINJA_API_KEY" has been renamed to "APERTURE_AGENT_FLUXNINJA_AGENT_API_KEY". Ensure that this change is reflected in all places where this environment variable is used, including any deployment scripts, configuration files, or documentation. Also, make sure that the new environment variable is set in the environment where the application is running.
extensions/fluxninja/extconfig/extconfig.go (2)
26-35: The
APIKeyfield has been deprecated and replaced withAgentAPIKey. Ensure that all references toAPIKeyin the codebase have been updated toAgentAPIKey. Also, verify that the new fieldAgentAPIKeyis being properly validated and used in the rest of the codebase.80-96: The logic to check for the presence of
AgentAPIKeyand use it if available, otherwise fall back to using theAPIKeyfield, ensures backward compatibility. However, it's important to note that theAPIKeyfield is deprecated and should be removed in a future version.apiKey := extensionConfig.AgentAPIKey if apiKey == "" { //nolint:staticcheck // SA1019 read APIKey config for backward compatibility apiKey = extensionConfig.APIKey }This code block can be refactored to a separate function that returns the API key. This would improve the modularity and maintainability of the code.
func getAPIKey(extensionConfig *FluxNinjaExtensionConfig) string { apiKey := extensionConfig.AgentAPIKey if apiKey == "" { //nolint:staticcheck // SA1019 read APIKey config for backward compatibility apiKey = extensionConfig.APIKey } return apiKey }And then use this function in the
provideEtcdConfigOverridefunction:apiKey := getAPIKey(extensionConfig)extensions/fluxninja/heartbeats/heartbeats.go (4)
66-66: The field
APIKeyhas been renamed toapiKey. Ensure that all references to this field in the codebase have been updated to match the new name. Also, note that the field name is now unexported (starts with a lowercase letter), which means it can't be accessed directly from other packages. If this field needs to be accessed from other packages, consider providing getter and setter methods.84-88: The code now checks for the presence of
AgentAPIKeyand uses it if available, otherwise falls back to using theAPIKeyfield. This is a good approach for maintaining backward compatibility. However, it would be beneficial to log a deprecation warning when theAPIKeyfield is used to encourage the transition toAgentAPIKey.apiKey := extensionConfig.AgentAPIKey if apiKey == "" { //nolint:staticcheck // SA1019 read APIKey config for backward compatibility apiKey = extensionConfig.APIKey + if apiKey != "" { + log.Warn().Msg("The use of APIKey is deprecated. Please use AgentAPIKey instead.") + } }
264-264: The metadata key "apiKey" has been kept the same. Ensure that the server-side code that reads this metadata key is also updated to handle the case where the value could now be an "Agent Key" instead of an "API Key".
288-288: The HTTP header key "apiKey" has been kept the same. Ensure that the server-side code that reads this header key is also updated to handle the case where the value could now be an "Agent Key" instead of an "API Key".
IridiumOxide
force-pushed
the
apikey-rename
branch
from
b55bb14 to
7a108db
Compare
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Files ignored due to filter (6)
- docs/gen/config/extensions/fluxninja/extension-swagger.yaml
- manifests/charts/aperture-agent/crds/fluxninja.com_agents.yaml
- manifests/charts/aperture-agent/templates/agent-deployment.yaml
- manifests/charts/aperture-controller/crds/fluxninja.com_controllers.yaml
- operator/config/crd/bases/fluxninja.com_agents.yaml
- operator/config/crd/bases/fluxninja.com_controllers.yaml
Files selected for processing (18)
- docs/agent.md (1 hunks)
- docs/content/get-started/installation/agent/docker.md (1 hunks)
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md (1 hunks)
- docs/content/get-started/self-hosting/agent.md (1 hunks)
- docs/content/reference/configuration/agent.md (1 hunks)
- docs/content/reference/configuration/controller.md (1 hunks)
- docs/content/reference/fluxninja.md (1 hunks)
- docs/controller.md (1 hunks)
- extensions/fluxninja/extconfig/extconfig.go (2 hunks)
- extensions/fluxninja/heartbeats/heartbeats.go (4 hunks)
- extensions/fluxninja/heartbeats/peers-watcher.go (1 hunks)
- extensions/fluxninja/heartbeats/provide.go (1 hunks)
- extensions/fluxninja/otel/otel_test.go (1 hunks)
- extensions/fluxninja/otel/provide.go (2 hunks)
- operator/controllers/agent/config_test.tpl (1 hunks)
- operator/controllers/controller/config_test.tpl (1 hunks)
- operator/controllers/utils.go (1 hunks)
- operator/controllers/utils_test.go (1 hunks)
Files skipped from review due to trivial changes (8)
- docs/content/get-started/installation/agent/docker.md
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md
- docs/content/reference/configuration/agent.md
- docs/content/reference/configuration/controller.md
- docs/content/reference/fluxninja.md
- extensions/fluxninja/otel/otel_test.go
- operator/controllers/controller/config_test.tpl
- operator/controllers/utils.go
Additional comments (Suppressed): 12
docs/content/get-started/self-hosting/agent.md (1)
- 68-71: The
api_keyfield has been renamed toagent_api_key. Ensure that all references to this field in the codebase have been updated to reflect this change. Also, verify that the new environment variable "APERTURE_AGENT_FLUXNINJA_AGENT_API_KEY" is set correctly in the deployment environment.extensions/fluxninja/heartbeats/provide.go (1)
- 68-73: The logic for checking the
AgentAPIKeyandAPIKeyfields has been updated to support backward compatibility. The function now checks forAgentAPIKeyfirst and falls back toAPIKeyifAgentAPIKeyis not set. This change is consistent with the PR summary and seems to be implemented correctly. However, ensure that all parts of the code that use these keys have been updated to reflect this change.docs/controller.md (1)
- 513-513: The
APIKeyfield has been renamed toAgentAPIKey. Ensure that all references to this field in the codebase have been updated to reflect this change. Also, verify that the new field name is correctly used in the configuration files and environment variables.extensions/fluxninja/otel/provide.go (2)
64-70: The new code checks for both
AgentAPIKeyandAPIKeybefore returning. This is a good practice for backward compatibility. However, it's important to ensure that the rest of the codebase is updated to prioritizeAgentAPIKeyoverAPIKeywhere applicable. Also, consider adding a deprecation warning whenAPIKeyis used.227-234: The new code correctly prioritizes
AgentAPIKeyoverAPIKeyfor authorization. This is consistent with the changes made in the rest of the codebase. However, consider adding a deprecation warning whenAPIKeyis used.operator/controllers/agent/config_test.tpl (1)
- 48-54: The
api_keyfield has been deprecated and replaced withagent_api_key. However, the deprecatedapi_keyfield is still present in the configuration for backward compatibility. Ensure that all references toapi_keyin the codebase have been updated toagent_api_keyand that the fallback logic correctly usesapi_keyifagent_api_keyis not set. Also, verify that the changes are reflected in the documentation and user instructions.docs/agent.md (1)
- 782-788: The
APIKeyfield has been renamed toAgentAPIKeyas per the changes mentioned in the pull request summary. Ensure that all references to this field in the codebase have been updated to reflect this change. Also, verify that the new environment variable "APERTURE_AGENT_FLUXNINJA_AGENT_API_KEY" is being used instead of the old one "APERTURE_AGENT_FLUXNINJA_API_KEY". This change should also be reflected in the configuration files whereapi_keyhas been replaced withagent_api_key.extensions/fluxninja/extconfig/extconfig.go (1)
- 26-35: The
APIKeyfield has been deprecated and replaced withAgentAPIKey. Ensure that all references toAPIKeyin the codebase have been updated toAgentAPIKey. Also, verify that the new fieldAgentAPIKeyis being properly validated and used throughout the codebase.extensions/fluxninja/heartbeats/heartbeats.go (3)
66-66: The field
apiKeyhas been renamed fromAPIKey. Ensure that all references to this field in the codebase have been updated to match the new name. Also, verify that this change does not break any functionality that relies on the oldAPIKeyfield.264-264: The metadata key has been kept as "apiKey" even though the field has been renamed to
apiKey. If the server-side code also has been updated to look for "AgentAPIKey", this could cause issues. Please verify that the server-side code still expects the key to be "apiKey".288-288: The request header key has been kept as "apiKey" even though the field has been renamed to
apiKey. If the server-side code also has been updated to look for "AgentAPIKey", this could cause issues. Please verify that the server-side code still expects the key to be "apiKey".operator/controllers/utils_test.go (1)
- 637-637: The environment variable "APERTURE_AGENT_FLUXNINJA_API_KEY" has been renamed to "APERTURE_AGENT_FLUXNINJA_AGENT_API_KEY". Ensure that this change is reflected in all places where this environment variable is used, including deployment scripts, CI/CD pipelines, and documentation.
IridiumOxide
force-pushed
the
apikey-rename
branch
from
7a108db to
c35829d
Compare
There was a problem hiding this comment.
Review Status
Actionable comments generated: 6
Files ignored due to filter (6)
- docs/gen/config/extensions/fluxninja/extension-swagger.yaml
- manifests/charts/aperture-agent/crds/fluxninja.com_agents.yaml
- manifests/charts/aperture-agent/templates/agent-deployment.yaml
- manifests/charts/aperture-controller/crds/fluxninja.com_controllers.yaml
- operator/config/crd/bases/fluxninja.com_agents.yaml
- operator/config/crd/bases/fluxninja.com_controllers.yaml
Files selected for processing (18)
- docs/agent.md (1 hunks)
- docs/content/get-started/installation/agent/docker.md (1 hunks)
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md (1 hunks)
- docs/content/get-started/self-hosting/agent.md (1 hunks)
- docs/content/reference/configuration/agent.md (1 hunks)
- docs/content/reference/configuration/controller.md (1 hunks)
- docs/content/reference/fluxninja.md (1 hunks)
- docs/controller.md (1 hunks)
- extensions/fluxninja/extconfig/extconfig.go (2 hunks)
- extensions/fluxninja/heartbeats/heartbeats.go (4 hunks)
- extensions/fluxninja/heartbeats/peers-watcher.go (1 hunks)
- extensions/fluxninja/heartbeats/provide.go (1 hunks)
- extensions/fluxninja/otel/otel_test.go (1 hunks)
- extensions/fluxninja/otel/provide.go (2 hunks)
- operator/controllers/agent/config_test.tpl (1 hunks)
- operator/controllers/controller/config_test.tpl (1 hunks)
- operator/controllers/utils.go (1 hunks)
- operator/controllers/utils_test.go (1 hunks)
Files skipped from review due to trivial changes (8)
- docs/content/get-started/installation/agent/docker.md
- docs/content/get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md
- docs/content/reference/configuration/agent.md
- docs/content/reference/fluxninja.md
- extensions/fluxninja/otel/otel_test.go
- operator/controllers/agent/config_test.tpl
- operator/controllers/controller/config_test.tpl
- operator/controllers/utils.go
Additional comments (Suppressed): 9
extensions/fluxninja/heartbeats/provide.go (1)
- 68-73: The logic for checking the API key has been updated to consider both
AgentAPIKeyandAPIKey. This change is backward compatible as it falls back toAPIKeyifAgentAPIKeyis not set. However, ensure that all instances where this function is called have been updated to pass the correct configuration object with the newAgentAPIKeyfield.docs/content/get-started/self-hosting/agent.md (1)
- 68-71: The
api_keyfield has been renamed toagent_api_key. Ensure that all references to this field in the codebase have been updated to reflect this change. Also, verify that the configuration files have been updated accordingly.docs/controller.md (1)
- 513-513: The
AgentAPIKeyfield has been introduced replacing theAPIKeyfield. Ensure that all references toAPIKeyin the codebase have been updated toAgentAPIKey. Also, verify that the change is reflected in the configuration files and environment variables.docs/content/reference/configuration/controller.md (1)
- 945-962: The changes in this hunk reflect the renaming of the
APIKeyfield toAgentAPIKeyas mentioned in the PR summary. The oldAPIKeyfield is marked as deprecated and the newAgentAPIKeyfield is introduced. This change is consistent with the PR summary and seems to be correctly implemented. However, ensure that all references to the oldAPIKeyfield in the codebase have been updated to use the newAgentAPIKeyfield. Also, verify that the deprecation of theAPIKeyfield does not break any existing functionality or integrations that rely on it.extensions/fluxninja/heartbeats/heartbeats.go (2)
66-66: The
APIKeyfield has been renamed toapiKeyand its visibility has been changed from public to private. This change is good for encapsulation and data hiding, but ensure that there are no external dependencies on this field.84-88: The logic has been updated to check if
AgentAPIKeyis empty and falls back toAPIKeyfor backward compatibility. This is a good practice to ensure that existing configurations continue to work.operator/controllers/utils_test.go (1)
- 637-637: The environment variable "APERTURE_AGENT_FLUXNINJA_API_KEY" has been renamed to "APERTURE_AGENT_FLUXNINJA_AGENT_API_KEY". Ensure that this change is reflected in all places where this environment variable is used, including any deployment scripts, CI/CD pipelines, and documentation. Also, verify that the new environment variable is set in the environment where the application is running.
extensions/fluxninja/otel/provide.go (1)
- 64-70: The new code checks if both
AgentAPIKeyandAPIKeyare empty before returning. This is a good approach for backward compatibility as it allows the use of the deprecatedAPIKeyifAgentAPIKeyis not set. However, ensure that this fallback logic is clearly documented for users who may still be using the deprecatedAPIKey.extensions/fluxninja/extconfig/extconfig.go (1)
- 26-34: The
APIKeyfield has been deprecated and replaced withAgentAPIKey. Ensure that all references toAPIKeyin the codebase have been updated toAgentAPIKey. Also, verify that the new fieldAgentAPIKeyis being properly validated and handled in the rest of the codebase.
Description of change
Checklist
Summary by CodeRabbit
APIKeyhas been renamed toAgentAPIKeyacross the codebase to improve clarity and consistency. This change affects the schema definitions, configuration files, and environment variables.APIKeytoAgentAPIKey. This includes installation instructions and configuration references.APIKeyto ensure backward compatibility. However, users are encouraged to start usingAgentAPIKeyfor future configurations.These changes aim to make the software more intuitive and user-friendly by using more descriptive terminology.