rename api key to agent key

fluxninja · Oct 17, 2023 · ee317c0 · ee317c0
1 parent edab448
commit ee317c0
Show file tree

Hide file tree

Showing 23 changed files with 89 additions and 30 deletions.
diff --git a/docs/agent.md b/docs/agent.md
@@ -782,7 +782,7 @@ empty schema
 
 | Name              | Type                           | Go type        | Required | Default | Description                                                                                                                   | Example |
 | ----------------- | ------------------------------ | -------------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------- | ------- |
-| APIKey            | string                         | `string`       |          |         | API Key for this agent. If this key is not set, the extension won't be enabled.                                               |         |
+| AgentAPIKey       | string                         | `string`       |          |         | API Key for this agent. If this key is not set, the extension won't be enabled.                                               |         |
 | Endpoint          | string                         | `string`       |          |         | Address to gRPC or HTTP(s) server listening in agent service. To use HTTP protocol, the address must start with `http(s)://`. |         |
 | HeartbeatInterval | string (formatted string)      | `string`       |          |         | Interval between each heartbeat.                                                                                              |         |
 | InstallationMode  | string                         | `string`       |          |         | Installation mode describes on which underlying platform the Agent or the Controller is being run.                            |         |

diff --git a/docs/content/get-started/installation/agent/docker.md b/docs/content/get-started/installation/agent/docker.md
@@ -29,7 +29,7 @@ Below are the instructions to install the Aperture Agent on Docker.
    fluxninja:
      enable_cloud_controller: true
      endpoint: "ORGANIZATION_NAME.app.fluxninja.com:443"
-     api_key: AGENT_API_KEY
+     agent_api_key: AGENT_API_KEY
    log:
      level: info
      pretty_console: true

diff --git a/.../get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md b/.../get-started/installation/agent/kubernetes/namespace-scoped/namespace-scoped.md
@@ -79,7 +79,7 @@ agent:
 By following these instructions, you will have deployed the Aperture Agent into
 your cluster.
 
-1. Configure the Aperture Cloud endpoint and API key parameters in the Agent.
+1. Configure the Aperture Cloud endpoint and Agent Key parameters in the Agent.
    Update the `values.yaml` file and pass it with the `install` command:
 
    ```yaml

diff --git a/docs/content/get-started/self-hosting/agent.md b/docs/content/get-started/self-hosting/agent.md
@@ -68,7 +68,7 @@ as release name. If your setup is different, adjust these endpoints accordingly.
 fluxninja:
   enable_cloud_controller: false
   endpoint: "ORGANIZATION_NAME.app.fluxninja.com:443"
-  api_key: API_KEY
+  agent_api_key: AGENT_API_KEY
 etcd:
   endpoints: ["http://etcd:2379"]
 prometheus:

diff --git a/docs/content/reference/configuration/agent.md b/docs/content/reference/configuration/agent.md
@@ -1430,6 +1430,18 @@ FluxNinjaExtensionConfig is the configuration for
 
 <!-- vale on -->
 
+Deprecated: use agent_api_key instead
+
+</dd>
+<dt>agent_api_key</dt>
+<dd>
+
+<!-- vale off -->
+
+(string)
+
+<!-- vale on -->
+
 API Key for this agent. If this key is not set, the extension won't be enabled.
 
 </dd>

diff --git a/docs/content/reference/configuration/controller.md b/docs/content/reference/configuration/controller.md
@@ -949,6 +949,18 @@ FluxNinjaExtensionConfig is the configuration for
 
 <!-- vale on -->
 
+Deprecated: use agent_api_key instead
+
+</dd>
+<dt>agent_api_key</dt>
+<dd>
+
+<!-- vale off -->
+
+(string)
+
+<!-- vale on -->
+
 API Key for this agent. If this key is not set, the extension won't be enabled.
 
 </dd>

diff --git a/docs/content/reference/fluxninja.md b/docs/content/reference/fluxninja.md
@@ -97,8 +97,8 @@ installation of the Aperture Controller or Agent:
   </TabItem>
 </Tabs>
 
-Replace the values of `ORGANIZATION_NAME` and `API_KEY` with the actual values
-of the organization on Aperture Cloud and API Key generated on it.
+Replace the values of `ORGANIZATION_NAME` and `AGENT_KEY` with the actual values
+of the organization on Aperture Cloud and Agent Key generated on it.
 
 :::note
 

diff --git a/docs/controller.md b/docs/controller.md
@@ -510,7 +510,7 @@ empty schema
 
 | Name              | Type                           | Go type        | Required | Default | Description                                                                                                                   | Example |
 | ----------------- | ------------------------------ | -------------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------- | ------- |
-| APIKey            | string                         | `string`       |          |         | API Key for this agent. If this key is not set, the extension won't be enabled.                                               |         |
+| AgentAPIKey       | string                         | `string`       |          |         | API Key for this agent. If this key is not set, the extension won't be enabled.                                               |         |
 | Endpoint          | string                         | `string`       |          |         | Address to gRPC or HTTP(s) server listening in agent service. To use HTTP protocol, the address must start with `http(s)://`. |         |
 | HeartbeatInterval | string (formatted string)      | `string`       |          |         | Interval between each heartbeat.                                                                                              |         |
 | InstallationMode  | string                         | `string`       |          |         | Installation mode describes on which underlying platform the Agent or the Controller is being run.                            |         |

