feat(jobs): add the ability to run a job on a target endpoint #2374

* feat(jobs): adding the ability to run scripts on endpoints fix(job): click on containerId in JobsDatatable redirects to container's logs refactor(job): remove the jobs datatable settings + texts changes on JobCreation view fix(jobs): jobs payloads are now following API rules and case feat(jobs): adding the capability to run scripts on hosts * feat(jobs): adding the ability to purge jobs containers * refactor(job): apply review changes * feat(job-creation): store image name in local storage * feat(host): disable job exec link in non-agent Swarm setup * feat(host): only display execute job in agent setups or standalone * feat(job): job execution overhaul * docs(swagger): update EndpointJob documentation
2025-07-19 05:19:39 +02:00 · 2018-10-28 07:06:50 +01:00 · 2018-10-28 07:06:50 +01:00 · 354fda31f1
commit 354fda31f1
parent 6ab510e5cb
37 changed files with 739 additions and 100 deletions
--- a/app/docker/components/datatables/host-jobs-datatable/jobsDatatableController.js
+++ b/app/docker/components/datatables/host-jobs-datatable/jobsDatatableController.js
@ -0,0 +1,140 @@
+angular.module('portainer.docker')
+  .controller('JobsDatatableController', ['$q', '$state', 'PaginationService', 'DatatableService', 'ContainerService', 'ModalService', 'Notifications',
+    function ($q, $state, PaginationService, DatatableService, ContainerService, ModalService, Notifications) {
+      var ctrl = this;
+
+      this.state = {
+        orderBy: this.orderBy,
+        paginatedItemLimit: PaginationService.getPaginationLimit(this.tableKey),
+        displayTextFilter: false
+      };
+
+      this.filters = {
+        state: {
+          open: false,
+          enabled: false,
+          values: []
+        }
+      };
+
+      this.changeOrderBy = function (orderField) {
+        this.state.reverseOrder = this.state.orderBy === orderField ? !this.state.reverseOrder : false;
+        this.state.orderBy = orderField;
+        DatatableService.setDataTableOrder(this.tableKey, orderField, this.state.reverseOrder);
+      };
+
+      this.changePaginationLimit = function () {
+        PaginationService.setPaginationLimit(this.tableKey, this.state.paginatedItemLimit);
+      };
+
+      this.applyFilters = function (value) {
+        var container = value;
+        var filters = ctrl.filters;
+        for (var i = 0; i < filters.state.values.length; i++) {
+          var filter = filters.state.values[i];
+          if (container.Status === filter.label && filter.display) {
+            return true;
+          }
+        }
+        return false;
+      };
+
+      this.onStateFilterChange = function () {
+        var filters = this.filters.state.values;
+        var filtered = false;
+        for (var i = 0; i < filters.length; i++) {
+          var filter = filters[i];
+          if (!filter.display) {
+            filtered = true;
+          }
+        }
+        this.filters.state.enabled = filtered;
+        DatatableService.setDataTableFilters(this.tableKey, this.filters);
+      };
+
+      this.prepareTableFromDataset = function () {
+        var availableStateFilters = [];
+        for (var i = 0; i < this.dataset.length; i++) {
+          var item = this.dataset[i];
+          availableStateFilters.push({
+            label: item.Status,
+            display: true
+          });
+        }
+        this.filters.state.values = _.uniqBy(availableStateFilters, 'label');
+      };
+
+      this.updateStoredFilters = function (storedFilters) {
+        var datasetFilters = this.filters.state.values;
+
+        for (var i = 0; i < datasetFilters.length; i++) {
+          var filter = datasetFilters[i];
+          existingFilter = _.find(storedFilters, ['label', filter.label]);
+          if (existingFilter && !existingFilter.display) {
+            filter.display = existingFilter.display;
+            this.filters.state.enabled = true;
+          }
+        }
+      };
+
+      function confirmPurgeJobs() {
+        return showConfirmationModal();
+
+        function showConfirmationModal() {
+          var deferred = $q.defer();
+
+          ModalService.confirm({
+            title: 'Are you sure ?',
+            message: 'Clearing job history will remove all stopped jobs containers.',
+            buttons: {
+              confirm: {
+                label: 'Purge',
+                className: 'btn-danger'
+              }
+            },
+            callback: function onConfirm(confirmed) {
+              deferred.resolve(confirmed);
+            }
+          });
+
+          return deferred.promise;
+        }
+      }
+
+      this.purgeAction = function () {
+        confirmPurgeJobs().then(function success(confirmed) {
+          if (!confirmed) {
+            return $q.when();
+          }
+          ContainerService.prune({ label: ['io.portainer.job.endpoint'] }).then(function success() {
+            Notifications.success('Success', 'Job hisotry cleared');
+            $state.reload();
+          }).catch(function error(err) {
+            Notifications.error('Failure', err.message, 'Unable to clear job history');
+          });
+        });
+      };
+
+      this.$onInit = function () {
+        setDefaults(this);
+        this.prepareTableFromDataset();
+
+        var storedOrder = DatatableService.getDataTableOrder(this.tableKey);
+        if (storedOrder !== null) {
+          this.state.reverseOrder = storedOrder.reverse;
+          this.state.orderBy = storedOrder.orderBy;
+        }
+
+        var storedFilters = DatatableService.getDataTableFilters(this.tableKey);
+        if (storedFilters !== null) {
+          this.updateStoredFilters(storedFilters.state.values);
+        }
+        this.filters.state.open = false;
+      };
+
+      function setDefaults(ctrl) {
+        ctrl.showTextFilter = ctrl.showTextFilter ? ctrl.showTextFilter : false;
+        ctrl.state.reverseOrder = ctrl.reverseOrder ? ctrl.reverseOrder : false;
+      }
+    }
+  ]);