feat: Support templating the namespace in manifests

rust/stackable-cockpit/src/platform/demo/spec.rs

@@ -97,18 +97,14 @@ impl DemoSpec {
  /// - Does the demo support to be installed in the requested namespace?
  /// - Does the cluster have enough resources available to run this demo?
  #[instrument(skip_all)]
- pub async fn check_prerequisites(
- &self,
- client: &Client,
- product_namespace: &str,
- ) -> Result<(), Error> {
+ pub async fn check_prerequisites(&self, client: &Client, namespace: &str) -> Result<(), Error> {
  debug!("Checking prerequisites before installing demo");
 
  // Returns an error if the demo doesn't support to be installed in the
  // requested namespace
- if !self.supports_namespace(product_namespace) {
+ if !self.supports_namespace(namespace) {
  return Err(Error::UnsupportedNamespace {
- requested: product_namespace.to_string(),
+ requested: namespace.to_owned(),
  supported: self.supported_namespaces.clone(),
  });
  }

rust/stackable-cockpit/src/platform/manifests.rs

@@ -62,18 +62,23 @@ pub enum Error {
 
 pub trait InstallManifestsExt {
  // TODO (Techassi): This step shouldn't care about templating the manifests nor fetching them from remote
- #[instrument(skip_all, fields(%product_namespace))]
+ #[instrument(skip_all, fields(%namespace))]
  #[allow(async_fn_in_trait)]
  async fn install_manifests(
  manifests: &[ManifestSpec],
  parameters: &HashMap<String, String>,
-product_namespace: &str,
+namespace: &str,
  labels: Labels,
  client: &Client,
  transfer_client: &xfer::Client,
  ) -> Result<(), Error> {
  debug!("Installing manifests");
 
+ let mut parameters = parameters.clone();
+ // We add the NAMESPACE parameter, so that stacks/demos can use that to render e.g. the
+ // fqdn service names [which contain the namespace].
+ parameters.insert("NAMESPACE".to_owned(), namespace.to_owned());
+
  for manifest in manifests {
  match manifest {
  ManifestSpec::HelmChart(helm_file) => {
@@ -85,7 +90,7 @@ pub trait InstallManifestsExt {
  })?;
 
  let helm_chart: helm::Chart = transfer_client
- .get(&helm_file, &Template::new(parameters).then(Yaml::new()))
+ .get(&helm_file, &Template::new(&parameters).then(Yaml::new()))
  .await
  .context(FileTransferSnafu)?;
 
@@ -111,7 +116,7 @@ pub trait InstallManifestsExt {
  chart_version: Some(&helm_chart.version),
  },
  Some(&values_yaml),
-product_namespace,
+namespace,
  true,
  )
  .context(InstallHelmReleaseSnafu {
@@ -130,12 +135,12 @@ pub trait InstallManifestsExt {
  })?;
 
  let manifests = transfer_client
- .get(&path_or_url, &Template::new(parameters))
+ .get(&path_or_url, &Template::new(&parameters))
  .await
  .context(FileTransferSnafu)?;
 
  client
- .deploy_manifests(&manifests, product_namespace, labels.clone())
+ .deploy_manifests(&manifests, namespace, labels.clone())
  .await
  .context(DeployManifestSnafu)?
  }

rust/stackable-cockpit/src/platform/stack/spec.rs

@@ -111,21 +111,17 @@ impl StackSpec {
  /// - Does the stack support to be installed in the requested namespace?
  /// - Does the cluster have enough resources available to run this stack?
  #[instrument(skip_all)]
- pub async fn check_prerequisites(
- &self,
- client: &Client,
- product_namespace: &str,
- ) -> Result<(), Error> {
+ pub async fn check_prerequisites(&self, client: &Client, namespace: &str) -> Result<(), Error> {
  debug!("Checking prerequisites before installing stack");
 
  // Returns an error if the stack doesn't support to be installed in the
  // requested product namespace. When installing a demo, this check is
  // already done on the demo spec level, however we still need to check
  // here, as stacks can be installed on their own.
- if !self.supports_namespace(product_namespace) {
+ if !self.supports_namespace(namespace) {
  return Err(Error::UnsupportedNamespace {
  supported: self.supported_namespaces.clone(),
- requested: product_namespace.to_string(),
+ requested: namespace.to_owned(),
  });
  }
 
@@ -204,7 +200,7 @@ impl StackSpec {
  &self,
  release_list: release::ReleaseList,
  operator_namespace: &str,
-_product_namespace: &str, // TODO (@NickLarsenNZ): remove this field
+_namespace: &str, // TODO (@NickLarsenNZ): remove this field
  chart_source: &ChartSourceType,
  ) -> Result<(), Error> {
  info!(self.release, "Trying to install release");

rust/stackablectl/CHANGELOG.md

@@ -4,9 +4,14 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Added
+
+- Pass the stack/demo namespace as a templating variable `NAMESPACE` to manifests.
+ This should unblock demos to run in all namespaces, as they can template the namespace e.g. for the FQDN of services ([#355]).
+
 ### Changed
 
-- Renamed `--product-namespace` argument to `--namespace` ([#373]).
+- Renamed `--product-namespace` argument to `--namespace` ([#373], [#355]).
  - Kept `--product-namespace` as a hidden alias to be removed in a later release.
 
 ### Fixed
@@ -25,6 +30,7 @@ All notable changes to this project will be documented in this file.
 - Improve tracing and log output ([#365]).
 
 [#351]: https://github.com/stackabletech/stackable-cockpit/pull/351
+[#355]: https://github.com/stackabletech/stackable-cockpit/pull/355
 [#364]: https://github.com/stackabletech/stackable-cockpit/pull/364
 [#365]: https://github.com/stackabletech/stackable-cockpit/pull/365
 

rust/stackablectl/src/cmds/stacklet.rs

@@ -48,10 +48,10 @@ pub struct StackletCredentialsArgs {
  short = 'n',
  global = true,
  default_value = DEFAULT_NAMESPACE,
-visible_aliases(["product-ns"]),
+aliases(["product-ns", "product-namespace"]),
  long_help = "Namespace in the cluster used to deploy the products. Use this to select
 a different namespace for credential lookup.")]
- pub product_namespace: String,
+ pub namespace: String,
 }
 
 #[derive(Debug, Args)]
@@ -211,7 +211,7 @@ async fn credentials_cmd(args: &StackletCredentialsArgs) -> Result<String, CmdEr
 
  match get_credentials_for_product(
  &client,
- &args.product_namespace,
+ &args.namespace,
  &args.stacklet_name,
  &args.product_name,
  )
@@ -229,7 +229,7 @@ async fn credentials_cmd(args: &StackletCredentialsArgs) -> Result<String, CmdEr
 
  let output = format!(
  "Credentials for {} ({}) in namespace '{}':",
- args.product_name, args.stacklet_name, args.product_namespace
+ args.product_name, args.stacklet_name, args.namespace
  );
 
  Ok(format!("{}\n\n{}", output, table))

rust/stackablectl/src/output/error.rs

@@ -16,7 +16,7 @@ impl ContextExt for ErrorContext {
  let mut ctx = tera::Context::new();
 
  ctx.insert("default_operator_namespace", DEFAULT_OPERATOR_NAMESPACE);
- ctx.insert("default_product_namespace", DEFAULT_NAMESPACE);
+ ctx.insert("default_namespace", DEFAULT_NAMESPACE);
 
  ctx.insert("post_hints", &self.post_hints);
  ctx.insert("pre_hints", &self.pre_hints);

rust/stackablectl/src/output/result.rs

@@ -5,7 +5,7 @@ use crate::output::{ContextExt, OutputKind};
 #[derive(Debug, Default)]
 pub struct ResultContext {
  used_operator_namespace: String,
-used_product_namespace: String,
+used_namespace: String,
 
  command_hints: Vec<String>,
  post_hints: Vec<String>,
@@ -20,10 +20,10 @@ impl ContextExt for ResultContext {
  let mut ctx = tera::Context::new();
 
  ctx.insert("default_operator_namespace", DEFAULT_OPERATOR_NAMESPACE);
- ctx.insert("default_product_namespace", DEFAULT_NAMESPACE);
+ ctx.insert("default_namespace", DEFAULT_NAMESPACE);
 
  ctx.insert("used_operator_namespace", &self.used_operator_namespace);
- ctx.insert("used_product_namespace", &self.used_product_namespace);
+ ctx.insert("used_namespace", &self.used_namespace);
 
  ctx.insert("command_hints", &self.command_hints);
  ctx.insert("post_hints", &self.post_hints);