diff --git a/docs/gen/config/extensions/fluxninja/extension-swagger.yaml b/docs/gen/config/extensions/fluxninja/extension-swagger.yaml
@@ -89,9 +89,14 @@ definitions:
         x-go-package: github.com/fluxninja/aperture/v2/pkg/config
     FluxNinjaExtensionConfig:
         properties:
-            api_key:
+            agent_api_key:
                 description: API Key for this agent. If this key is not set, the extension won't be enabled.
                 type: string
+                x-go-name: AgentAPIKey
+                x-go-tag-json: agent_api_key
+            api_key:
+                description: 'Deprecated: use agent_api_key instead'
+                type: string
                 x-go-name: APIKey
                 x-go-tag-json: api_key
             client:

diff --git a/extensions/fluxninja/extconfig/extconfig.go b/extensions/fluxninja/extconfig/extconfig.go
@@ -26,8 +26,10 @@ type FluxNinjaExtensionConfig struct {
 	// For connecting to Aperture Cloud Controller, the `endpoint` should be a `grpc/http2` address.
 	// For self-hosted controller, the HTTP protocol address can start with `http(s)://`.
 	Endpoint string `json:"endpoint" validate:"omitempty,hostname_port|url|fqdn"`
-	// API Key for this agent. If this key is not set, the extension won't be enabled.
+	// Deprecated: use agent_api_key instead
 	APIKey string `json:"api_key"`
+	// API Key for this agent. If this key is not set, the extension won't be enabled.
+	AgentAPIKey string `json:"agent_api_key"`
 	// Installation mode describes on which underlying platform the Agent or the Controller is being run.
 	InstallationMode string `json:"installation_mode" validate:"oneof=KUBERNETES_SIDECAR KUBERNETES_DAEMONSET LINUX_BARE_METAL" default:"LINUX_BARE_METAL"`
 	// Whether to connect to [Aperture Cloud Controller](/reference/fluxninja.md).
@@ -78,12 +80,16 @@ func provideConfig(unmarshaller config.Unmarshaller) (*FluxNinjaExtensionConfig,
 
 func provideEtcdConfigOverride(extensionConfig *FluxNinjaExtensionConfig) *etcdclient.ConfigOverride {
 	if extensionConfig.EnableCloudController {
+		apiKey := extensionConfig.AgentAPIKey
+		if apiKey == "" {
+			apiKey = extensionConfig.APIKey
+		}
 		return &etcdclient.ConfigOverride{
 			Namespace: "",
 			Endpoints: []string{extensionConfig.Endpoint},
 			PerRPCCredentials: perRPCHeaders{
 				headers: map[string]string{
-					"apiKey": extensionConfig.APIKey,
+					"apiKey": apiKey,
 				},
 			},
 			OverriderName: "fluxninja extension",

diff --git a/extensions/fluxninja/heartbeats/heartbeats.go b/extensions/fluxninja/heartbeats/heartbeats.go
@@ -63,7 +63,7 @@ type Heartbeats struct {
 	flowControlPoints         *cache.Cache[selectors.TypedControlPointID]
 	agentInfo                 *agentinfo.AgentInfo
 	election                  *election.Election
-	APIKey                    string
+	apiKey                    string
 	jobName                   string
 	installationMode          string
 	heartbeatsAddr            string
@@ -81,10 +81,14 @@ func newHeartbeats(
 	flowControlPoints *cache.Cache[selectors.TypedControlPointID],
 	autoscalek8sControlPoints autoscalek8sdiscovery.AutoScaleControlPoints,
 ) *Heartbeats {
+	apiKey := extensionConfig.AgentAPIKey
+	if apiKey == "" {
+		apiKey = extensionConfig.APIKey
+	}
 	return &Heartbeats{
 		heartbeatsAddr:            extensionConfig.Endpoint,
 		interval:                  extensionConfig.HeartbeatInterval,
-		APIKey:                    extensionConfig.APIKey,
+		apiKey:                    apiKey,
 		jobGroup:                  jobGroup,
 		statusRegistry:            statusRegistry,
 		entities:                  entities,
@@ -255,8 +259,8 @@ func (h *Heartbeats) newHeartbeat(
 func (h *Heartbeats) sendSingleHeartbeat(jobCtxt context.Context) (proto.Message, error) {
 	report := h.newHeartbeat(jobCtxt)
 
-	// Add api key value to metadata
-	md := metadata.Pairs("apiKey", h.APIKey)
+	// Add agent key value to metadata
+	md := metadata.Pairs("apiKey", h.apiKey)
 	ctx := metadata.NewOutgoingContext(jobCtxt, md)
 	_, err := h.heartbeatsClient.Report(ctx, report)
 	if err != nil {
@@ -280,7 +284,7 @@ func (h *Heartbeats) sendSingleHeartbeatByHTTP(jobCtxt context.Context) (proto.M
 		log.Warn().Err(err).Msg("could not create request")
 		return &emptypb.Empty{}, err
 	}
-	req.Header.Add("apiKey", h.APIKey)
+	req.Header.Add("apiKey", h.apiKey)
 	cli := http.DefaultClient
 	cli.Transport = &http.Transport{}
 	_, err = cli.Do(req)

diff --git a/extensions/fluxninja/heartbeats/peers-watcher.go b/extensions/fluxninja/heartbeats/peers-watcher.go
@@ -34,7 +34,11 @@ func setupPeersWatcher(
 	sessionScopedKV *etcdclient.SessionScopedKV,
 	lc fx.Lifecycle,
 ) (PeersOut, error) {
-	if extensionConfig.APIKey == "" {
+	apiKey := extensionConfig.AgentAPIKey
+	if apiKey == "" {
+		apiKey = extensionConfig.APIKey
+	}
+	if apiKey == "" {
 		return PeersOut{}, nil
 	}
 

diff --git a/extensions/fluxninja/heartbeats/provide.go b/extensions/fluxninja/heartbeats/provide.go
@@ -66,8 +66,8 @@ type ConstructorIn struct {
 
 // provide provides a new instance of Heartbeats.
 func provide(in ConstructorIn) (*Heartbeats, error) {
-	if in.ExtensionConfig.APIKey == "" {
-		log.Info().Msg("Heartbeats API key not set, skipping")
+	if in.ExtensionConfig.AgentAPIKey == "" && in.ExtensionConfig.APIKey == "" {
+		log.Info().Msg("Heartbeats Agent Key not set, skipping")
 		return nil, nil
 	}
 

diff --git a/extensions/fluxninja/otel/otel_test.go b/extensions/fluxninja/otel/otel_test.go
@@ -27,8 +27,8 @@ var _ = DescribeTable("FN Extension OTel", func(
 ) {
 	cfg := map[string]interface{}{
 		"fluxninja": map[string]interface{}{
-			"api_key":  "deadbeef",
-			"endpoint": "http://localhost:1234",
+			"agent_api_key": "deadbeef",
+			"endpoint":      "http://localhost:1234",
 		},
 	}
 	marshalledCfg, err := json.Marshal(cfg)

diff --git a/extensions/fluxninja/otel/provide.go b/extensions/fluxninja/otel/provide.go
@@ -64,7 +64,7 @@ func injectOtelConfig(
 	extensionConfig *extconfig.FluxNinjaExtensionConfig,
 	configProvider *otelconfig.Provider,
 ) {
-	if extensionConfig.APIKey == "" {
+	if extensionConfig.AgentAPIKey == "" && extensionConfig.APIKey == "" {
 		return
 	}
 
@@ -226,10 +226,14 @@ func addFluxNinjaExporter(config *otelconfig.Config,
 	grpcClientConfig *grpcclient.GRPCClientConfig,
 	httpClientConfig *httpclient.HTTPClientConfig,
 ) {
+	apiKey := extensionConfig.AgentAPIKey
+	if apiKey == "" {
+		apiKey = extensionConfig.APIKey
+	}
 	cfg := map[string]interface{}{
 		"endpoint": extensionConfig.Endpoint,
 		"headers": map[string]interface{}{
-			"authorization": fmt.Sprintf("Bearer %s", extensionConfig.APIKey),
+			"authorization": fmt.Sprintf("Bearer %s", apiKey),
 		},
 		"sending_queue": map[string]interface{}{
 			// Needed to avoid sending metrics out of order, which leads to metrics

diff --git a/manifests/charts/aperture-agent/crds/fluxninja.com_agents.yaml b/manifests/charts/aperture-agent/crds/fluxninja.com_agents.yaml
@@ -1164,10 +1164,13 @@ spec:
                   fluxninja:
                     description: FluxNinja extension configuration.
                     properties:
-                      api_key:
+                      agent_api_key:
                         description: API Key for this agent. If this key is not set,
                           the extension won't be enabled.
                         type: string
+                      api_key:
+                        description: 'Deprecated: use agent_api_key instead'
+                        type: string
                       client:
                         description: Client configuration.
                         properties:

diff --git a/manifests/charts/aperture-agent/templates/agent-deployment.yaml b/manifests/charts/aperture-agent/templates/agent-deployment.yaml
@@ -103,7 +103,7 @@ spec:
             - name: APERTURE_AGENT_SERVICE_DISCOVERY_KUBERNETES_ENABLED
               value: "false"
             {{- if or (and .Values.agent.secrets.fluxNinjaExtension .Values.agent.secrets.fluxNinjaExtension.create) (and .Values.agent.secrets.fluxNinjaExtension .Values.agent.secrets.fluxNinjaExtension.secretKeyRef .Values.agent.secrets.fluxNinjaExtension.secretKeyRef.name) }}
-            - name: APERTURE_AGENT_FLUXNINJA_API_KEY
+            - name: APERTURE_AGENT_FLUXNINJA_AGENT_KEY
               valueFrom:
                 secretKeyRef:
                   name: {{ include "agent.apiSecret.name" (dict "agent" .Values.agent "context" . $ ) }}

diff --git a/manifests/charts/aperture-controller/crds/fluxninja.com_controllers.yaml b/manifests/charts/aperture-controller/crds/fluxninja.com_controllers.yaml
@@ -1048,10 +1048,13 @@ spec:
                   fluxninja:
                     description: FluxNinja extension configuration.
                     properties:
-                      api_key:
+                      agent_api_key:
                         description: API Key for this agent. If this key is not set,
                           the extension won't be enabled.
                         type: string
+                      api_key:
+                        description: 'Deprecated: use agent_api_key instead'
+                        type: string
                       client:
                         description: Client configuration.
                         properties:

diff --git a/operator/config/crd/bases/fluxninja.com_agents.yaml b/operator/config/crd/bases/fluxninja.com_agents.yaml
@@ -1164,10 +1164,13 @@ spec:
                   fluxninja:
                     description: FluxNinja extension configuration.
                     properties:
-                      api_key:
+                      agent_api_key:
                         description: API Key for this agent. If this key is not set,
                           the extension won't be enabled.
                         type: string
+                      api_key:
+                        description: 'Deprecated: use agent_api_key instead'
+                        type: string
                       client:
                         description: Client configuration.
                         properties:

diff --git a/operator/config/crd/bases/fluxninja.com_controllers.yaml b/operator/config/crd/bases/fluxninja.com_controllers.yaml
@@ -1048,10 +1048,13 @@ spec:
                   fluxninja:
                     description: FluxNinja extension configuration.
                     properties:
-                      api_key:
+                      agent_api_key:
                         description: API Key for this agent. If this key is not set,
                           the extension won't be enabled.
                         type: string
+                      api_key:
+                        description: 'Deprecated: use agent_api_key instead'
+                        type: string
                       client:
                         description: Client configuration.
                         properties:

diff --git a/operator/controllers/agent/config_test.tpl b/operator/controllers/agent/config_test.tpl
@@ -48,7 +48,7 @@ auto_scale:
   kubernetes:
     enabled: false
 fluxninja:
-  api_key: ""
+  agent_api_key: ""
   client:
     grpc:
       backoff:

diff --git a/operator/controllers/utils.go b/operator/controllers/utils.go
@@ -245,7 +245,7 @@ func AgentEnv(instance *agentv1alpha1.Agent, agentGroup string) []corev1.EnvVar
 
 	if instance.Spec.Secrets.FluxNinjaExtension.Create || instance.Spec.Secrets.FluxNinjaExtension.SecretKeyRef.Name != "" {
 		envs = append(envs, corev1.EnvVar{
-			Name: "APERTURE_AGENT_FLUXNINJA_API_KEY",
+			Name: "APERTURE_AGENT_FLUXNINJA_AGENT_KEY",
 			ValueFrom: &corev1.EnvVarSource{
 				SecretKeyRef: &corev1.SecretKeySelector{
 					LocalObjectReference: corev1.LocalObjectReference{

diff --git a/operator/controllers/utils_test.go b/operator/controllers/utils_test.go
@@ -634,7 +634,7 @@ var _ = Describe("Tests for agentEnv", func() {
 					Value: "true",
 				},
 				{
-					Name: "APERTURE_AGENT_FLUXNINJA_API_KEY",
+					Name: "APERTURE_AGENT_FLUXNINJA_AGENT_KEY",
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{