feat: change helm release and helm repository names in cli (#1330)

Author: danielorihuela

agent-control/src/bin/main_agent_control_cli.rs

@@ -3,9 +3,7 @@ use newrelic_agent_control::cli::errors::CliError;
 use newrelic_agent_control::cli::install_agent_control::{
     AgentControlInstallData, install_agent_control,
 };
-use newrelic_agent_control::cli::uninstall_agent_control::{
-    AgentControlUninstallData, uninstall_agent_control,
-};
+use newrelic_agent_control::cli::uninstall_agent_control::uninstall_agent_control;
 use newrelic_agent_control::{
     agent_control::defaults::AGENT_CONTROL_LOG_DIR,
     http::tls::install_rustls_default_crypto_provider,
@@ -38,7 +36,7 @@ enum Operations {
     /// Install agent control chart and create required resources
     InstallAgentControl(AgentControlInstallData),
     /// Uninstall agent control and delete related resources
-    UninstallAgentControl(AgentControlUninstallData),
+    UninstallAgentControl,
 }
 
 fn main() -> ExitCode {
@@ -62,9 +60,7 @@ fn main() -> ExitCode {
         Operations::InstallAgentControl(agent_control_data) => {
             install_agent_control(agent_control_data, cli.namespace)
         }
-        Operations::UninstallAgentControl(agent_control_data) => {
-            uninstall_agent_control(agent_control_data, cli.namespace)
-        }
+        Operations::UninstallAgentControl => uninstall_agent_control(cli.namespace),
     };
 
     match result {

agent-control/src/cli/install_agent_control.rs

@@ -1,4 +1,5 @@
 use crate::agent_control::config::{helmrelease_v2_type_meta, helmrepository_type_meta};
+use crate::agent_control::defaults::AGENT_CONTROL_ID;
 use crate::cli::errors::CliError;
 use crate::cli::utils::*;
 use crate::health::health_checker::HealthChecker;
@@ -20,7 +21,8 @@ use std::thread::sleep;
 use std::time::Duration;
 use tracing::{debug, info};
 
-pub const REPOSITORY_NAME: &str = "newrelic";
+pub const RELEASE_NAME: &str = AC_DEPLOYMENT_CHART_NAME;
+pub const REPOSITORY_NAME: &str = AGENT_CONTROL_ID;
 const REPOSITORY_URL: &str = "https://helm-charts.newrelic.com";
 const FIVE_MINUTES: &str = "300s";
 const AC_DEPLOYMENT_CHART_NAME: &str = "agent-control-deployment";
@@ -30,10 +32,6 @@ const INSTALLATION_CHECK_DEFAULT_RETRY_INTERVAL: Duration = Duration::from_secs(
 
 #[derive(Debug, Clone, Parser)]
 pub struct AgentControlInstallData {
-    /// Release name
-    #[arg(long)]
-    pub release_name: String,
-
     /// Version of the agent control deployment chart
     #[arg(long)]
     pub chart_version: String,
@@ -212,7 +210,7 @@ fn helm_release(
     DynamicObject {
         types: Some(helmrelease_v2_type_meta()),
         metadata: ObjectMeta {
-            name: Some(value.release_name.clone()),
+            name: Some(RELEASE_NAME.to_string()),
             labels: Some(labels),
             annotations: Some(annotations),
             ..Default::default()
@@ -293,12 +291,10 @@ fn check_installation(
 mod tests {
     use super::*;
 
-    const RELEASE_NAME: &str = "agent-control-deployment-release";
     const VERSION: &str = "1.0.0";
 
     fn agent_control_data() -> AgentControlInstallData {
         AgentControlInstallData {
-            release_name: RELEASE_NAME.to_string(),
             chart_version: VERSION.to_string(),
             secrets: None,
             extra_labels: None,

agent-control/src/cli/uninstall_agent_control.rs

@@ -2,36 +2,24 @@ use crate::agent_control::config::{
     default_group_version_kinds, helmrelease_v2_type_meta, helmrepository_type_meta,
 };
 use crate::cli::errors::CliError;
-use crate::cli::install_agent_control::REPOSITORY_NAME;
+use crate::cli::install_agent_control::{RELEASE_NAME, REPOSITORY_NAME};
 use crate::cli::utils::{retry, try_new_k8s_client};
 #[cfg_attr(test, mockall_double::double)]
 use crate::k8s::client::SyncK8sClient;
 use crate::k8s::labels::Labels;
-use clap::Parser;
 use either::Either;
 use kube::api::{DynamicObject, ObjectList, TypeMeta};
 use kube::client::Status;
 use std::collections::HashSet;
-use std::fmt::Debug;
 use std::time::Duration;
 use tracing::info;
 
-#[derive(Debug, Parser)]
-pub struct AgentControlUninstallData {
-    /// Release name
-    #[arg(long)]
-    pub release_name: String,
-}
-
-pub fn uninstall_agent_control(
-    data: AgentControlUninstallData,
-    namespace: String,
-) -> Result<(), CliError> {
+pub fn uninstall_agent_control(namespace: String) -> Result<(), CliError> {
     let k8s_client = try_new_k8s_client(namespace.clone())?;
     let kinds_available = retrieve_api_resources(&k8s_client)?;
 
     // we delete first the AC so that it does not interfere (by recreating resources that we have just deleted).
-    delete_agent_control_crs(&k8s_client, &kinds_available, data)?;
+    delete_agent_control_crs(&k8s_client, &kinds_available)?;
     // Deleting remaining objects owned by AC
     delete_owned_objects(&k8s_client, &kinds_available)?;
 
@@ -99,10 +87,9 @@ fn objects_to_delete(kinds_available: &HashSet<TypeMeta>) -> Vec<TypeMeta> {
 fn delete_agent_control_crs(
     k8s_client: &SyncK8sClient,
     kinds_available: &HashSet<TypeMeta>,
-    data: AgentControlUninstallData,
 ) -> Result<(), CliError> {
     let mut crs_to_delete: Vec<(TypeMeta, &str)> = vec![
-        (helmrelease_v2_type_meta(), data.release_name.as_str()),
+        (helmrelease_v2_type_meta(), RELEASE_NAME),
         (helmrepository_type_meta(), REPOSITORY_NAME),
     ];
 

agent-control/tests/k8s/agent_control_cli/dynamic_objects.rs

@@ -1,4 +1,5 @@
 use assert_cmd::Command;
+use newrelic_agent_control::cli::install_agent_control::{RELEASE_NAME, REPOSITORY_NAME};
 use newrelic_agent_control::sub_agent::identity::AgentIdentity;
 
 use crate::k8s::tools::k8s_env::K8sEnv;
@@ -7,9 +8,6 @@ use newrelic_agent_control::agent_control::config::{
 };
 use newrelic_agent_control::k8s::client::SyncK8sClient;
 
-const REPOSITORY_NAME: &str = "newrelic";
-const RELEASE_NAME: &str = "agent-control-deployment";
-
 #[test]
 #[ignore = "needs k8s cluster"]
 fn k8s_cli_install_agent_control_creates_resources() {
@@ -20,7 +18,6 @@ fn k8s_cli_install_agent_control_creates_resources() {
 
     let mut cmd = Command::cargo_bin("newrelic-agent-control-cli").unwrap();
     cmd.arg("install-agent-control");
-    cmd.arg("--release-name").arg(RELEASE_NAME);
     cmd.arg("--chart-version").arg("1.0.0");
     cmd.arg("--namespace").arg(namespace.clone());
     cmd.arg("--extra-labels")
@@ -122,7 +119,6 @@ fn k8s_cli_install_agent_control_creates_resources_with_specific_repository_url(
     let repository_url = "https://cli-charts.newrelic.com";
     let mut cmd = Command::cargo_bin("newrelic-agent-control-cli").unwrap();
     cmd.arg("install-agent-control");
-    cmd.arg("--release-name").arg(RELEASE_NAME);
     cmd.arg("--chart-version").arg("1.0.0");
     cmd.arg("--namespace").arg(namespace.clone());
     cmd.arg("--skip-installation-check"); // Skipping checks because we are merely checking that the resources are created.

agent-control/tests/k8s/agent_control_cli/installation.rs

@@ -89,7 +89,6 @@ fn k8s_cli_install_agent_control_installation_failed_upgrade() {
 pub fn ac_install_cmd(namespace: &str, chart_version: &str, secrets: &str) -> Command {
     let mut cmd = Command::cargo_bin("newrelic-agent-control-cli").unwrap();
     cmd.arg("install-agent-control");
-    cmd.arg("--release-name").arg("test-release");
     cmd.arg("--chart-version").arg(chart_version);
     cmd.arg("--namespace").arg(namespace);
     cmd.arg("--secrets").arg(secrets);
@@ -108,6 +107,7 @@ pub(crate) fn create_simple_values_secret(
     // We set cleanupManagedResources: false to avoid race conditions between the old way to uninstall and the new one
     // TODO remove it once it is not needed anymore.
     let values = serde_json::json!({
+        "nameOverride": "",
         "cleanupManagedResources": false,
         "config": {
             "fleet_control": {

agent-control/tests/k8s/agent_control_cli/uninstallation.rs

@@ -5,14 +5,14 @@ use assert_cmd::Command;
 use k8s_openapi::api::apps::v1::Deployment;
 use k8s_openapi::api::core::v1::{ConfigMap, Secret};
 use kube::Api;
+use newrelic_agent_control::cli::install_agent_control::RELEASE_NAME;
 use predicates::prelude::predicate;
 use std::time::Duration;
 
 #[test]
 fn cli_uninstall_agent_control_fails_when_no_kubernetes() {
     let mut cmd = Command::cargo_bin("newrelic-agent-control-cli").unwrap();
     cmd.arg("uninstall-agent-control");
-    cmd.arg("--release-name").arg("agent-control-release");
 
     cmd.assert().failure();
     cmd.assert().code(predicate::eq(69));
@@ -45,7 +45,10 @@ fn k8s_cli_install_agent_control_installation_and_uninstallation() {
     let secrets: Api<Secret> = Api::namespaced(k8s_env.client.clone(), &namespace);
 
     retry(10, Duration::from_secs(1), || {
-        let _ = runtime.block_on(deployments.get("test-release-agent-control"))?;
+        // We set "nameOverride" in the secret values to force the deployment name
+        // to be equal to the release name. This avoids breaking the test if the
+        // default value changes in the chart.
+        let _ = runtime.block_on(deployments.get(RELEASE_NAME))?;
         Ok(())
     });
     retry(10, Duration::from_secs(1), || {
@@ -61,7 +64,7 @@ fn k8s_cli_install_agent_control_installation_and_uninstallation() {
     cmd.assert().success();
 
     let _ = runtime
-        .block_on(deployments.get("test-release-agent-control"))
+        .block_on(deployments.get("agent-control"))
         .expect_err("AC deployment should be deleted");
     let _ = runtime
         .block_on(config_maps.get("local-data-nr-infra"))
@@ -76,7 +79,6 @@ fn k8s_cli_install_agent_control_installation_and_uninstallation() {
 fn cli_uninstall_agent_control_fails_when_no_kubernetes_namespace() {
     let mut cmd = Command::cargo_bin("newrelic-agent-control-cli").unwrap();
     cmd.arg("uninstall-agent-control");
-    cmd.arg("--release-name").arg("agent-control-release");
     cmd.arg("--namespace").arg("not-existing-namespace");
 
     cmd.assert().failure();
@@ -102,7 +104,6 @@ fn k8s_cli_uninstall_agent_control_clean_empty_cluster() {
 fn ac_uninstall_cmd(namespace: &str) -> Command {
     let mut cmd = Command::cargo_bin("newrelic-agent-control-cli").unwrap();
     cmd.arg("uninstall-agent-control");
-    cmd.arg("--release-name").arg("test-release");
     cmd.arg("--namespace").arg(namespace);
     cmd
 }