chore(bors): merge pull request #504

504: feat(naming): make it easier to use custom names r=tiagolobocastro a=tiagolobocastro

Would still require a lot of manual changes though as values are spread on many .yaml files, ie values.yaml product.yaml doc.yaml... A script would be the required to make all changes.

<!

Co-authored-by: Tiago Castro <[email protected]>

call-home/Cargo.toml

@@ -18,6 +18,7 @@ name = "obs-callhome-stats"
 path = "src/bin/stats/main.rs"
 
 [dependencies]
+constants = { path = "../constants" }
 openapi = {path = "../dependencies/control-plane/openapi"}
 kube = { version = "0.85.0", features = ["runtime", "derive"] }
 k8s-openapi = { version = "0.19.0", features = ["v1_20"] }

call-home/src/bin/callhome/main.rs

@@ -139,7 +139,7 @@ async fn generate_report(
     aggregator_url: Option<Url>,
 ) -> Report {
     let mut report = Report {
-        product_name: PRODUCT.to_string(),
+        product_name: product(),
         k8s_cluster_id,
         deploy_namespace,
         product_version,

call-home/src/bin/callhome/transmitter/client.rs

@@ -42,7 +42,7 @@ impl Receiver {
             .header("CAStor-Cluster-Id", &self.cluster_id)
             .header("CAStor-Version", release_version())
             .header("CAStor-Report-Type", "health_report")
-            .header("CAStor-Product", PRODUCT)
+            .header("CAStor-Product", product())
             .header("CAStor-Time", Utc::now().to_string())
             .header("Content-Type", "text/PGP; charset=binary")
             .body(body)

call-home/src/common/constants.rs

@@ -5,13 +5,12 @@ use std::{
 use utils::version_info;
 
 /// PRODUCT is the name of the project for which this call-home component is deployed.
-pub const PRODUCT: &str = "Mayastor";
-
-/// Label for release name.
-pub const HELM_RELEASE_NAME_LABEL: &str = "openebs.io/release";
+pub fn product() -> String {
+    ::constants::product_pascal()
+}
 
 /// Defines the default helm chart release name.
-pub const DEFAULT_RELEASE_NAME: &str = "mayastor";
+pub const DEFAULT_RELEASE_NAME: &str = ::constants::DEFAULT_RELEASE_NAME;
 
 /// Defines the Label select for mayastor REST API.
 pub const API_REST_LABEL_SELECTOR: &str = "app=api-rest";
@@ -34,7 +33,7 @@ pub const POOL_STATS: &str = "Pool stats";
 /// Defines the help argument for nexus stats need for promethueus library.
 pub const NEXUS_STATS: &str = "Nexus stats";
 
-/// Variable label for promethueus library.
+/// Variable label for prometheus library.
 pub const ACTION: &str = "action";
 
 /// Create action for events.
@@ -112,7 +111,7 @@ pub fn key_filepath() -> PathBuf {
 }
 
 /// RECEIVER_API_ENDPOINT is the URL to anonymous call-home metrics collection endpoint.
-pub const RECEIVER_ENDPOINT: &str = "https://openebs.phonehome.datacore.com/openebs/report";
+pub const RECEIVER_ENDPOINT: &str = ::constants::CALL_HOME_ENDPOINT;
 
 /// CALL_HOME_FREQUENCY_IN_HOURS is the frequency of call-home metrics transmission, in hours.
 /// The function call_home_frequency() returns the frequency as an std::time::Duration.

chart/values.yaml

@@ -633,7 +633,7 @@ loki-stack:
         # -- The Loki address to post logs to
         - url: http://{{ .Release.Name }}-loki:3100/loki/api/v1/push
       snippets:
-        # Promtail will export logs to loki only based on based on below
+        # Promtail will export logs to loki only based on below
         # configuration, below scrape config will export only our services
         # which are labeled with openebs.io/logging=true
         scrapeConfigs: |

constants/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "constants"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+utils = {path = "../dependencies/control-plane/utils/utils-lib" }
+convert_case = "0.4.0"

constants/src/lib.rs

@@ -0,0 +1,51 @@
+use convert_case::Casing;
+use utils::constants::PRODUCT_DOMAIN_NAME;
+pub use utils::PRODUCT_NAME;
+
+/// Name of the product.
+pub fn product_pascal() -> String {
+    PRODUCT_NAME.to_case(convert_case::Case::Pascal)
+}
+
+/// Helm release name label's key.
+pub fn helm_release_name_key() -> String {
+    format!("{PRODUCT_DOMAIN_NAME}/release")
+}
+
+/// Upgrade job container image name.
+pub fn upgrade_job_img() -> String {
+    format!("{PRODUCT_NAME}-upgrade-job")
+}
+/// Upgrade job container image name.
+pub fn upgrade_job_container_name() -> String {
+    format!("{PRODUCT_NAME}-upgrade-job")
+}
+/// UPGRADE_EVENT_REASON is the reason field in upgrade job.
+pub fn upgrade_event_reason() -> String {
+    format!("{}Upgrade", product_pascal())
+}
+/// Upgrade job container image repository.
+pub const UPGRADE_JOB_IMAGE_REPO: &str = "openebs";
+/// This is the user docs URL for the Umbrella chart.
+pub const UMBRELLA_CHART_UPGRADE_DOCS_URL: &str =
+    "https://openebs.io/docs/user-guides/upgrade#mayastor-upgrade";
+
+/// Defines the default helm chart release name.
+pub const DEFAULT_RELEASE_NAME: &str = PRODUCT_NAME;
+
+/// Installed release version.
+pub fn helm_release_version_key() -> String {
+    format!("{PRODUCT_DOMAIN_NAME}/version")
+}
+
+/// Loki Logging key.
+pub fn loki_logging_key() -> String {
+    format!("{PRODUCT_DOMAIN_NAME}/logging")
+}
+
+/// This is the name of the Helm chart which included the core chart as a sub-chart.
+/// Under the hood, this installs the Core Helm chart (see below).
+pub const UMBRELLA_CHART_NAME: &str = "openebs";
+
+/// RECEIVER_API_ENDPOINT is the URL to anonymous call-home metrics collection endpoint.
+pub const CALL_HOME_ENDPOINT: &str = "https://openebs.phonehome.datacore.com/openebs/report";

k8s/plugin/Cargo.toml

@@ -19,6 +19,7 @@ tls = [ "openapi/tower-client-tls", "rest-plugin/tls" ]
 [dependencies]
 openapi = { path = "../../dependencies/control-plane/openapi", default-features = false, features = [ "tower-trace" ] }
 utils = { path = "../../dependencies/control-plane/utils/utils-lib" }
+constants = { path = "../../constants" }
 rest-plugin = { path = "../../dependencies/control-plane/control-plane/plugin", default-features = false }
 console-logger = { path = "../../console-logger" }
 supportability = { path = "../supportability" }

k8s/supportability/Cargo.toml

@@ -46,3 +46,5 @@ platform = { path = "../../dependencies/control-plane/utils/platform" }
 openapi = { path = "../../dependencies/control-plane/openapi", default-features = false, features = [ "tower-client", "tower-trace" ] }
 kube-proxy = { path = "../proxy" }
 rest-plugin = { path = "../../dependencies/control-plane/control-plane/plugin", default-features = false }
+utils = { path = "../../dependencies/control-plane/utils/utils-lib" }
+constants = { path = "../../constants" }

k8s/supportability/src/collect/constants.rs

@@ -37,8 +37,10 @@ pub(crate) const MAYASTOR_SERVICE: &str = "io-engine";
 /// Defines the name of mayastor-io container(dataplane container)
 pub(crate) const DATA_PLANE_CONTAINER_NAME: &str = "io-engine";
 
-/// Defines the logging label(key-value pair) on mayastor services
-pub(crate) const LOGGING_LABEL_SELECTOR: &str = "openebs.io/logging=true";
+/// Defines the logging label(key-value pair) on services.
+pub(crate) fn logging_label_selector() -> String {
+    format!("{}=true", ::constants::loki_logging_key())
+}
 
 /// Defines the name of upgrade service
 pub(crate) const UPGRADE_SERVICE: &str = "upgrade";

k8s/supportability/src/collect/k8s_resources/k8s_resource_dump.rs

@@ -19,8 +19,7 @@ use std::{
     iter::FromIterator,
     path::{Path, PathBuf},
 };
-
-const MAYASTOR_CSI_DRIVER: &str = "io.openebs.csi-mayastor";
+use utils::csi_plugin_name;
 
 /// K8s resource dumper client
 #[derive(Clone)]
@@ -333,7 +332,7 @@ async fn get_k8s_vs_classes(
 ) -> Result<(), K8sResourceDumperError> {
     log("\t Collecting Kubernetes VolumeSnapshotClass resources".to_string());
     match k8s_client
-        .list_volumesnapshot_classes(Some(MAYASTOR_CSI_DRIVER), None, None)
+        .list_volumesnapshot_classes(Some(&csi_plugin_name()), None, None)
         .await
     {
         Ok(vscs) => {
@@ -356,7 +355,7 @@ async fn get_k8s_vsnapshot_contents(
 ) -> Result<(), K8sResourceDumperError> {
     log("\t Collecting Kubernetes VolumeSnapshotContents resources".to_string());
     match k8s_client
-        .list_volumesnapshotcontents(Some(MAYASTOR_CSI_DRIVER), None, None)
+        .list_volumesnapshotcontents(Some(&csi_plugin_name()), None, None)
         .await
     {
         Ok(vscs) => {

k8s/supportability/src/collect/logs/mod.rs

@@ -3,8 +3,8 @@ mod loki;
 
 use crate::collect::{
     constants::{
-        CALLHOME_JOB_SERVICE, CONTROL_PLANE_SERVICES, DATA_PLANE_SERVICES,
-        HOST_NAME_REQUIRED_SERVICES, LOGGING_LABEL_SELECTOR, NATS_JOB_SERVICE, UPGRADE_JOB_SERVICE,
+        logging_label_selector, CALLHOME_JOB_SERVICE, CONTROL_PLANE_SERVICES, DATA_PLANE_SERVICES,
+        HOST_NAME_REQUIRED_SERVICES, NATS_JOB_SERVICE, UPGRADE_JOB_SERVICE,
     },
     k8s_resources::{
         client::{ClientSet, K8sResourceError},
@@ -268,7 +268,7 @@ impl Logger for LogCollection {
         let pods = self
             .k8s_logger_client
             .get_k8s_clientset()
-            .get_pods(LOGGING_LABEL_SELECTOR, "")
+            .get_pods(&logging_label_selector(), "")
             .await?;
 
         let control_plane_pods = pods
@@ -295,7 +295,7 @@ impl Logger for LogCollection {
         let pods = self
             .k8s_logger_client
             .get_k8s_clientset()
-            .get_pods(LOGGING_LABEL_SELECTOR, "")
+            .get_pods(&logging_label_selector(), "")
             .await?;
         let data_plane_pods = pods
             .into_iter()
@@ -321,7 +321,7 @@ impl Logger for LogCollection {
         let pods = self
             .k8s_logger_client
             .get_k8s_clientset()
-            .get_pods(LOGGING_LABEL_SELECTOR, "")
+            .get_pods(&logging_label_selector(), "")
             .await?;
 
         let upgrade_pod = pods
@@ -348,7 +348,7 @@ impl Logger for LogCollection {
         let pods = self
             .k8s_logger_client
             .get_k8s_clientset()
-            .get_pods(LOGGING_LABEL_SELECTOR, "")
+            .get_pods(&logging_label_selector(), "")
             .await?;
 
         let callhome_pod = pods
@@ -375,7 +375,7 @@ impl Logger for LogCollection {
         let pods = self
             .k8s_logger_client
             .get_k8s_clientset()
-            .get_pods(LOGGING_LABEL_SELECTOR, "")
+            .get_pods(&logging_label_selector(), "")
             .await?;
 
         let nats_pods = pods

k8s/upgrade/Cargo.toml

@@ -14,8 +14,10 @@ path = "src/lib.rs"
 [dependencies]
 openapi = { path = "../../dependencies/control-plane/openapi", default-features = false, features = [ "tower-trace" ] }
 utils = { path = "../../dependencies/control-plane/utils/utils-lib" }
+constants = { path = "../../constants" }
 kube-proxy = { path = "../proxy" }
 console-logger = { path = "../../console-logger" }
+convert_case = "0.4.0"
 kube = { version = "0.85.0",  default-features = true, features = [ "derive", "runtime" ] }
 anyhow = "1.0.75"
 clap = { version = "4.4.6", features = ["derive", "env", "string", "color"] }

k8s/upgrade/src/bin/upgrade-job/common/constants.rs

@@ -1,14 +1,14 @@
 use semver::Version;
 
 /// This is the name of the project that is being upgraded.
-pub(crate) const PRODUCT: &str = "Mayastor";
+pub use constants::product_pascal;
 
 /// This is the name of the Helm chart which included the core chart as a sub-chart.
 /// Under the hood, this installs the Core Helm chart (see below).
-pub(crate) const UMBRELLA_CHART_NAME: &str = "openebs";
+pub(crate) const UMBRELLA_CHART_NAME: &str = constants::UMBRELLA_CHART_NAME;
 
 /// This is the name of the Helm chart of this project.
-pub(crate) const CORE_CHART_NAME: &str = "mayastor";
+pub(crate) const CORE_CHART_NAME: &str = constants::PRODUCT_NAME;
 
 /// This is the shared Pod label of the <helm-release>-io-engine DaemonSet.
 pub(crate) const IO_ENGINE_LABEL: &str = "app=io-engine";
@@ -17,20 +17,23 @@ pub(crate) const IO_ENGINE_LABEL: &str = "app=io-engine";
 pub(crate) const AGENT_CORE_LABEL: &str = "app=agent-core";
 
 /// This is the shared label across the helm chart components which carries the chart version.
-pub(crate) const CHART_VERSION_LABEL_KEY: &str = "openebs.io/version";
+pub(crate) use constants::helm_release_version_key;
 
 /// This is the label set on a storage API Node resource when a 'Node Drain' is issued.
-pub(crate) const DRAIN_FOR_UPGRADE: &str = "mayastor-upgrade";
+pub fn drain_for_upgrade() -> String {
+    format!("{CORE_CHART_NAME}-upgrade")
+}
 
 /// This is the label set on a storage API Node resource when a 'Node Drain' is issued.
-pub(crate) const CORDON_FOR_ANA_CHECK: &str = "mayastor-upgrade-nvme-ana-check";
+pub fn cordon_ana_check() -> String {
+    format!("{CORE_CHART_NAME}-upgrade-nvme-ana-check")
+}
 
 /// This is the allowed upgrade to-version/to-version-range for the Umbrella chart.
 pub(crate) const TO_UMBRELLA_SEMVER: &str = "4.0.1";
 
 /// This is the user docs URL for the Umbrella chart.
-pub(crate) const UMBRELLA_CHART_UPGRADE_DOCS_URL: &str =
-    "https://openebs.io/docs/user-guides/upgrade#mayastor-upgrade";
+pub(crate) const UMBRELLA_CHART_UPGRADE_DOCS_URL: &str = constants::UMBRELLA_CHART_UPGRADE_DOCS_URL;
 
 /// This is the limit for the number of objects we want to collect over the network from
 /// the kubernetes api.