NAS-130226 / 24.10 / Improves App installation, update, deletion

src/app/enums/chart-release-status.enum.ts

@@ -1,11 +1,11 @@
-export enum ChartReleaseStatus {
+export enum CatalogAppState {
   Active = 'ACTIVE',
   Deploying = 'DEPLOYING',
   Stopped = 'STOPPED',
 }
 
-export const chartStatusIcons = new Map<ChartReleaseStatus, string>([
-  [ChartReleaseStatus.Active, 'mdi-check-circle'],
-  [ChartReleaseStatus.Deploying, 'mdi-progress-wrench'],
-  [ChartReleaseStatus.Stopped, 'mdi-stop-circle'],
+export const appStateIcons = new Map<CatalogAppState, string>([
+  [CatalogAppState.Active, 'mdi-check-circle'],
+  [CatalogAppState.Deploying, 'mdi-progress-wrench'],
+  [CatalogAppState.Stopped, 'mdi-stop-circle'],
 ]);

src/app/interfaces/api/api-call-directory.interface.ts

@@ -27,7 +27,7 @@ import {
 } from 'app/interfaces/alert.interface';
 import { ApiTimestamp } from 'app/interfaces/api-date.interface';
 import { ApiKey, CreateApiKeyRequest, UpdateApiKeyRequest } from 'app/interfaces/api-key.interface';
-import { UpgradeSummary } from 'app/interfaces/application.interface';
+import { AppUpgradeSummary } from 'app/interfaces/application.interface';
 import { AuditConfig, AuditEntry, AuditQueryParams } from 'app/interfaces/audit/audit.interface';
 import { AuthSession } from 'app/interfaces/auth-session.interface';
 import { LoginQuery } from 'app/interfaces/auth.interface';
@@ -40,9 +40,6 @@ import {
 } from 'app/interfaces/bootenv.interface';
 import {
   Catalog, CatalogApp,
-  CatalogItems,
-  CatalogItemsQueryParams,
-  CatalogQueryParams,
   CatalogUpdate, GetItemDetailsParams,
 } from 'app/interfaces/catalog.interface';
 import {
@@ -58,9 +55,9 @@ import {
   ChartReleaseEvent,
 } from 'app/interfaces/chart-release-event.interface';
 import {
-  ChartRelease,
+  App,
   ChartReleaseQueryParams,
-  ChartReleaseUpgradeParams,
+  AppUpgradeParams,
 } from 'app/interfaces/chart-release.interface';
 import { Choices } from 'app/interfaces/choices.interface';
 import {
@@ -355,11 +352,9 @@ export interface ApiCallDirectory {
   'bootenv.update': { params: UpdateBootenvParams; response: string };
 
   // Catalog
-  'catalog.delete': { params: [name: string]; response: boolean };
-  'catalog.get_item_details': { params: [name: string, params: GetItemDetailsParams]; response: CatalogApp };
-  'catalog.items': { params: [label: string, params?: CatalogItemsQueryParams]; response: CatalogItems };
-  'catalog.query': { params: CatalogQueryParams; response: Catalog[] };
-  'catalog.update': { params: [id: string, update: CatalogUpdate]; response: Catalog };
+  'catalog.get_app_details': { params: [name: string, params: GetItemDetailsParams]; response: CatalogApp };
+  'catalog.update': { params: [CatalogUpdate]; response: Catalog };
+  'catalog.config': { params: void; response: Catalog };
 
   // Certificate
   'certificate.acme_server_choices': { params: void; response: Choices };
@@ -381,13 +376,17 @@ export interface ApiCallDirectory {
     response: CertificateAuthority;
   };
 
+  // Apps
+  'app.query': { params: ChartReleaseQueryParams; response: App[] };
+  'app.upgrade_summary': { params: AppUpgradeParams; response: AppUpgradeSummary };
+
   // Chart
   'chart.release.events': { params: [name: string]; response: ChartReleaseEvent[] };
   'chart.release.get_chart_releases_using_chart_release_images': { params: [name: string]; response: Choices };
   'chart.release.pod_console_choices': { params: [string]; response: Record<string, string[]> };
   'chart.release.pod_logs_choices': { params: [string]; response: Record<string, string[]> };
-  'chart.release.query': { params: ChartReleaseQueryParams; response: ChartRelease[] };
-  'chart.release.upgrade_summary': { params: ChartReleaseUpgradeParams; response: UpgradeSummary };
+  'chart.release.query': { params: ChartReleaseQueryParams; response: App[] };
+  'chart.release.upgrade_summary': { params: AppUpgradeParams; response: AppUpgradeSummary };
 
   // CloudBackup
   'cloud_backup.abort': { params: [id: number]; response: void };

src/app/interfaces/api/api-event-directory.interface.ts

@@ -1,7 +1,7 @@
 import { DockerStatusResponse } from 'app/enums/docker-config.interface';
 import { FailoverStatus } from 'app/enums/failover-status.enum';
 import { Alert } from 'app/interfaces/alert.interface';
-import { ChartRelease, ChartStatisticsUpdate } from 'app/interfaces/chart-release.interface';
+import { App, ChartStatisticsUpdate } from 'app/interfaces/chart-release.interface';
 import { PullContainerImageResponse, PullContainerImageParams, ContainerImage } from 'app/interfaces/container-image.interface';
 import { DirectoryServicesState } from 'app/interfaces/directory-services-state.interface';
 import { Disk } from 'app/interfaces/disk.interface';
@@ -20,7 +20,8 @@ import { ZfsSnapshot } from 'app/interfaces/zfs-snapshot.interface';
 
 export interface ApiEventDirectory {
   'alert.list': { response: Alert };
-  'chart.release.query': { response: ChartRelease };
+  'chart.release.query': { response: App };
+  'app.query': { response: App };
   'chart.release.statistics': { response: ChartStatisticsUpdate[] };
   'core.get_jobs': { response: Job };
   'directoryservices.status': { response: DirectoryServicesState };

src/app/interfaces/api/api-job-directory.interface.ts

@@ -3,18 +3,19 @@ import { SetAcl } from 'app/interfaces/acl.interface';
 import { ActiveDirectoryConfig, LeaveActiveDirectory } from 'app/interfaces/active-directory-config.interface';
 import { ActiveDirectoryUpdate } from 'app/interfaces/active-directory.interface';
 import { AuditEntry } from 'app/interfaces/audit/audit.interface';
-import { Catalog, CatalogCreate } from 'app/interfaces/catalog.interface';
 import { Certificate, CertificateCreate, CertificateUpdate } from 'app/interfaces/certificate.interface';
 import {
   ChartRollbackParams,
-  ChartScaleQueryParams,
+  AppStartQueryParams,
   ChartScaleResult,
+  AppDeleteParams,
 } from 'app/interfaces/chart-release-event.interface';
 import {
-  ChartRelease,
-  ChartReleaseCreate,
-  ChartReleaseUpdate,
-  ChartReleaseUpgrade,
+  App,
+  AppCreate,
+  AppUpdate,
+  AppUpgrade,
+  AppUpgradeParams,
 } from 'app/interfaces/chart-release.interface';
 import { CloudBackupRestoreParams, CloudBackupSnapshot } from 'app/interfaces/cloud-backup.interface';
 import { CloudSyncTaskUpdate } from 'app/interfaces/cloud-sync-task.interface';
@@ -72,21 +73,28 @@ export interface ApiJobDirectory {
   'bootenv.delete': { params: [string]; response: boolean };
 
   // Catalog
-  'catalog.create': { params: [CatalogCreate]; response: Catalog };
   'catalog.sync': { params: [label: string]; response: void };
 
   // Certificate
   'certificate.create': { params: [CertificateCreate]; response: Certificate };
   'certificate.delete': { params: [id: number, force?: boolean]; response: boolean };
   'certificate.update': { params: [id: number, update: CertificateUpdate]; response: Certificate };
 
+  // App
+  'app.create': { params: [AppCreate]; response: App };
+  'app.update': { params: [string, AppUpdate]; response: App };
+  'app.start': { params: AppStartQueryParams; response: void };
+  'app.stop': { params: AppStartQueryParams; response: void };
+  'app.delete': { params: AppDeleteParams; response: boolean };
+  'app.upgrade': { params: AppUpgradeParams; response: App };
+
   // Chart Release
-  'chart.release.create': { params: [ChartReleaseCreate]; response: ChartRelease };
+  'chart.release.create': { params: [AppCreate]; response: App };
   'chart.release.delete': { params: [string, { delete_unused_images: boolean }]; response: boolean };
-  'chart.release.rollback': { params: [name: string, params: ChartRollbackParams]; response: ChartRelease };
-  'chart.release.scale': { params: ChartScaleQueryParams; response: ChartScaleResult };
-  'chart.release.update': { params: [name: string, update: ChartReleaseUpdate]; response: ChartRelease };
-  'chart.release.upgrade': { params: [name: string, upgrade: ChartReleaseUpgrade]; response: ChartRelease };
+  'chart.release.rollback': { params: [name: string, params: ChartRollbackParams]; response: App };
+  'chart.release.scale': { params: AppStartQueryParams; response: ChartScaleResult };
+  'chart.release.update': { params: [name: string, update: AppUpdate]; response: App };
+  'chart.release.upgrade': { params: [name: string, upgrade: AppUpgrade]; response: App };
 
   // CloudBackup
   'cloud_backup.sync': { params: [id: number, params?: { dry_run: boolean }]; response: void };

src/app/interfaces/application.interface.ts

@@ -1,16 +1,11 @@
-import { ChartContainerImage } from './chart-release.interface';
-
-export interface UpgradeSummary {
+export interface AppUpgradeSummary {
+  latest_version: string;
+  latest_human_version: string;
+  upgrade_version: string;
+  upgrade_human_version: string;
   changelog: string;
   available_versions_for_upgrade: {
     version: string;
     human_version: string;
   }[];
-  container_images_to_update: Record<string, ChartContainerImage>;
-  item_update_available: boolean;
-  image_update_available: boolean;
-  latest_version: string;
-  upgrade_version: string;
-  latest_human_version: string;
-  upgrade_human_version: string;
 }

src/app/interfaces/catalog.interface.ts

@@ -1,62 +1,19 @@
-import { JobState } from 'app/enums/job-state.enum';
 import { AppMaintainer } from 'app/interfaces/available-app.interface';
 import {
   AppMetadata, ChartFormValue, ChartSchemaGroup, ChartSchemaNode,
 } from 'app/interfaces/chart-release.interface';
-import { QueryParams } from 'app/interfaces/query-api.interface';
 
 export interface Catalog {
-  branch: string;
-  builtin: boolean;
-  healthy: boolean;
   id: string;
   label: string;
-
-  /**
-   * E.g. "/mnt/pool/ix-applications/catalogs/github_com_truenas_charts_git_master"
-   */
   location: string;
   preferred_trains: string[];
-
-  /**
-   * E.g. https://github.com/truenas/charts.git
-   */
-  repository: string;
-  trains: Record<string, CatalogTrain>;
-  error: boolean;
-  cached: boolean;
-  caching_job: {
-    id: number;
-    abortable: boolean;
-    method: string;
-    progress: {
-      percent: number;
-      description: string;
-    };
-    state: JobState;
-  };
 }
 
-export type CatalogQueryParams = QueryParams<Catalog, {
-  extra: {
-    item_details?: boolean;
-    cache?: boolean;
-    include_chart_schema?: boolean;
-  };
-}>;
-
 export interface CatalogUpdate {
   preferred_trains: string[];
 }
 
-export interface CatalogCreate {
-  label: string;
-  repository: string;
-  branch: string;
-  preferred_trains: string[];
-  force: boolean;
-}
-
 export type CatalogTrain = Record<string, CatalogApp>;
 
 export interface CatalogApp {
@@ -94,7 +51,7 @@ export interface CatalogApp {
 export interface CatalogAppVersion {
   app_readme: string;
   changelog: string;
-  chart_metadata: ChartMetadata;
+  metadata: ChartMetadata;
   detailed_readme: string;
   healthy: boolean;
   healthy_error: string;
@@ -144,14 +101,6 @@ export interface ChartMetadataDependency {
 
 export type CatalogItems = Record<string, CatalogTrain>;
 
-export interface CatalogItemsQueryParams {
-  cache?: boolean;
-  cache_only?: boolean;
-  retrieve_all_trains?: boolean;
-  retrieve_versions?: boolean;
-  trains?: string[];
-}
-
 export interface GetItemDetailsParams {
   cache?: boolean;
   catalog?: string;

src/app/interfaces/chart-release-event.interface.ts

@@ -33,10 +33,15 @@ export interface ChartReleaseEventObject {
   uid: string;
 }
 
-export type ChartScaleQueryParams = [
+export type AppStartQueryParams = [
   name: string,
-  params?: {
-    replica_count: number;
+];
+
+export type AppDeleteParams = [
+  string,
+  {
+    remove_images?: boolean;
+    remove_ix_volumes?: boolean;
   },
 ];
 
@@ -49,7 +54,7 @@ export interface ChartRollbackParams {
   force_rollback?: boolean;
   recreate_resources?: boolean;
   rollback_snapshot?: boolean;
-  item_version: string;
+  app_version: string;
 }
 
 export interface ChartEventMetadata {