+
diff --git a/app/portainer/services/nameValidator.js b/app/portainer/services/nameValidator.js
new file mode 100644
index 000000000..71dd94be4
--- /dev/null
+++ b/app/portainer/services/nameValidator.js
@@ -0,0 +1,20 @@
+import angular from 'angular';
+
+angular.module('portainer.app').factory('NameValidator', NameValidatorFactory);
+/* @ngInject */
+function NameValidatorFactory(EndpointService, Notifications) {
+ return {
+ validateEnvironmentName,
+ };
+
+ async function validateEnvironmentName(environmentName) {
+ try {
+ const endpoints = await EndpointService.endpoints();
+ const endpointArray = endpoints.value;
+ const nameDuplicated = endpointArray.filter((item) => item.Name === environmentName);
+ return nameDuplicated.length > 0;
+ } catch (err) {
+ Notifications.error('Failure', err, 'Unable to retrieve environment details');
+ }
+ }
+}
diff --git a/app/portainer/views/auth/authController.js b/app/portainer/views/auth/authController.js
index 1735c66bd..5a095cc2f 100644
--- a/app/portainer/views/auth/authController.js
+++ b/app/portainer/views/auth/authController.js
@@ -124,7 +124,7 @@ class AuthenticationController {
const isAdmin = this.Authentication.isAdmin();
if (endpoints.value.length === 0 && isAdmin) {
- return this.$state.go('portainer.init.endpoint');
+ return this.$state.go('portainer.wizard');
} else {
return this.$state.go('portainer.home');
}
diff --git a/app/portainer/views/init/admin/initAdminController.js b/app/portainer/views/init/admin/initAdminController.js
index 31b0c34bc..9ab139442 100644
--- a/app/portainer/views/init/admin/initAdminController.js
+++ b/app/portainer/views/init/admin/initAdminController.js
@@ -54,7 +54,7 @@ angular.module('portainer.app').controller('InitAdminController', [
})
.then(function success(data) {
if (data.value.length === 0) {
- $state.go('portainer.init.endpoint');
+ $state.go('portainer.wizard');
} else {
$state.go('portainer.home');
}
@@ -71,7 +71,7 @@ angular.module('portainer.app').controller('InitAdminController', [
UserService.administratorExists()
.then(function success(exists) {
if (exists) {
- $state.go('portainer.home');
+ $state.go('portainer.wizard');
}
})
.catch(function error(err) {
diff --git a/app/portainer/views/wizard/index.js b/app/portainer/views/wizard/index.js
new file mode 100644
index 000000000..d343c724a
--- /dev/null
+++ b/app/portainer/views/wizard/index.js
@@ -0,0 +1,7 @@
+import angular from 'angular';
+import controller from './wizard-view.controller.js';
+
+angular.module('portainer.app').component('wizardView', {
+ templateUrl: './wizard-view.html',
+ controller,
+});
diff --git a/app/portainer/views/wizard/wizard-endpoints/index.js b/app/portainer/views/wizard/wizard-endpoints/index.js
new file mode 100644
index 000000000..ea92654c6
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/index.js
@@ -0,0 +1,8 @@
+import angular from 'angular';
+import controller from './wizard-endpoints.controller.js';
+import './wizard-endpoints.css';
+
+angular.module('portainer.app').component('wizardEndpoints', {
+ templateUrl: './wizard-endpoints.html',
+ controller,
+});
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-aci/index.js b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-aci/index.js
new file mode 100644
index 000000000..5b7a5d254
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-aci/index.js
@@ -0,0 +1,11 @@
+import angular from 'angular';
+import controller from './wizard-aci.controller.js';
+
+angular.module('portainer.app').component('wizardAci', {
+ templateUrl: './wizard-aci.html',
+ controller,
+ bindings: {
+ onUpdate: '<',
+ onAnalytics: '<',
+ },
+});
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-aci/wizard-aci.controller.js b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-aci/wizard-aci.controller.js
new file mode 100644
index 000000000..a698d7775
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-aci/wizard-aci.controller.js
@@ -0,0 +1,63 @@
+import { buildOption } from '@/portainer/components/box-selector';
+
+export default class WizardAciController {
+ /* @ngInject */
+ constructor($async, EndpointService, Notifications, NameValidator) {
+ this.$async = $async;
+ this.EndpointService = EndpointService;
+ this.Notifications = Notifications;
+ this.NameValidator = NameValidator;
+ }
+
+ addAciEndpoint() {
+ return this.$async(async () => {
+ const { name, azureApplicationId, azureTenantId, azureAuthenticationKey } = this.formValues;
+ const groupId = 1;
+ const tagIds = [];
+
+ try {
+ this.state.actionInProgress = true;
+ // Check name is duplicated or not
+ let nameUsed = await this.NameValidator.validateEnvironmentName(name);
+ if (nameUsed) {
+ this.Notifications.error('Failure', true, 'This name is been used, please try another one');
+ return;
+ }
+ await this.EndpointService.createAzureEndpoint(name, azureApplicationId, azureTenantId, azureAuthenticationKey, groupId, tagIds);
+ this.Notifications.success('Environment connected', name);
+ this.clearForm();
+ this.onUpdate();
+ this.onAnalytics('aci-api');
+ } catch (err) {
+ this.Notifications.error('Failure', err, 'Unable to connect your environment');
+ } finally {
+ this.state.actionInProgress = false;
+ }
+ });
+ }
+
+ clearForm() {
+ this.formValues = {
+ name: '',
+ azureApplicationId: '',
+ azureTenantId: '',
+ azureAuthenticationKey: '',
+ };
+ }
+
+ $onInit() {
+ return this.$async(async () => {
+ this.state = {
+ actionInProgress: false,
+ endpointType: 'api',
+ availableOptions: [buildOption('API', 'fa fa-bolt', 'API', '', 'api')],
+ };
+ this.formValues = {
+ name: '',
+ azureApplicationId: '',
+ azureTenantId: '',
+ azureAuthenticationKey: '',
+ };
+ });
+ }
+}
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-aci/wizard-aci.html b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-aci/wizard-aci.html
new file mode 100644
index 000000000..0232d4bcb
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-aci/wizard-aci.html
@@ -0,0 +1,67 @@
+
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-docker/index.js b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-docker/index.js
new file mode 100644
index 000000000..3ec63022e
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-docker/index.js
@@ -0,0 +1,11 @@
+import angular from 'angular';
+import controller from './wizard-docker.controller.js';
+
+angular.module('portainer.app').component('wizardDocker', {
+ templateUrl: './wizard-docker.html',
+ controller,
+ bindings: {
+ onUpdate: '<',
+ onAnalytics: '<',
+ },
+});
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-docker/wizard-docker.controller.js b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-docker/wizard-docker.controller.js
new file mode 100644
index 000000000..5d82d6197
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-docker/wizard-docker.controller.js
@@ -0,0 +1,211 @@
+//import { getAgentShortVersion } from 'Portainer/views/endpoints/helpers';
+import { PortainerEndpointCreationTypes } from 'Portainer/models/endpoint/models';
+import { buildOption } from '@/portainer/components/box-selector';
+import { EndpointSecurityFormData } from 'Portainer/components/endpointSecurity/porEndpointSecurityModel';
+
+export default class WizardDockerController {
+ /* @ngInject */
+ constructor($async, EndpointService, StateManager, Notifications, clipboard, $filter, NameValidator) {
+ this.$async = $async;
+ this.EndpointService = EndpointService;
+ this.StateManager = StateManager;
+ this.Notifications = Notifications;
+ this.clipboard = clipboard;
+ this.$filter = $filter;
+ this.NameValidator = NameValidator;
+ }
+
+ copyLinuxCommand() {
+ this.clipboard.copyText(this.command.linuxCommand);
+ $('#linuxCommandNotification').show().fadeOut(2500);
+ }
+
+ copyWinCommand() {
+ this.clipboard.copyText(this.command.winCommand);
+ $('#winCommandNotification').show().fadeOut(2500);
+ }
+
+ copyLinuxSocket() {
+ this.clipboard.copyText(this.command.linuxSocket);
+ $('#linuxSocketNotification').show().fadeOut(2500);
+ }
+
+ copyWinSocket() {
+ this.clipboard.copyText(this.command.winSocket);
+ $('#winSocketNotification').show().fadeOut(2500);
+ }
+
+ onChangeFile(file) {
+ this.formValues.securityFormData = file;
+ }
+
+ // connect docker environment
+ connectEnvironment(type) {
+ return this.$async(async () => {
+ const name = this.formValues.name;
+ const url = this.$filter('stripprotocol')(this.formValues.url);
+ const publicUrl = url.split(':')[0];
+ const overrideUrl = this.formValues.socketPath;
+ const groupId = this.formValues.groupId;
+ const tagIds = this.formValues.tagIds;
+ const securityData = this.formValues.securityFormData;
+ const socketUrl = this.formValues.overrideSocket ? overrideUrl : url;
+
+ var creationType = null;
+
+ if (type === 'agent') {
+ creationType = PortainerEndpointCreationTypes.AgentEnvironment;
+ }
+
+ if (type === 'api') {
+ creationType = PortainerEndpointCreationTypes.LocalDockerEnvironment;
+ }
+
+ // Check name is duplicated or not
+ const nameUsed = await this.NameValidator.validateEnvironmentName(name);
+ if (nameUsed) {
+ this.Notifications.error('Failure', true, 'This name is been used, please try another one');
+ return;
+ }
+ switch (type) {
+ case 'agent':
+ await this.addDockerAgentEndpoint(name, creationType, url, publicUrl, groupId, tagIds);
+ break;
+ case 'api':
+ await this.addDockerApiEndpoint(name, creationType, url, publicUrl, groupId, tagIds, securityData);
+ break;
+ case 'socket':
+ await this.addDockerLocalEndpoint(name, socketUrl, publicUrl, groupId, tagIds);
+ break;
+ }
+ });
+ }
+
+ // Docker Agent Endpoint
+ async addDockerAgentEndpoint(name, creationType, url, publicUrl, groupId, tagIds) {
+ const tsl = true;
+ const tlsSkipVerify = true;
+ const tlsSkipClientVerify = true;
+ const tlsCaFile = null;
+ const tlsCertFile = null;
+ const tlsKeyFile = null;
+
+ await this.addRemoteEndpoint(name, creationType, url, publicUrl, groupId, tagIds, tsl, tlsSkipVerify, tlsSkipClientVerify, tlsCaFile, tlsCertFile, tlsKeyFile);
+ }
+
+ // Docker Api Endpoint
+ async addDockerApiEndpoint(name, creationType, url, publicUrl, groupId, tagIds, securityData) {
+ const tsl = this.formValues.tls;
+ const tlsSkipVerify = this.formValues.skipCertification;
+ const tlsSkipClientVerify = this.formValues.skipCertification;
+ const tlsCaFile = tlsSkipVerify ? null : securityData.TLSCACert;
+ const tlsCertFile = tlsSkipClientVerify ? null : securityData.TLSCert;
+ const tlsKeyFile = tlsSkipClientVerify ? null : securityData.TLSKey;
+
+ await this.addRemoteEndpoint(name, creationType, url, publicUrl, groupId, tagIds, tsl, tlsSkipVerify, tlsSkipClientVerify, tlsCaFile, tlsCertFile, tlsKeyFile);
+ }
+
+ async addDockerLocalEndpoint(name, url, publicUrl, groupId, tagIds) {
+ this.state.actionInProgress = true;
+ try {
+ await this.EndpointService.createLocalEndpoint(name, url, publicUrl, groupId, tagIds);
+ this.Notifications.success('Environment connected', name);
+ this.clearForm();
+ this.onUpdate();
+ } catch (err) {
+ this.Notifications.error('Failure', err, 'Unable to connect your environment');
+ } finally {
+ this.state.actionInProgress = false;
+ }
+ }
+
+ async addRemoteEndpoint(name, creationType, url, publicURL, groupId, tagIds, TLS, tlsSkipVerify, tlsSkipClientVerify, tlsCaFile, tlsCertFile, tlsKeyFile) {
+ this.state.actionInProgress = true;
+ try {
+ await this.EndpointService.createRemoteEndpoint(
+ name,
+ creationType,
+ url,
+ publicURL,
+ groupId,
+ tagIds,
+ TLS,
+ tlsSkipVerify,
+ tlsSkipClientVerify,
+ tlsCaFile,
+ tlsCertFile,
+ tlsKeyFile
+ );
+ this.Notifications.success('Environment connected', name);
+ this.clearForm();
+ this.onUpdate();
+
+ if (creationType === PortainerEndpointCreationTypes.AgentEnvironment) {
+ this.onAnalytics('docker-agent');
+ }
+
+ if (creationType === PortainerEndpointCreationTypes.LocalDockerEnvironment) {
+ this.onAnalytics('docker-api');
+ }
+ } catch (err) {
+ this.Notifications.error('Failure', err, 'Unable to connect your environment');
+ } finally {
+ this.state.actionInProgress = false;
+ }
+ }
+
+ clearForm() {
+ this.formValues = {
+ name: '',
+ url: '',
+ publicURL: '',
+ groupId: 1,
+ tagIds: [],
+ environmentUrl: '',
+ dockerApiurl: '',
+ socketPath: '',
+ overrodeSocket: false,
+ skipCertification: false,
+ tls: false,
+ securityFormData: new EndpointSecurityFormData(),
+ };
+ }
+
+ $onInit() {
+ return this.$async(async () => {
+ this.state = {
+ endpointType: 'agent',
+ ConnectSocket: false,
+ actionInProgress: false,
+ endpoints: [],
+ availableOptions: [
+ buildOption('Agent', 'fa fa-bolt', 'Agent', '', 'agent'),
+ buildOption('API', 'fa fa-cloud', 'API', '', 'api'),
+ buildOption('Socket', 'fab fa-docker', 'Socket', '', 'socket'),
+ ],
+ };
+
+ this.formValues = {
+ name: '',
+ url: '',
+ publicURL: '',
+ groupId: 1,
+ tagIds: [],
+ environmentUrl: '',
+ dockerApiurl: '',
+ socketPath: '',
+ overrideSocket: false,
+ skipCertification: false,
+ tls: false,
+ securityFormData: new EndpointSecurityFormData(),
+ };
+
+ this.command = {
+ linuxCommand: `curl -L https://downloads.portainer.io/agent-stack.yml -o agent-stack.yml && docker stack deploy --compose-file=agent-stack.yml portainer-agent `,
+ winCommand: `curl -L https://downloads.portainer.io/agent-stack-windows.yml -o agent-stack-windows.yml && docker stack deploy --compose-file=agent-stack-windows.yml portainer-agent `,
+ linuxSocket: `-v "/var/run/docker.sock:/var/run/docker.sock" `,
+ winSocket: `-v \.\pipe\docker_engine:\.\pipe\docker_engine `,
+ };
+ });
+ }
+}
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-docker/wizard-docker.html b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-docker/wizard-docker.html
new file mode 100644
index 000000000..18f1884ca
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-docker/wizard-docker.html
@@ -0,0 +1,172 @@
+
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-kubernetes/index.js b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-kubernetes/index.js
new file mode 100644
index 000000000..86d40a5aa
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-kubernetes/index.js
@@ -0,0 +1,11 @@
+import angular from 'angular';
+import controller from './wizard-kubernetes.controller.js';
+
+angular.module('portainer.app').component('wizardKubernetes', {
+ templateUrl: './wizard-kubernetes.html',
+ controller,
+ bindings: {
+ onUpdate: '<',
+ onAnalytics: '<',
+ },
+});
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-kubernetes/wizard-kubernetes.controller.js b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-kubernetes/wizard-kubernetes.controller.js
new file mode 100644
index 000000000..0971e8b9b
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-kubernetes/wizard-kubernetes.controller.js
@@ -0,0 +1,105 @@
+import { PortainerEndpointCreationTypes } from 'Portainer/models/endpoint/models';
+//import { getAgentShortVersion } from 'Portainer/views/endpoints/helpers';
+import { buildOption } from '@/portainer/components/box-selector';
+
+export default class WizardKubernetesController {
+ /* @ngInject */
+ constructor($async, EndpointService, StateManager, Notifications, $filter, clipboard, NameValidator) {
+ this.$async = $async;
+ this.EndpointService = EndpointService;
+ this.StateManager = StateManager;
+ this.Notifications = Notifications;
+ this.$filter = $filter;
+ this.clipboard = clipboard;
+ this.NameValidator = NameValidator;
+ }
+
+ addKubernetesAgent() {
+ return this.$async(async () => {
+ const name = this.state.formValues.name;
+ const groupId = 1;
+ const tagIds = [];
+ const url = this.$filter('stripprotocol')(this.state.formValues.url);
+ const publicUrl = url.split(':')[0];
+ const creationType = PortainerEndpointCreationTypes.AgentEnvironment;
+ const tls = true;
+ const tlsSkipVerify = true;
+ const tlsSkipClientVerify = true;
+ const tlsCaFile = null;
+ const tlsCertFile = null;
+ const tlsKeyFile = null;
+
+ // Check name is duplicated or not
+ let nameUsed = await this.NameValidator.validateEnvironmentName(name);
+ if (nameUsed) {
+ this.Notifications.error('Failure', true, 'This name is been used, please try another one');
+ return;
+ }
+ await this.addRemoteEndpoint(name, creationType, url, publicUrl, groupId, tagIds, tls, tlsSkipVerify, tlsSkipClientVerify, tlsCaFile, tlsCertFile, tlsKeyFile);
+ });
+ }
+
+ async addRemoteEndpoint(name, creationType, url, publicURL, groupId, tagIds, tls, tlsSkipVerify, tlsSkipClientVerify, tlsCaFile, tlsCertFile, tlsKeyFile) {
+ this.state.actionInProgress = true;
+ try {
+ await this.EndpointService.createRemoteEndpoint(
+ name,
+ creationType,
+ url,
+ publicURL,
+ groupId,
+ tagIds,
+ tls,
+ tlsSkipVerify,
+ tlsSkipClientVerify,
+ tlsCaFile,
+ tlsCertFile,
+ tlsKeyFile
+ );
+ this.Notifications.success('Environment connected', name);
+ this.clearForm();
+ this.onUpdate();
+ this.onAnalytics('kubernetes-agent');
+ } catch (err) {
+ this.Notifications.error('Failure', err, 'Unable to conect your environment');
+ } finally {
+ this.state.actionInProgress = false;
+ }
+ }
+
+ copyLoadBalancer() {
+ this.clipboard.copyText(this.command.loadBalancer);
+ $('#loadBalancerNotification').show().fadeOut(2500);
+ }
+
+ copyNodePort() {
+ this.clipboard.copyText(this.command.nodePort);
+ $('#nodePortNotification').show().fadeOut(2500);
+ }
+
+ clearForm() {
+ this.state.formValues = {
+ name: '',
+ url: '',
+ };
+ }
+
+ $onInit() {
+ return this.$async(async () => {
+ this.state = {
+ endpointType: 'agent',
+ actionInProgress: false,
+ formValues: {
+ name: '',
+ url: '',
+ },
+ availableOptions: [buildOption('Agent', 'fa fa-bolt', 'Agent', '', 'agent')],
+ };
+
+ this.command = {
+ loadBalancer: `curl -L https://downloads.portainer.io/portainer-agent-k8s-lb.yaml -o portainer-agent-k8s.yaml; kubectl apply -f portainer-agent-k8s.yaml `,
+ nodePort: `curl -L https://downloads.portainer.io/portainer-agent-k8s-nodeport.yaml -o portainer-agent-k8s.yaml; kubectl apply -f portainer-agent-k8s.yaml `,
+ };
+ });
+ }
+}
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-kubernetes/wizard-kubernetes.html b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-kubernetes/wizard-kubernetes.html
new file mode 100644
index 000000000..cd6cac537
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-kubernetes/wizard-kubernetes.html
@@ -0,0 +1,65 @@
+
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-list/index.js b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-list/index.js
new file mode 100644
index 000000000..26c5f21db
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-list/index.js
@@ -0,0 +1,9 @@
+import angular from 'angular';
+import './wizard-endpoint-list.css';
+
+angular.module('portainer.app').component('wizardEndpointList', {
+ templateUrl: './wizard-endpoint-list.html',
+ bindings: {
+ endpointList: '<',
+ },
+});
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-list/wizard-endpoint-list.css b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-list/wizard-endpoint-list.css
new file mode 100644
index 000000000..82be4836e
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-list/wizard-endpoint-list.css
@@ -0,0 +1,41 @@
+.wizard-list-wrapper {
+ display: grid;
+ grid-template-columns: 50px 1fr;
+ grid-template-areas:
+ 'image title'
+ 'image subtitle'
+ 'image type';
+ border: 1px solid rgb(221, 221, 221);
+ border-radius: 5px;
+ margin-bottom: 10px;
+ margin-top: 3px;
+ padding: 10px;
+ box-shadow: 0 3px 10px -2px rgb(161 170 166 / 20%);
+}
+
+.wizard-list-image {
+ grid-area: image;
+ font-size: 35px;
+ color: #337ab7;
+}
+
+.wizard-list-title {
+ grid-column: title;
+ padding: 0px 5px;
+ font-weight: bold;
+ font-size: 14px;
+}
+
+.wizard-list-subtitle {
+ grid-column: subtitle;
+ padding: 0px 5px;
+ font-size: 10px;
+ color: rgb(129, 129, 129);
+}
+
+.wizard-list-type {
+ grid-column: type;
+ padding: 0px 5px;
+ font-size: 10px;
+ color: rgb(129, 129, 129);
+}
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-list/wizard-endpoint-list.html b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-list/wizard-endpoint-list.html
new file mode 100644
index 000000000..2feaa7c74
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoint-list/wizard-endpoint-list.html
@@ -0,0 +1,11 @@
+
+
+
+
+
+
{{ endpoint.Name }}
+
URL: {{ endpoint.URL | stripprotocol }}
+
Type: {{ endpoint.Type | endpointtypename }}
+
+
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoints.controller.js b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoints.controller.js
new file mode 100644
index 000000000..57a164304
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoints.controller.js
@@ -0,0 +1,196 @@
+export default class WizardEndpointsController {
+ /* @ngInject */
+ constructor($async, $scope, $state, EndpointService, $analytics) {
+ this.$async = $async;
+ this.$scope = $scope;
+ this.$state = $state;
+ this.EndpointService = EndpointService;
+ this.$analytics = $analytics;
+
+ this.updateEndpoint = this.updateEndpoint.bind(this);
+ this.addAnalytics = this.addAnalytics.bind(this);
+ }
+ /**
+ * WIZARD ENDPOINT SECTION
+ */
+
+ async updateEndpoint() {
+ const updateEndpoints = await this.EndpointService.endpoints();
+ this.endpoints = updateEndpoints.value;
+ }
+
+ startWizard() {
+ const options = this.state.options;
+ this.state.selections = options.filter((item) => item.selected === true);
+ this.state.maxStep = this.state.selections.length;
+
+ if (this.state.selections.length !== 0) {
+ this.state.section = this.state.selections[this.state.currentStep].endpoint;
+ this.state.selections[this.state.currentStep].stage = 'active';
+ }
+
+ if (this.state.currentStep === this.state.maxStep - 1) {
+ this.state.nextStep = 'Finish';
+ }
+
+ this.$analytics.eventTrack('endpoint-wizard-endpoint-select', {
+ category: 'portainer',
+ metadata: {
+ environment: this.state.analytics.docker + this.state.analytics.kubernetes + this.state.analytics.aci,
+ },
+ });
+ this.state.currentStep++;
+ }
+
+ previousStep() {
+ this.state.section = this.state.selections[this.state.currentStep - 2].endpoint;
+ this.state.selections[this.state.currentStep - 2].stage = 'active';
+ this.state.selections[this.state.currentStep - 1].stage = '';
+ this.state.nextStep = 'Next Step';
+ this.state.currentStep--;
+ }
+
+ async nextStep() {
+ if (this.state.currentStep >= this.state.maxStep - 1) {
+ this.state.nextStep = 'Finish';
+ }
+ if (this.state.currentStep === this.state.maxStep) {
+ // the Local Endpoint Counter from endpoints array due to including Local Endpoint been added Automatic before Wizard start
+ const endpointsAdded = await this.EndpointService.endpoints();
+ const endpointsArray = endpointsAdded.value;
+ const filter = endpointsArray.filter((item) => item.Type === 1 || item.Type === 5);
+ // NOTICE: This is the temporary fix for excluded docker api endpoint been counted as local endpoint
+ this.state.counter.localEndpoint = filter.length - this.state.counter.dockerApi;
+
+ this.$analytics.eventTrack('endpoint-wizard-environment-add-finish', {
+ category: 'portainer',
+ metadata: {
+ 'docker-agent': this.state.counter.dockerAgent,
+ 'docker-api': this.state.counter.dockerApi,
+ 'kubernetes-agent': this.state.counter.kubernetesAgent,
+ 'aci-api': this.state.counter.aciApi,
+ 'local-endpoint': this.state.counter.localEndpoint,
+ },
+ });
+ this.$state.go('portainer.home');
+ } else {
+ this.state.section = this.state.selections[this.state.currentStep].endpoint;
+ this.state.selections[this.state.currentStep].stage = 'active';
+ this.state.selections[this.state.currentStep - 1].stage = 'completed';
+ this.state.currentStep++;
+ }
+ }
+
+ addAnalytics(endpoint) {
+ switch (endpoint) {
+ case 'docker-agent':
+ this.state.counter.dockerAgent++;
+ break;
+ case 'docker-api':
+ this.state.counter.dockerApi++;
+ break;
+ case 'kubernetes-agent':
+ this.state.counter.kubernetesAgent++;
+ break;
+ case 'aci-api':
+ this.state.counter.aciApi++;
+ break;
+ }
+ }
+
+ endpointSelect(endpoint) {
+ switch (endpoint) {
+ case 'docker':
+ if (this.state.options[0].selected) {
+ this.state.options[0].selected = false;
+ this.state.dockerActive = '';
+ this.state.analytics.docker = '';
+ } else {
+ this.state.options[0].selected = true;
+ this.state.dockerActive = 'wizard-active';
+ this.state.analytics.docker = 'Docker/';
+ }
+ break;
+ case 'kubernetes':
+ if (this.state.options[1].selected) {
+ this.state.options[1].selected = false;
+ this.state.kubernetesActive = '';
+ this.state.analytics.kubernetes = '';
+ } else {
+ this.state.options[1].selected = true;
+ this.state.kubernetesActive = 'wizard-active';
+ this.state.analytics.kubernetes = 'Kubernetes/';
+ }
+ break;
+ case 'aci':
+ if (this.state.options[2].selected) {
+ this.state.options[2].selected = false;
+ this.state.aciActive = '';
+ this.state.analytics.aci = '';
+ } else {
+ this.state.options[2].selected = true;
+ this.state.aciActive = 'wizard-active';
+ this.state.analytics.aci = 'ACI';
+ }
+ break;
+ }
+ const options = this.state.options;
+ this.state.selections = options.filter((item) => item.selected === true);
+ }
+
+ $onInit() {
+ return this.$async(async () => {
+ (this.state = {
+ currentStep: 0,
+ section: '',
+ dockerActive: '',
+ kubernetesActive: '',
+ aciActive: '',
+ maxStep: '',
+ previousStep: 'Previous',
+ nextStep: 'Next Step',
+ selections: [],
+ analytics: {
+ docker: '',
+ kubernetes: '',
+ aci: '',
+ },
+ counter: {
+ dockerAgent: 0,
+ dockerApi: 0,
+ kubernetesAgent: 0,
+ aciApi: 0,
+ localEndpoint: 0,
+ },
+ options: [
+ {
+ endpoint: 'docker',
+ selected: false,
+ stage: '',
+ nameClass: 'docker',
+ icon: 'fab fa-docker',
+ },
+ {
+ endpoint: 'kubernetes',
+ selected: false,
+ stage: '',
+ nameClass: 'kubernetes',
+ icon: 'fas fa-dharmachakra',
+ },
+ {
+ endpoint: 'aci',
+ selected: false,
+ stage: '',
+ nameClass: 'aci',
+ icon: 'fab fa-microsoft',
+ },
+ ],
+ selectOption: '',
+ }),
+ (this.endpoints = []);
+
+ const endpoints = await this.EndpointService.endpoints();
+ this.endpoints = endpoints.value;
+ });
+ }
+}
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoints.css b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoints.css
new file mode 100644
index 000000000..8b6a8a56f
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoints.css
@@ -0,0 +1,155 @@
+.wizard-endpoints {
+ display: block;
+ width: 200px;
+ height: 300px;
+ border: 1px solid rgb(163, 163, 163);
+ border-radius: 5px;
+ float: left;
+ margin-right: 15px;
+ padding: 25px 20px;
+ cursor: pointer;
+ box-shadow: 0 3px 10px -2px rgb(161 170 166 / 60%);
+}
+
+.wizard-endpoints:hover {
+ box-shadow: 0 3px 10px -2px rgb(161 170 166 / 80%);
+ border: 1px solid #3ca4ff;
+ color: #337ab7;
+}
+
+.wizard-active:hover {
+ color: #fff;
+}
+
+.wizard-active {
+ background: #337ab7;
+ color: #fff;
+ border: 1px solid #3ca4ff;
+ box-shadow: 0 3px 10px -2px rgb(161 170 166 / 80%);
+}
+
+.wizard-form-required {
+ color: rgb(255, 24, 24);
+ padding: 0px 5px;
+}
+
+.wizard-form {
+ margin-top: 40px;
+}
+
+.wizard-code {
+ margin-right: 15px;
+}
+
+.wizard-action {
+ margin-top: 20px;
+}
+
+.wizard-connect-button {
+ margin-left: 0px !important;
+ margin-top: 40px;
+}
+
+.wizard-copy-button {
+ color: #444;
+ cursor: pointer;
+}
+
+.wizard-step-action {
+ padding-top: 40px;
+ padding-bottom: 40px;
+ text-align: right;
+ border-top: 1px solid #777;
+}
+
+.next-btn {
+ float: right;
+}
+
+.previous-btn {
+ float: left;
+ margin-left: 0px !important;
+}
+
+.wizard-wrapper {
+ display: grid;
+ grid-template-columns: 1fr 400px;
+ grid-template-areas:
+ 'main sidebar'
+ 'footer sidebar';
+}
+
+.wizard-main {
+ grid-column: main;
+}
+
+.wizard-aside {
+ grid-column: sidebar;
+ margin-right: 15px;
+}
+
+.wizard-footer {
+ grid-column: footer;
+}
+
+.wizard-endpoint-section {
+ padding-right: 10px;
+}
+
+.wizard-main-title {
+ margin-bottom: 10px;
+}
+
+.wizard-env-section {
+ display: block;
+ padding: 10px;
+ border: 1px solid red;
+ width: 80%;
+ margin-left: auto;
+ margin-right: auto;
+ height: 600px;
+ text-align: center;
+}
+
+.wizard-env-icon {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.wizard-content-wrapper {
+ position: relative;
+ left: 50%;
+}
+
+.wizard-content {
+ float: left;
+ position: relative;
+ left: -50%;
+}
+
+.wizard-section {
+ display: grid;
+ justify-content: left;
+ align-content: left;
+ gap: 10px;
+ grid-auto-flow: column;
+ margin-bottom: 20px;
+}
+
+.wizard-section-title {
+ font-size: 32px;
+ margin-top: 30px;
+ margin-bottom: 15px;
+}
+.wizard-setion-subtitle {
+ font-size: 18px;
+}
+
+.wizard-section-action {
+ margin-top: 50px;
+ margin-bottom: 20px;
+}
+
+.no-margin {
+ margin-left: 0px;
+}
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-endpoints.html b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoints.html
new file mode 100644
index 000000000..d54eb5bd7
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-endpoints.html
@@ -0,0 +1,96 @@
+
+ Environment Wizard
+
+
+
+
+
+
+
+
+
+
+ Connect to your {{ $ctrl.state.section }} environment
+
+
+
+
+
+
+
+
+ {{ $ctrl.state.nextStep }}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select your environment(s)
+
+
+ You can onboard different types of environments, select all that apply.
+
+
+
+
+
+
+
+
+
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/index.js b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/index.js
new file mode 100644
index 000000000..5e0e78b0b
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/index.js
@@ -0,0 +1,9 @@
+import angular from 'angular';
+import './wizard-stepper.css';
+
+angular.module('portainer.app').component('wizardStepper', {
+ templateUrl: './wizard-stepper.html',
+ bindings: {
+ endpointSelections: '<',
+ },
+});
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-endpoint-type/index.js b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-endpoint-type/index.js
new file mode 100644
index 000000000..fb51b1401
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-endpoint-type/index.js
@@ -0,0 +1,11 @@
+import angular from 'angular';
+
+angular.module('portainer.app').component('wizardEndpointType', {
+ templateUrl: './wizard-endpoint-type.html',
+ bindings: {
+ endpointTitle: '@',
+ description: '@',
+ icon: '@',
+ active: '<',
+ },
+});
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-endpoint-type/wizard-endpoint-type.html b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-endpoint-type/wizard-endpoint-type.html
new file mode 100644
index 000000000..3088e3616
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-endpoint-type/wizard-endpoint-type.html
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
{{ $ctrl.endpointTitle }}
+ {{ $ctrl.description }}
+
+
+
+
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-stepper.css b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-stepper.css
new file mode 100644
index 000000000..2bff2354e
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-stepper.css
@@ -0,0 +1,95 @@
+.stepper-wrapper {
+ width: 60%;
+ margin-top: auto;
+ display: flex;
+ justify-content: space-between;
+ margin-bottom: 20px;
+ margin-left: 10px;
+}
+.stepper-item {
+ position: relative;
+ display: flex;
+ flex-direction: column;
+ align-items: stretch;
+ flex: 1;
+}
+
+.docker {
+ margin-left: -5px;
+ text-transform: capitalize;
+}
+.kubernetes {
+ margin-left: -20px;
+ text-transform: capitalize;
+}
+.aci {
+ margin-left: 5px;
+ text-transform: uppercase;
+}
+
+.stepper-item::before {
+ position: absolute;
+ content: '';
+ border-bottom: 5px solid rgb(231, 231, 231);
+ width: 100%;
+ top: 20px;
+ left: -100%;
+ z-index: 2;
+}
+
+.stepper-item::after {
+ position: absolute;
+ content: '';
+ border-bottom: 5px solid rgb(231, 231, 231);
+ width: 100%;
+ top: 20px;
+ left: 0;
+ z-index: 2;
+}
+
+.stepper-item .step-counter {
+ position: relative;
+ z-index: 5;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ width: 40px;
+ height: 40px;
+ border-radius: 50%;
+ background: rgb(231, 231, 231);
+ margin-bottom: 6px;
+}
+
+.stepper-item.active {
+ font-weight: bold;
+ background: #fff;
+ content: none;
+}
+
+.stepper-item.active .step-counter {
+ background: #337ab7;
+ color: #fff;
+}
+
+.stepper-item.completed .step-counter {
+ background-color: #48b400;
+ color: #fff;
+}
+
+.stepper-item.completed::after {
+ position: absolute;
+ content: '';
+ border-bottom: 5px solid #48b400;
+ width: 100%;
+ top: 20px;
+ left: 0;
+ z-index: 3;
+}
+
+.stepper-item:first-child::before {
+ content: none;
+}
+
+.stepper-item:last-child::after {
+ content: none;
+}
diff --git a/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-stepper.html b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-stepper.html
new file mode 100644
index 000000000..741487c9d
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-endpoints/wizard-stepper/wizard-stepper.html
@@ -0,0 +1,6 @@
+
+
+
{{ $index + 1 }}
+
{{ selection.endpoint }}
+
+
diff --git a/app/portainer/views/wizard/wizard-link/index.js b/app/portainer/views/wizard/wizard-link/index.js
new file mode 100644
index 000000000..e0f8cbb8d
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-link/index.js
@@ -0,0 +1,11 @@
+import angular from 'angular';
+import './wizard-link.css';
+
+angular.module('portainer.app').component('wizardLink', {
+ templateUrl: './wizard-link.html',
+ bindings: {
+ linkTitle: '@',
+ description: '@',
+ icon: '<',
+ },
+});
diff --git a/app/portainer/views/wizard/wizard-link/wizard-link.css b/app/portainer/views/wizard/wizard-link/wizard-link.css
new file mode 100644
index 000000000..f62148e0c
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-link/wizard-link.css
@@ -0,0 +1,41 @@
+.wizard-button {
+ display: block;
+ border: 1px solid rgb(163, 163, 163);
+ border-radius: 5px;
+ width: 200px;
+ height: 300px;
+ float: left;
+ margin-right: 30px;
+ cursor: pointer;
+ padding: 25px 20px;
+ box-shadow: 0 3px 10px -2px rgb(161 170 166 / 60%);
+}
+
+.wizard-button:hover {
+ box-shadow: 0 3px 10px -2px rgb(161 170 166 / 80%);
+ border: 1px solid #3ca4ff;
+ color: #337ab7;
+}
+
+.wizard-link {
+ color: #000;
+}
+
+.wizard-title {
+ color: #000;
+}
+
+.wizard-button-subtitle {
+ color: rgb(112, 112, 112);
+ margin-bottom: 30px;
+ text-align: center;
+}
+
+.wizard-button-title {
+ font-size: 12px;
+ margin-bottom: 15px;
+}
+
+.wizard-link-section {
+ margin-top: 15px;
+}
diff --git a/app/portainer/views/wizard/wizard-link/wizard-link.html b/app/portainer/views/wizard/wizard-link/wizard-link.html
new file mode 100644
index 000000000..5f32b07ca
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-link/wizard-link.html
@@ -0,0 +1,7 @@
+
diff --git a/app/portainer/views/wizard/wizard-tls/index.js b/app/portainer/views/wizard/wizard-tls/index.js
new file mode 100644
index 000000000..3f1cf61cd
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-tls/index.js
@@ -0,0 +1,9 @@
+import angular from 'angular';
+
+angular.module('portainer.app').component('wizardTls', {
+ templateUrl: './wizard-tls.html',
+ bindings: {
+ formData: '<',
+ onChange: '<',
+ },
+});
diff --git a/app/portainer/views/wizard/wizard-tls/wizard-tls.html b/app/portainer/views/wizard/wizard-tls/wizard-tls.html
new file mode 100644
index 000000000..32e7e2fd5
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-tls/wizard-tls.html
@@ -0,0 +1,49 @@
+
diff --git a/app/portainer/views/wizard/wizard-view.controller.js b/app/portainer/views/wizard/wizard-view.controller.js
new file mode 100644
index 000000000..f615b69ef
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-view.controller.js
@@ -0,0 +1,87 @@
+import { PortainerEndpointCreationTypes } from 'Portainer/models/endpoint/models';
+
+export default class WizardViewController {
+ /* @ngInject */
+ constructor($async, $state, EndpointService, $analytics) {
+ this.$async = $async;
+ this.$state = $state;
+ this.EndpointService = EndpointService;
+ this.$analytics = $analytics;
+ }
+
+ /**
+ * WIZARD APPLICATION
+ */
+ manageLocalEndpoint() {
+ this.$state.go('portainer.home');
+ }
+
+ addRemoteEndpoint() {
+ this.$state.go('portainer.wizard.endpoints');
+ }
+
+ async createLocalKubernetesEndpoint() {
+ this.state.endpoint.loading = true;
+ try {
+ await this.EndpointService.createLocalKubernetesEndpoint();
+ this.state.endpoint.loading = false;
+ this.state.endpoint.added = true;
+ this.state.endpoint.connected = 'kubernetes';
+ this.state.local.icon = 'fas fa-dharmachakra';
+ } catch (err) {
+ this.state.endpoint.kubernetesError = true;
+ }
+ }
+
+ async createLocalDockerEndpoint() {
+ try {
+ await this.EndpointService.createLocalEndpoint();
+ this.state.endpoint.loading = false;
+ this.state.endpoint.added = true;
+ this.state.endpoint.connected = 'docker';
+ this.state.local.icon = 'fab fa-docker';
+ } finally {
+ this.state.endpoint.loading = false;
+ }
+ }
+
+ $onInit() {
+ return this.$async(async () => {
+ this.state = {
+ local: {
+ icon: '',
+ },
+ remote: {
+ icon: 'fa fa-plug',
+ },
+ endpoint: {
+ kubernetesError: false,
+ connected: '',
+ loading: false,
+ added: false,
+ },
+ };
+
+ const endpoints = await this.EndpointService.endpoints();
+ if (endpoints.totalCount === '0') {
+ await this.createLocalKubernetesEndpoint();
+ if (this.state.endpoint.kubernetesError) {
+ await this.createLocalDockerEndpoint();
+ }
+ } else {
+ const addedLocalEndpoint = endpoints.value[0];
+ if (addedLocalEndpoint.Type === PortainerEndpointCreationTypes.LocalDockerEnvironment) {
+ this.state.endpoint.added = true;
+ this.state.endpoint.connected = 'docker';
+ this.state.local.icon = 'fab fa-docker';
+ }
+
+ if (addedLocalEndpoint.Type === PortainerEndpointCreationTypes.LocalKubernetesEnvironment) {
+ this.state.endpoint.added = true;
+ this.state.endpoint.connected = 'kubernetes';
+ this.state.local.icon = 'fas fa-dharmachakra';
+ }
+ }
+ });
+ }
+}
diff --git a/app/portainer/views/wizard/wizard-view.html b/app/portainer/views/wizard/wizard-view.html
new file mode 100644
index 000000000..db8c880b6
--- /dev/null
+++ b/app/portainer/views/wizard/wizard-view.html
@@ -0,0 +1,52 @@
+
+ Endpoint Wizard
+
+
+
+
+
+
+
+
+
+ Welcome to Portainer
+
+
+
+ We have connected your local environment of {{ $ctrl.state.endpoint.connected }} to Portainer.
+
+ We could not connect your local environment to Portainer. https://documentation.portainer.io/quickstart
+
+ Get started below with your local portainer or connect more container environments.
+
+
+
+
+
+
+
+
+
From 756ef060dbff8e840a9f4de91096aa7b623c000a Mon Sep 17 00:00:00 2001
From: Richard Wei <54336863+WaysonWei@users.noreply.github.com>
Date: Fri, 10 Sep 2021 22:42:25 +1200
Subject: [PATCH 10/26] feat(k8s):add kubeconfig expiry days on mouse hover
EE-1300 (#5589)
* add kubeconfig expiry days on mouse hover
* replace settings with publicSettings for non-admin user
---
api/http/handler/settings/settings_public.go | 3 ++
.../kube-config-download-button.controller.js | 34 +++++++++++++++++--
.../kube-config-download-button.html | 4 ++-
app/portainer/models/settings.js | 1 +
4 files changed, 39 insertions(+), 3 deletions(-)
diff --git a/api/http/handler/settings/settings_public.go b/api/http/handler/settings/settings_public.go
index aab33e59e..dbe8c243e 100644
--- a/api/http/handler/settings/settings_public.go
+++ b/api/http/handler/settings/settings_public.go
@@ -22,6 +22,8 @@ type publicSettingsResponse struct {
OAuthLogoutURI string `json:"OAuthLogoutURI" example:"https://gitlab.com/oauth/logout"`
// Whether telemetry is enabled
EnableTelemetry bool `json:"EnableTelemetry" example:"true"`
+ // The expiry of a Kubeconfig
+ KubeconfigExpiry string `example:"24h" default:"0"`
}
// @id SettingsPublic
@@ -49,6 +51,7 @@ func generatePublicSettings(appSettings *portainer.Settings) *publicSettingsResp
AuthenticationMethod: appSettings.AuthenticationMethod,
EnableEdgeComputeFeatures: appSettings.EnableEdgeComputeFeatures,
EnableTelemetry: appSettings.EnableTelemetry,
+ KubeconfigExpiry: appSettings.KubeconfigExpiry,
}
//if OAuth authentication is on, compose the related fields from application settings
if publicSettings.AuthenticationMethod == portainer.AuthenticationOAuth {
diff --git a/app/kubernetes/components/kube-config-download-button/kube-config-download-button.controller.js b/app/kubernetes/components/kube-config-download-button/kube-config-download-button.controller.js
index 643dcefa0..55a8ec548 100644
--- a/app/kubernetes/components/kube-config-download-button/kube-config-download-button.controller.js
+++ b/app/kubernetes/components/kube-config-download-button/kube-config-download-button.controller.js
@@ -1,15 +1,45 @@
export default class KubeConfigController {
/* @ngInject */
- constructor($window, KubernetesConfigService) {
+ constructor($async, $window, KubernetesConfigService, SettingsService) {
+ this.$async = $async;
this.$window = $window;
this.KubernetesConfigService = KubernetesConfigService;
+ this.SettingsService = SettingsService;
}
async downloadKubeconfig() {
await this.KubernetesConfigService.downloadConfig();
}
+ async expiryHoverMessage() {
+ const settings = await this.SettingsService.publicSettings();
+ const expiryDays = settings.KubeconfigExpiry;
+ switch (expiryDays) {
+ case '0':
+ this.state.expiryDays = 'not expire';
+ break;
+ case '24h':
+ this.state.expiryDays = 'expire in 1 day';
+ break;
+ case '168h':
+ this.state.expiryDays = 'expire in 7 days';
+ break;
+ case '720h':
+ this.state.expiryDays = 'expire in 30 days';
+ break;
+ case '8640h':
+ this.state.expiryDays = 'expire in 1 year';
+ break;
+ }
+ }
+
$onInit() {
- this.state = { isHTTPS: this.$window.location.protocol === 'https:' };
+ return this.$async(async () => {
+ this.state = {
+ isHTTPS: this.$window.location.protocol === 'https:',
+ expiryDays: '',
+ };
+ await this.expiryHoverMessage();
+ });
}
}
diff --git a/app/kubernetes/components/kube-config-download-button/kube-config-download-button.html b/app/kubernetes/components/kube-config-download-button/kube-config-download-button.html
index b2bae2cdf..343073af9 100644
--- a/app/kubernetes/components/kube-config-download-button/kube-config-download-button.html
+++ b/app/kubernetes/components/kube-config-download-button/kube-config-download-button.html
@@ -1,4 +1,5 @@
-
+
Kubeconfig
+
diff --git a/app/portainer/models/settings.js b/app/portainer/models/settings.js
index 232175560..05bdc832b 100644
--- a/app/portainer/models/settings.js
+++ b/app/portainer/models/settings.js
@@ -21,6 +21,7 @@ export function PublicSettingsViewModel(settings) {
this.OAuthLoginURI = settings.OAuthLoginURI;
this.EnableTelemetry = settings.EnableTelemetry;
this.OAuthLogoutURI = settings.OAuthLogoutURI;
+ this.KubeconfigExpiry = settings.KubeconfigExpiry;
}
export function LDAPSettingsViewModel(data) {
From 1374e53dfa70075d708a74be3327d732a5ca31ac Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Busso?=
Date: Mon, 13 Sep 2021 09:00:49 +1200
Subject: [PATCH 11/26] Remove references to deviantony gist (#5594)
---
api/api-description.md | 4 ++--
api/swagger.yaml | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/api/api-description.md b/api/api-description.md
index 030687259..bcdd8843d 100644
--- a/api/api-description.md
+++ b/api/api-description.md
@@ -1,5 +1,5 @@
Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API.
-Examples are available at https://gist.github.com/deviantony/77026d402366b4b43fa5918d41bc42f8
+Examples are available at https://documentation.portainer.io/api/api-examples/
You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).
# Authentication
@@ -50,4 +50,4 @@ Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you
To do so, you can use the `/endpoints/{id}/docker` Portainer API endpoint (which is not documented below due to Swagger limitations). This endpoint has a restricted access policy so you still need to be authenticated to be able to query this endpoint. Any query on this endpoint will be proxied to the Docker API of the associated endpoint (requests and responses objects are the same as documented in the Docker API).
-**NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://gist.github.com/deviantony/77026d402366b4b43fa5918d41bc42f8).
+**NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/).
diff --git a/api/swagger.yaml b/api/swagger.yaml
index 77513bf0a..ae48df4ef 100644
--- a/api/swagger.yaml
+++ b/api/swagger.yaml
@@ -2502,7 +2502,7 @@ info:
email: info@portainer.io
description: |
Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API.
- Examples are available at https://gist.github.com/deviantony/77026d402366b4b43fa5918d41bc42f8
+ Examples are available at https://documentation.portainer.io/api/api-examples/
You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).
# Authentication
@@ -2553,7 +2553,7 @@ info:
To do so, you can use the `/endpoints/{id}/docker` Portainer API endpoint (which is not documented below due to Swagger limitations). This endpoint has a restricted access policy so you still need to be authenticated to be able to query this endpoint. Any query on this endpoint will be proxied to the Docker API of the associated endpoint (requests and responses objects are the same as documented in the Docker API).
- **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://gist.github.com/deviantony/77026d402366b4b43fa5918d41bc42f8).
+ **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/).
license: {}
title: PortainerCE API
version: 2.0.0
From 396a921b1265b5a38dd3293c67139afc5a750510 Mon Sep 17 00:00:00 2001
From: Dmitry Salakhov
Date: Mon, 13 Sep 2021 11:11:22 +1200
Subject: [PATCH 12/26] fix(stacks): allow root based compose file paths
(#5564)
---
api/exec/compose_stack.go | 35 +++++++++++++++++++++++++++++-----
api/exec/compose_stack_test.go | 18 +++++++++++++++++
2 files changed, 48 insertions(+), 5 deletions(-)
diff --git a/api/exec/compose_stack.go b/api/exec/compose_stack.go
index 087274fe9..c3296e37d 100644
--- a/api/exec/compose_stack.go
+++ b/api/exec/compose_stack.go
@@ -5,6 +5,7 @@ import (
"fmt"
"os"
"path"
+ "path/filepath"
"regexp"
"strings"
@@ -58,8 +59,8 @@ func (manager *ComposeStackManager) Up(ctx context.Context, stack *portainer.Sta
return errors.Wrap(err, "failed to create env file")
}
- filePaths := append([]string{stack.EntryPoint}, stack.AdditionalFiles...)
- return manager.deployer.Deploy(ctx, stack.ProjectPath, url, stack.Name, filePaths, envFilePath)
+ filePaths := getStackFiles(stack)
+ err = manager.deployer.Deploy(ctx, stack.ProjectPath, url, stack.Name, filePaths, envFilePath)
return errors.Wrap(err, "failed to deploy a stack")
}
@@ -73,9 +74,9 @@ func (manager *ComposeStackManager) Down(ctx context.Context, stack *portainer.S
defer proxy.Close()
}
- filePaths := append([]string{stack.EntryPoint}, stack.AdditionalFiles...)
-
- return manager.deployer.Remove(ctx, stack.ProjectPath, url, stack.Name, filePaths)
+ filePaths := getStackFiles(stack)
+ err = manager.deployer.Remove(ctx, stack.ProjectPath, url, stack.Name, filePaths)
+ return errors.Wrap(err, "failed to remove a stack")
}
// NormalizeStackName returns a new stack name with unsupported characters replaced
@@ -116,3 +117,27 @@ func createEnvFile(stack *portainer.Stack) (string, error) {
return "stack.env", nil
}
+
+// getStackFiles returns list of stack's confile file paths.
+// items in the list would be sanitized according to following criterias:
+// 1. no empty paths
+// 2. no "../xxx" paths that are trying to escape stack folder
+// 3. no dir paths
+// 4. root paths would be made relative
+func getStackFiles(stack *portainer.Stack) []string {
+ paths := make([]string, 0, len(stack.AdditionalFiles)+1)
+
+ for _, p := range append([]string{stack.EntryPoint}, stack.AdditionalFiles...) {
+ if strings.HasPrefix(p, "/") {
+ p = `.` + p
+ }
+
+ if p == `` || p == `.` || strings.HasPrefix(p, `..`) || strings.HasSuffix(p, string(filepath.Separator)) {
+ continue
+ }
+
+ paths = append(paths, p)
+ }
+
+ return paths
+}
diff --git a/api/exec/compose_stack_test.go b/api/exec/compose_stack_test.go
index c61285ebd..0b5dec2a3 100644
--- a/api/exec/compose_stack_test.go
+++ b/api/exec/compose_stack_test.go
@@ -64,3 +64,21 @@ func Test_createEnvFile(t *testing.T) {
})
}
}
+
+func Test_getStackFiles(t *testing.T) {
+ stack := &portainer.Stack{
+ EntryPoint: "./file", // picks entry point
+ AdditionalFiles: []string{
+ ``, // ignores empty string
+ `.`, // ignores .
+ `..`, // ignores ..
+ `./dir/`, // ignrores paths that end with trailing /
+ `/with-root-prefix`, // replaces "root" based paths with relative
+ `./relative`, // keeps relative paths
+ `../escape`, // prevents dir escape
+ },
+ }
+
+ filePaths := getStackFiles(stack)
+ assert.ElementsMatch(t, filePaths, []string{`./file`, `./with-root-prefix`, `./relative`})
+}
From e437a3b570beba1f23741fcea61bf13b6e54485d Mon Sep 17 00:00:00 2001
From: Matt Hook
Date: Mon, 13 Sep 2021 14:14:07 +1200
Subject: [PATCH 13/26] fix(docs): fix yarn build docs broken for helm (#5606)
* fix(docs): fix yarn build docs broken for helm
* ensure correct version of swag is used
* remove line that prevented swag from updating
---
package.json | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/package.json b/package.json
index c594562fc..a8dadc9ad 100644
--- a/package.json
+++ b/package.json
@@ -20,8 +20,8 @@
"build": "grunt clean:all && grunt build",
"build:server": "grunt clean:server && grunt build:server",
"build:client": "grunt clean:client && grunt build:client",
- "prebuild:docs": "(! command -v swag &> /dev/null) && go get -u github.com/swaggo/swag/cmd/swag",
- "build:docs": "cd api && swag init -g ./http/handler/handler.go --markdownFiles ./",
+ "prebuild:docs": "go install github.com/swaggo/swag/cmd/swag@v1.7.1",
+ "build:docs": "cd api && swag init -g ./http/handler/handler.go --parseDependency --parseInternal --parseDepth 2 --markdownFiles ./",
"clean": "grunt clean:all",
"start": "grunt start",
"start:clean": "grunt clean:all && grunt start",
From 1633eceed548f13121a90b17c67632aa96de29a5 Mon Sep 17 00:00:00 2001
From: Yi Chen <69284638+yi-portainer@users.noreply.github.com>
Date: Mon, 13 Sep 2021 15:42:53 +1200
Subject: [PATCH 14/26] fix(swagger) Fix openapi issues (#5123)
* * fix api version
* fix license info
* fix error response schema
* fix other typos & mistakes
* * remove unused tag
* * fix helm issues
---
.../handler/customtemplates/customtemplate_create.go | 2 +-
api/http/handler/edgegroups/edgegroup_create.go | 2 +-
api/http/handler/edgegroups/edgegroup_delete.go | 2 +-
api/http/handler/edgegroups/edgegroup_inspect.go | 2 +-
api/http/handler/edgegroups/edgegroup_list.go | 2 +-
api/http/handler/edgegroups/edgegroup_update.go | 2 +-
api/http/handler/edgejobs/edgejob_create.go | 6 +++---
api/http/handler/edgejobs/edgejob_delete.go | 2 +-
api/http/handler/edgejobs/edgejob_file.go | 2 +-
api/http/handler/edgejobs/edgejob_inspect.go | 2 +-
api/http/handler/edgejobs/edgejob_list.go | 2 +-
api/http/handler/edgejobs/edgejob_tasklogs_clear.go | 2 +-
api/http/handler/edgejobs/edgejob_tasklogs_collect.go | 2 +-
api/http/handler/edgejobs/edgejob_tasklogs_inspect.go | 2 +-
api/http/handler/edgejobs/edgejob_tasks_list.go | 2 +-
api/http/handler/edgejobs/edgejob_update.go | 2 +-
api/http/handler/edgestacks/edgestack_create.go | 2 +-
api/http/handler/edgestacks/edgestack_delete.go | 2 +-
api/http/handler/edgestacks/edgestack_file.go | 2 +-
api/http/handler/edgestacks/edgestack_inspect.go | 2 +-
api/http/handler/edgestacks/edgestack_list.go | 2 +-
api/http/handler/edgestacks/edgestack_update.go | 2 +-
.../endpointedge/endpoint_edgestack_inspect.go | 2 +-
.../handler/endpointgroups/endpointgroup_inspect.go | 2 +-
.../handler/endpointgroups/endpointgroup_update.go | 2 +-
.../handler/endpoints/endpoint_association_delete.go | 11 ++++++-----
api/http/handler/endpoints/endpoint_list.go | 2 +-
.../handler/endpoints/endpoint_settings_update.go | 2 +-
api/http/handler/handler.go | 6 ++----
api/http/handler/helm/helm_delete.go | 5 +++--
api/http/handler/helm/helm_install.go | 3 ++-
api/http/handler/helm/helm_list.go | 3 ++-
api/http/handler/helm/helm_show.go | 2 +-
api/http/handler/helm/user_helm_repos.go | 5 +++--
api/http/handler/stacks/stack_create.go | 2 +-
api/http/handler/stacks/stack_update_git_redeploy.go | 2 +-
api/http/handler/teams/team_delete.go | 1 +
api/http/handler/teams/team_memberships.go | 1 +
38 files changed, 52 insertions(+), 47 deletions(-)
diff --git a/api/http/handler/customtemplates/customtemplate_create.go b/api/http/handler/customtemplates/customtemplate_create.go
index dc741da7a..f2bacb6f9 100644
--- a/api/http/handler/customtemplates/customtemplate_create.go
+++ b/api/http/handler/customtemplates/customtemplate_create.go
@@ -21,7 +21,7 @@ import (
// @description **Access policy**: authenticated
// @tags custom_templates
// @security jwt
-// @accept json, multipart/form-data
+// @accept json,multipart/form-data
// @produce json
// @param method query string true "method for creating template" Enums(string, file, repository)
// @param body_string body customTemplateFromFileContentPayload false "Required when using method=string"
diff --git a/api/http/handler/edgegroups/edgegroup_create.go b/api/http/handler/edgegroups/edgegroup_create.go
index c461de77f..087e7847a 100644
--- a/api/http/handler/edgegroups/edgegroup_create.go
+++ b/api/http/handler/edgegroups/edgegroup_create.go
@@ -41,7 +41,7 @@ func (payload *edgeGroupCreatePayload) Validate(r *http.Request) error {
// @produce json
// @param body body edgeGroupCreatePayload true "EdgeGroup data"
// @success 200 {object} portainer.EdgeGroup
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @failure 500
// @router /edge_groups [post]
func (handler *Handler) edgeGroupCreate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
diff --git a/api/http/handler/edgegroups/edgegroup_delete.go b/api/http/handler/edgegroups/edgegroup_delete.go
index e9ed2446d..7ff9c1ed5 100644
--- a/api/http/handler/edgegroups/edgegroup_delete.go
+++ b/api/http/handler/edgegroups/edgegroup_delete.go
@@ -20,7 +20,7 @@ import (
// @produce json
// @param id path int true "EdgeGroup Id"
// @success 204
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @failure 500
// @router /edge_groups/{id} [delete]
func (handler *Handler) edgeGroupDelete(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
diff --git a/api/http/handler/edgegroups/edgegroup_inspect.go b/api/http/handler/edgegroups/edgegroup_inspect.go
index e40d3989d..4d378b2be 100644
--- a/api/http/handler/edgegroups/edgegroup_inspect.go
+++ b/api/http/handler/edgegroups/edgegroup_inspect.go
@@ -19,7 +19,7 @@ import (
// @produce json
// @param id path int true "EdgeGroup Id"
// @success 200 {object} portainer.EdgeGroup
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @failure 500
// @router /edge_groups/{id} [get]
func (handler *Handler) edgeGroupInspect(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
diff --git a/api/http/handler/edgegroups/edgegroup_list.go b/api/http/handler/edgegroups/edgegroup_list.go
index 0363ce87e..5d81feed9 100644
--- a/api/http/handler/edgegroups/edgegroup_list.go
+++ b/api/http/handler/edgegroups/edgegroup_list.go
@@ -24,7 +24,7 @@ type decoratedEdgeGroup struct {
// @produce json
// @success 200 {array} portainer.EdgeGroup{HasEdgeStack=bool} "EdgeGroups"
// @failure 500
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_groups [get]
func (handler *Handler) edgeGroupList(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeGroups, err := handler.DataStore.EdgeGroup().EdgeGroups()
diff --git a/api/http/handler/edgegroups/edgegroup_update.go b/api/http/handler/edgegroups/edgegroup_update.go
index f034325c6..15920c5b2 100644
--- a/api/http/handler/edgegroups/edgegroup_update.go
+++ b/api/http/handler/edgegroups/edgegroup_update.go
@@ -44,7 +44,7 @@ func (payload *edgeGroupUpdatePayload) Validate(r *http.Request) error {
// @param id path int true "EdgeGroup Id"
// @param body body edgeGroupUpdatePayload true "EdgeGroup data"
// @success 200 {object} portainer.EdgeGroup
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @failure 500
// @router /edge_groups/{id} [put]
func (handler *Handler) edgeGroupUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
diff --git a/api/http/handler/edgejobs/edgejob_create.go b/api/http/handler/edgejobs/edgejob_create.go
index efb826e66..b2c2c8f52 100644
--- a/api/http/handler/edgejobs/edgejob_create.go
+++ b/api/http/handler/edgejobs/edgejob_create.go
@@ -22,10 +22,10 @@ import (
// @accept json
// @produce json
// @param method query string true "Creation Method" Enums(file, string)
-// @param body body edgeJobCreateFromFileContentPayload true "EdgeGroup data when method is string"
-// @param body body edgeJobCreateFromFilePayload true "EdgeGroup data when method is file"
+// @param body_string body edgeJobCreateFromFileContentPayload true "EdgeGroup data when method is string"
+// @param body_file body edgeJobCreateFromFilePayload true "EdgeGroup data when method is file"
// @success 200 {object} portainer.EdgeGroup
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @failure 500
// @router /edge_jobs [post]
func (handler *Handler) edgeJobCreate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
diff --git a/api/http/handler/edgejobs/edgejob_delete.go b/api/http/handler/edgejobs/edgejob_delete.go
index e90d3e1fe..8217dcd39 100644
--- a/api/http/handler/edgejobs/edgejob_delete.go
+++ b/api/http/handler/edgejobs/edgejob_delete.go
@@ -22,7 +22,7 @@ import (
// @success 204
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs/{id} [delete]
func (handler *Handler) edgeJobDelete(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeJobID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgejobs/edgejob_file.go b/api/http/handler/edgejobs/edgejob_file.go
index 85fe20ce2..1b5d4ae29 100644
--- a/api/http/handler/edgejobs/edgejob_file.go
+++ b/api/http/handler/edgejobs/edgejob_file.go
@@ -25,7 +25,7 @@ type edgeJobFileResponse struct {
// @success 200 {object} edgeJobFileResponse
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs/{id}/file [get]
func (handler *Handler) edgeJobFile(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeJobID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgejobs/edgejob_inspect.go b/api/http/handler/edgejobs/edgejob_inspect.go
index c86b8b80b..38c826227 100644
--- a/api/http/handler/edgejobs/edgejob_inspect.go
+++ b/api/http/handler/edgejobs/edgejob_inspect.go
@@ -26,7 +26,7 @@ type edgeJobInspectResponse struct {
// @success 200 {object} portainer.EdgeJob
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs/{id} [get]
func (handler *Handler) edgeJobInspect(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeJobID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgejobs/edgejob_list.go b/api/http/handler/edgejobs/edgejob_list.go
index d3776df18..f2c93ebf1 100644
--- a/api/http/handler/edgejobs/edgejob_list.go
+++ b/api/http/handler/edgejobs/edgejob_list.go
@@ -17,7 +17,7 @@ import (
// @success 200 {array} portainer.EdgeJob
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs [get]
// GET request on /api/edge_jobs
func (handler *Handler) edgeJobList(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
diff --git a/api/http/handler/edgejobs/edgejob_tasklogs_clear.go b/api/http/handler/edgejobs/edgejob_tasklogs_clear.go
index 7a4afd8ab..230b387af 100644
--- a/api/http/handler/edgejobs/edgejob_tasklogs_clear.go
+++ b/api/http/handler/edgejobs/edgejob_tasklogs_clear.go
@@ -23,7 +23,7 @@ import (
// @success 204
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs/{id}/tasks/{taskID}/logs [delete]
func (handler *Handler) edgeJobTasksClear(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeJobID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgejobs/edgejob_tasklogs_collect.go b/api/http/handler/edgejobs/edgejob_tasklogs_collect.go
index e08fe0c8b..919b2ff4c 100644
--- a/api/http/handler/edgejobs/edgejob_tasklogs_collect.go
+++ b/api/http/handler/edgejobs/edgejob_tasklogs_collect.go
@@ -22,7 +22,7 @@ import (
// @success 204
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs/{id}/tasks/{taskID}/logs [post]
func (handler *Handler) edgeJobTasksCollect(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeJobID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgejobs/edgejob_tasklogs_inspect.go b/api/http/handler/edgejobs/edgejob_tasklogs_inspect.go
index d5d25b91b..ce7813d28 100644
--- a/api/http/handler/edgejobs/edgejob_tasklogs_inspect.go
+++ b/api/http/handler/edgejobs/edgejob_tasklogs_inspect.go
@@ -25,7 +25,7 @@ type fileResponse struct {
// @success 200 {object} fileResponse
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs/{id}/tasks/{taskID}/logs [get]
func (handler *Handler) edgeJobTaskLogsInspect(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeJobID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgejobs/edgejob_tasks_list.go b/api/http/handler/edgejobs/edgejob_tasks_list.go
index 769dfc205..6f05946c9 100644
--- a/api/http/handler/edgejobs/edgejob_tasks_list.go
+++ b/api/http/handler/edgejobs/edgejob_tasks_list.go
@@ -28,7 +28,7 @@ type taskContainer struct {
// @success 200 {array} taskContainer
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs/{id}/tasks [get]
func (handler *Handler) edgeJobTasksList(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeJobID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgejobs/edgejob_update.go b/api/http/handler/edgejobs/edgejob_update.go
index a0f473b52..9e2a6eae0 100644
--- a/api/http/handler/edgejobs/edgejob_update.go
+++ b/api/http/handler/edgejobs/edgejob_update.go
@@ -40,7 +40,7 @@ func (payload *edgeJobUpdatePayload) Validate(r *http.Request) error {
// @success 200 {object} portainer.EdgeJob
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs/{id} [post]
func (handler *Handler) edgeJobUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeJobID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgestacks/edgestack_create.go b/api/http/handler/edgestacks/edgestack_create.go
index 4a3f5ce30..dfc952f92 100644
--- a/api/http/handler/edgestacks/edgestack_create.go
+++ b/api/http/handler/edgestacks/edgestack_create.go
@@ -30,7 +30,7 @@ import (
// @param body_repository body swarmStackFromGitRepositoryPayload true "Required when using method=repository"
// @success 200 {object} portainer.EdgeStack
// @failure 500
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_stacks [post]
func (handler *Handler) edgeStackCreate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
method, err := request.RetrieveQueryParameter(r, "method", false)
diff --git a/api/http/handler/edgestacks/edgestack_delete.go b/api/http/handler/edgestacks/edgestack_delete.go
index f9269705b..b9e61d594 100644
--- a/api/http/handler/edgestacks/edgestack_delete.go
+++ b/api/http/handler/edgestacks/edgestack_delete.go
@@ -22,7 +22,7 @@ import (
// @success 204
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_stacks/{id} [delete]
func (handler *Handler) edgeStackDelete(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeStackID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgestacks/edgestack_file.go b/api/http/handler/edgestacks/edgestack_file.go
index e4adee8d8..5584fd806 100644
--- a/api/http/handler/edgestacks/edgestack_file.go
+++ b/api/http/handler/edgestacks/edgestack_file.go
@@ -26,7 +26,7 @@ type stackFileResponse struct {
// @success 200 {object} stackFileResponse
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_stacks/{id}/file [get]
func (handler *Handler) edgeStackFile(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
stackID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgestacks/edgestack_inspect.go b/api/http/handler/edgestacks/edgestack_inspect.go
index c6450f321..463fca874 100644
--- a/api/http/handler/edgestacks/edgestack_inspect.go
+++ b/api/http/handler/edgestacks/edgestack_inspect.go
@@ -21,7 +21,7 @@ import (
// @success 200 {object} portainer.EdgeStack
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_stacks/{id} [get]
func (handler *Handler) edgeStackInspect(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeStackID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/edgestacks/edgestack_list.go b/api/http/handler/edgestacks/edgestack_list.go
index 2d0cb423f..5be73dea1 100644
--- a/api/http/handler/edgestacks/edgestack_list.go
+++ b/api/http/handler/edgestacks/edgestack_list.go
@@ -17,7 +17,7 @@ import (
// @success 200 {array} portainer.EdgeStack
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_stacks [get]
func (handler *Handler) edgeStackList(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
edgeStacks, err := handler.DataStore.EdgeStack().EdgeStacks()
diff --git a/api/http/handler/edgestacks/edgestack_update.go b/api/http/handler/edgestacks/edgestack_update.go
index f2d2bd329..7245c1b8e 100644
--- a/api/http/handler/edgestacks/edgestack_update.go
+++ b/api/http/handler/edgestacks/edgestack_update.go
@@ -43,7 +43,7 @@ func (payload *updateEdgeStackPayload) Validate(r *http.Request) error {
// @success 200 {object} portainer.EdgeStack
// @failure 500
// @failure 400
-// @failure 503 Edge compute features are disabled
+// @failure 503 "Edge compute features are disabled"
// @router /edge_stacks/{id} [put]
func (handler *Handler) edgeStackUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
stackID, err := request.RetrieveNumericRouteVariableValue(r, "id")
diff --git a/api/http/handler/endpointedge/endpoint_edgestack_inspect.go b/api/http/handler/endpointedge/endpoint_edgestack_inspect.go
index 8f749fb1b..b9d7bb452 100644
--- a/api/http/handler/endpointedge/endpoint_edgestack_inspect.go
+++ b/api/http/handler/endpointedge/endpoint_edgestack_inspect.go
@@ -24,7 +24,7 @@ type configResponse struct {
// @accept json
// @produce json
// @param id path string true "Endpoint Id"
-// @param stackID path string true "EdgeStack Id"
+// @param stackId path string true "EdgeStack Id"
// @success 200 {object} configResponse
// @failure 500
// @failure 400
diff --git a/api/http/handler/endpointgroups/endpointgroup_inspect.go b/api/http/handler/endpointgroups/endpointgroup_inspect.go
index e25290669..2cec65bd9 100644
--- a/api/http/handler/endpointgroups/endpointgroup_inspect.go
+++ b/api/http/handler/endpointgroups/endpointgroup_inspect.go
@@ -22,7 +22,7 @@ import (
// @failure 400 "Invalid request"
// @failure 404 "EndpointGroup not found"
// @failure 500 "Server error"
-// @router /endpoint_groups/:id [get]
+// @router /endpoint_groups/{id} [get]
func (handler *Handler) endpointGroupInspect(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
endpointGroupID, err := request.RetrieveNumericRouteVariableValue(r, "id")
if err != nil {
diff --git a/api/http/handler/endpointgroups/endpointgroup_update.go b/api/http/handler/endpointgroups/endpointgroup_update.go
index ab60c289c..bf7708847 100644
--- a/api/http/handler/endpointgroups/endpointgroup_update.go
+++ b/api/http/handler/endpointgroups/endpointgroup_update.go
@@ -41,7 +41,7 @@ func (payload *endpointGroupUpdatePayload) Validate(r *http.Request) error {
// @failure 400 "Invalid request"
// @failure 404 "EndpointGroup not found"
// @failure 500 "Server error"
-// @router /endpoint_groups/:id [put]
+// @router /endpoint_groups/{id} [put]
func (handler *Handler) endpointGroupUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
endpointGroupID, err := request.RetrieveNumericRouteVariableValue(r, "id")
if err != nil {
diff --git a/api/http/handler/endpoints/endpoint_association_delete.go b/api/http/handler/endpoints/endpoint_association_delete.go
index 2ef6fe6c4..cc339d159 100644
--- a/api/http/handler/endpoints/endpoint_association_delete.go
+++ b/api/http/handler/endpoints/endpoint_association_delete.go
@@ -4,14 +4,15 @@ import (
"encoding/base64"
"errors"
"fmt"
+ "net/http"
+ "regexp"
+ "strings"
+
httperror "github.com/portainer/libhttp/error"
"github.com/portainer/libhttp/request"
"github.com/portainer/libhttp/response"
portainer "github.com/portainer/portainer/api"
bolterrors "github.com/portainer/portainer/api/bolt/errors"
- "net/http"
- "regexp"
- "strings"
)
// @id EndpointAssociationDelete
@@ -26,7 +27,7 @@ import (
// @failure 400 "Invalid request"
// @failure 404 "Endpoint not found"
// @failure 500 "Server error"
-// @router /api/endpoints/:id/association [put]
+// @router /api/endpoints/{id}/association [put]
func (handler *Handler) endpointAssociationDelete(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
endpointID, err := request.RetrieveNumericRouteVariableValue(r, "id")
if err != nil {
@@ -84,5 +85,5 @@ func (handler *Handler) updateEdgeKey(edgeKey string) (string, error) {
func getPort(url string) string {
items := strings.Split(url, ":")
- return items[len(items) - 1]
+ return items[len(items)-1]
}
diff --git a/api/http/handler/endpoints/endpoint_list.go b/api/http/handler/endpoints/endpoint_list.go
index 5f8b1b5d6..6fd549a2d 100644
--- a/api/http/handler/endpoints/endpoint_list.go
+++ b/api/http/handler/endpoints/endpoint_list.go
@@ -31,7 +31,7 @@ import (
// @param tagsPartialMatch query bool false "If true, will return endpoint which has one of tagIds, if false (or missing) will return only endpoints that has all the tags"
// @param endpointIds query []int false "will return only these endpoints"
// @success 200 {array} portainer.Endpoint "Endpoints"
-// @failure 500 Server error
+// @failure 500 "Server error"
// @router /endpoints [get]
func (handler *Handler) endpointList(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
start, _ := request.RetrieveNumericQueryParameter(r, "start", true)
diff --git a/api/http/handler/endpoints/endpoint_settings_update.go b/api/http/handler/endpoints/endpoint_settings_update.go
index 116868a6e..1770f5d68 100644
--- a/api/http/handler/endpoints/endpoint_settings_update.go
+++ b/api/http/handler/endpoints/endpoint_settings_update.go
@@ -49,7 +49,7 @@ func (payload *endpointSettingsUpdatePayload) Validate(r *http.Request) error {
// @failure 400 "Invalid request"
// @failure 404 "Endpoint not found"
// @failure 500 "Server error"
-// @router /api/endpoints/:id/settings [put]
+// @router /api/endpoints/{id}/settings [put]
func (handler *Handler) endpointSettingsUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
endpointID, err := request.RetrieveNumericRouteVariableValue(r, "id")
if err != nil {
diff --git a/api/http/handler/handler.go b/api/http/handler/handler.go
index dbd2c6c20..ec8a32e0c 100644
--- a/api/http/handler/handler.go
+++ b/api/http/handler/handler.go
@@ -78,8 +78,8 @@ type Handler struct {
// @contact.email info@portainer.io
-// @license.name
-// @license.url
+// @license.name zlib
+// @license.url https://github.com/portainer/portainer/blob/develop/LICENSE
// @host
// @BasePath /api
@@ -121,8 +121,6 @@ type Handler struct {
// @tag.description Manage Portainer settings
// @tag.name status
// @tag.description Information about the Portainer instance
-// @tag.name stacks
-// @tag.description Manage Docker stacks
// @tag.name users
// @tag.description Manage users
// @tag.name tags
diff --git a/api/http/handler/helm/helm_delete.go b/api/http/handler/helm/helm_delete.go
index 7939c253f..c4a9234fe 100644
--- a/api/http/handler/helm/helm_delete.go
+++ b/api/http/handler/helm/helm_delete.go
@@ -17,14 +17,15 @@ import (
// @security jwt
// @accept json
// @produce json
-// @param release query string true "The name of the release/application to uninstall"
+// @param id path int true "Endpoint identifier"
+// @param release path string true "The name of the release/application to uninstall"
// @param namespace query string true "An optional namespace"
// @success 204 "Success"
// @failure 400 "Invalid endpoint id or bad request"
// @failure 401 "Unauthorized"
// @failure 404 "Endpoint or ServiceAccount not found"
// @failure 500 "Server error or helm error"
-// @router /endpoints/:id/kubernetes/helm/{release} [delete]
+// @router /endpoints/{id}/kubernetes/helm/{release} [delete]
func (handler *Handler) helmDelete(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
release, err := request.RetrieveRouteVariableValue(r, "release")
if err != nil {
diff --git a/api/http/handler/helm/helm_install.go b/api/http/handler/helm/helm_install.go
index 33860ad7f..bf89e99f2 100644
--- a/api/http/handler/helm/helm_install.go
+++ b/api/http/handler/helm/helm_install.go
@@ -36,12 +36,13 @@ var errChartNameInvalid = errors.New("invalid chart name. " +
// @security jwt
// @accept json
// @produce json
+// @param id path int true "Endpoint identifier"
// @param payload body installChartPayload true "Chart details"
// @success 201 {object} release.Release "Created"
// @failure 401 "Unauthorized"
// @failure 404 "Endpoint or ServiceAccount not found"
// @failure 500 "Server error"
-// @router /endpoints/:id/kubernetes/helm [post]
+// @router /endpoints/{id}/kubernetes/helm [post]
func (handler *Handler) helmInstall(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
var payload installChartPayload
err := request.DecodeAndValidateJSONPayload(r, &payload)
diff --git a/api/http/handler/helm/helm_list.go b/api/http/handler/helm/helm_list.go
index f943a31ef..26246920a 100644
--- a/api/http/handler/helm/helm_list.go
+++ b/api/http/handler/helm/helm_list.go
@@ -17,6 +17,7 @@ import (
// @security jwt
// @accept json
// @produce json
+// @param id path int true "Endpoint identifier"
// @param namespace query string true "specify an optional namespace"
// @param filter query string true "specify an optional filter"
// @param selector query string true "specify an optional selector"
@@ -25,7 +26,7 @@ import (
// @failure 401 "Unauthorized"
// @failure 404 "Endpoint or ServiceAccount not found"
// @failure 500 "Server error"
-// @router /endpoints/:id/kubernetes/helm [get]
+// @router /endpoints/{id}/kubernetes/helm [get]
func (handler *Handler) helmList(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
clusterAccess, httperr := handler.getHelmClusterAccess(r)
if httperr != nil {
diff --git a/api/http/handler/helm/helm_show.go b/api/http/handler/helm/helm_show.go
index 220e33ab4..5ae2017ab 100644
--- a/api/http/handler/helm/helm_show.go
+++ b/api/http/handler/helm/helm_show.go
@@ -19,7 +19,7 @@ import (
// @tags helm_chart
// @param repo query string true "Helm repository URL"
// @param chart query string true "Chart name"
-// @param command path string false "chart/values/readme"
+// @param command path string true "chart/values/readme"
// @security jwt
// @accept json
// @produce text/plain
diff --git a/api/http/handler/helm/user_helm_repos.go b/api/http/handler/helm/user_helm_repos.go
index 31df98d78..46eb65db7 100644
--- a/api/http/handler/helm/user_helm_repos.go
+++ b/api/http/handler/helm/user_helm_repos.go
@@ -36,12 +36,13 @@ func (p *addHelmRepoUrlPayload) Validate(_ *http.Request) error {
// @security jwt
// @accept json
// @produce json
+// @param id path int true "Endpoint identifier"
// @param payload body addHelmRepoUrlPayload true "Helm Repository"
// @success 200 {object} portainer.HelmUserRepository "Success"
// @failure 400 "Invalid request"
// @failure 403 "Permission denied"
// @failure 500 "Server error"
-// @router /endpoints/:id/kubernetes/helm/repositories [post]
+// @router /endpoints/{id}/kubernetes/helm/repositories [post]
func (handler *Handler) userCreateHelmRepo(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
tokenData, err := security.RetrieveTokenData(r)
if err != nil {
@@ -99,7 +100,7 @@ func (handler *Handler) userCreateHelmRepo(w http.ResponseWriter, r *http.Reques
// @failure 400 "Invalid request"
// @failure 403 "Permission denied"
// @failure 500 "Server error"
-// @router /endpoints/:id/kubernetes/helm/repositories [get]
+// @router /endpoints/{id}/kubernetes/helm/repositories [get]
func (handler *Handler) userGetHelmRepos(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
tokenData, err := security.RetrieveTokenData(r)
if err != nil {
diff --git a/api/http/handler/stacks/stack_create.go b/api/http/handler/stacks/stack_create.go
index 64132b617..a4f96f89c 100644
--- a/api/http/handler/stacks/stack_create.go
+++ b/api/http/handler/stacks/stack_create.go
@@ -36,7 +36,7 @@ func (handler *Handler) cleanUp(stack *portainer.Stack, doCleanUp *bool) error {
// @description **Access policy**: restricted
// @tags stacks
// @security jwt
-// @accept json, multipart/form-data
+// @accept json,multipart/form-data
// @produce json
// @param type query int true "Stack deployment type. Possible values: 1 (Swarm stack) or 2 (Compose stack)." Enums(1,2)
// @param method query string true "Stack deployment method. Possible values: file, string or repository." Enums(string, file, repository)
diff --git a/api/http/handler/stacks/stack_update_git_redeploy.go b/api/http/handler/stacks/stack_update_git_redeploy.go
index 9b9d485ee..cebba9cdc 100644
--- a/api/http/handler/stacks/stack_update_git_redeploy.go
+++ b/api/http/handler/stacks/stack_update_git_redeploy.go
@@ -53,7 +53,7 @@ func (payload *stackGitRedployPayload) Validate(r *http.Request) error {
// @failure 403 "Permission denied"
// @failure 404 "Not found"
// @failure 500 "Server error"
-// @router /stacks/:id/git/redeploy [put]
+// @router /stacks/{id}/git/redeploy [put]
func (handler *Handler) stackGitRedeploy(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
stackID, err := request.RetrieveNumericRouteVariableValue(r, "id")
if err != nil {
diff --git a/api/http/handler/teams/team_delete.go b/api/http/handler/teams/team_delete.go
index bc51128d1..36b3c4aee 100644
--- a/api/http/handler/teams/team_delete.go
+++ b/api/http/handler/teams/team_delete.go
@@ -17,6 +17,7 @@ import (
// @description **Access policy**: administrator
// @tags teams
// @security jwt
+// @param id path string true "Team Id"
// @success 204 "Success"
// @failure 400 "Invalid request"
// @failure 403 "Permission denied"
diff --git a/api/http/handler/teams/team_memberships.go b/api/http/handler/teams/team_memberships.go
index 03b86ce62..422ef2ac5 100644
--- a/api/http/handler/teams/team_memberships.go
+++ b/api/http/handler/teams/team_memberships.go
@@ -18,6 +18,7 @@ import (
// @tags team_memberships
// @security jwt
// @produce json
+// @param id path string true "Team Id"
// @success 200 {array} portainer.TeamMembership "Success"
// @failure 400 "Invalid request"
// @failure 403 "Permission denied"
From c7760b7d48e2a2c67e003552c6ea685e952f0a74 Mon Sep 17 00:00:00 2001
From: zees-dev <63374656+zees-dev@users.noreply.github.com>
Date: Tue, 14 Sep 2021 09:46:59 +1200
Subject: [PATCH 15/26] - setting port 9443 as primary (#5610)
- updated markdown files
- updated dockerfiles
- updated test files
- updated webpack
---
.github/ISSUE_TEMPLATE.md | 16 +++++++---------
.github/ISSUE_TEMPLATE/Bug_report.md | 3 +--
CONTRIBUTING.md | 2 +-
.../views/endpoints/create/createendpoint.html | 6 +++---
build/linux/Dockerfile | 1 +
build/linux/alpine.Dockerfile | 1 +
build/linux/dev-toolkit/toolkit.Dockerfile | 1 +
build/windows/Dockerfile | 1 +
test/e2e/cypress.json | 2 +-
.../components/startContainerController.spec.js | 10 +++++-----
webpack/webpack.common.js | 2 +-
11 files changed, 23 insertions(+), 22 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 811f71a04..221d4eb1d 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -28,17 +28,15 @@ Briefly describe the problem you are having in a few paragraphs.
**Steps to reproduce the issue:**
-1.
-2.
-3.
+1. 2. 3.
Any other info e.g. Why do you consider this to be a bug? What did you expect to happen instead?
**Technical details:**
-* Portainer version:
-* Target Docker version (the host/cluster you manage):
-* Platform (windows/linux):
-* Command used to start Portainer (`docker run -p 9000:9000 portainer/portainer`):
-* Target Swarm version (if applicable):
-* Browser:
+- Portainer version:
+- Target Docker version (the host/cluster you manage):
+- Platform (windows/linux):
+- Command used to start Portainer (`docker run -p 9443:9443 portainer/portainer`):
+- Target Swarm version (if applicable):
+- Browser:
diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md
index 52a031d48..1d950b9ac 100644
--- a/.github/ISSUE_TEMPLATE/Bug_report.md
+++ b/.github/ISSUE_TEMPLATE/Bug_report.md
@@ -4,7 +4,6 @@ about: Create a bug report
title: ''
labels: bug/need-confirmation, kind/bug
assignees: ''
-
---
