Docker/portainer
Docker/portainer
1
0
Fork 0
mirror of https://github.com/portainer/portainer.git synced 2025-07-20 13:59:40 +02:00
Code Issues Releases Activity

feat(edge/templates): introduce edge specific settings [EE-6276] (#10609)

Browse source
This commit is contained in:
Chaim Lev-Ari 2023-11-15 14:43:18 +02:00 • committed by GitHub
parent 68950fbb24
commit e43d076269
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
42 changed files with 885 additions and 319 deletions
Download patch file Download diff file Expand all files Collapse all files

74
app/react/edge/edge-stacks/queries/useCreateEdgeStack/createStackFromGit.ts Normal file
View file

@ -0,0 +1,74 @@
import axios, { parseAxiosError } from '@/portainer/services/axios';
import { RegistryId } from '@/react/portainer/registries/types';
import { Pair } from '@/react/portainer/settings/types';
import { EdgeGroup } from '@/react/edge/edge-groups/types';
import { AutoUpdateModel } from '@/react/portainer/gitops/types';
import { DeploymentType, EdgeStack, StaggerConfig } from '../../types';
import { buildUrl } from '../buildUrl';
/**
* Payload to create an EdgeStack from a git repository
*/
export type GitRepositoryPayload = {
/** Name of the stack */
name: string;
/** URL of a Git repository hosting the Stack file */
repositoryUrl: string;
/** Reference name of a Git repository hosting the Stack file */
repositoryReferenceName?: string;
/** Use basic authentication to clone the Git repository */
repositoryAuthentication?: boolean;
/** Username used in basic authentication. Required when RepositoryAuthentication is true. */
repositoryUsername?: string;
/** Password used in basic authentication. Required when RepositoryAuthentication is true. */
repositoryPassword?: string;
/** GitCredentialID used to identify the binded git credential */
repositoryGitCredentialId?: number;
/** Path to the Stack file inside the Git repository */
filePathInRepository?: string;
/** List of identifiers of EdgeGroups */
edgeGroups: Array<EdgeGroup['Id']>;
/** Deployment type to deploy this stack. Valid values are: 0 - 'compose', 1 - 'kubernetes', 2 - 'nomad'. Compose is enabled only for docker environments, kubernetes is enabled only for kubernetes environments, nomad is enabled only for nomad environments */
deploymentType: DeploymentType;
/** List of Registries to use for this stack */
registries?: Array<RegistryId>;
/** Uses the manifest's namespaces instead of the default one */
useManifestNamespaces?: boolean;
/** Pre Pull image */
prePullImage?: boolean;
/** Retry deploy */
retryDeploy?: boolean;
/** TLSSkipVerify skips SSL verification when cloning the Git repository */
tlsSkipVerify?: boolean;
/** Optional GitOps update configuration */
autoUpdate?: AutoUpdateModel;
/** Whether the stack supports relative path volume */
supportRelativePath?: boolean;
/** Local filesystem path */
filesystemPath?: string;
/** Whether the edge stack supports per device configs */
supportPerDeviceConfigs?: boolean;
/** Per device configs match type */
perDeviceConfigsMatchType?: string;
/** Per device configs group match type */
perDeviceConfigsGroupMatchType?: string;
/** Per device configs path */
perDeviceConfigsPath?: string;
/** List of environment variables */
envVars?: Array<Pair>;
/** Configuration for stagger updates */
staggerConfig?: StaggerConfig;
};
export async function createStackFromGit(payload: GitRepositoryPayload) {
try {
const { data } = await axios.post<EdgeStack>(
buildUrl(undefined, 'create/repository'),
payload
);
return data;
} catch (e) {
throw parseAxiosError(e as Error);
}
}