refactor: replace service by containers (#32)

charts/simpaas-app/templates/deployment.yaml → charts/simpaas-app/templates/container/deployment.yaml

@@ -1,4 +1,4 @@
-{{- range $service := .Values.services }}
+{{- range $service := .Values.containers }}
 {{- $podAnnotations := merge $.Values.common.podAnnotations (default dict $service.values.podAnnotations) -}}
 {{- $podLabels := merge $.Values.common.podLabels (default dict $service.values.podLabels) -}}
 {{- $imagePullSecrets := concat $.Values.common.imagePullSecrets (default list $service.values.imagePullSecrets) -}}

charts/simpaas-app/templates/service.yaml → charts/simpaas-app/templates/container/service.yaml

@@ -1,4 +1,4 @@
-{{- range $service := .Values.services }}
+{{- range $service := .Values.containers }}
 {{- if gt (len (default list $service.expose)) 0 }}
 {{- $vars := dict "Chart" $.Chart "Release" $.Release "Service" $service  -}}
 apiVersion: v1

charts/simpaas-app/templates/ingress.yaml

@@ -1,4 +1,4 @@
-{{- range $service := .Values.services }}
+{{- range $service := .Values.containers }}
 {{- range $expose := default list $service.expose }}
 {{- if $expose.ingress }}
 {{- $vars := dict "Chart" $.Chart "Expose" $expose "Release" $.Release "Service" $service  -}}

charts/simpaas-app/values.yaml

@@ -28,4 +28,4 @@ common:
 
   tolerations: []
 
-services: []
+containers: []

charts/simpaas/crds/app.yaml

@@ -20,14 +20,8 @@ spec:
         properties:
           spec:
             properties:
-              namespace:
-                description: Namespace.
-                type: string
-              owner:
-                description: Owner of the app.
-                type: string
-              services:
-                description: List of app services.
+              containers:
+                description: List of container services.
                 items:
                   properties:
                     expose:
@@ -93,15 +87,21 @@ spec:
                   - name
                   type: object
                 type: array
+              namespace:
+                description: Namespace.
+                type: string
+              owner:
+                description: Owner of the app.
+                type: string
               values:
                 additionalProperties: true
                 default: {}
                 description: Helm chart values.
                 type: object
             required:
+            - containers
             - namespace
             - owner
-            - services
             type: object
           status:
             nullable: true

charts/simpaas/templates/op/configmap.yaml

@@ -5,5 +5,5 @@ metadata:
   labels:
     {{- include "simpaas.op.labels" . | nindent 4 }}
 data:
-  values.yaml: |
-    {{ toYaml .Values.op.chartValues | nindent 4 }}
+  app.yaml: |
+    {{ toYaml .Values.op.appChartValues | nindent 4 }}

charts/simpaas/templates/op/deployment.yaml

@@ -56,8 +56,8 @@ spec:
           {{ toYaml . | nindent 10 }}
         {{- end }}
         env:
-        - name: CHART_VALUES
-          value: {{ printf "%s/values.yaml" $chartValuesDir }}
+        - name: APP_CHART_VALUES
+          value: {{ printf "%s/app.yaml" $chartValuesDir }}
         - name: SMTP_HOST
           value: {{ default (printf "%s-smtp" .Release.Name) .Values.op.smtp.host }}
         - name: SMTP_PORT

charts/simpaas/values.yaml

@@ -155,7 +155,7 @@ op:
   livenessProbe: {}
   readinessProbe: {}
 
-  chartValues: {}
+  appChartValues: {}
 
   logFilter: ""
 

get-simpaas

@@ -134,7 +134,7 @@ install_chart $ns_simpaas simpaas $repo_simpaas/simpaas-stack \
   --set-json "simpaas.ingress.annotations={\"cert-manager.io/cluster-issuer\":\"$issuer\"}" \
   --set simpaas.ingress.create=$ingress_create \
   --set "simpaas.ingress.domain=$SIMPAAS_DOMAIN" \
-  --set-json "simpaas.op.chartValues={\"ingress\":{\"annotations\":{\"cert-manager.io/cluster-issuer\":\"$issuer\"}}}" \
+  --set-json "simpaas.op.appChartValues={\"ingress\":{\"annotations\":{\"cert-manager.io/cluster-issuer\":\"$issuer\"}}}" \
   "${set_smtp_env[@]}" \
   "${set_values[@]}"
 

src/api.rs

@@ -36,7 +36,8 @@ use validator::{Validate, ValidationError, ValidationErrors};
 
 use crate::{
     domain::{
-        Action, App, AppSpec, AppStatus, Invitation, InvitationSpec, Service, User, UserSpec,
+        Action, App, AppSpec, AppStatus, ContainerService, Invitation, InvitationSpec, User,
+        UserSpec,
     },
     jwt::JwtEncoder,
     kube::{AppFilter, KubeClient, FINALIZER},
@@ -164,6 +165,9 @@ struct AppFilterQuery {
 #[derive(Clone, Debug, Deserialize, Eq, PartialEq, JsonSchema, Serialize, Validate)]
 #[serde(rename_all = "camelCase")]
 struct CreateAppRequest {
+    /// List of container services.
+    #[validate(nested)]
+    containers: Vec<ContainerService>,
     /// Name.
     #[serde(deserialize_with = "string_trim")]
     #[validate(length(min = 1))]
@@ -172,9 +176,6 @@ struct CreateAppRequest {
     #[serde(default, deserialize_with = "option_string_trim")]
     #[validate(length(min = 1))]
     namespace: Option<String>,
-    /// List of app services.
-    #[validate(nested)]
-    services: Vec<Service>,
     /// Helm chart values.
     #[serde(default)]
     values: Map<String, Value>,
@@ -195,11 +196,11 @@ struct SendInvitationRequest {
 #[derive(Clone, Debug, Deserialize, PartialEq, JsonSchema, Serialize, Validate)]
 #[serde(rename_all = "camelCase")]
 struct UpdateAppRequest {
+    /// List of container services.
+    #[validate(nested)]
+    containers: Vec<ContainerService>,
     /// Owner of the app.
     owner: String,
-    /// List of app services.
-    #[validate(nested)]
-    services: Vec<Service>,
     /// Helm chart values.
     #[serde(default)]
     values: Map<String, Value>,
@@ -376,7 +377,11 @@ async fn check_permission<K: KubeClient>(user: &User, action: Action<'_>, kube:
     }
 }
 
-async fn ensure_domains_are_free<K: KubeClient>(name: &str, svcs: &[Service], kube: &K) -> Result {
+async fn ensure_domains_are_free<K: KubeClient>(
+    name: &str,
+    svcs: &[ContainerService],
+    kube: &K,
+) -> Result {
     let usages = kube.domain_usages(name, svcs).await?;
     if usages.is_empty() {
         Ok(())
@@ -508,7 +513,7 @@ async fn create_app<J: JwtEncoder, K: KubeClient, P: PasswordEncoder>(
     async {
         check_permission(&user, Action::CreateApp, &ctx.kube).await?;
         req.validate()?;
-        ensure_domains_are_free(&req.name, &req.services, &ctx.kube).await?;
+        ensure_domains_are_free(&req.name, &req.containers, &ctx.kube).await?;
         if ctx.kube.get_app(&req.name).await?.is_some() {
             return Err(Error::ResourceAlreadyExists(vec![
                 ResourceAlreadyExistsItem {
@@ -522,7 +527,7 @@ async fn create_app<J: JwtEncoder, K: KubeClient, P: PasswordEncoder>(
         let spec = AppSpec {
             namespace,
             owner: username,
-            services: req.services,
+            containers: req.containers,
             values: req.values,
         };
         let app = App {
@@ -788,7 +793,7 @@ async fn update_app<J: JwtEncoder, K: KubeClient, P: PasswordEncoder>(
             check_permission(&user, Action::UpdateApp(&name), &ctx.kube).await?;
         }
         req.validate()?;
-        ensure_domains_are_free(&name, &req.services, &ctx.kube).await?;
+        ensure_domains_are_free(&name, &req.containers, &ctx.kube).await?;
         if ctx.kube.get_user(&req.owner).await?.is_none() {
             return Err(Error::PreconditionFailed(PreconditionFailedResponse {
                 field: "owner".into(),
@@ -802,7 +807,7 @@ async fn update_app<J: JwtEncoder, K: KubeClient, P: PasswordEncoder>(
             },
             spec: AppSpec {
                 owner: req.owner,
-                services: req.services,
+                containers: req.containers,
                 values: req.values,
                 ..app.spec
             },

src/deploy/helm.rs

@@ -9,6 +9,10 @@ use crate::{domain::App, helm::HelmClient, kube::KubeClient};
 
 use super::{Deployer, Result};
 
+// Defaults
+
+const DEFAULT_CHART_PATH: &str = "charts/simpaas-app";
+
 // Errors
 
 #[derive(Debug, thiserror::Error)]
@@ -41,15 +45,30 @@ pub enum Error {
 
 // Data structs
 
-#[derive(clap::Args, Clone, Debug, Default, Eq, PartialEq)]
+#[derive(clap::Args, Clone, Debug, Eq, PartialEq)]
 pub struct HelmDeployerArgs {
     #[arg(
-        long = "CHART_VALUES",
-        env = "CHART_VALUES",
-        name = "CHART_VALUES",
+        long,
+        env,
+        default_value = DEFAULT_CHART_PATH,
+        long_help = "Path to built-in simpaas-app chart"
+    )]
+    pub app_chart: String,
+    #[arg(
+        long,
+        env,
         long_help = "Path to YAML file of default values of simpaas-app chart"
     )]
-    pub values_filepath: Option<PathBuf>,
+    pub app_chart_values: Option<PathBuf>,
+}
+
+impl Default for HelmDeployerArgs {
+    fn default() -> Self {
+        Self {
+            app_chart: DEFAULT_CHART_PATH.into(),
+            app_chart_values: None,
+        }
+    }
 }
 
 // HelmDeployer
@@ -75,25 +94,27 @@ impl<H: HelmClient> HelmDeployer<H> {
 
 impl<H: HelmClient> Deployer for HelmDeployer<H> {
     #[instrument(skip(self, app, _kube), fields(app.name = name))]
-    async fn deploy<K: KubeClient>(&self, name: &str, app: &App, _kube: &K) -> Result {
+    async fn deploy_app<K: KubeClient>(&self, name: &str, app: &App, _kube: &K) -> Result {
         info!("deploying app");
         debug!("creating temporary directory");
         let dir = TempDir::new(name)?;
         let app_filepath = Self::dump_yaml(&dir, &app.spec)?;
         let mut filepaths = vec![];
-        if let Some(path) = &self.args.values_filepath {
+        if let Some(path) = &self.args.app_chart_values {
             filepaths.push(path.clone());
         };
         filepaths.push(app_filepath);
-        self.helm.upgrade(name, app, &filepaths).await?;
+        self.helm
+            .upgrade(&self.args.app_chart, name, &app.spec.namespace, &filepaths)
+            .await?;
         info!("app deployed");
         Ok(())
     }
 
     #[instrument(skip(self, app, kube), fields(app.name = name))]
-    async fn undeploy<K: KubeClient>(&self, name: &str, app: &App, kube: &K) -> Result {
+    async fn undeploy_app<K: KubeClient>(&self, name: &str, app: &App, kube: &K) -> Result {
         info!("undeploying app");
-        self.helm.uninstall(name, app).await?;
+        self.helm.uninstall(name, &app.spec.namespace).await?;
         kube.delete_namespace(&app.spec.namespace).await?;
         info!("app undeployed");
         Ok(())

src/deploy/mod.rs

@@ -19,14 +19,14 @@ pub struct Error(#[source] pub Box<dyn std::error::Error + Send + Sync>);
 // Traits
 
 pub trait Deployer: Send + Sync {
-    fn deploy<K: KubeClient>(
+    fn deploy_app<K: KubeClient>(
         &self,
         name: &str,
         app: &App,
         kube: &K,
     ) -> impl Future<Output = Result> + Send;
 
-    fn undeploy<K: KubeClient>(
+    fn undeploy_app<K: KubeClient>(
         &self,
         name: &str,
         app: &App,

src/domain.rs

@@ -41,12 +41,12 @@ pub enum Action<'a> {
 )]
 #[serde(rename_all = "camelCase")]
 pub struct AppSpec {
+    /// List of container services.
+    pub containers: Vec<ContainerService>,
     /// Namespace.
     pub namespace: String,
     /// Owner of the app.
     pub owner: String,
-    /// List of app services.
-    pub services: Vec<Service>,
     /// Helm chart values.
     #[serde(default)]
     pub values: Map<String, Value>,
@@ -192,7 +192,7 @@ pub struct RoleSpec {
 
 #[derive(Clone, Debug, Deserialize, Eq, PartialEq, JsonSchema, Serialize, Validate)]
 #[serde(rename_all = "camelCase")]
-pub struct Service {
+pub struct ContainerService {
     /// List of ports to expose.
     #[serde(default)]
     #[validate(nested)]