@northflank/js-client 0.7.3 → 0.7.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-client.d.ts +1572 -690
- package/dist/cjs/api-client.js +1 -1
- package/dist/esm/api-client.d.ts +1572 -690
- package/dist/esm/api-client.js +1 -1
- package/package.json +1 -1
package/dist/cjs/api-client.d.ts
CHANGED
|
@@ -205,7 +205,7 @@ type ListServicesResult = {
|
|
|
205
205
|
/** Details about the status of the most recent build. */
|
|
206
206
|
'build'?: {
|
|
207
207
|
/** The current status of the build. Example: "SUCCESS" */
|
|
208
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
208
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
209
209
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
210
210
|
'lastTransitionTime'?: string;
|
|
211
211
|
};
|
|
@@ -489,6 +489,281 @@ declare class NorthflankExecCommand {
|
|
|
489
489
|
private assertStartedWithNodejs;
|
|
490
490
|
}
|
|
491
491
|
|
|
492
|
+
type LogsRequestCommon = LogRequestTextFilters & {
|
|
493
|
+
lineLimit?: number;
|
|
494
|
+
startTime?: Date;
|
|
495
|
+
containerName?: string | 'all';
|
|
496
|
+
};
|
|
497
|
+
type LogsRangeRequestData = LogsRequestCommon & {
|
|
498
|
+
direction?: 'forward' | 'backward';
|
|
499
|
+
endTime?: Date;
|
|
500
|
+
duration?: number;
|
|
501
|
+
};
|
|
502
|
+
type LogsTailRequestData = LogsRequestCommon & {
|
|
503
|
+
direction?: never;
|
|
504
|
+
endTime?: never;
|
|
505
|
+
duration?: never;
|
|
506
|
+
};
|
|
507
|
+
type LogsRequestDataTextIncl = {
|
|
508
|
+
textIncludes?: string;
|
|
509
|
+
textNotIncludes?: never;
|
|
510
|
+
regexIncludes?: never;
|
|
511
|
+
regexNotIncludes?: never;
|
|
512
|
+
};
|
|
513
|
+
type LogsRequestDataTextExcl = {
|
|
514
|
+
textIncludes?: never;
|
|
515
|
+
textNotIncludes?: string;
|
|
516
|
+
regexIncludes?: never;
|
|
517
|
+
regexNotIncludes?: never;
|
|
518
|
+
};
|
|
519
|
+
type LogsRequestDataRegexIncl = {
|
|
520
|
+
textIncludes?: never;
|
|
521
|
+
textNotIncludes?: never;
|
|
522
|
+
regexIncludes?: string;
|
|
523
|
+
regexNotIncludes?: never;
|
|
524
|
+
};
|
|
525
|
+
type LogsRequestDataRegexExcl = {
|
|
526
|
+
textIncludes?: never;
|
|
527
|
+
textNotIncludes?: never;
|
|
528
|
+
regexIncludes?: never;
|
|
529
|
+
regexNotIncludes?: string;
|
|
530
|
+
};
|
|
531
|
+
type LogRequestTextFilters = LogsRequestDataTextIncl | LogsRequestDataTextExcl | LogsRequestDataRegexIncl | LogsRequestDataRegexExcl;
|
|
532
|
+
type LogsConfigCommon = {
|
|
533
|
+
projectId: string;
|
|
534
|
+
entityType: 'service' | 'job' | 'addon' | 'build';
|
|
535
|
+
entityId: string;
|
|
536
|
+
buildId?: string;
|
|
537
|
+
};
|
|
538
|
+
type LogsRangeConfig = LogsRangeRequestData & LogsConfigCommon & {
|
|
539
|
+
queryType: 'range';
|
|
540
|
+
};
|
|
541
|
+
type LogsTailConfig = LogsTailRequestData & LogsConfigCommon & {
|
|
542
|
+
queryType: 'tail';
|
|
543
|
+
};
|
|
544
|
+
type LogLine = {
|
|
545
|
+
containerId: string;
|
|
546
|
+
log: any;
|
|
547
|
+
ts: Date;
|
|
548
|
+
};
|
|
549
|
+
interface LogsClient extends EventEmitter {
|
|
550
|
+
on(event: 'logs-received', listener: (logLines: LogLine[]) => any): any;
|
|
551
|
+
on(event: 'error', listener: (error: any) => any): any;
|
|
552
|
+
on(event: 'open', listener: () => any): any;
|
|
553
|
+
on(event: 'close', listener: () => any): any;
|
|
554
|
+
}
|
|
555
|
+
declare class LogsClient extends EventEmitter {
|
|
556
|
+
private readonly baseUrl;
|
|
557
|
+
readonly logsConfig: LogsTailConfig;
|
|
558
|
+
private readonly token;
|
|
559
|
+
private remote;
|
|
560
|
+
private logSession;
|
|
561
|
+
private duplex;
|
|
562
|
+
constructor(baseUrl: string, logsConfig: LogsTailConfig, token: string);
|
|
563
|
+
static getLogsEndpoint(config: LogsTailConfig | LogsRangeConfig): string;
|
|
564
|
+
private get logsEndpoint();
|
|
565
|
+
stop: () => Promise<any>;
|
|
566
|
+
start(): Promise<void>;
|
|
567
|
+
private initialAuth;
|
|
568
|
+
private reset;
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
type ApiCallLogRangeResponse = ApiCallResponse<LogLine[]>;
|
|
572
|
+
declare class NorthflankLogFetch {
|
|
573
|
+
private readonly contextProvider;
|
|
574
|
+
constructor(contextProvider: ApiClientContextProvider);
|
|
575
|
+
/** Fetches service container logs over a specific time span applying optional filters. */
|
|
576
|
+
getServiceLogs(parameters: {
|
|
577
|
+
projectId: string;
|
|
578
|
+
serviceId: string;
|
|
579
|
+
}, data: LogsRangeRequestData): Promise<ApiCallLogRangeResponse>;
|
|
580
|
+
/** Fetches service build container logs over a specific time span applying optional filters. */
|
|
581
|
+
getServiceBuildLogs(parameters: {
|
|
582
|
+
projectId: string;
|
|
583
|
+
serviceId: string;
|
|
584
|
+
buildId: string;
|
|
585
|
+
}, data: LogsRangeRequestData): Promise<ApiCallLogRangeResponse>;
|
|
586
|
+
/** Fetches job container logs over a specific time span applying optional filters. */
|
|
587
|
+
getJobLogs(parameters: {
|
|
588
|
+
projectId: string;
|
|
589
|
+
jobId: string;
|
|
590
|
+
}, data: LogsRangeRequestData): Promise<ApiCallLogRangeResponse>;
|
|
591
|
+
/** Fetches job build container logs over a specific time span applying optional filters. */
|
|
592
|
+
getJobBuildLogs(parameters: {
|
|
593
|
+
projectId: string;
|
|
594
|
+
jobId: string;
|
|
595
|
+
buildId: string;
|
|
596
|
+
}, data: LogsRangeRequestData): Promise<ApiCallLogRangeResponse>;
|
|
597
|
+
/** Fetches addon container logs over a specific time span applying optional filters. */
|
|
598
|
+
getAddonLogs(parameters: {
|
|
599
|
+
projectId: string;
|
|
600
|
+
addonId: string;
|
|
601
|
+
}, data: LogsRangeRequestData): Promise<ApiCallLogRangeResponse>;
|
|
602
|
+
logRange(parameters: {
|
|
603
|
+
projectId: string;
|
|
604
|
+
entityId: string;
|
|
605
|
+
buildId?: string;
|
|
606
|
+
}, data: LogsRangeRequestData, entityType: 'service' | 'job' | 'addon'): Promise<ApiCallLogRangeResponse>;
|
|
607
|
+
tailServiceLogs(parameters: {
|
|
608
|
+
projectId: string;
|
|
609
|
+
serviceId: string;
|
|
610
|
+
}, data: LogsTailRequestData): Promise<LogsClient>;
|
|
611
|
+
/** Starts a log tail on a service build container. */
|
|
612
|
+
tailServiceBuildLogs(parameters: {
|
|
613
|
+
projectId: string;
|
|
614
|
+
serviceId: string;
|
|
615
|
+
buildId: string;
|
|
616
|
+
}, data: LogsTailRequestData): Promise<LogsClient>;
|
|
617
|
+
/** Starts a log tail on a job container. */
|
|
618
|
+
tailJobLogs(parameters: {
|
|
619
|
+
projectId: string;
|
|
620
|
+
jobId: string;
|
|
621
|
+
}, data: LogsTailRequestData): Promise<LogsClient>;
|
|
622
|
+
/** Starts a log tail on a job build container. */
|
|
623
|
+
tailJobBuildLogs(parameters: {
|
|
624
|
+
projectId: string;
|
|
625
|
+
jobId: string;
|
|
626
|
+
buildId: string;
|
|
627
|
+
}, data: LogsTailRequestData): Promise<LogsClient>;
|
|
628
|
+
/** Starts a log tail on an addon container. */
|
|
629
|
+
tailAddonLogs(parameters: {
|
|
630
|
+
projectId: string;
|
|
631
|
+
addonId: string;
|
|
632
|
+
}, data: LogsTailRequestData): Promise<LogsClient>;
|
|
633
|
+
/** Starts a log tail. */
|
|
634
|
+
logTail(parameters: {
|
|
635
|
+
projectId: string;
|
|
636
|
+
entityId: string;
|
|
637
|
+
buildId?: string;
|
|
638
|
+
}, data: LogsTailRequestData, entityType: 'service' | 'job' | 'addon'): Promise<LogsClient>;
|
|
639
|
+
private assertStartedWithNodejs;
|
|
640
|
+
}
|
|
641
|
+
|
|
642
|
+
type ApiCallMetricsResponse = ApiCallResponse<Record<MetricType, MetricsEntry>>;
|
|
643
|
+
declare enum MetricType {
|
|
644
|
+
Cpu = "cpu",
|
|
645
|
+
Memory = "memory",
|
|
646
|
+
NetworkIngress = "networkIngress",
|
|
647
|
+
NetworkEgress = "networkEgress",
|
|
648
|
+
TcpConnectionOpen = "tcpConnectionsOpen",
|
|
649
|
+
PvcUsage = "diskUsage",
|
|
650
|
+
Requests = "requests",
|
|
651
|
+
Http4xxResponses = "http4xxResponses",
|
|
652
|
+
Http5xxResponses = "http5xxResponses"
|
|
653
|
+
}
|
|
654
|
+
type MetricUnit = 'pct' | 'vCPU' | 'mb' | 'kbps' | 'rps' | 'count';
|
|
655
|
+
type MetricValue = {
|
|
656
|
+
metadata: {
|
|
657
|
+
containerId: string;
|
|
658
|
+
volumeId?: string;
|
|
659
|
+
};
|
|
660
|
+
data: {
|
|
661
|
+
value: string;
|
|
662
|
+
ts: Date;
|
|
663
|
+
}[];
|
|
664
|
+
};
|
|
665
|
+
type MetricsEntry = {
|
|
666
|
+
metricInfo: {
|
|
667
|
+
metricId: MetricType;
|
|
668
|
+
metricUnit: MetricUnit;
|
|
669
|
+
metricResolution?: number;
|
|
670
|
+
};
|
|
671
|
+
values: MetricValue[];
|
|
672
|
+
};
|
|
673
|
+
type MetricsRequestCommon = {
|
|
674
|
+
containerName?: string | 'all';
|
|
675
|
+
metricTypes: MetricType[];
|
|
676
|
+
};
|
|
677
|
+
type MetricsRangeRequestData = MetricsRequestCommon & {
|
|
678
|
+
startTime?: Date;
|
|
679
|
+
endTime?: Date;
|
|
680
|
+
timestamp?: never;
|
|
681
|
+
duration?: number;
|
|
682
|
+
};
|
|
683
|
+
type MetricsSingleRequestData = MetricsRequestCommon & {
|
|
684
|
+
timestamp?: Date;
|
|
685
|
+
startTime?: never;
|
|
686
|
+
endTime?: never;
|
|
687
|
+
duration?: never;
|
|
688
|
+
};
|
|
689
|
+
type MetricsConfigCommon = {
|
|
690
|
+
projectId: string;
|
|
691
|
+
entityType: 'service' | 'job' | 'addon' | 'build';
|
|
692
|
+
entityId: string;
|
|
693
|
+
buildId?: string;
|
|
694
|
+
};
|
|
695
|
+
type MetricsSingleConfig = MetricsSingleRequestData & MetricsConfigCommon & {
|
|
696
|
+
queryType: 'single';
|
|
697
|
+
};
|
|
698
|
+
declare class NorthflankMetricFetch {
|
|
699
|
+
private readonly contextProvider;
|
|
700
|
+
constructor(contextProvider: ApiClientContextProvider);
|
|
701
|
+
/** Fetches service container metrics over a specific time span applying optional filters. */
|
|
702
|
+
getServiceMetrics(parameters: {
|
|
703
|
+
projectId: string;
|
|
704
|
+
serviceId: string;
|
|
705
|
+
}, data: MetricsSingleRequestData): Promise<ApiCallMetricsResponse>;
|
|
706
|
+
/** Fetches service build container metrics over a specific time span applying optional filters. */
|
|
707
|
+
getServiceBuildMetrics(parameters: {
|
|
708
|
+
projectId: string;
|
|
709
|
+
serviceId: string;
|
|
710
|
+
buildId: string;
|
|
711
|
+
}, data: MetricsSingleRequestData): Promise<ApiCallMetricsResponse>;
|
|
712
|
+
/** Fetches job container metrics over a specific time span applying optional filters. */
|
|
713
|
+
getJobMetrics(parameters: {
|
|
714
|
+
projectId: string;
|
|
715
|
+
jobId: string;
|
|
716
|
+
}, data: MetricsSingleRequestData): Promise<ApiCallMetricsResponse>;
|
|
717
|
+
/** Fetches job build container metrics over a specific time span applying optional filters. */
|
|
718
|
+
getJobBuildMetrics(parameters: {
|
|
719
|
+
projectId: string;
|
|
720
|
+
jobId: string;
|
|
721
|
+
buildId: string;
|
|
722
|
+
}, data: MetricsSingleRequestData): Promise<ApiCallMetricsResponse>;
|
|
723
|
+
/** Fetches addon container metrics over a specific time span applying optional filters. */
|
|
724
|
+
getAddonMetrics(parameters: {
|
|
725
|
+
projectId: string;
|
|
726
|
+
addonId: string;
|
|
727
|
+
}, data: MetricsSingleConfig): Promise<ApiCallMetricsResponse>;
|
|
728
|
+
metricsSingle(parameters: {
|
|
729
|
+
projectId: string;
|
|
730
|
+
entityId: string;
|
|
731
|
+
}, data: MetricsSingleRequestData, entityType: 'service' | 'job' | 'addon'): Promise<ApiCallMetricsResponse>;
|
|
732
|
+
getServiceMetricsRange(parameters: {
|
|
733
|
+
projectId: string;
|
|
734
|
+
serviceId: string;
|
|
735
|
+
}, data: MetricsRangeRequestData): Promise<ApiCallMetricsResponse>;
|
|
736
|
+
/** Get metrics range for a service build container. */
|
|
737
|
+
getServiceBuildMetricsRange(parameters: {
|
|
738
|
+
projectId: string;
|
|
739
|
+
serviceId: string;
|
|
740
|
+
buildId: string;
|
|
741
|
+
}, data: MetricsRangeRequestData): Promise<ApiCallMetricsResponse>;
|
|
742
|
+
/** Get metrics range for a job container. */
|
|
743
|
+
getJobMetricsRange(parameters: {
|
|
744
|
+
projectId: string;
|
|
745
|
+
jobId: string;
|
|
746
|
+
}, data: MetricsRangeRequestData): Promise<ApiCallMetricsResponse>;
|
|
747
|
+
/** Get metrics range for a job build container. */
|
|
748
|
+
getJobBuildMetricsRange(parameters: {
|
|
749
|
+
projectId: string;
|
|
750
|
+
jobId: string;
|
|
751
|
+
buildId: string;
|
|
752
|
+
}, data: MetricsRangeRequestData): Promise<ApiCallMetricsResponse>;
|
|
753
|
+
/** Get metrics range for an addon container. */
|
|
754
|
+
getAddonMetricsRange(parameters: {
|
|
755
|
+
projectId: string;
|
|
756
|
+
addonId: string;
|
|
757
|
+
}, data: MetricsRangeRequestData): Promise<ApiCallMetricsResponse>;
|
|
758
|
+
/** Fetches a series of metrics over a timerange. */
|
|
759
|
+
metricsRange(parameters: {
|
|
760
|
+
projectId: string;
|
|
761
|
+
entityId: string;
|
|
762
|
+
buildId?: string;
|
|
763
|
+
}, data: MetricsRangeRequestData, entityType: 'service' | 'job' | 'addon'): Promise<ApiCallMetricsResponse>;
|
|
764
|
+
private getMetrics;
|
|
765
|
+
}
|
|
766
|
+
|
|
492
767
|
type ListProjectsResult = {
|
|
493
768
|
/** An array of projects. */
|
|
494
769
|
'projects': {
|
|
@@ -522,10 +797,23 @@ declare class ListProjectsEndpoint extends GetApiEndpoint<ListProjectsRequest, L
|
|
|
522
797
|
}
|
|
523
798
|
|
|
524
799
|
type CreateProjectResult = {
|
|
525
|
-
/**
|
|
526
|
-
'
|
|
527
|
-
/**
|
|
528
|
-
'
|
|
800
|
+
/** The name of the project. Example: "New Project" */
|
|
801
|
+
'name': string;
|
|
802
|
+
/** The description of the project. Example: "This is a new project." */
|
|
803
|
+
'description'?: string;
|
|
804
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
805
|
+
'color'?: string;
|
|
806
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
807
|
+
'region'?: string;
|
|
808
|
+
} | {
|
|
809
|
+
/** The name of the project. Example: "New Project" */
|
|
810
|
+
'name': string;
|
|
811
|
+
/** The description of the project. Example: "This is a new project." */
|
|
812
|
+
'description'?: string;
|
|
813
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
814
|
+
'color'?: string;
|
|
815
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
816
|
+
'clusterId'?: string;
|
|
529
817
|
};
|
|
530
818
|
type CreateProjectCall = (opts: CreateProjectRequest) => Promise<ApiCallResponse<CreateProjectResult>>;
|
|
531
819
|
type CreateProjectRequest = {
|
|
@@ -649,57 +937,64 @@ declare class DeleteProjectEndpoint extends DeleteApiEndpoint<DeleteProjectReque
|
|
|
649
937
|
}
|
|
650
938
|
|
|
651
939
|
type CreateAddonResult = {
|
|
652
|
-
/**
|
|
653
|
-
'id': string;
|
|
654
|
-
/** Addon name. Example: "Example Addon" */
|
|
940
|
+
/** The name of the addon. Example: "Example Addon" */
|
|
655
941
|
'name': string;
|
|
656
|
-
/**
|
|
657
|
-
'appId': string;
|
|
658
|
-
/** A short description of the addon. Example: "This is the addon description" */
|
|
942
|
+
/** A description of the addon. Example: "An addon description" */
|
|
659
943
|
'description'?: string;
|
|
660
|
-
/**
|
|
661
|
-
'
|
|
662
|
-
/**
|
|
663
|
-
'
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
};
|
|
944
|
+
/** An array of previously defined tags to help identify and group the resource. */
|
|
945
|
+
'tags'?: string[];
|
|
946
|
+
/** The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint. Example: "postgres" */
|
|
947
|
+
'type': string;
|
|
948
|
+
/** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest`, the addon will be created with the most recent minor version belonging to that major version. Example: "latest" */
|
|
949
|
+
'version': string;
|
|
950
|
+
'billing': {
|
|
951
|
+
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
952
|
+
'deploymentPlan': string;
|
|
953
|
+
/** The type of storage. Only configurable if the relevant feature flag is enabled for you account Example: "ssd" */
|
|
954
|
+
'storageClass'?: 'ssd' | 'hdd';
|
|
955
|
+
/** The size of the addon storage, in megabytes. Example: 4096 */
|
|
956
|
+
'storage': number;
|
|
957
|
+
/** The number of addon replicas to run. Example: 1 */
|
|
958
|
+
'replicas': number;
|
|
959
|
+
};
|
|
960
|
+
/** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
|
|
961
|
+
'source'?: {
|
|
962
|
+
/** ID of the addon to fork. Example: "existing-addon" */
|
|
963
|
+
'addonId': string;
|
|
964
|
+
/** ID of a backup belonging to that addon to use for the fork. Example: "existing-backup" */
|
|
965
|
+
'backupId': string;
|
|
966
|
+
};
|
|
967
|
+
/** Enables access to the addon via TLS (if supported by the addon type). */
|
|
968
|
+
'tlsEnabled'?: boolean;
|
|
969
|
+
/** Enables external access to the addon via TLS (if supported by the addon type). */
|
|
970
|
+
'externalAccessEnabled'?: boolean;
|
|
971
|
+
/** An array of IP address policies. */
|
|
972
|
+
'ipPolicies'?: {
|
|
973
|
+
/** An array of IP addresses used for this rule */
|
|
974
|
+
'addresses': string[];
|
|
975
|
+
/** The action for this rule. Example: "DENY" */
|
|
976
|
+
'action': 'ALLOW' | 'DENY';
|
|
977
|
+
}[];
|
|
978
|
+
/** Enables point-in-time recovery (PITR) for the addon (if supported by the addon type). */
|
|
979
|
+
'pitrEnabled'?: boolean;
|
|
980
|
+
'typeSpecificSettings'?: {
|
|
981
|
+
/** Postgres only: enable high-availability mode. */
|
|
982
|
+
'postgresHAEnabled'?: boolean;
|
|
700
983
|
};
|
|
701
|
-
|
|
984
|
+
'customCredentials'?: {
|
|
985
|
+
/** Custom database name. Not supported for all addon types. */
|
|
986
|
+
'dbName'?: string;
|
|
987
|
+
};
|
|
988
|
+
/** Identifier for the addon. Example: "example-addon" */
|
|
989
|
+
'id': string;
|
|
990
|
+
/** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
|
|
991
|
+
'appId': string;
|
|
992
|
+
/** The current state of the addon. Example: "running" */
|
|
702
993
|
'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'backup' | 'restore' | 'failed' | 'deleting' | 'deleted';
|
|
994
|
+
/** time of creation */
|
|
995
|
+
'createdAt'?: string;
|
|
996
|
+
/** time of update */
|
|
997
|
+
'updatedAt'?: string;
|
|
703
998
|
};
|
|
704
999
|
type CreateAddonCall = (opts: CreateAddonRequest) => Promise<ApiCallResponse<CreateAddonResult>>;
|
|
705
1000
|
type CreateAddonRequest = {
|
|
@@ -754,6 +1049,10 @@ type CreateAddonData = {
|
|
|
754
1049
|
/** Postgres only: enable high-availability mode. */
|
|
755
1050
|
'postgresHAEnabled'?: boolean;
|
|
756
1051
|
};
|
|
1052
|
+
'customCredentials'?: {
|
|
1053
|
+
/** Custom database name. Not supported for all addon types. */
|
|
1054
|
+
'dbName'?: string;
|
|
1055
|
+
};
|
|
757
1056
|
};
|
|
758
1057
|
/** Creates a new addon */
|
|
759
1058
|
declare class CreateAddonEndpoint extends PostApiEndpoint<CreateAddonRequest, CreateAddonResult> {
|
|
@@ -809,6 +1108,10 @@ type PutAddonResult = {
|
|
|
809
1108
|
/** Postgres only: enable high-availability mode. */
|
|
810
1109
|
'postgresHAEnabled'?: boolean;
|
|
811
1110
|
};
|
|
1111
|
+
'customCredentials'?: {
|
|
1112
|
+
/** Custom database name. Not supported for all addon types. */
|
|
1113
|
+
'dbName'?: string;
|
|
1114
|
+
};
|
|
812
1115
|
/** Identifier for the addon. Example: "example-addon" */
|
|
813
1116
|
'id': string;
|
|
814
1117
|
/** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
|
|
@@ -873,6 +1176,10 @@ type PutAddonData = {
|
|
|
873
1176
|
/** Postgres only: enable high-availability mode. */
|
|
874
1177
|
'postgresHAEnabled'?: boolean;
|
|
875
1178
|
};
|
|
1179
|
+
'customCredentials'?: {
|
|
1180
|
+
/** Custom database name. Not supported for all addon types. */
|
|
1181
|
+
'dbName'?: string;
|
|
1182
|
+
};
|
|
876
1183
|
};
|
|
877
1184
|
/** Creates or updates an addon */
|
|
878
1185
|
declare class PutAddonEndpoint extends PutApiEndpoint<PutAddonRequest, PutAddonResult> {
|
|
@@ -999,6 +1306,10 @@ type PatchAddonResult = {
|
|
|
999
1306
|
/** Postgres only: enable high-availability mode. */
|
|
1000
1307
|
'postgresHAEnabled'?: boolean;
|
|
1001
1308
|
};
|
|
1309
|
+
'customCredentials'?: {
|
|
1310
|
+
/** Custom database name. Not supported for all addon types. */
|
|
1311
|
+
'dbName'?: string;
|
|
1312
|
+
};
|
|
1002
1313
|
/** Identifier for the addon. Example: "example-addon" */
|
|
1003
1314
|
'id': string;
|
|
1004
1315
|
/** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
|
|
@@ -2570,6 +2881,20 @@ type CreateClusterData = {
|
|
|
2570
2881
|
/** Plan to use for builds if they are run on the cluster Example: "nf-compute-200" */
|
|
2571
2882
|
'plan'?: string;
|
|
2572
2883
|
};
|
|
2884
|
+
'registry'?: {
|
|
2885
|
+
'mode'?: 'paas' | 'self-hosted';
|
|
2886
|
+
/** Credentials to use for storing of images. Example: "my-registry-credentials" */
|
|
2887
|
+
'registryId'?: string;
|
|
2888
|
+
};
|
|
2889
|
+
'logging'?: {
|
|
2890
|
+
'mode'?: 'paas' | 'loki';
|
|
2891
|
+
'loki'?: {
|
|
2892
|
+
's3BucketName': string;
|
|
2893
|
+
's3AccessKey': string;
|
|
2894
|
+
's3SecretKey': string;
|
|
2895
|
+
's3Region': string;
|
|
2896
|
+
} | any;
|
|
2897
|
+
};
|
|
2573
2898
|
/** Request modifiers to use for different resources. */
|
|
2574
2899
|
'requestModifiers'?: {
|
|
2575
2900
|
/** Request modifiers for services */
|
|
@@ -2767,6 +3092,20 @@ type UpdateClusterData = {
|
|
|
2767
3092
|
/** Plan to use for builds if they are run on the cluster Example: "nf-compute-200" */
|
|
2768
3093
|
'plan'?: string;
|
|
2769
3094
|
};
|
|
3095
|
+
'registry'?: {
|
|
3096
|
+
'mode'?: 'paas' | 'self-hosted';
|
|
3097
|
+
/** Credentials to use for storing of images. Example: "my-registry-credentials" */
|
|
3098
|
+
'registryId'?: string;
|
|
3099
|
+
};
|
|
3100
|
+
'logging'?: {
|
|
3101
|
+
'mode'?: 'paas' | 'loki';
|
|
3102
|
+
'loki'?: {
|
|
3103
|
+
's3BucketName': string;
|
|
3104
|
+
's3AccessKey': string;
|
|
3105
|
+
's3SecretKey': string;
|
|
3106
|
+
's3Region': string;
|
|
3107
|
+
} | any;
|
|
3108
|
+
};
|
|
2770
3109
|
/** Request modifiers to use for different resources. */
|
|
2771
3110
|
'requestModifiers'?: {
|
|
2772
3111
|
/** Request modifiers for services */
|
|
@@ -2837,6 +3176,8 @@ type ListJobsResult = {
|
|
|
2837
3176
|
'disabledCI': boolean;
|
|
2838
3177
|
/** Whether Continuous Deployment is disabled */
|
|
2839
3178
|
'disabledCD': boolean;
|
|
3179
|
+
/** Cron specific. Whether or not the job's automatic scheduling is suspended */
|
|
3180
|
+
'suspended'?: boolean;
|
|
2840
3181
|
}[];
|
|
2841
3182
|
};
|
|
2842
3183
|
type ListJobsCall = (opts: ListJobsRequest) => Promise<ApiCallResponse<ListJobsResult>>;
|
|
@@ -2974,6 +3315,8 @@ type GetJobResult = {
|
|
|
2974
3315
|
/** ID of the billing plan used by this job Example: "nf-compute-20" */
|
|
2975
3316
|
'deploymentPlan': string;
|
|
2976
3317
|
};
|
|
3318
|
+
/** Cron specific. Whether or not the job's automatic scheduling is suspended */
|
|
3319
|
+
'suspended'?: boolean;
|
|
2977
3320
|
/** Job settings */
|
|
2978
3321
|
'settings': {
|
|
2979
3322
|
/** Cron job specific settings */
|
|
@@ -3027,125 +3370,172 @@ declare class DeleteJobEndpoint extends DeleteApiEndpoint<DeleteJobRequest, Dele
|
|
|
3027
3370
|
}
|
|
3028
3371
|
|
|
3029
3372
|
type CreateJobManualResult = {
|
|
3030
|
-
/**
|
|
3031
|
-
'id': string;
|
|
3032
|
-
/** Full identifier used for job deployment Example: "/example-user/default-project/example-job" */
|
|
3033
|
-
'appId': string;
|
|
3034
|
-
/** Job name Example: "Example Job" */
|
|
3373
|
+
/** The name of the job. Example: "Example Job" */
|
|
3035
3374
|
'name': string;
|
|
3036
|
-
/** A
|
|
3375
|
+
/** A description of the job. Example: "A job description" */
|
|
3037
3376
|
'description'?: string;
|
|
3038
|
-
/**
|
|
3039
|
-
'
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
/** URL of the repository being built Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
3044
|
-
'projectUrl': string;
|
|
3045
|
-
/** VCS provider for the repo being built Example: "github" */
|
|
3046
|
-
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
3047
|
-
/** ID of the self-hosted VCS, if applicable. Example: "example-team/self-hosted-vcs" */
|
|
3048
|
-
'selfHostedVcsId'?: string;
|
|
3049
|
-
/** Branch of the repo being built Example: "master" */
|
|
3050
|
-
'projectBranch'?: string;
|
|
3051
|
-
/** Whether the repo is being accessed without authentication. */
|
|
3052
|
-
'publicRepo'?: boolean;
|
|
3053
|
-
/** Working directory used by the dockerfile Example: "/" */
|
|
3054
|
-
'dockerWorkDir': string;
|
|
3055
|
-
/** File path of the Dockerfile Example: "/Dockerfile" */
|
|
3056
|
-
'dockerFilePath': string;
|
|
3057
|
-
};
|
|
3058
|
-
'buildConfiguration'?: {
|
|
3059
|
-
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3060
|
-
'pathIgnoreRules'?: string[];
|
|
3061
|
-
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
3062
|
-
'isAllowList'?: boolean;
|
|
3063
|
-
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
3064
|
-
'ciIgnoreFlagsEnabled'?: boolean;
|
|
3065
|
-
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
3066
|
-
'ciIgnoreFlags'?: string[];
|
|
3067
|
-
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
3068
|
-
'dockerfileTarget'?: string;
|
|
3069
|
-
/** Include .git folder inside the build context */
|
|
3070
|
-
'includeGitFolder'?: boolean;
|
|
3071
|
-
/** Include the entire git history as part of the .git folder. Only relevant if "includeGitFolder" is set. */
|
|
3072
|
-
'fullGitClone'?: boolean;
|
|
3377
|
+
/** An array of previously defined tags to help identify and group the resource. */
|
|
3378
|
+
'tags'?: string[];
|
|
3379
|
+
'billing': {
|
|
3380
|
+
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
3381
|
+
'deploymentPlan': string;
|
|
3073
3382
|
};
|
|
3074
|
-
|
|
3075
|
-
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
|
|
3080
|
-
'builder'?: 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
3081
|
-
/** Array of custom Buildpacks used. */
|
|
3082
|
-
'buildpackLocators'?: string[];
|
|
3083
|
-
/** Should build dependencies be cached? */
|
|
3084
|
-
'useCache'?: boolean;
|
|
3085
|
-
};
|
|
3086
|
-
/** Details about Buildkit settings. */
|
|
3087
|
-
'buildkit'?: {
|
|
3088
|
-
/** Should intermediate image layers be cached? */
|
|
3089
|
-
'useCache'?: boolean;
|
|
3090
|
-
};
|
|
3091
|
-
/** Details about Kaniko settings. */
|
|
3092
|
-
'kaniko'?: {
|
|
3093
|
-
/** Should intermediate image layers be cached? */
|
|
3094
|
-
'useCache'?: boolean;
|
|
3095
|
-
};
|
|
3096
|
-
};
|
|
3097
|
-
/** Whether Continuous Integration is disabled */
|
|
3098
|
-
'disabledCI': boolean;
|
|
3099
|
-
/** Whether Continuous Deployment is disabled */
|
|
3100
|
-
'disabledCD': boolean;
|
|
3383
|
+
/** The number of attempts to rerun a job before it is marked as failed. */
|
|
3384
|
+
'backoffLimit': number;
|
|
3385
|
+
/** Configure when the job should be run if the source image changes. Example: "never" */
|
|
3386
|
+
'runOnSourceChange'?: 'never' | 'cd-promote' | 'always';
|
|
3387
|
+
/** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
|
|
3388
|
+
'activeDeadlineSeconds'?: number;
|
|
3101
3389
|
'deployment'?: {
|
|
3102
|
-
/**
|
|
3103
|
-
'region'?: string;
|
|
3104
|
-
/** Details about the Buildpack overrides for this deployment. */
|
|
3390
|
+
/** Allows for customization of buildpack runtime */
|
|
3105
3391
|
'buildpack'?: {
|
|
3106
|
-
/** Type of buildpack run configuration
|
|
3392
|
+
/** Type of buildpack run configuration */
|
|
3107
3393
|
'configType': 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand';
|
|
3108
|
-
/** Custom process which should be run. */
|
|
3394
|
+
/** Custom process which should be run. Required in case where `configType` is `customProcess` */
|
|
3109
3395
|
'customProcess'?: string;
|
|
3110
|
-
/** Custom entrypoint which should be run. */
|
|
3396
|
+
/** Custom entrypoint which should be run. Required in case where `configType` is `customEntrypointCustomCommand` */
|
|
3111
3397
|
'customEntrypoint'?: string;
|
|
3112
|
-
/** Custom command which should be run. */
|
|
3398
|
+
/** Custom command which should be run. Required in case where `configType` is `customCommand`, `customEntrypointCustomCommand` or `originalEntrypointCustomCommand` */
|
|
3113
3399
|
'customCommand'?: string;
|
|
3114
3400
|
};
|
|
3115
|
-
/**
|
|
3401
|
+
/** Allows for customization of docker runtime */
|
|
3116
3402
|
'docker'?: {
|
|
3117
|
-
/**
|
|
3403
|
+
/** Type of entrypoint & command override configuration Example: "default" */
|
|
3118
3404
|
'configType': 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand';
|
|
3119
|
-
/**
|
|
3405
|
+
/** Custom entrypoint which should be used. Required in case where `configType` is `customEntrypoint` or `customEntrypointCustomCommand` */
|
|
3120
3406
|
'customEntrypoint'?: string;
|
|
3121
|
-
/**
|
|
3407
|
+
/** Custom command which should be used. Required in case where `configType` is `customCommand` or `customEntrypointCustomCommand` */
|
|
3122
3408
|
'customCommand'?: string;
|
|
3123
3409
|
};
|
|
3124
|
-
/** Details about storage settings for this deployment. */
|
|
3125
3410
|
'storage'?: {
|
|
3126
|
-
/** Details about ephemeral storage settings for this deployment. */
|
|
3127
3411
|
'ephemeralStorage'?: {
|
|
3128
3412
|
/** Ephemeral storage per container in MB Example: 1024 */
|
|
3129
|
-
'storageSize'
|
|
3413
|
+
'storageSize'?: number;
|
|
3130
3414
|
};
|
|
3131
3415
|
};
|
|
3416
|
+
'vcs'?: {
|
|
3417
|
+
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
3418
|
+
'projectUrl': string;
|
|
3419
|
+
/** The VCS provider to use. Example: "github" */
|
|
3420
|
+
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
3421
|
+
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
3422
|
+
'selfHostedVcsId'?: string;
|
|
3423
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
3424
|
+
'accountLogin'?: string;
|
|
3425
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
3426
|
+
'vcsLinkId'?: string;
|
|
3427
|
+
/** The name of the branch to use. Example: "master" */
|
|
3428
|
+
'projectBranch': string;
|
|
3429
|
+
};
|
|
3430
|
+
'external'?: {
|
|
3431
|
+
/** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
|
|
3432
|
+
'imagePath': string;
|
|
3433
|
+
/** ID of the saved credentials to use to access this external image. Example: "example-credentials" */
|
|
3434
|
+
'credentials'?: string;
|
|
3435
|
+
};
|
|
3436
|
+
'internal'?: {
|
|
3437
|
+
/** ID of the build service to deploy Example: "example-build-service" */
|
|
3438
|
+
'id'?: string;
|
|
3439
|
+
/** Branch to deploy Example: "master" */
|
|
3440
|
+
'branch'?: string;
|
|
3441
|
+
/** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
|
|
3442
|
+
'buildSHA'?: string | 'latest';
|
|
3443
|
+
/** ID of the build that should be deployed Example: "premium-guide-6393" */
|
|
3444
|
+
'buildId'?: string;
|
|
3445
|
+
};
|
|
3132
3446
|
};
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3447
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
3448
|
+
'disabledCI'?: boolean;
|
|
3449
|
+
'buildConfiguration'?: {
|
|
3450
|
+
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3451
|
+
'pathIgnoreRules'?: string[];
|
|
3452
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
3453
|
+
'isAllowList'?: boolean;
|
|
3454
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
3455
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
3456
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
3457
|
+
'ciIgnoreFlags'?: string[];
|
|
3458
|
+
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
3459
|
+
'dockerfileTarget'?: string;
|
|
3460
|
+
/** Include .git folder inside the build context */
|
|
3461
|
+
'includeGitFolder'?: boolean;
|
|
3462
|
+
/** Include the entire git history as part of the .git folder. Only relevant if "includeGitFolder" is set. */
|
|
3463
|
+
'fullGitClone'?: boolean;
|
|
3136
3464
|
};
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3465
|
+
'buildSettings'?: {
|
|
3466
|
+
'dockerfile': {
|
|
3467
|
+
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
3468
|
+
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
3469
|
+
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
3470
|
+
'dockerFilePath': string;
|
|
3471
|
+
/** The working directory of the Dockerfile. Example: "/" */
|
|
3472
|
+
'dockerWorkDir': string;
|
|
3473
|
+
/** Should intermediate image layers be cached? */
|
|
3474
|
+
'useCache'?: boolean;
|
|
3475
|
+
};
|
|
3476
|
+
} | {
|
|
3477
|
+
'buildpack': {
|
|
3478
|
+
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
3479
|
+
'builder'?: 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
3480
|
+
/** Array of custom Buildpacks to use. */
|
|
3481
|
+
'buildpackLocators'?: string[];
|
|
3482
|
+
/** The working directory to build in. Example: "/" */
|
|
3483
|
+
'buildContext'?: string;
|
|
3484
|
+
/** Should build dependencies be cached? */
|
|
3485
|
+
'useCache'?: boolean;
|
|
3486
|
+
};
|
|
3487
|
+
};
|
|
3488
|
+
/** An object containing the runtime environment to set for the job. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"variable1":"abcdef","variable2":"12345"} */
|
|
3489
|
+
'runtimeEnvironment'?: any;
|
|
3490
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
3491
|
+
'runtimeFiles'?: any;
|
|
3492
|
+
/** An object containing the build arguments to set for the job. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"variable1":"abcdef","variable2":"12345"} */
|
|
3493
|
+
'buildArguments'?: any;
|
|
3494
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
3495
|
+
'buildFiles'?: any;
|
|
3496
|
+
/** An array of health checks. */
|
|
3497
|
+
'healthChecks'?: {
|
|
3498
|
+
/** The protocol to access the health check with. Example: "HTTP" */
|
|
3499
|
+
'protocol': 'HTTP' | 'CMD' | 'TCP';
|
|
3500
|
+
/** The type of health check. Example: "readinessProbe" */
|
|
3501
|
+
'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
|
|
3502
|
+
/** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
|
|
3503
|
+
'path'?: string;
|
|
3504
|
+
/** The command to run for the health check. Required when protocol is CMD */
|
|
3505
|
+
'cmd'?: string;
|
|
3506
|
+
/** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
|
|
3507
|
+
'port'?: number;
|
|
3508
|
+
/** Initial delay, in seconds, before the health check is first run. Example: 10 */
|
|
3509
|
+
'initialDelaySeconds': number;
|
|
3510
|
+
/** The time between each check, in seconds. Example: 60 */
|
|
3511
|
+
'periodSeconds': number;
|
|
3512
|
+
/** The time to wait for a response before marking the health check as a failure. Example: 1 */
|
|
3513
|
+
'timeoutSeconds': number;
|
|
3514
|
+
/** The maximum number of allowed failures. Example: 3 */
|
|
3515
|
+
'failureThreshold': number;
|
|
3516
|
+
/** The number of successes required to mark the health check as a success. Example: 1 */
|
|
3517
|
+
'successThreshold'?: number;
|
|
3518
|
+
}[];
|
|
3519
|
+
/** Type of the job (manual or manual) Example: "manual" */
|
|
3520
|
+
'jobType': 'manual';
|
|
3521
|
+
/** Identifier for the job Example: "example-job" */
|
|
3522
|
+
'id': string;
|
|
3523
|
+
/** Full identifier used for job deployment Example: "/example-user/default-project/example-job" */
|
|
3524
|
+
'appId': string;
|
|
3525
|
+
/** Details about the current job status. */
|
|
3526
|
+
'status': {
|
|
3527
|
+
/** Details about the status of the most recent build. */
|
|
3528
|
+
'build'?: {
|
|
3529
|
+
/** The current status of the build. Example: "SUCCESS" */
|
|
3530
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
3531
|
+
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
3532
|
+
'lastTransitionTime'?: string;
|
|
3533
|
+
};
|
|
3146
3534
|
};
|
|
3147
|
-
/**
|
|
3148
|
-
'
|
|
3535
|
+
/** time of creation */
|
|
3536
|
+
'createdAt'?: string;
|
|
3537
|
+
/** time of update */
|
|
3538
|
+
'updatedAt'?: string;
|
|
3149
3539
|
};
|
|
3150
3540
|
type CreateJobManualCall = (opts: CreateJobManualRequest) => Promise<ApiCallResponse<CreateJobManualResult>>;
|
|
3151
3541
|
type CreateJobManualRequest = {
|
|
@@ -3209,6 +3599,8 @@ type CreateJobManualData = {
|
|
|
3209
3599
|
'selfHostedVcsId'?: string;
|
|
3210
3600
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
3211
3601
|
'accountLogin'?: string;
|
|
3602
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
3603
|
+
'vcsLinkId'?: string;
|
|
3212
3604
|
/** The name of the branch to use. Example: "master" */
|
|
3213
3605
|
'projectBranch': string;
|
|
3214
3606
|
};
|
|
@@ -3283,6 +3675,8 @@ type CreateJobManualData = {
|
|
|
3283
3675
|
'buildId'?: string;
|
|
3284
3676
|
};
|
|
3285
3677
|
} | any;
|
|
3678
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
3679
|
+
'disabledCI'?: boolean;
|
|
3286
3680
|
'buildConfiguration'?: {
|
|
3287
3681
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3288
3682
|
'pathIgnoreRules'?: string[];
|
|
@@ -3416,6 +3810,8 @@ type PutJobManualResult = {
|
|
|
3416
3810
|
'selfHostedVcsId'?: string;
|
|
3417
3811
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
3418
3812
|
'accountLogin'?: string;
|
|
3813
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
3814
|
+
'vcsLinkId'?: string;
|
|
3419
3815
|
/** The name of the branch to use. Example: "master" */
|
|
3420
3816
|
'projectBranch': string;
|
|
3421
3817
|
};
|
|
@@ -3436,6 +3832,8 @@ type PutJobManualResult = {
|
|
|
3436
3832
|
'buildId'?: string;
|
|
3437
3833
|
};
|
|
3438
3834
|
};
|
|
3835
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
3836
|
+
'disabledCI'?: boolean;
|
|
3439
3837
|
'buildConfiguration'?: {
|
|
3440
3838
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3441
3839
|
'pathIgnoreRules'?: string[];
|
|
@@ -3517,7 +3915,7 @@ type PutJobManualResult = {
|
|
|
3517
3915
|
/** Details about the status of the most recent build. */
|
|
3518
3916
|
'build'?: {
|
|
3519
3917
|
/** The current status of the build. Example: "SUCCESS" */
|
|
3520
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
3918
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
3521
3919
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
3522
3920
|
'lastTransitionTime'?: string;
|
|
3523
3921
|
};
|
|
@@ -3589,6 +3987,8 @@ type PutJobManualData = {
|
|
|
3589
3987
|
'selfHostedVcsId'?: string;
|
|
3590
3988
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
3591
3989
|
'accountLogin'?: string;
|
|
3990
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
3991
|
+
'vcsLinkId'?: string;
|
|
3592
3992
|
/** The name of the branch to use. Example: "master" */
|
|
3593
3993
|
'projectBranch': string;
|
|
3594
3994
|
};
|
|
@@ -3663,6 +4063,8 @@ type PutJobManualData = {
|
|
|
3663
4063
|
'buildId'?: string;
|
|
3664
4064
|
};
|
|
3665
4065
|
} | any;
|
|
4066
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
4067
|
+
'disabledCI'?: boolean;
|
|
3666
4068
|
'buildConfiguration'?: {
|
|
3667
4069
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3668
4070
|
'pathIgnoreRules'?: string[];
|
|
@@ -3796,6 +4198,8 @@ type PatchJobManualResult = {
|
|
|
3796
4198
|
'selfHostedVcsId'?: string;
|
|
3797
4199
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
3798
4200
|
'accountLogin'?: string;
|
|
4201
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
4202
|
+
'vcsLinkId'?: string;
|
|
3799
4203
|
/** The name of the branch to use. Example: "master" */
|
|
3800
4204
|
'projectBranch': string;
|
|
3801
4205
|
};
|
|
@@ -3816,6 +4220,8 @@ type PatchJobManualResult = {
|
|
|
3816
4220
|
'buildId'?: string;
|
|
3817
4221
|
};
|
|
3818
4222
|
};
|
|
4223
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
4224
|
+
'disabledCI'?: boolean;
|
|
3819
4225
|
'buildConfiguration'?: {
|
|
3820
4226
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3821
4227
|
'pathIgnoreRules'?: string[];
|
|
@@ -3897,7 +4303,7 @@ type PatchJobManualResult = {
|
|
|
3897
4303
|
/** Details about the status of the most recent build. */
|
|
3898
4304
|
'build'?: {
|
|
3899
4305
|
/** The current status of the build. Example: "SUCCESS" */
|
|
3900
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
4306
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
3901
4307
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
3902
4308
|
'lastTransitionTime'?: string;
|
|
3903
4309
|
};
|
|
@@ -3932,6 +4338,8 @@ type PatchJobManualData = {
|
|
|
3932
4338
|
'runOnSourceChange'?: 'never' | 'cd-promote' | 'always';
|
|
3933
4339
|
/** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
|
|
3934
4340
|
'activeDeadlineSeconds'?: number;
|
|
4341
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
4342
|
+
'disabledCI'?: boolean;
|
|
3935
4343
|
'buildConfiguration'?: {
|
|
3936
4344
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3937
4345
|
'pathIgnoreRules'?: string[];
|
|
@@ -4006,131 +4414,178 @@ declare class PatchJobManualEndpoint extends PatchApiEndpoint<PatchJobManualRequ
|
|
|
4006
4414
|
}
|
|
4007
4415
|
|
|
4008
4416
|
type CreateJobCronResult = {
|
|
4009
|
-
/**
|
|
4010
|
-
'id': string;
|
|
4011
|
-
/** Full identifier used for job deployment Example: "/example-user/default-project/example-job" */
|
|
4012
|
-
'appId': string;
|
|
4013
|
-
/** Job name Example: "Example Job" */
|
|
4417
|
+
/** The name of the job. Example: "Example Job" */
|
|
4014
4418
|
'name': string;
|
|
4015
|
-
/** A
|
|
4419
|
+
/** A description of the job. Example: "A job description" */
|
|
4016
4420
|
'description'?: string;
|
|
4017
|
-
/**
|
|
4018
|
-
'
|
|
4019
|
-
|
|
4020
|
-
|
|
4021
|
-
|
|
4022
|
-
/** URL of the repository being built Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
4023
|
-
'projectUrl': string;
|
|
4024
|
-
/** VCS provider for the repo being built Example: "github" */
|
|
4025
|
-
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
4026
|
-
/** ID of the self-hosted VCS, if applicable. Example: "example-team/self-hosted-vcs" */
|
|
4027
|
-
'selfHostedVcsId'?: string;
|
|
4028
|
-
/** Branch of the repo being built Example: "master" */
|
|
4029
|
-
'projectBranch'?: string;
|
|
4030
|
-
/** Whether the repo is being accessed without authentication. */
|
|
4031
|
-
'publicRepo'?: boolean;
|
|
4032
|
-
/** Working directory used by the dockerfile Example: "/" */
|
|
4033
|
-
'dockerWorkDir': string;
|
|
4034
|
-
/** File path of the Dockerfile Example: "/Dockerfile" */
|
|
4035
|
-
'dockerFilePath': string;
|
|
4036
|
-
};
|
|
4037
|
-
'buildConfiguration'?: {
|
|
4038
|
-
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4039
|
-
'pathIgnoreRules'?: string[];
|
|
4040
|
-
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
4041
|
-
'isAllowList'?: boolean;
|
|
4042
|
-
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
4043
|
-
'ciIgnoreFlagsEnabled'?: boolean;
|
|
4044
|
-
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
4045
|
-
'ciIgnoreFlags'?: string[];
|
|
4046
|
-
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
4047
|
-
'dockerfileTarget'?: string;
|
|
4048
|
-
/** Include .git folder inside the build context */
|
|
4049
|
-
'includeGitFolder'?: boolean;
|
|
4050
|
-
/** Include the entire git history as part of the .git folder. Only relevant if "includeGitFolder" is set. */
|
|
4051
|
-
'fullGitClone'?: boolean;
|
|
4421
|
+
/** An array of previously defined tags to help identify and group the resource. */
|
|
4422
|
+
'tags'?: string[];
|
|
4423
|
+
'billing': {
|
|
4424
|
+
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
4425
|
+
'deploymentPlan': string;
|
|
4052
4426
|
};
|
|
4053
|
-
|
|
4054
|
-
|
|
4055
|
-
|
|
4056
|
-
|
|
4427
|
+
/** The number of attempts to rerun a job before it is marked as failed. */
|
|
4428
|
+
'backoffLimit': number;
|
|
4429
|
+
/** Configure when the job should be run if the source image changes. Example: "never" */
|
|
4430
|
+
'runOnSourceChange'?: 'never' | 'cd-promote' | 'always';
|
|
4431
|
+
/** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
|
|
4432
|
+
'activeDeadlineSeconds'?: number;
|
|
4433
|
+
'deployment'?: {
|
|
4434
|
+
/** Allows for customization of buildpack runtime */
|
|
4057
4435
|
'buildpack'?: {
|
|
4058
|
-
/**
|
|
4059
|
-
'builder'?: 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
4060
|
-
/** Array of custom Buildpacks used. */
|
|
4061
|
-
'buildpackLocators'?: string[];
|
|
4062
|
-
/** Should build dependencies be cached? */
|
|
4063
|
-
'useCache'?: boolean;
|
|
4064
|
-
};
|
|
4065
|
-
/** Details about Buildkit settings. */
|
|
4066
|
-
'buildkit'?: {
|
|
4067
|
-
/** Should intermediate image layers be cached? */
|
|
4068
|
-
'useCache'?: boolean;
|
|
4069
|
-
};
|
|
4070
|
-
/** Details about Kaniko settings. */
|
|
4071
|
-
'kaniko'?: {
|
|
4072
|
-
/** Should intermediate image layers be cached? */
|
|
4073
|
-
'useCache'?: boolean;
|
|
4074
|
-
};
|
|
4075
|
-
};
|
|
4076
|
-
/** Whether Continuous Integration is disabled */
|
|
4077
|
-
'disabledCI': boolean;
|
|
4078
|
-
/** Whether Continuous Deployment is disabled */
|
|
4079
|
-
'disabledCD': boolean;
|
|
4080
|
-
'deployment'?: {
|
|
4081
|
-
/** Region where this job is deployed and built Example: "europe-west" */
|
|
4082
|
-
'region'?: string;
|
|
4083
|
-
/** Details about the Buildpack overrides for this deployment. */
|
|
4084
|
-
'buildpack'?: {
|
|
4085
|
-
/** Type of buildpack run configuration. Example: "default" */
|
|
4436
|
+
/** Type of buildpack run configuration */
|
|
4086
4437
|
'configType': 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand';
|
|
4087
|
-
/** Custom process which should be run. */
|
|
4438
|
+
/** Custom process which should be run. Required in case where `configType` is `customProcess` */
|
|
4088
4439
|
'customProcess'?: string;
|
|
4089
|
-
/** Custom entrypoint which should be run. */
|
|
4440
|
+
/** Custom entrypoint which should be run. Required in case where `configType` is `customEntrypointCustomCommand` */
|
|
4090
4441
|
'customEntrypoint'?: string;
|
|
4091
|
-
/** Custom command which should be run. */
|
|
4442
|
+
/** Custom command which should be run. Required in case where `configType` is `customCommand`, `customEntrypointCustomCommand` or `originalEntrypointCustomCommand` */
|
|
4092
4443
|
'customCommand'?: string;
|
|
4093
4444
|
};
|
|
4094
|
-
/**
|
|
4445
|
+
/** Allows for customization of docker runtime */
|
|
4095
4446
|
'docker'?: {
|
|
4096
|
-
/**
|
|
4447
|
+
/** Type of entrypoint & command override configuration Example: "default" */
|
|
4097
4448
|
'configType': 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand';
|
|
4098
|
-
/**
|
|
4449
|
+
/** Custom entrypoint which should be used. Required in case where `configType` is `customEntrypoint` or `customEntrypointCustomCommand` */
|
|
4099
4450
|
'customEntrypoint'?: string;
|
|
4100
|
-
/**
|
|
4451
|
+
/** Custom command which should be used. Required in case where `configType` is `customCommand` or `customEntrypointCustomCommand` */
|
|
4101
4452
|
'customCommand'?: string;
|
|
4102
4453
|
};
|
|
4103
|
-
/** Details about storage settings for this deployment. */
|
|
4104
4454
|
'storage'?: {
|
|
4105
|
-
/** Details about ephemeral storage settings for this deployment. */
|
|
4106
4455
|
'ephemeralStorage'?: {
|
|
4107
4456
|
/** Ephemeral storage per container in MB Example: 1024 */
|
|
4108
|
-
'storageSize'
|
|
4457
|
+
'storageSize'?: number;
|
|
4109
4458
|
};
|
|
4110
4459
|
};
|
|
4460
|
+
'vcs'?: {
|
|
4461
|
+
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
4462
|
+
'projectUrl': string;
|
|
4463
|
+
/** The VCS provider to use. Example: "github" */
|
|
4464
|
+
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
4465
|
+
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
4466
|
+
'selfHostedVcsId'?: string;
|
|
4467
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
4468
|
+
'accountLogin'?: string;
|
|
4469
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
4470
|
+
'vcsLinkId'?: string;
|
|
4471
|
+
/** The name of the branch to use. Example: "master" */
|
|
4472
|
+
'projectBranch': string;
|
|
4473
|
+
};
|
|
4474
|
+
'external'?: {
|
|
4475
|
+
/** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
|
|
4476
|
+
'imagePath': string;
|
|
4477
|
+
/** ID of the saved credentials to use to access this external image. Example: "example-credentials" */
|
|
4478
|
+
'credentials'?: string;
|
|
4479
|
+
};
|
|
4480
|
+
'internal'?: {
|
|
4481
|
+
/** ID of the build service to deploy Example: "example-build-service" */
|
|
4482
|
+
'id'?: string;
|
|
4483
|
+
/** Branch to deploy Example: "master" */
|
|
4484
|
+
'branch'?: string;
|
|
4485
|
+
/** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
|
|
4486
|
+
'buildSHA'?: string | 'latest';
|
|
4487
|
+
/** ID of the build that should be deployed Example: "premium-guide-6393" */
|
|
4488
|
+
'buildId'?: string;
|
|
4489
|
+
};
|
|
4111
4490
|
};
|
|
4112
|
-
|
|
4113
|
-
|
|
4114
|
-
|
|
4491
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
4492
|
+
'disabledCI'?: boolean;
|
|
4493
|
+
'buildConfiguration'?: {
|
|
4494
|
+
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4495
|
+
'pathIgnoreRules'?: string[];
|
|
4496
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
4497
|
+
'isAllowList'?: boolean;
|
|
4498
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
4499
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
4500
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
4501
|
+
'ciIgnoreFlags'?: string[];
|
|
4502
|
+
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
4503
|
+
'dockerfileTarget'?: string;
|
|
4504
|
+
/** Include .git folder inside the build context */
|
|
4505
|
+
'includeGitFolder'?: boolean;
|
|
4506
|
+
/** Include the entire git history as part of the .git folder. Only relevant if "includeGitFolder" is set. */
|
|
4507
|
+
'fullGitClone'?: boolean;
|
|
4115
4508
|
};
|
|
4116
|
-
|
|
4117
|
-
|
|
4118
|
-
|
|
4119
|
-
|
|
4120
|
-
/** The
|
|
4121
|
-
'
|
|
4122
|
-
/**
|
|
4123
|
-
'
|
|
4509
|
+
'buildSettings'?: {
|
|
4510
|
+
'dockerfile': {
|
|
4511
|
+
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
4512
|
+
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
4513
|
+
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
4514
|
+
'dockerFilePath': string;
|
|
4515
|
+
/** The working directory of the Dockerfile. Example: "/" */
|
|
4516
|
+
'dockerWorkDir': string;
|
|
4517
|
+
/** Should intermediate image layers be cached? */
|
|
4518
|
+
'useCache'?: boolean;
|
|
4519
|
+
};
|
|
4520
|
+
} | {
|
|
4521
|
+
'buildpack': {
|
|
4522
|
+
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
4523
|
+
'builder'?: 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
4524
|
+
/** Array of custom Buildpacks to use. */
|
|
4525
|
+
'buildpackLocators'?: string[];
|
|
4526
|
+
/** The working directory to build in. Example: "/" */
|
|
4527
|
+
'buildContext'?: string;
|
|
4528
|
+
/** Should build dependencies be cached? */
|
|
4529
|
+
'useCache'?: boolean;
|
|
4124
4530
|
};
|
|
4125
|
-
/** The number of attempts to rerun a job before it is marked as failed. */
|
|
4126
|
-
'backoffLimit': number;
|
|
4127
|
-
/** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
|
|
4128
|
-
'activeDeadlineSeconds': number;
|
|
4129
4531
|
};
|
|
4532
|
+
/** An object containing the runtime environment to set for the job. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"variable1":"abcdef","variable2":"12345"} */
|
|
4533
|
+
'runtimeEnvironment'?: any;
|
|
4534
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
4535
|
+
'runtimeFiles'?: any;
|
|
4536
|
+
/** An object containing the build arguments to set for the job. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"variable1":"abcdef","variable2":"12345"} */
|
|
4537
|
+
'buildArguments'?: any;
|
|
4538
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
4539
|
+
'buildFiles'?: any;
|
|
4540
|
+
/** An array of health checks. */
|
|
4541
|
+
'healthChecks'?: {
|
|
4542
|
+
/** The protocol to access the health check with. Example: "HTTP" */
|
|
4543
|
+
'protocol': 'HTTP' | 'CMD' | 'TCP';
|
|
4544
|
+
/** The type of health check. Example: "readinessProbe" */
|
|
4545
|
+
'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
|
|
4546
|
+
/** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
|
|
4547
|
+
'path'?: string;
|
|
4548
|
+
/** The command to run for the health check. Required when protocol is CMD */
|
|
4549
|
+
'cmd'?: string;
|
|
4550
|
+
/** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
|
|
4551
|
+
'port'?: number;
|
|
4552
|
+
/** Initial delay, in seconds, before the health check is first run. Example: 10 */
|
|
4553
|
+
'initialDelaySeconds': number;
|
|
4554
|
+
/** The time between each check, in seconds. Example: 60 */
|
|
4555
|
+
'periodSeconds': number;
|
|
4556
|
+
/** The time to wait for a response before marking the health check as a failure. Example: 1 */
|
|
4557
|
+
'timeoutSeconds': number;
|
|
4558
|
+
/** The maximum number of allowed failures. Example: 3 */
|
|
4559
|
+
'failureThreshold': number;
|
|
4560
|
+
/** The number of successes required to mark the health check as a success. Example: 1 */
|
|
4561
|
+
'successThreshold'?: number;
|
|
4562
|
+
}[];
|
|
4563
|
+
/** The cron timer scheduling when to run the job. Example: "30 8 * * *" */
|
|
4564
|
+
'schedule': string;
|
|
4565
|
+
/** Whether the cron's automatic scheduling is suspended */
|
|
4566
|
+
'suspended'?: boolean;
|
|
4567
|
+
/** Whether this job should run when another instance of the job is already running. `allow` will enable multiple instances of this job to run. `forbid` will keep the current instance of the job running and stop a new instance from being run. `replace` will terminate any currently running instance of the job and start a new one. Example: "forbid" */
|
|
4568
|
+
'concurrencyPolicy': 'allow' | 'forbid' | 'replace';
|
|
4130
4569
|
/** Type of the job (manual or cron) Example: "cron" */
|
|
4131
|
-
'jobType': '
|
|
4132
|
-
/**
|
|
4133
|
-
'
|
|
4570
|
+
'jobType': 'cron';
|
|
4571
|
+
/** Identifier for the job Example: "example-job" */
|
|
4572
|
+
'id': string;
|
|
4573
|
+
/** Full identifier used for job deployment Example: "/example-user/default-project/example-job" */
|
|
4574
|
+
'appId': string;
|
|
4575
|
+
/** Details about the current job status. */
|
|
4576
|
+
'status': {
|
|
4577
|
+
/** Details about the status of the most recent build. */
|
|
4578
|
+
'build'?: {
|
|
4579
|
+
/** The current status of the build. Example: "SUCCESS" */
|
|
4580
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
4581
|
+
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
4582
|
+
'lastTransitionTime'?: string;
|
|
4583
|
+
};
|
|
4584
|
+
};
|
|
4585
|
+
/** time of creation */
|
|
4586
|
+
'createdAt'?: string;
|
|
4587
|
+
/** time of update */
|
|
4588
|
+
'updatedAt'?: string;
|
|
4134
4589
|
};
|
|
4135
4590
|
type CreateJobCronCall = (opts: CreateJobCronRequest) => Promise<ApiCallResponse<CreateJobCronResult>>;
|
|
4136
4591
|
type CreateJobCronRequest = {
|
|
@@ -4194,6 +4649,8 @@ type CreateJobCronData = {
|
|
|
4194
4649
|
'selfHostedVcsId'?: string;
|
|
4195
4650
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
4196
4651
|
'accountLogin'?: string;
|
|
4652
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
4653
|
+
'vcsLinkId'?: string;
|
|
4197
4654
|
/** The name of the branch to use. Example: "master" */
|
|
4198
4655
|
'projectBranch': string;
|
|
4199
4656
|
};
|
|
@@ -4268,6 +4725,8 @@ type CreateJobCronData = {
|
|
|
4268
4725
|
'buildId'?: string;
|
|
4269
4726
|
};
|
|
4270
4727
|
} | any;
|
|
4728
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
4729
|
+
'disabledCI'?: boolean;
|
|
4271
4730
|
'buildConfiguration'?: {
|
|
4272
4731
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4273
4732
|
'pathIgnoreRules'?: string[];
|
|
@@ -4340,6 +4799,8 @@ type CreateJobCronData = {
|
|
|
4340
4799
|
}[];
|
|
4341
4800
|
/** The cron timer scheduling when to run the job. Example: "30 8 * * *" */
|
|
4342
4801
|
'schedule': string;
|
|
4802
|
+
/** Whether the cron's automatic scheduling is suspended */
|
|
4803
|
+
'suspended'?: boolean;
|
|
4343
4804
|
/** Whether this job should run when another instance of the job is already running. `allow` will enable multiple instances of this job to run. `forbid` will keep the current instance of the job running and stop a new instance from being run. `replace` will terminate any currently running instance of the job and start a new one. Example: "forbid" */
|
|
4344
4805
|
'concurrencyPolicy': 'allow' | 'forbid' | 'replace';
|
|
4345
4806
|
};
|
|
@@ -4405,6 +4866,8 @@ type PutJobCronResult = {
|
|
|
4405
4866
|
'selfHostedVcsId'?: string;
|
|
4406
4867
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
4407
4868
|
'accountLogin'?: string;
|
|
4869
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
4870
|
+
'vcsLinkId'?: string;
|
|
4408
4871
|
/** The name of the branch to use. Example: "master" */
|
|
4409
4872
|
'projectBranch': string;
|
|
4410
4873
|
};
|
|
@@ -4425,6 +4888,8 @@ type PutJobCronResult = {
|
|
|
4425
4888
|
'buildId'?: string;
|
|
4426
4889
|
};
|
|
4427
4890
|
};
|
|
4891
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
4892
|
+
'disabledCI'?: boolean;
|
|
4428
4893
|
'buildConfiguration'?: {
|
|
4429
4894
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4430
4895
|
'pathIgnoreRules'?: string[];
|
|
@@ -4497,6 +4962,8 @@ type PutJobCronResult = {
|
|
|
4497
4962
|
}[];
|
|
4498
4963
|
/** The cron timer scheduling when to run the job. Example: "30 8 * * *" */
|
|
4499
4964
|
'schedule': string;
|
|
4965
|
+
/** Whether the cron's automatic scheduling is suspended */
|
|
4966
|
+
'suspended'?: boolean;
|
|
4500
4967
|
/** Whether this job should run when another instance of the job is already running. `allow` will enable multiple instances of this job to run. `forbid` will keep the current instance of the job running and stop a new instance from being run. `replace` will terminate any currently running instance of the job and start a new one. Example: "forbid" */
|
|
4501
4968
|
'concurrencyPolicy': 'allow' | 'forbid' | 'replace';
|
|
4502
4969
|
/** Type of the job (manual or cron) Example: "cron" */
|
|
@@ -4510,7 +4977,7 @@ type PutJobCronResult = {
|
|
|
4510
4977
|
/** Details about the status of the most recent build. */
|
|
4511
4978
|
'build'?: {
|
|
4512
4979
|
/** The current status of the build. Example: "SUCCESS" */
|
|
4513
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
4980
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
4514
4981
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
4515
4982
|
'lastTransitionTime'?: string;
|
|
4516
4983
|
};
|
|
@@ -4582,6 +5049,8 @@ type PutJobCronData = {
|
|
|
4582
5049
|
'selfHostedVcsId'?: string;
|
|
4583
5050
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
4584
5051
|
'accountLogin'?: string;
|
|
5052
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
5053
|
+
'vcsLinkId'?: string;
|
|
4585
5054
|
/** The name of the branch to use. Example: "master" */
|
|
4586
5055
|
'projectBranch': string;
|
|
4587
5056
|
};
|
|
@@ -4656,6 +5125,8 @@ type PutJobCronData = {
|
|
|
4656
5125
|
'buildId'?: string;
|
|
4657
5126
|
};
|
|
4658
5127
|
} | any;
|
|
5128
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
5129
|
+
'disabledCI'?: boolean;
|
|
4659
5130
|
'buildConfiguration'?: {
|
|
4660
5131
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4661
5132
|
'pathIgnoreRules'?: string[];
|
|
@@ -4728,6 +5199,8 @@ type PutJobCronData = {
|
|
|
4728
5199
|
}[];
|
|
4729
5200
|
/** The cron timer scheduling when to run the job. Example: "30 8 * * *" */
|
|
4730
5201
|
'schedule': string;
|
|
5202
|
+
/** Whether the cron's automatic scheduling is suspended */
|
|
5203
|
+
'suspended'?: boolean;
|
|
4731
5204
|
/** Whether this job should run when another instance of the job is already running. `allow` will enable multiple instances of this job to run. `forbid` will keep the current instance of the job running and stop a new instance from being run. `replace` will terminate any currently running instance of the job and start a new one. Example: "forbid" */
|
|
4732
5205
|
'concurrencyPolicy': 'allow' | 'forbid' | 'replace';
|
|
4733
5206
|
};
|
|
@@ -4793,6 +5266,8 @@ type PatchJobCronResult = {
|
|
|
4793
5266
|
'selfHostedVcsId'?: string;
|
|
4794
5267
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
4795
5268
|
'accountLogin'?: string;
|
|
5269
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
5270
|
+
'vcsLinkId'?: string;
|
|
4796
5271
|
/** The name of the branch to use. Example: "master" */
|
|
4797
5272
|
'projectBranch': string;
|
|
4798
5273
|
};
|
|
@@ -4813,6 +5288,8 @@ type PatchJobCronResult = {
|
|
|
4813
5288
|
'buildId'?: string;
|
|
4814
5289
|
};
|
|
4815
5290
|
};
|
|
5291
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
5292
|
+
'disabledCI'?: boolean;
|
|
4816
5293
|
'buildConfiguration'?: {
|
|
4817
5294
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4818
5295
|
'pathIgnoreRules'?: string[];
|
|
@@ -4885,6 +5362,8 @@ type PatchJobCronResult = {
|
|
|
4885
5362
|
}[];
|
|
4886
5363
|
/** The cron timer scheduling when to run the job. Example: "30 8 * * *" */
|
|
4887
5364
|
'schedule': string;
|
|
5365
|
+
/** Whether the cron's automatic scheduling is suspended */
|
|
5366
|
+
'suspended'?: boolean;
|
|
4888
5367
|
/** Whether this job should run when another instance of the job is already running. `allow` will enable multiple instances of this job to run. `forbid` will keep the current instance of the job running and stop a new instance from being run. `replace` will terminate any currently running instance of the job and start a new one. Example: "forbid" */
|
|
4889
5368
|
'concurrencyPolicy': 'allow' | 'forbid' | 'replace';
|
|
4890
5369
|
/** Type of the job (manual or cron) Example: "cron" */
|
|
@@ -4898,7 +5377,7 @@ type PatchJobCronResult = {
|
|
|
4898
5377
|
/** Details about the status of the most recent build. */
|
|
4899
5378
|
'build'?: {
|
|
4900
5379
|
/** The current status of the build. Example: "SUCCESS" */
|
|
4901
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
5380
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
4902
5381
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
4903
5382
|
'lastTransitionTime'?: string;
|
|
4904
5383
|
};
|
|
@@ -4933,6 +5412,8 @@ type PatchJobCronData = {
|
|
|
4933
5412
|
'runOnSourceChange'?: 'never' | 'cd-promote' | 'always';
|
|
4934
5413
|
/** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
|
|
4935
5414
|
'activeDeadlineSeconds'?: number;
|
|
5415
|
+
/** Whether CI should be disabled. Only relevant for jobs deploying directly from version control. */
|
|
5416
|
+
'disabledCI'?: boolean;
|
|
4936
5417
|
'buildConfiguration'?: {
|
|
4937
5418
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4938
5419
|
'pathIgnoreRules'?: string[];
|
|
@@ -4996,6 +5477,8 @@ type PatchJobCronData = {
|
|
|
4996
5477
|
/** The number of successes required to mark the health check as a success. Example: 1 */
|
|
4997
5478
|
'successThreshold'?: number;
|
|
4998
5479
|
}[];
|
|
5480
|
+
/** Whether the cron's automatic scheduling is suspended */
|
|
5481
|
+
'suspended'?: boolean;
|
|
4999
5482
|
/** Whether this job should run when another instance of the job is already running. `allow` will enable multiple instances of this job to run. `forbid` will keep the current instance of the job running and stop a new instance from being run. `replace` will terminate any currently running instance of the job and start a new one. Example: "forbid" */
|
|
5000
5483
|
'concurrencyPolicy'?: 'allow' | 'forbid' | 'replace';
|
|
5001
5484
|
};
|
|
@@ -5466,7 +5949,7 @@ type GetJobBuildsResult = {
|
|
|
5466
5949
|
/** ID of the pull request the commit belongs to. */
|
|
5467
5950
|
'pullRequestId'?: number;
|
|
5468
5951
|
/** The status of the build. Example: "SUCCESS" */
|
|
5469
|
-
'status'?: 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
5952
|
+
'status'?: 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
5470
5953
|
/** The sha of the built commit. Example: "12c15e7ee25fd78f567ebf87f9178b8ad70025b3" */
|
|
5471
5954
|
'sha'?: string;
|
|
5472
5955
|
/** Whether the build has finished. Example: true */
|
|
@@ -5563,7 +6046,7 @@ type GetJobBuildResult = {
|
|
|
5563
6046
|
/** ID of the pull request the commit belongs to. */
|
|
5564
6047
|
'pullRequestId'?: number;
|
|
5565
6048
|
/** The status of the build. Example: "SUCCESS" */
|
|
5566
|
-
'status'?: 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
6049
|
+
'status'?: 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
5567
6050
|
/** The sha of the built commit. Example: "12c15e7ee25fd78f567ebf87f9178b8ad70025b3" */
|
|
5568
6051
|
'sha'?: string;
|
|
5569
6052
|
/** Whether the build has finished. Example: true */
|
|
@@ -7568,11 +8051,15 @@ type GetReleaseflowResult = {
|
|
|
7568
8051
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
7569
8052
|
'arguments'?: any;
|
|
7570
8053
|
'spec': any;
|
|
8054
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
8055
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
7571
8056
|
/** The stage of the pipeline this release flow belongs to. Example: "Development" */
|
|
7572
8057
|
'stage'?: string;
|
|
7573
|
-
/**
|
|
8058
|
+
/** Status of the template run Example: "success" */
|
|
8059
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
8060
|
+
/** Timestamp the template was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
7574
8061
|
'createdAt': string;
|
|
7575
|
-
/**
|
|
8062
|
+
/** Timestamp the template was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
7576
8063
|
'updatedAt': string;
|
|
7577
8064
|
};
|
|
7578
8065
|
type GetReleaseflowCall = (opts: GetReleaseflowRequest) => Promise<ApiCallResponse<GetReleaseflowResult>>;
|
|
@@ -7616,6 +8103,8 @@ type UpdateReleaseflowData = {
|
|
|
7616
8103
|
'arguments'?: any;
|
|
7617
8104
|
'spec': any;
|
|
7618
8105
|
};
|
|
8106
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
8107
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
7619
8108
|
};
|
|
7620
8109
|
/** Updates a release flow */
|
|
7621
8110
|
declare class UpdateReleaseflowEndpoint extends PostApiEndpoint<UpdateReleaseflowRequest, UpdateReleaseflowResult> {
|
|
@@ -7669,11 +8158,17 @@ type ListReleaseflowrunsResult = {
|
|
|
7669
8158
|
'name'?: string;
|
|
7670
8159
|
/** Optional description for the release flow run Example: "This is an example description" */
|
|
7671
8160
|
'description'?: string;
|
|
7672
|
-
/** Status of the
|
|
7673
|
-
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
7674
|
-
/**
|
|
8161
|
+
/** Status of the template run Example: "success" */
|
|
8162
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
8163
|
+
/** Timestamp the run started at. Example: "2021-01-01 12:01:00.000Z" */
|
|
8164
|
+
'startedAt'?: string;
|
|
8165
|
+
/** Whether the run has concluded (aborted, success, failed) Example: true */
|
|
8166
|
+
'concluded': boolean;
|
|
8167
|
+
/** Timestamp the run concluded at. Example: "2021-01-01 12:10:00.000Z" */
|
|
8168
|
+
'concludedAt'?: string;
|
|
8169
|
+
/** Timestamp the run was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
7675
8170
|
'createdAt': string;
|
|
7676
|
-
/**
|
|
8171
|
+
/** Timestamp the run was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
7677
8172
|
'updatedAt': string;
|
|
7678
8173
|
}[];
|
|
7679
8174
|
};
|
|
@@ -7719,11 +8214,17 @@ type GetReleaseflowrunResult = {
|
|
|
7719
8214
|
'name'?: string;
|
|
7720
8215
|
/** Optional description for the release flow run Example: "This is an example description" */
|
|
7721
8216
|
'description'?: string;
|
|
7722
|
-
/** Status of the
|
|
7723
|
-
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
7724
|
-
/**
|
|
8217
|
+
/** Status of the template run Example: "success" */
|
|
8218
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
8219
|
+
/** Timestamp the run started at. Example: "2021-01-01 12:01:00.000Z" */
|
|
8220
|
+
'startedAt'?: string;
|
|
8221
|
+
/** Whether the run has concluded (aborted, success, failed) Example: true */
|
|
8222
|
+
'concluded': boolean;
|
|
8223
|
+
/** Timestamp the run concluded at. Example: "2021-01-01 12:10:00.000Z" */
|
|
8224
|
+
'concludedAt'?: string;
|
|
8225
|
+
/** Timestamp the run was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
7725
8226
|
'createdAt': string;
|
|
7726
|
-
/**
|
|
8227
|
+
/** Timestamp the run was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
7727
8228
|
'updatedAt': string;
|
|
7728
8229
|
};
|
|
7729
8230
|
type GetReleaseflowrunCall = (opts: GetReleaseflowrunRequest) => Promise<ApiCallResponse<GetReleaseflowrunResult>>;
|
|
@@ -7739,7 +8240,7 @@ type GetReleaseflowrunParameters = {
|
|
|
7739
8240
|
/** ID of the release flow run */
|
|
7740
8241
|
'runId': string;
|
|
7741
8242
|
};
|
|
7742
|
-
/** Get
|
|
8243
|
+
/** Get information about the given release flow run */
|
|
7743
8244
|
declare class GetReleaseflowrunEndpoint extends GetApiEndpoint<GetReleaseflowrunRequest, GetReleaseflowrunResult> {
|
|
7744
8245
|
description: string;
|
|
7745
8246
|
withAuth: boolean;
|
|
@@ -7748,6 +8249,54 @@ declare class GetReleaseflowrunEndpoint extends GetApiEndpoint<GetReleaseflowrun
|
|
|
7748
8249
|
body: () => undefined;
|
|
7749
8250
|
}
|
|
7750
8251
|
|
|
8252
|
+
type AbortReleaseflowrunResult = {
|
|
8253
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
8254
|
+
'apiVersion': 'v1';
|
|
8255
|
+
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
8256
|
+
'arguments'?: any;
|
|
8257
|
+
'spec': any;
|
|
8258
|
+
'refs'?: any;
|
|
8259
|
+
/** ID of the release flow run Example: "110ddb52-bdcd-482d-8ac2-05ba580afe2f" */
|
|
8260
|
+
'id': string;
|
|
8261
|
+
/** Optional name for the release flow run Example: "Example run" */
|
|
8262
|
+
'name'?: string;
|
|
8263
|
+
/** Optional description for the release flow run Example: "This is an example description" */
|
|
8264
|
+
'description'?: string;
|
|
8265
|
+
/** Status of the template run Example: "success" */
|
|
8266
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
8267
|
+
/** Timestamp the run started at. Example: "2021-01-01 12:01:00.000Z" */
|
|
8268
|
+
'startedAt'?: string;
|
|
8269
|
+
/** Whether the run has concluded (aborted, success, failed) Example: true */
|
|
8270
|
+
'concluded': boolean;
|
|
8271
|
+
/** Timestamp the run concluded at. Example: "2021-01-01 12:10:00.000Z" */
|
|
8272
|
+
'concludedAt'?: string;
|
|
8273
|
+
/** Timestamp the run was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
8274
|
+
'createdAt': string;
|
|
8275
|
+
/** Timestamp the run was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
8276
|
+
'updatedAt': string;
|
|
8277
|
+
};
|
|
8278
|
+
type AbortReleaseflowrunCall = (opts: AbortReleaseflowrunRequest) => Promise<ApiCallResponse<AbortReleaseflowrunResult>>;
|
|
8279
|
+
type AbortReleaseflowrunRequest = {
|
|
8280
|
+
parameters: AbortReleaseflowrunParameters;
|
|
8281
|
+
};
|
|
8282
|
+
type AbortReleaseflowrunParameters = {
|
|
8283
|
+
/** ID of the project */ 'projectId': string;
|
|
8284
|
+
/** ID of the pipeline */
|
|
8285
|
+
'pipelineId': string;
|
|
8286
|
+
/** Stage of the pipeline */
|
|
8287
|
+
'stage': string;
|
|
8288
|
+
/** ID of the release flow run */
|
|
8289
|
+
'runId': string;
|
|
8290
|
+
};
|
|
8291
|
+
/** Abort the given release flow run */
|
|
8292
|
+
declare class AbortReleaseflowrunEndpoint extends PostApiEndpoint<AbortReleaseflowrunRequest, AbortReleaseflowrunResult> {
|
|
8293
|
+
description: string;
|
|
8294
|
+
withAuth: boolean;
|
|
8295
|
+
requiredPermissions: string;
|
|
8296
|
+
endpointUrl: (opts: AbortReleaseflowrunRequest) => string;
|
|
8297
|
+
body: () => undefined;
|
|
8298
|
+
}
|
|
8299
|
+
|
|
7751
8300
|
type ListSecretsResult = {
|
|
7752
8301
|
/** An array of secret groups */
|
|
7753
8302
|
'secrets': {
|
|
@@ -7803,20 +8352,18 @@ declare class ListSecretsEndpoint extends GetApiEndpoint<ListSecretsRequest, Lis
|
|
|
7803
8352
|
}
|
|
7804
8353
|
|
|
7805
8354
|
type CreateSecretResult = {
|
|
7806
|
-
/**
|
|
7807
|
-
'id': string;
|
|
7808
|
-
/** Secret group name Example: "Example secret group" */
|
|
8355
|
+
/** The name of the secret. Example: "Example Secret" */
|
|
7809
8356
|
'name': string;
|
|
7810
|
-
/** A
|
|
8357
|
+
/** A description of the secret. Example: "A description" */
|
|
7811
8358
|
'description'?: string;
|
|
7812
|
-
/**
|
|
8359
|
+
/** An array of previously defined tags to help identify and group the resource. */
|
|
8360
|
+
'tags'?: string[];
|
|
8361
|
+
/** The type of the created secret Example: "environment" */
|
|
7813
8362
|
'secretType': 'environment-arguments' | 'environment' | 'arguments';
|
|
7814
|
-
/**
|
|
7815
|
-
'projectId': string;
|
|
7816
|
-
/** The priority with which different secret groups will be merged Example: 10 */
|
|
8363
|
+
/** The priority with which different secrets will be merged. Example: 10 */
|
|
7817
8364
|
'priority': number;
|
|
7818
8365
|
/** Restriction settings of the secret */
|
|
7819
|
-
'restrictions'
|
|
8366
|
+
'restrictions'?: {
|
|
7820
8367
|
/** Is the secret restricted Example: true */
|
|
7821
8368
|
'restricted'?: boolean;
|
|
7822
8369
|
/** List of Northflank services & jobs the secret is restricted to */
|
|
@@ -7827,6 +8374,30 @@ type CreateSecretResult = {
|
|
|
7827
8374
|
'type': 'service' | 'job';
|
|
7828
8375
|
}[];
|
|
7829
8376
|
};
|
|
8377
|
+
/** An array of addons to link to this secret group. */
|
|
8378
|
+
'addonDependencies'?: {
|
|
8379
|
+
/** The id of the addon to link. Example: "example-addon" */
|
|
8380
|
+
'addonId': string;
|
|
8381
|
+
/** An array of objects containing details about the keys to link to this secret group. */
|
|
8382
|
+
'keys': {
|
|
8383
|
+
/** The name of the key to link. Example: "USERNAME" */
|
|
8384
|
+
'keyName': string;
|
|
8385
|
+
/** An array of aliases for the key. */
|
|
8386
|
+
'aliases'?: string[];
|
|
8387
|
+
}[];
|
|
8388
|
+
}[];
|
|
8389
|
+
'secrets'?: {
|
|
8390
|
+
/** Secret variables as JSON object, encrypted at rest. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"NODE_ENV":"production","MONGO_DB":"some_connection_string"} */
|
|
8391
|
+
'variables'?: any;
|
|
8392
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
8393
|
+
'files'?: any;
|
|
8394
|
+
};
|
|
8395
|
+
/** Identifier for the secret group Example: "example-secret-group" */
|
|
8396
|
+
'id': string;
|
|
8397
|
+
/** time of creation */
|
|
8398
|
+
'createdAt'?: string;
|
|
8399
|
+
/** time of update */
|
|
8400
|
+
'updatedAt'?: string;
|
|
7830
8401
|
} | any;
|
|
7831
8402
|
type CreateSecretCall = (opts: CreateSecretRequest) => Promise<ApiCallResponse<CreateSecretResult>>;
|
|
7832
8403
|
type CreateSecretRequest = {
|
|
@@ -8401,114 +8972,122 @@ declare class DeleteSecretlinkEndpoint extends DeleteApiEndpoint<DeleteSecretlin
|
|
|
8401
8972
|
}
|
|
8402
8973
|
|
|
8403
8974
|
type CreateServiceCombinedResult = {
|
|
8404
|
-
/**
|
|
8405
|
-
'id': string;
|
|
8406
|
-
/** Full identifier used for service deployment Example: "/example-user/default-project/example-service" */
|
|
8407
|
-
'appId': string;
|
|
8408
|
-
/** Service name Example: "Example Service" */
|
|
8975
|
+
/** The name of the service. Example: "Example Service" */
|
|
8409
8976
|
'name': string;
|
|
8410
|
-
/** A
|
|
8977
|
+
/** A description of the service. Example: "A service description" */
|
|
8411
8978
|
'description'?: string;
|
|
8412
|
-
/**
|
|
8413
|
-
'
|
|
8414
|
-
/** The time the service was created. Example: "2021-01-20T11:19:53.175Z" */
|
|
8415
|
-
'createdAt': string;
|
|
8416
|
-
/** Whether Continuous Integration is disabled */
|
|
8417
|
-
'disabledCI': boolean;
|
|
8418
|
-
/** Whether Continuous Deployment is disabled */
|
|
8419
|
-
'disabledCD': boolean;
|
|
8979
|
+
/** An array of previously defined tags to help identify and group the resource. */
|
|
8980
|
+
'tags'?: string[];
|
|
8420
8981
|
'billing': {
|
|
8421
|
-
/** ID of the
|
|
8982
|
+
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
8422
8983
|
'deploymentPlan': string;
|
|
8423
8984
|
};
|
|
8424
|
-
|
|
8425
|
-
|
|
8426
|
-
|
|
8427
|
-
|
|
8428
|
-
/** The current status of the build. Example: "SUCCESS" */
|
|
8429
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
8430
|
-
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
8431
|
-
'lastTransitionTime'?: string;
|
|
8432
|
-
};
|
|
8433
|
-
/** Details about the current deployment status. */
|
|
8434
|
-
'deployment'?: {
|
|
8435
|
-
/** The current status of the deployment. Example: "COMPLETED" */
|
|
8436
|
-
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
8437
|
-
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
8438
|
-
'reason': 'SCALING' | 'DEPLOYING';
|
|
8439
|
-
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
8440
|
-
'lastTransitionTime'?: string;
|
|
8441
|
-
};
|
|
8442
|
-
};
|
|
8443
|
-
/** Is the service paused? */
|
|
8444
|
-
'servicePaused': boolean;
|
|
8445
|
-
/** Type of the service (combined, build or deployment) Example: "combined" */
|
|
8446
|
-
'serviceType': 'combined' | 'build' | 'deployment';
|
|
8447
|
-
'vcsData'?: {
|
|
8448
|
-
/** URL of the repository being built Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
8449
|
-
'projectUrl': string;
|
|
8450
|
-
/** VCS provider for the repo being built Example: "github" */
|
|
8451
|
-
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
8452
|
-
/** ID of the self-hosted VCS, if applicable. Example: "example-team/self-hosted-vcs" */
|
|
8453
|
-
'selfHostedVcsId'?: string;
|
|
8454
|
-
/** Branch of the repo being built Example: "master" */
|
|
8455
|
-
'projectBranch'?: string;
|
|
8456
|
-
/** Whether the repo is being accessed without authentication. */
|
|
8457
|
-
'publicRepo'?: boolean;
|
|
8458
|
-
/** Working directory used by the dockerfile Example: "/" */
|
|
8459
|
-
'dockerWorkDir': string;
|
|
8460
|
-
/** File path of the Dockerfile Example: "/Dockerfile" */
|
|
8461
|
-
'dockerFilePath': string;
|
|
8462
|
-
};
|
|
8463
|
-
'deployment'?: {
|
|
8464
|
-
/** Region where this service is deployed and/or built Example: "europe-west" */
|
|
8465
|
-
'region'?: string;
|
|
8466
|
-
/** Number of instances/replicas running Example: 1 */
|
|
8467
|
-
'instances'?: number;
|
|
8468
|
-
'internal'?: {
|
|
8469
|
-
/** Database ID of deployed entity Example: "example-service" */
|
|
8470
|
-
'nfObjectId': string;
|
|
8471
|
-
/** Type of deployed entity Example: "service" */
|
|
8472
|
-
'nfObjectType': 'service';
|
|
8473
|
-
/** URL of the repository being deployed Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
8474
|
-
'repository': string;
|
|
8475
|
-
/** Branch of the repo being deployed Example: "master" */
|
|
8476
|
-
'branch': string;
|
|
8477
|
-
/** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
|
|
8478
|
-
'buildSHA': string;
|
|
8479
|
-
/** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
|
|
8480
|
-
'deployedSHA'?: string;
|
|
8481
|
-
};
|
|
8482
|
-
/** Details about the Docker overrides for this deployment. */
|
|
8483
|
-
'docker'?: {
|
|
8484
|
-
/** Override configuration which is used at runtime. Example: "default" */
|
|
8485
|
-
'configType': 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand';
|
|
8486
|
-
/** The CMD to run instead of the default if entrypoint override is enabled. */
|
|
8487
|
-
'customEntrypoint'?: string;
|
|
8488
|
-
/** The CMD to run instead of the default if CMD override is enabled. */
|
|
8489
|
-
'customCommand'?: string;
|
|
8490
|
-
};
|
|
8491
|
-
/** Details about the Buildpack overrides for this deployment. */
|
|
8985
|
+
'deployment': {
|
|
8986
|
+
/** The number of instances to run the service on. Example: 1 */
|
|
8987
|
+
'instances': number;
|
|
8988
|
+
/** Allows for customization of buildpack runtime */
|
|
8492
8989
|
'buildpack'?: {
|
|
8493
|
-
/** Type of buildpack run configuration
|
|
8990
|
+
/** Type of buildpack run configuration */
|
|
8494
8991
|
'configType': 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand';
|
|
8495
|
-
/** Custom process which should be run. */
|
|
8992
|
+
/** Custom process which should be run. Required in case where `configType` is `customProcess` */
|
|
8496
8993
|
'customProcess'?: string;
|
|
8497
|
-
/** Custom entrypoint which should be run. */
|
|
8994
|
+
/** Custom entrypoint which should be run. Required in case where `configType` is `customEntrypointCustomCommand` */
|
|
8498
8995
|
'customEntrypoint'?: string;
|
|
8499
|
-
/** Custom command which should be run. */
|
|
8996
|
+
/** Custom command which should be run. Required in case where `configType` is `customCommand`, `customEntrypointCustomCommand` or `originalEntrypointCustomCommand` */
|
|
8997
|
+
'customCommand'?: string;
|
|
8998
|
+
};
|
|
8999
|
+
/** Allows for customization of docker runtime */
|
|
9000
|
+
'docker'?: {
|
|
9001
|
+
/** Type of entrypoint & command override configuration Example: "default" */
|
|
9002
|
+
'configType': 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand';
|
|
9003
|
+
/** Custom entrypoint which should be used. Required in case where `configType` is `customEntrypoint` or `customEntrypointCustomCommand` */
|
|
9004
|
+
'customEntrypoint'?: string;
|
|
9005
|
+
/** Custom command which should be used. Required in case where `configType` is `customCommand` or `customEntrypointCustomCommand` */
|
|
8500
9006
|
'customCommand'?: string;
|
|
8501
9007
|
};
|
|
8502
|
-
/** Details about storage settings for this deployment. */
|
|
8503
9008
|
'storage'?: {
|
|
8504
|
-
/** Details about ephemeral storage settings for this deployment. */
|
|
8505
9009
|
'ephemeralStorage'?: {
|
|
8506
9010
|
/** Ephemeral storage per container in MB Example: 1024 */
|
|
8507
|
-
'storageSize'
|
|
9011
|
+
'storageSize'?: number;
|
|
8508
9012
|
};
|
|
8509
9013
|
};
|
|
9014
|
+
'strategy'?: {
|
|
9015
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9016
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9017
|
+
};
|
|
9018
|
+
};
|
|
9019
|
+
'ports'?: {
|
|
9020
|
+
/** The name used to identify the port. Example: "port-1" */
|
|
9021
|
+
'name': string;
|
|
9022
|
+
/** The port number. Example: 8080 */
|
|
9023
|
+
'internalPort': number;
|
|
9024
|
+
/** If true, the port will be exposed publicly. Example: true */
|
|
9025
|
+
'public'?: boolean;
|
|
9026
|
+
'security'?: {
|
|
9027
|
+
/** An array of credentials to access the service. */
|
|
9028
|
+
'credentials'?: {
|
|
9029
|
+
/** The username to access the service Example: "admin" */
|
|
9030
|
+
'username': string;
|
|
9031
|
+
/** The password to access the service with this username. Example: "password123" */
|
|
9032
|
+
'password': string;
|
|
9033
|
+
/** The type of authentication used Example: "basic-auth" */
|
|
9034
|
+
'type': 'basic-auth';
|
|
9035
|
+
}[];
|
|
9036
|
+
/** An array of IP address policies. */
|
|
9037
|
+
'policies'?: {
|
|
9038
|
+
/** An array of IP addresses used for this rule */
|
|
9039
|
+
'addresses': string[];
|
|
9040
|
+
/** The action for this rule. Example: "DENY" */
|
|
9041
|
+
'action': 'ALLOW' | 'DENY';
|
|
9042
|
+
}[];
|
|
9043
|
+
};
|
|
9044
|
+
/** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
|
|
9045
|
+
'domains'?: string[];
|
|
9046
|
+
/** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
|
|
9047
|
+
'disableNfDomain'?: boolean;
|
|
9048
|
+
/** The protocol to use for the port. Example: "HTTP" */
|
|
9049
|
+
'protocol': 'HTTP' | 'HTTP/2' | 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
9050
|
+
}[];
|
|
9051
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
9052
|
+
'disabledCI'?: boolean;
|
|
9053
|
+
'vcsData': {
|
|
9054
|
+
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
9055
|
+
'projectUrl': string;
|
|
9056
|
+
/** The VCS provider to use. Example: "github" */
|
|
9057
|
+
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
9058
|
+
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
9059
|
+
'selfHostedVcsId'?: string;
|
|
9060
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
9061
|
+
'accountLogin'?: string;
|
|
9062
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
9063
|
+
'vcsLinkId'?: string;
|
|
9064
|
+
/** The name of the branch to use. Example: "master" */
|
|
9065
|
+
'projectBranch': string;
|
|
8510
9066
|
};
|
|
8511
|
-
'
|
|
9067
|
+
'buildSettings': {
|
|
9068
|
+
'dockerfile': {
|
|
9069
|
+
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
9070
|
+
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
9071
|
+
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
9072
|
+
'dockerFilePath': string;
|
|
9073
|
+
/** The working directory of the Dockerfile. Example: "/" */
|
|
9074
|
+
'dockerWorkDir': string;
|
|
9075
|
+
/** Should intermediate image layers be cached? */
|
|
9076
|
+
'useCache'?: boolean;
|
|
9077
|
+
};
|
|
9078
|
+
} | {
|
|
9079
|
+
'buildpack': {
|
|
9080
|
+
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
9081
|
+
'builder'?: 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
9082
|
+
/** Array of custom Buildpacks to use. */
|
|
9083
|
+
'buildpackLocators'?: string[];
|
|
9084
|
+
/** The working directory to build in. Example: "/" */
|
|
9085
|
+
'buildContext'?: string;
|
|
9086
|
+
/** Should build dependencies be cached? */
|
|
9087
|
+
'useCache'?: boolean;
|
|
9088
|
+
};
|
|
9089
|
+
};
|
|
9090
|
+
'buildConfiguration'?: {
|
|
8512
9091
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
8513
9092
|
'pathIgnoreRules'?: string[];
|
|
8514
9093
|
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
@@ -8524,33 +9103,93 @@ type CreateServiceCombinedResult = {
|
|
|
8524
9103
|
/** Include the entire git history as part of the .git folder. Only relevant if "includeGitFolder" is set. */
|
|
8525
9104
|
'fullGitClone'?: boolean;
|
|
8526
9105
|
};
|
|
8527
|
-
|
|
8528
|
-
|
|
8529
|
-
|
|
8530
|
-
|
|
8531
|
-
|
|
8532
|
-
|
|
8533
|
-
|
|
8534
|
-
|
|
8535
|
-
|
|
8536
|
-
|
|
8537
|
-
|
|
9106
|
+
/** An object containing the runtime environment to set for the service. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
|
|
9107
|
+
'runtimeEnvironment'?: any;
|
|
9108
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
9109
|
+
'runtimeFiles'?: any;
|
|
9110
|
+
/** An object containing the build arguments to set for the service. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
|
|
9111
|
+
'buildArguments'?: any;
|
|
9112
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
9113
|
+
'buildFiles'?: any;
|
|
9114
|
+
/** An array of health checks. */
|
|
9115
|
+
'healthChecks'?: {
|
|
9116
|
+
/** The protocol to access the health check with. Example: "HTTP" */
|
|
9117
|
+
'protocol': 'HTTP' | 'CMD' | 'TCP';
|
|
9118
|
+
/** The type of health check. Example: "readinessProbe" */
|
|
9119
|
+
'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
|
|
9120
|
+
/** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
|
|
9121
|
+
'path'?: string;
|
|
9122
|
+
/** The command to run for the health check. Required when protocol is CMD */
|
|
9123
|
+
'cmd'?: string;
|
|
9124
|
+
/** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
|
|
9125
|
+
'port'?: number;
|
|
9126
|
+
/** Initial delay, in seconds, before the health check is first run. Example: 10 */
|
|
9127
|
+
'initialDelaySeconds': number;
|
|
9128
|
+
/** The time between each check, in seconds. Example: 60 */
|
|
9129
|
+
'periodSeconds': number;
|
|
9130
|
+
/** The time to wait for a response before marking the health check as a failure. Example: 1 */
|
|
9131
|
+
'timeoutSeconds': number;
|
|
9132
|
+
/** The maximum number of allowed failures. Example: 3 */
|
|
9133
|
+
'failureThreshold': number;
|
|
9134
|
+
/** The number of successes required to mark the health check as a success. Example: 1 */
|
|
9135
|
+
'successThreshold'?: number;
|
|
9136
|
+
}[];
|
|
9137
|
+
/** Describes all autoscaling configurations */
|
|
9138
|
+
'autoscaling'?: {
|
|
9139
|
+
/** Describes the horizontal autoscaling configuration */
|
|
9140
|
+
'horizontal'?: {
|
|
9141
|
+
/** Whether horizontal autoscaling should be enabled */
|
|
9142
|
+
'enabled': boolean;
|
|
9143
|
+
/** Minimum number of replicas which should be running at any time */
|
|
9144
|
+
'minReplicas': number;
|
|
9145
|
+
/** Maximum number of replicas which can be running at any time */
|
|
9146
|
+
'maxReplicas': number;
|
|
9147
|
+
'cpu'?: {
|
|
9148
|
+
/** Whether autoscaling should take into account cpu usage */
|
|
9149
|
+
'enabled': boolean;
|
|
9150
|
+
/** Threshold CPU usage percentage at which the workload will be scaled */
|
|
9151
|
+
'thresholdPercentage': number;
|
|
9152
|
+
};
|
|
9153
|
+
'memory'?: {
|
|
9154
|
+
/** Whether autoscaling should take into account memory usage */
|
|
9155
|
+
'enabled': boolean;
|
|
9156
|
+
/** Threshold memory usage percentage at which the workload will be scaled */
|
|
9157
|
+
'thresholdPercentage': number;
|
|
9158
|
+
};
|
|
8538
9159
|
};
|
|
8539
|
-
|
|
8540
|
-
|
|
8541
|
-
|
|
8542
|
-
|
|
9160
|
+
};
|
|
9161
|
+
'deploymentSysctlSettings'?: {
|
|
9162
|
+
'vm.max_map_count'?: number;
|
|
9163
|
+
};
|
|
9164
|
+
/** Type of the service (combined, build or deployment) Example: "combined" */
|
|
9165
|
+
'serviceType': 'combined';
|
|
9166
|
+
/** Identifier for the service Example: "example-service" */
|
|
9167
|
+
'id': string;
|
|
9168
|
+
/** Full identifier used for service deployment Example: "/example-user/default-project/example-service" */
|
|
9169
|
+
'appId': string;
|
|
9170
|
+
/** time of creation */
|
|
9171
|
+
'createdAt'?: string;
|
|
9172
|
+
/** time of update */
|
|
9173
|
+
'updatedAt'?: string;
|
|
9174
|
+
/** Details about the current service status. */
|
|
9175
|
+
'status': {
|
|
9176
|
+
/** Details about the status of the most recent build. */
|
|
9177
|
+
'build'?: {
|
|
9178
|
+
/** The current status of the build. Example: "SUCCESS" */
|
|
9179
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
9180
|
+
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
9181
|
+
'lastTransitionTime'?: string;
|
|
8543
9182
|
};
|
|
8544
|
-
/** Details about
|
|
8545
|
-
'
|
|
8546
|
-
/**
|
|
8547
|
-
'
|
|
9183
|
+
/** Details about the current deployment status. */
|
|
9184
|
+
'deployment'?: {
|
|
9185
|
+
/** The current status of the deployment. Example: "COMPLETED" */
|
|
9186
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
9187
|
+
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
9188
|
+
'reason': 'SCALING' | 'DEPLOYING';
|
|
9189
|
+
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
9190
|
+
'lastTransitionTime'?: string;
|
|
8548
9191
|
};
|
|
8549
9192
|
};
|
|
8550
|
-
/** Whether the service will be built immediately Example: true */
|
|
8551
|
-
'buildInitiated': boolean;
|
|
8552
|
-
/** The ID of the initial build of the service. Example: "joyous-view-6290" */
|
|
8553
|
-
'buildId'?: string;
|
|
8554
9193
|
} | any;
|
|
8555
9194
|
type CreateServiceCombinedCall = (opts: CreateServiceCombinedRequest) => Promise<ApiCallResponse<CreateServiceCombinedResult>>;
|
|
8556
9195
|
type CreateServiceCombinedRequest = {
|
|
@@ -8637,6 +9276,8 @@ type CreateServiceCombinedData = {
|
|
|
8637
9276
|
/** The protocol to use for the port. Example: "HTTP" */
|
|
8638
9277
|
'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
8639
9278
|
}[];
|
|
9279
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
9280
|
+
'disabledCI'?: boolean;
|
|
8640
9281
|
'vcsData': {
|
|
8641
9282
|
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
8642
9283
|
'projectUrl': string;
|
|
@@ -8646,6 +9287,8 @@ type CreateServiceCombinedData = {
|
|
|
8646
9287
|
'selfHostedVcsId'?: string;
|
|
8647
9288
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
8648
9289
|
'accountLogin'?: string;
|
|
9290
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
9291
|
+
'vcsLinkId'?: string;
|
|
8649
9292
|
/** The name of the branch to use. Example: "master" */
|
|
8650
9293
|
'projectBranch': string;
|
|
8651
9294
|
};
|
|
@@ -8830,6 +9473,8 @@ type PutServiceCombinedResult = {
|
|
|
8830
9473
|
/** The protocol to use for the port. Example: "HTTP" */
|
|
8831
9474
|
'protocol': 'HTTP' | 'HTTP/2' | 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
8832
9475
|
}[];
|
|
9476
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
9477
|
+
'disabledCI'?: boolean;
|
|
8833
9478
|
'vcsData': {
|
|
8834
9479
|
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
8835
9480
|
'projectUrl': string;
|
|
@@ -8839,6 +9484,8 @@ type PutServiceCombinedResult = {
|
|
|
8839
9484
|
'selfHostedVcsId'?: string;
|
|
8840
9485
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
8841
9486
|
'accountLogin'?: string;
|
|
9487
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
9488
|
+
'vcsLinkId'?: string;
|
|
8842
9489
|
/** The name of the branch to use. Example: "master" */
|
|
8843
9490
|
'projectBranch': string;
|
|
8844
9491
|
};
|
|
@@ -8954,7 +9601,7 @@ type PutServiceCombinedResult = {
|
|
|
8954
9601
|
/** Details about the status of the most recent build. */
|
|
8955
9602
|
'build'?: {
|
|
8956
9603
|
/** The current status of the build. Example: "SUCCESS" */
|
|
8957
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
9604
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
8958
9605
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
8959
9606
|
'lastTransitionTime'?: string;
|
|
8960
9607
|
};
|
|
@@ -9054,6 +9701,8 @@ type PutServiceCombinedData = {
|
|
|
9054
9701
|
/** The protocol to use for the port. Example: "HTTP" */
|
|
9055
9702
|
'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
9056
9703
|
}[];
|
|
9704
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
9705
|
+
'disabledCI'?: boolean;
|
|
9057
9706
|
'vcsData': {
|
|
9058
9707
|
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
9059
9708
|
'projectUrl': string;
|
|
@@ -9063,6 +9712,8 @@ type PutServiceCombinedData = {
|
|
|
9063
9712
|
'selfHostedVcsId'?: string;
|
|
9064
9713
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
9065
9714
|
'accountLogin'?: string;
|
|
9715
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
9716
|
+
'vcsLinkId'?: string;
|
|
9066
9717
|
/** The name of the branch to use. Example: "master" */
|
|
9067
9718
|
'projectBranch': string;
|
|
9068
9719
|
};
|
|
@@ -9247,6 +9898,8 @@ type PatchServiceCombinedResult = {
|
|
|
9247
9898
|
/** The protocol to use for the port. Example: "HTTP" */
|
|
9248
9899
|
'protocol': 'HTTP' | 'HTTP/2' | 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
9249
9900
|
}[];
|
|
9901
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
9902
|
+
'disabledCI'?: boolean;
|
|
9250
9903
|
'vcsData': {
|
|
9251
9904
|
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
9252
9905
|
'projectUrl': string;
|
|
@@ -9256,6 +9909,8 @@ type PatchServiceCombinedResult = {
|
|
|
9256
9909
|
'selfHostedVcsId'?: string;
|
|
9257
9910
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
9258
9911
|
'accountLogin'?: string;
|
|
9912
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
9913
|
+
'vcsLinkId'?: string;
|
|
9259
9914
|
/** The name of the branch to use. Example: "master" */
|
|
9260
9915
|
'projectBranch': string;
|
|
9261
9916
|
};
|
|
@@ -9371,7 +10026,7 @@ type PatchServiceCombinedResult = {
|
|
|
9371
10026
|
/** Details about the status of the most recent build. */
|
|
9372
10027
|
'build'?: {
|
|
9373
10028
|
/** The current status of the build. Example: "SUCCESS" */
|
|
9374
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
10029
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
9375
10030
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
9376
10031
|
'lastTransitionTime'?: string;
|
|
9377
10032
|
};
|
|
@@ -9401,22 +10056,210 @@ type PatchServiceCombinedData = {
|
|
|
9401
10056
|
'description'?: string;
|
|
9402
10057
|
/** An array of previously defined tags to help identify and group the resource. */
|
|
9403
10058
|
'tags'?: string[];
|
|
9404
|
-
'billing'?: {
|
|
10059
|
+
'billing'?: {
|
|
10060
|
+
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
10061
|
+
'deploymentPlan'?: string;
|
|
10062
|
+
};
|
|
10063
|
+
'deployment'?: {
|
|
10064
|
+
/** The number of instances to run the service on. Example: 1 */
|
|
10065
|
+
'instances'?: number;
|
|
10066
|
+
'buildpack'?: {
|
|
10067
|
+
'configType'?: 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand';
|
|
10068
|
+
'customProcess'?: string;
|
|
10069
|
+
'customEntrypoint'?: string;
|
|
10070
|
+
'customCommand'?: string;
|
|
10071
|
+
};
|
|
10072
|
+
'docker'?: {
|
|
10073
|
+
'configType'?: 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand';
|
|
10074
|
+
'customEntrypoint'?: string;
|
|
10075
|
+
'customCommand'?: string;
|
|
10076
|
+
};
|
|
10077
|
+
'storage'?: {
|
|
10078
|
+
'ephemeralStorage'?: {
|
|
10079
|
+
/** Ephemeral storage per container in MB Example: 1024 */
|
|
10080
|
+
'storageSize'?: number;
|
|
10081
|
+
};
|
|
10082
|
+
};
|
|
10083
|
+
'strategy'?: {
|
|
10084
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
10085
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
10086
|
+
};
|
|
10087
|
+
};
|
|
10088
|
+
'ports'?: {
|
|
10089
|
+
/** The name used to identify the port. Example: "port-1" */
|
|
10090
|
+
'name': string;
|
|
10091
|
+
/** The port number. Example: 8080 */
|
|
10092
|
+
'internalPort': number;
|
|
10093
|
+
/** If true, the port will be exposed publicly. Example: true */
|
|
10094
|
+
'public'?: boolean;
|
|
10095
|
+
'security'?: {
|
|
10096
|
+
/** An array of credentials to access the service. */
|
|
10097
|
+
'credentials'?: {
|
|
10098
|
+
/** The username to access the service Example: "admin" */
|
|
10099
|
+
'username': string;
|
|
10100
|
+
/** The password to access the service with this username. Example: "password123" */
|
|
10101
|
+
'password': string;
|
|
10102
|
+
/** The type of authentication used Example: "basic-auth" */
|
|
10103
|
+
'type': 'basic-auth';
|
|
10104
|
+
}[];
|
|
10105
|
+
/** An array of IP address policies. */
|
|
10106
|
+
'policies'?: {
|
|
10107
|
+
/** An array of IP addresses used for this rule */
|
|
10108
|
+
'addresses': string[];
|
|
10109
|
+
/** The action for this rule. Example: "DENY" */
|
|
10110
|
+
'action': 'ALLOW' | 'DENY';
|
|
10111
|
+
}[];
|
|
10112
|
+
};
|
|
10113
|
+
/** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
|
|
10114
|
+
'domains'?: string[];
|
|
10115
|
+
/** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
|
|
10116
|
+
'disableNfDomain'?: boolean;
|
|
10117
|
+
/** The protocol to use for the port. Example: "HTTP" */
|
|
10118
|
+
'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
10119
|
+
}[];
|
|
10120
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
10121
|
+
'disabledCI'?: boolean;
|
|
10122
|
+
'vcsData'?: {
|
|
10123
|
+
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
10124
|
+
'projectUrl'?: string;
|
|
10125
|
+
/** The VCS provider to use. Example: "github" */
|
|
10126
|
+
'projectType'?: 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
10127
|
+
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
10128
|
+
'selfHostedVcsId'?: string;
|
|
10129
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
10130
|
+
'accountLogin'?: string;
|
|
10131
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
10132
|
+
'vcsLinkId'?: string;
|
|
10133
|
+
/** The name of the branch to use. Example: "master" */
|
|
10134
|
+
'projectBranch'?: string;
|
|
10135
|
+
};
|
|
10136
|
+
'buildSettings'?: {
|
|
10137
|
+
'dockerfile'?: {
|
|
10138
|
+
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
10139
|
+
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
10140
|
+
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
10141
|
+
'dockerFilePath'?: string;
|
|
10142
|
+
/** The working directory of the Dockerfile. Example: "/" */
|
|
10143
|
+
'dockerWorkDir'?: string;
|
|
10144
|
+
/** Should intermediate image layers be cached? */
|
|
10145
|
+
'useCache'?: boolean;
|
|
10146
|
+
};
|
|
10147
|
+
'buildpack'?: {
|
|
10148
|
+
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
10149
|
+
'builder'?: 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
10150
|
+
/** Array of custom Buildpacks to use. */
|
|
10151
|
+
'buildpackLocators'?: string[];
|
|
10152
|
+
/** The working directory to build in. Example: "/" */
|
|
10153
|
+
'buildContext'?: string;
|
|
10154
|
+
/** Should build dependencies be cached? */
|
|
10155
|
+
'useCache'?: boolean;
|
|
10156
|
+
};
|
|
10157
|
+
};
|
|
10158
|
+
'buildConfiguration'?: {
|
|
10159
|
+
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
10160
|
+
'pathIgnoreRules'?: string[];
|
|
10161
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
10162
|
+
'isAllowList'?: boolean;
|
|
10163
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
10164
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
10165
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
10166
|
+
'ciIgnoreFlags'?: string[];
|
|
10167
|
+
};
|
|
10168
|
+
/** An object containing the runtime environment to set for the service. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
|
|
10169
|
+
'runtimeEnvironment'?: any;
|
|
10170
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
10171
|
+
'runtimeFiles'?: any;
|
|
10172
|
+
/** An object containing the build arguments to set for the service. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
|
|
10173
|
+
'buildArguments'?: any;
|
|
10174
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
10175
|
+
'buildFiles'?: any;
|
|
10176
|
+
/** An array of health checks. */
|
|
10177
|
+
'healthChecks'?: {
|
|
10178
|
+
/** The protocol to access the health check with. Example: "HTTP" */
|
|
10179
|
+
'protocol': 'HTTP' | 'CMD' | 'TCP';
|
|
10180
|
+
/** The type of health check. Example: "readinessProbe" */
|
|
10181
|
+
'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
|
|
10182
|
+
/** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
|
|
10183
|
+
'path'?: string;
|
|
10184
|
+
/** The command to run for the health check. Required when protocol is CMD */
|
|
10185
|
+
'cmd'?: string;
|
|
10186
|
+
/** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
|
|
10187
|
+
'port'?: number;
|
|
10188
|
+
/** Initial delay, in seconds, before the health check is first run. Example: 10 */
|
|
10189
|
+
'initialDelaySeconds': number;
|
|
10190
|
+
/** The time between each check, in seconds. Example: 60 */
|
|
10191
|
+
'periodSeconds': number;
|
|
10192
|
+
/** The time to wait for a response before marking the health check as a failure. Example: 1 */
|
|
10193
|
+
'timeoutSeconds': number;
|
|
10194
|
+
/** The maximum number of allowed failures. Example: 3 */
|
|
10195
|
+
'failureThreshold': number;
|
|
10196
|
+
/** The number of successes required to mark the health check as a success. Example: 1 */
|
|
10197
|
+
'successThreshold'?: number;
|
|
10198
|
+
}[];
|
|
10199
|
+
'autoscaling'?: {
|
|
10200
|
+
'horizontal'?: {
|
|
10201
|
+
/** Whether horizontal autoscaling should be enabled */
|
|
10202
|
+
'enabled'?: boolean;
|
|
10203
|
+
/** Minimum number of replicas which should be running at any time */
|
|
10204
|
+
'minReplicas'?: number;
|
|
10205
|
+
/** Maximum number of replicas which can be running at any time */
|
|
10206
|
+
'maxReplicas'?: number;
|
|
10207
|
+
'cpu'?: {
|
|
10208
|
+
/** Whether autoscaling should take into account cpu usage */
|
|
10209
|
+
'enabled'?: boolean;
|
|
10210
|
+
/** Threshold CPU usage percentage at which the workload will be scaled */
|
|
10211
|
+
'thresholdPercentage'?: number;
|
|
10212
|
+
};
|
|
10213
|
+
'memory'?: {
|
|
10214
|
+
/** Whether autoscaling should take into account memory usage */
|
|
10215
|
+
'enabled'?: boolean;
|
|
10216
|
+
/** Threshold memory usage percentage at which the workload will be scaled */
|
|
10217
|
+
'thresholdPercentage'?: number;
|
|
10218
|
+
};
|
|
10219
|
+
};
|
|
10220
|
+
};
|
|
10221
|
+
};
|
|
10222
|
+
/** Updates a combined service. */
|
|
10223
|
+
declare class PatchServiceCombinedEndpoint extends PatchApiEndpoint<PatchServiceCombinedRequest, PatchServiceCombinedResult> {
|
|
10224
|
+
description: string;
|
|
10225
|
+
withAuth: boolean;
|
|
10226
|
+
requiredPermissions: string;
|
|
10227
|
+
endpointUrl: (opts: PatchServiceCombinedRequest) => string;
|
|
10228
|
+
body: (payload: PatchServiceCombinedRequest) => string;
|
|
10229
|
+
}
|
|
10230
|
+
|
|
10231
|
+
type CreateServiceDeploymentResult = {
|
|
10232
|
+
/** The name of the service. Example: "Example Service" */
|
|
10233
|
+
'name': string;
|
|
10234
|
+
/** A description of the service. Example: "A service description" */
|
|
10235
|
+
'description'?: string;
|
|
10236
|
+
/** An array of previously defined tags to help identify and group the resource. */
|
|
10237
|
+
'tags'?: string[];
|
|
10238
|
+
'billing': {
|
|
9405
10239
|
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
9406
|
-
'deploymentPlan'
|
|
10240
|
+
'deploymentPlan': string;
|
|
9407
10241
|
};
|
|
9408
|
-
'deployment'
|
|
10242
|
+
'deployment': {
|
|
9409
10243
|
/** The number of instances to run the service on. Example: 1 */
|
|
9410
|
-
'instances'
|
|
10244
|
+
'instances': number;
|
|
10245
|
+
/** Allows for customization of buildpack runtime */
|
|
9411
10246
|
'buildpack'?: {
|
|
9412
|
-
|
|
10247
|
+
/** Type of buildpack run configuration */
|
|
10248
|
+
'configType': 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand';
|
|
10249
|
+
/** Custom process which should be run. Required in case where `configType` is `customProcess` */
|
|
9413
10250
|
'customProcess'?: string;
|
|
10251
|
+
/** Custom entrypoint which should be run. Required in case where `configType` is `customEntrypointCustomCommand` */
|
|
9414
10252
|
'customEntrypoint'?: string;
|
|
10253
|
+
/** Custom command which should be run. Required in case where `configType` is `customCommand`, `customEntrypointCustomCommand` or `originalEntrypointCustomCommand` */
|
|
9415
10254
|
'customCommand'?: string;
|
|
9416
10255
|
};
|
|
10256
|
+
/** Allows for customization of docker runtime */
|
|
9417
10257
|
'docker'?: {
|
|
9418
|
-
|
|
10258
|
+
/** Type of entrypoint & command override configuration Example: "default" */
|
|
10259
|
+
'configType': 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand';
|
|
10260
|
+
/** Custom entrypoint which should be used. Required in case where `configType` is `customEntrypoint` or `customEntrypointCustomCommand` */
|
|
9419
10261
|
'customEntrypoint'?: string;
|
|
10262
|
+
/** Custom command which should be used. Required in case where `configType` is `customCommand` or `customEntrypointCustomCommand` */
|
|
9420
10263
|
'customCommand'?: string;
|
|
9421
10264
|
};
|
|
9422
10265
|
'storage'?: {
|
|
@@ -9429,6 +10272,22 @@ type PatchServiceCombinedData = {
|
|
|
9429
10272
|
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9430
10273
|
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9431
10274
|
};
|
|
10275
|
+
'internal'?: {
|
|
10276
|
+
/** ID of the build service to deploy Example: "example-build-service" */
|
|
10277
|
+
'id'?: string;
|
|
10278
|
+
/** Branch to deploy Example: "master" */
|
|
10279
|
+
'branch'?: string;
|
|
10280
|
+
/** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
|
|
10281
|
+
'buildSHA'?: string | 'latest';
|
|
10282
|
+
/** ID of the build that should be deployed Example: "premium-guide-6393" */
|
|
10283
|
+
'buildId'?: string;
|
|
10284
|
+
};
|
|
10285
|
+
'external'?: {
|
|
10286
|
+
/** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
|
|
10287
|
+
'imagePath': string;
|
|
10288
|
+
/** ID of the saved credentials to use to access this external image. Example: "example-credentials" */
|
|
10289
|
+
'credentials'?: string;
|
|
10290
|
+
};
|
|
9432
10291
|
};
|
|
9433
10292
|
'ports'?: {
|
|
9434
10293
|
/** The name used to identify the port. Example: "port-1" */
|
|
@@ -9460,60 +10319,12 @@ type PatchServiceCombinedData = {
|
|
|
9460
10319
|
/** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
|
|
9461
10320
|
'disableNfDomain'?: boolean;
|
|
9462
10321
|
/** The protocol to use for the port. Example: "HTTP" */
|
|
9463
|
-
'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
10322
|
+
'protocol': 'HTTP' | 'HTTP/2' | 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
|
|
9464
10323
|
}[];
|
|
9465
|
-
|
|
9466
|
-
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
9467
|
-
'projectUrl'?: string;
|
|
9468
|
-
/** The VCS provider to use. Example: "github" */
|
|
9469
|
-
'projectType'?: 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
9470
|
-
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
9471
|
-
'selfHostedVcsId'?: string;
|
|
9472
|
-
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
9473
|
-
'accountLogin'?: string;
|
|
9474
|
-
/** The name of the branch to use. Example: "master" */
|
|
9475
|
-
'projectBranch'?: string;
|
|
9476
|
-
};
|
|
9477
|
-
'buildSettings'?: {
|
|
9478
|
-
'dockerfile'?: {
|
|
9479
|
-
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
9480
|
-
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
9481
|
-
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
9482
|
-
'dockerFilePath'?: string;
|
|
9483
|
-
/** The working directory of the Dockerfile. Example: "/" */
|
|
9484
|
-
'dockerWorkDir'?: string;
|
|
9485
|
-
/** Should intermediate image layers be cached? */
|
|
9486
|
-
'useCache'?: boolean;
|
|
9487
|
-
};
|
|
9488
|
-
'buildpack'?: {
|
|
9489
|
-
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
9490
|
-
'builder'?: 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
9491
|
-
/** Array of custom Buildpacks to use. */
|
|
9492
|
-
'buildpackLocators'?: string[];
|
|
9493
|
-
/** The working directory to build in. Example: "/" */
|
|
9494
|
-
'buildContext'?: string;
|
|
9495
|
-
/** Should build dependencies be cached? */
|
|
9496
|
-
'useCache'?: boolean;
|
|
9497
|
-
};
|
|
9498
|
-
};
|
|
9499
|
-
'buildConfiguration'?: {
|
|
9500
|
-
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
9501
|
-
'pathIgnoreRules'?: string[];
|
|
9502
|
-
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
9503
|
-
'isAllowList'?: boolean;
|
|
9504
|
-
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
9505
|
-
'ciIgnoreFlagsEnabled'?: boolean;
|
|
9506
|
-
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
9507
|
-
'ciIgnoreFlags'?: string[];
|
|
9508
|
-
};
|
|
9509
|
-
/** An object containing the runtime environment to set for the service. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
|
|
10324
|
+
/** An object containing the runtime environment to set for the service Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
|
|
9510
10325
|
'runtimeEnvironment'?: any;
|
|
9511
10326
|
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
9512
10327
|
'runtimeFiles'?: any;
|
|
9513
|
-
/** An object containing the build arguments to set for the service. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
|
|
9514
|
-
'buildArguments'?: any;
|
|
9515
|
-
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
9516
|
-
'buildFiles'?: any;
|
|
9517
10328
|
/** An array of health checks. */
|
|
9518
10329
|
'healthChecks'?: {
|
|
9519
10330
|
/** The protocol to access the health check with. Example: "HTTP" */
|
|
@@ -9537,68 +10348,45 @@ type PatchServiceCombinedData = {
|
|
|
9537
10348
|
/** The number of successes required to mark the health check as a success. Example: 1 */
|
|
9538
10349
|
'successThreshold'?: number;
|
|
9539
10350
|
}[];
|
|
10351
|
+
/** Describes all autoscaling configurations */
|
|
9540
10352
|
'autoscaling'?: {
|
|
10353
|
+
/** Describes the horizontal autoscaling configuration */
|
|
9541
10354
|
'horizontal'?: {
|
|
9542
10355
|
/** Whether horizontal autoscaling should be enabled */
|
|
9543
|
-
'enabled'
|
|
10356
|
+
'enabled': boolean;
|
|
9544
10357
|
/** Minimum number of replicas which should be running at any time */
|
|
9545
|
-
'minReplicas'
|
|
10358
|
+
'minReplicas': number;
|
|
9546
10359
|
/** Maximum number of replicas which can be running at any time */
|
|
9547
|
-
'maxReplicas'
|
|
10360
|
+
'maxReplicas': number;
|
|
9548
10361
|
'cpu'?: {
|
|
9549
10362
|
/** Whether autoscaling should take into account cpu usage */
|
|
9550
|
-
'enabled'
|
|
10363
|
+
'enabled': boolean;
|
|
9551
10364
|
/** Threshold CPU usage percentage at which the workload will be scaled */
|
|
9552
|
-
'thresholdPercentage'
|
|
10365
|
+
'thresholdPercentage': number;
|
|
9553
10366
|
};
|
|
9554
10367
|
'memory'?: {
|
|
9555
10368
|
/** Whether autoscaling should take into account memory usage */
|
|
9556
|
-
'enabled'
|
|
10369
|
+
'enabled': boolean;
|
|
9557
10370
|
/** Threshold memory usage percentage at which the workload will be scaled */
|
|
9558
|
-
'thresholdPercentage'
|
|
10371
|
+
'thresholdPercentage': number;
|
|
9559
10372
|
};
|
|
9560
10373
|
};
|
|
9561
10374
|
};
|
|
9562
|
-
|
|
9563
|
-
|
|
9564
|
-
|
|
9565
|
-
|
|
9566
|
-
|
|
9567
|
-
requiredPermissions: string;
|
|
9568
|
-
endpointUrl: (opts: PatchServiceCombinedRequest) => string;
|
|
9569
|
-
body: (payload: PatchServiceCombinedRequest) => string;
|
|
9570
|
-
}
|
|
9571
|
-
|
|
9572
|
-
type CreateServiceDeploymentResult = {
|
|
10375
|
+
'deploymentSysctlSettings'?: {
|
|
10376
|
+
'vm.max_map_count'?: number;
|
|
10377
|
+
};
|
|
10378
|
+
/** Type of the service (combined, build or deployment) Example: "deployment" */
|
|
10379
|
+
'serviceType': 'deployment';
|
|
9573
10380
|
/** Identifier for the service Example: "example-service" */
|
|
9574
10381
|
'id': string;
|
|
9575
10382
|
/** Full identifier used for service deployment Example: "/example-user/default-project/example-service" */
|
|
9576
10383
|
'appId': string;
|
|
9577
|
-
/**
|
|
9578
|
-
'
|
|
9579
|
-
/**
|
|
9580
|
-
'
|
|
9581
|
-
/** ID of the project that the service belongs to Example: "default-project" */
|
|
9582
|
-
'projectId': string;
|
|
9583
|
-
/** The time the service was created. Example: "2021-01-20T11:19:53.175Z" */
|
|
9584
|
-
'createdAt': string;
|
|
9585
|
-
/** Whether Continuous Integration is disabled */
|
|
9586
|
-
'disabledCI': boolean;
|
|
9587
|
-
/** Whether Continuous Deployment is disabled */
|
|
9588
|
-
'disabledCD': boolean;
|
|
9589
|
-
'billing': {
|
|
9590
|
-
/** ID of the billing plan used by this service Example: "nf-compute-20" */
|
|
9591
|
-
'deploymentPlan': string;
|
|
9592
|
-
};
|
|
10384
|
+
/** time of creation */
|
|
10385
|
+
'createdAt'?: string;
|
|
10386
|
+
/** time of update */
|
|
10387
|
+
'updatedAt'?: string;
|
|
9593
10388
|
/** Details about the current service status. */
|
|
9594
10389
|
'status': {
|
|
9595
|
-
/** Details about the status of the most recent build. */
|
|
9596
|
-
'build'?: {
|
|
9597
|
-
/** The current status of the build. Example: "SUCCESS" */
|
|
9598
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
9599
|
-
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
9600
|
-
'lastTransitionTime'?: string;
|
|
9601
|
-
};
|
|
9602
10390
|
/** Details about the current deployment status. */
|
|
9603
10391
|
'deployment'?: {
|
|
9604
10392
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
@@ -9609,67 +10397,6 @@ type CreateServiceDeploymentResult = {
|
|
|
9609
10397
|
'lastTransitionTime'?: string;
|
|
9610
10398
|
};
|
|
9611
10399
|
};
|
|
9612
|
-
/** Is the service paused? */
|
|
9613
|
-
'servicePaused': boolean;
|
|
9614
|
-
/** Type of the service (combined, build or deployment) Example: "deployment" */
|
|
9615
|
-
'serviceType': 'combined' | 'build' | 'deployment';
|
|
9616
|
-
'deployment'?: {
|
|
9617
|
-
/** Region where this service is deployed and/or built Example: "europe-west" */
|
|
9618
|
-
'region'?: string;
|
|
9619
|
-
/** Number of instances/replicas running Example: 1 */
|
|
9620
|
-
'instances'?: number;
|
|
9621
|
-
/** Data about a deployment from an external registry. */
|
|
9622
|
-
'external'?: {
|
|
9623
|
-
/** Path of the external image excluding the hostname */
|
|
9624
|
-
'imagePath': string;
|
|
9625
|
-
/** Registry provider hosting the external image */
|
|
9626
|
-
'registryProvider': 'dockerhub' | 'gcr' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
|
|
9627
|
-
/** Does the image require authentication */
|
|
9628
|
-
'privateImage': boolean;
|
|
9629
|
-
};
|
|
9630
|
-
'internal'?: {
|
|
9631
|
-
/** Database ID of deployed entity Example: "example-service" */
|
|
9632
|
-
'nfObjectId': string;
|
|
9633
|
-
/** Type of deployed entity Example: "service" */
|
|
9634
|
-
'nfObjectType': 'service';
|
|
9635
|
-
/** URL of the repository being deployed Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
9636
|
-
'repository': string;
|
|
9637
|
-
/** Branch of the repo being deployed Example: "master" */
|
|
9638
|
-
'branch': string;
|
|
9639
|
-
/** Commit SHA to be deployed. `latest` means the latest commit is automatically being deployed. Example: "latest" */
|
|
9640
|
-
'buildSHA': string;
|
|
9641
|
-
/** Currently deployed commit SHA. If buildSHA is set to `latest`, this will show the SHA of the latest commit. Example: "262ed9817b3cad5142fbceabe0c9e371e390d616" */
|
|
9642
|
-
'deployedSHA'?: string;
|
|
9643
|
-
};
|
|
9644
|
-
/** Details about the Docker overrides for this deployment. */
|
|
9645
|
-
'docker'?: {
|
|
9646
|
-
/** Override configuration which is used at runtime. Example: "default" */
|
|
9647
|
-
'configType': 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand';
|
|
9648
|
-
/** The CMD to run instead of the default if entrypoint override is enabled. */
|
|
9649
|
-
'customEntrypoint'?: string;
|
|
9650
|
-
/** The CMD to run instead of the default if CMD override is enabled. */
|
|
9651
|
-
'customCommand'?: string;
|
|
9652
|
-
};
|
|
9653
|
-
/** Details about the Buildpack overrides for this deployment. */
|
|
9654
|
-
'buildpack'?: {
|
|
9655
|
-
/** Type of buildpack run configuration. Example: "default" */
|
|
9656
|
-
'configType': 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand';
|
|
9657
|
-
/** Custom process which should be run. */
|
|
9658
|
-
'customProcess'?: string;
|
|
9659
|
-
/** Custom entrypoint which should be run. */
|
|
9660
|
-
'customEntrypoint'?: string;
|
|
9661
|
-
/** Custom command which should be run. */
|
|
9662
|
-
'customCommand'?: string;
|
|
9663
|
-
};
|
|
9664
|
-
/** Details about storage settings for this deployment. */
|
|
9665
|
-
'storage'?: {
|
|
9666
|
-
/** Details about ephemeral storage settings for this deployment. */
|
|
9667
|
-
'ephemeralStorage'?: {
|
|
9668
|
-
/** Ephemeral storage per container in MB Example: 1024 */
|
|
9669
|
-
'storageSize': number;
|
|
9670
|
-
};
|
|
9671
|
-
};
|
|
9672
|
-
};
|
|
9673
10400
|
} | any;
|
|
9674
10401
|
type CreateServiceDeploymentCall = (opts: CreateServiceDeploymentRequest) => Promise<ApiCallResponse<CreateServiceDeploymentResult>>;
|
|
9675
10402
|
type CreateServiceDeploymentRequest = {
|
|
@@ -10569,103 +11296,107 @@ type PatchServiceDeploymentData = {
|
|
|
10569
11296
|
};
|
|
10570
11297
|
};
|
|
10571
11298
|
};
|
|
10572
|
-
};
|
|
10573
|
-
/** Updates a deployment service. */
|
|
10574
|
-
declare class PatchServiceDeploymentEndpoint extends PatchApiEndpoint<PatchServiceDeploymentRequest, PatchServiceDeploymentResult> {
|
|
10575
|
-
description: string;
|
|
10576
|
-
withAuth: boolean;
|
|
10577
|
-
requiredPermissions: string;
|
|
10578
|
-
endpointUrl: (opts: PatchServiceDeploymentRequest) => string;
|
|
10579
|
-
body: (payload: PatchServiceDeploymentRequest) => string;
|
|
10580
|
-
}
|
|
10581
|
-
|
|
10582
|
-
type CreateServiceBuildResult = {
|
|
11299
|
+
};
|
|
11300
|
+
/** Updates a deployment service. */
|
|
11301
|
+
declare class PatchServiceDeploymentEndpoint extends PatchApiEndpoint<PatchServiceDeploymentRequest, PatchServiceDeploymentResult> {
|
|
11302
|
+
description: string;
|
|
11303
|
+
withAuth: boolean;
|
|
11304
|
+
requiredPermissions: string;
|
|
11305
|
+
endpointUrl: (opts: PatchServiceDeploymentRequest) => string;
|
|
11306
|
+
body: (payload: PatchServiceDeploymentRequest) => string;
|
|
11307
|
+
}
|
|
11308
|
+
|
|
11309
|
+
type CreateServiceBuildResult = {
|
|
11310
|
+
/** The name of the service. Example: "Example Service" */
|
|
11311
|
+
'name': string;
|
|
11312
|
+
/** A description of the service. Example: "A service description" */
|
|
11313
|
+
'description'?: string;
|
|
11314
|
+
/** An array of previously defined tags to help identify and group the resource. */
|
|
11315
|
+
'tags'?: string[];
|
|
11316
|
+
'billing': {
|
|
11317
|
+
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
11318
|
+
'deploymentPlan': string;
|
|
11319
|
+
};
|
|
11320
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
11321
|
+
'disabledCI'?: boolean;
|
|
11322
|
+
'vcsData': {
|
|
11323
|
+
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
11324
|
+
'projectUrl': string;
|
|
11325
|
+
/** The VCS provider to use. Example: "github" */
|
|
11326
|
+
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
11327
|
+
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
11328
|
+
'selfHostedVcsId'?: string;
|
|
11329
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
11330
|
+
'accountLogin'?: string;
|
|
11331
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
11332
|
+
'vcsLinkId'?: string;
|
|
11333
|
+
};
|
|
11334
|
+
'buildSettings': {
|
|
11335
|
+
'dockerfile': {
|
|
11336
|
+
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
11337
|
+
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
11338
|
+
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
11339
|
+
'dockerFilePath': string;
|
|
11340
|
+
/** The working directory of the Dockerfile. Example: "/" */
|
|
11341
|
+
'dockerWorkDir': string;
|
|
11342
|
+
/** Should intermediate image layers be cached? */
|
|
11343
|
+
'useCache'?: boolean;
|
|
11344
|
+
};
|
|
11345
|
+
} | {
|
|
11346
|
+
'buildpack': {
|
|
11347
|
+
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
11348
|
+
'builder'?: 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
11349
|
+
/** Array of custom Buildpacks to use. */
|
|
11350
|
+
'buildpackLocators'?: string[];
|
|
11351
|
+
/** The working directory to build in. Example: "/" */
|
|
11352
|
+
'buildContext'?: string;
|
|
11353
|
+
/** Should build dependencies be cached? */
|
|
11354
|
+
'useCache'?: boolean;
|
|
11355
|
+
};
|
|
11356
|
+
};
|
|
11357
|
+
'buildConfiguration'?: {
|
|
11358
|
+
/** An array of pull request build rules. Only supported for build services. Each commit belonging to a pull request on a branch that matches one of the provided build rules will be built automatically. */
|
|
11359
|
+
'prRestrictions'?: string[];
|
|
11360
|
+
/** An array of branch build rules. Only supported for build services. Each commit belonging to a branch that matches one of the provided build rules will be built automatically. */
|
|
11361
|
+
'branchRestrictions'?: string[];
|
|
11362
|
+
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
11363
|
+
'pathIgnoreRules'?: string[];
|
|
11364
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
11365
|
+
'isAllowList'?: boolean;
|
|
11366
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
11367
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
11368
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `["[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
11369
|
+
'ciIgnoreFlags'?: string[];
|
|
11370
|
+
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
11371
|
+
'dockerfileTarget'?: string;
|
|
11372
|
+
/** Include .git folder inside the build context */
|
|
11373
|
+
'includeGitFolder'?: boolean;
|
|
11374
|
+
/** Include the entire git history as part of the .git folder. Only relevant if "includeGitFolder" is set. */
|
|
11375
|
+
'fullGitClone'?: boolean;
|
|
11376
|
+
};
|
|
11377
|
+
/** An object containing the build arguments to set for the service Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
|
|
11378
|
+
'buildArguments'?: any;
|
|
11379
|
+
/** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
|
|
11380
|
+
'buildFiles'?: any;
|
|
11381
|
+
/** Type of the service (combined, build or deployment) Example: "build" */
|
|
11382
|
+
'serviceType': 'build';
|
|
10583
11383
|
/** Identifier for the service Example: "example-service" */
|
|
10584
11384
|
'id': string;
|
|
10585
11385
|
/** Full identifier used for service deployment Example: "/example-user/default-project/example-service" */
|
|
10586
11386
|
'appId': string;
|
|
10587
|
-
/**
|
|
10588
|
-
'
|
|
10589
|
-
/**
|
|
10590
|
-
'
|
|
10591
|
-
/** ID of the project that the service belongs to Example: "default-project" */
|
|
10592
|
-
'projectId': string;
|
|
10593
|
-
/** The time the service was created. Example: "2021-01-20T11:19:53.175Z" */
|
|
10594
|
-
'createdAt': string;
|
|
10595
|
-
/** Whether Continuous Integration is disabled */
|
|
10596
|
-
'disabledCI': boolean;
|
|
10597
|
-
/** Whether Continuous Deployment is disabled */
|
|
10598
|
-
'disabledCD': boolean;
|
|
10599
|
-
'billing': {
|
|
10600
|
-
/** ID of the billing plan used by this service Example: "nf-compute-20" */
|
|
10601
|
-
'deploymentPlan': string;
|
|
10602
|
-
};
|
|
11387
|
+
/** time of creation */
|
|
11388
|
+
'createdAt'?: string;
|
|
11389
|
+
/** time of update */
|
|
11390
|
+
'updatedAt'?: string;
|
|
10603
11391
|
/** Details about the current service status. */
|
|
10604
11392
|
'status': {
|
|
10605
11393
|
/** Details about the status of the most recent build. */
|
|
10606
11394
|
'build'?: {
|
|
10607
11395
|
/** The current status of the build. Example: "SUCCESS" */
|
|
10608
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
11396
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
10609
11397
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
10610
11398
|
'lastTransitionTime'?: string;
|
|
10611
11399
|
};
|
|
10612
|
-
/** Details about the current deployment status. */
|
|
10613
|
-
'deployment'?: {
|
|
10614
|
-
/** The current status of the deployment. Example: "COMPLETED" */
|
|
10615
|
-
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
10616
|
-
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
10617
|
-
'reason': 'SCALING' | 'DEPLOYING';
|
|
10618
|
-
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
10619
|
-
'lastTransitionTime'?: string;
|
|
10620
|
-
};
|
|
10621
|
-
};
|
|
10622
|
-
/** Is the service paused? */
|
|
10623
|
-
'servicePaused': boolean;
|
|
10624
|
-
/** Type of the service (combined, build or deployment) Example: "build" */
|
|
10625
|
-
'serviceType': 'combined' | 'build' | 'deployment';
|
|
10626
|
-
'vcsData'?: {
|
|
10627
|
-
/** URL of the repository being built Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
10628
|
-
'projectUrl': string;
|
|
10629
|
-
/** VCS provider for the repo being built Example: "github" */
|
|
10630
|
-
'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
10631
|
-
/** ID of the self-hosted VCS, if applicable. Example: "example-team/self-hosted-vcs" */
|
|
10632
|
-
'selfHostedVcsId'?: string;
|
|
10633
|
-
/** Branch of the repo being built Example: "master" */
|
|
10634
|
-
'projectBranch'?: string;
|
|
10635
|
-
/** Whether the repo is being accessed without authentication. */
|
|
10636
|
-
'publicRepo'?: boolean;
|
|
10637
|
-
/** Working directory used by the dockerfile Example: "/" */
|
|
10638
|
-
'dockerWorkDir': string;
|
|
10639
|
-
/** File path of the Dockerfile Example: "/Dockerfile" */
|
|
10640
|
-
'dockerFilePath': string;
|
|
10641
|
-
};
|
|
10642
|
-
'buildConfiguration'?: {
|
|
10643
|
-
'branchRestrictions'?: string[];
|
|
10644
|
-
'prRestrictions'?: string[];
|
|
10645
|
-
'pathIgnoreRules': string[];
|
|
10646
|
-
};
|
|
10647
|
-
'buildEngineConfiguration': {
|
|
10648
|
-
/** The build engine used. Example: "buildpack" */
|
|
10649
|
-
'buildEngine'?: 'buildpack' | 'kaniko' | 'buildkit';
|
|
10650
|
-
/** Details about Buildpack settings. */
|
|
10651
|
-
'buildpack'?: {
|
|
10652
|
-
/** The Buildpack stack used. Example: "HEROKU_22_CLASSIC" */
|
|
10653
|
-
'builder'?: 'HEROKU_22' | 'HEROKU_22_CLASSIC' | 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY' | 'PAKETO_BASE' | 'PAKETO_FULL';
|
|
10654
|
-
/** Array of custom Buildpacks used. */
|
|
10655
|
-
'buildpackLocators'?: string[];
|
|
10656
|
-
/** Should build dependencies be cached? */
|
|
10657
|
-
'useCache'?: boolean;
|
|
10658
|
-
};
|
|
10659
|
-
/** Details about Buildkit settings. */
|
|
10660
|
-
'buildkit'?: {
|
|
10661
|
-
/** Should intermediate image layers be cached? */
|
|
10662
|
-
'useCache'?: boolean;
|
|
10663
|
-
};
|
|
10664
|
-
/** Details about Kaniko settings. */
|
|
10665
|
-
'kaniko'?: {
|
|
10666
|
-
/** Should intermediate image layers be cached? */
|
|
10667
|
-
'useCache'?: boolean;
|
|
10668
|
-
};
|
|
10669
11400
|
};
|
|
10670
11401
|
} | any;
|
|
10671
11402
|
type CreateServiceBuildCall = (opts: CreateServiceBuildRequest) => Promise<ApiCallResponse<CreateServiceBuildResult>>;
|
|
@@ -10687,6 +11418,8 @@ type CreateServiceBuildData = {
|
|
|
10687
11418
|
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
10688
11419
|
'deploymentPlan': string;
|
|
10689
11420
|
};
|
|
11421
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
11422
|
+
'disabledCI'?: boolean;
|
|
10690
11423
|
'vcsData': {
|
|
10691
11424
|
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
10692
11425
|
'projectUrl': string;
|
|
@@ -10696,6 +11429,8 @@ type CreateServiceBuildData = {
|
|
|
10696
11429
|
'selfHostedVcsId'?: string;
|
|
10697
11430
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
10698
11431
|
'accountLogin'?: string;
|
|
11432
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
11433
|
+
'vcsLinkId'?: string;
|
|
10699
11434
|
};
|
|
10700
11435
|
'buildSettings': {
|
|
10701
11436
|
'dockerfile': {
|
|
@@ -10765,6 +11500,8 @@ type PutServiceBuildResult = {
|
|
|
10765
11500
|
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
10766
11501
|
'deploymentPlan': string;
|
|
10767
11502
|
};
|
|
11503
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
11504
|
+
'disabledCI'?: boolean;
|
|
10768
11505
|
'vcsData': {
|
|
10769
11506
|
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
10770
11507
|
'projectUrl': string;
|
|
@@ -10774,6 +11511,8 @@ type PutServiceBuildResult = {
|
|
|
10774
11511
|
'selfHostedVcsId'?: string;
|
|
10775
11512
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
10776
11513
|
'accountLogin'?: string;
|
|
11514
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
11515
|
+
'vcsLinkId'?: string;
|
|
10777
11516
|
};
|
|
10778
11517
|
'buildSettings': {
|
|
10779
11518
|
'dockerfile': {
|
|
@@ -10837,7 +11576,7 @@ type PutServiceBuildResult = {
|
|
|
10837
11576
|
/** Details about the status of the most recent build. */
|
|
10838
11577
|
'build'?: {
|
|
10839
11578
|
/** The current status of the build. Example: "SUCCESS" */
|
|
10840
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
11579
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
10841
11580
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
10842
11581
|
'lastTransitionTime'?: string;
|
|
10843
11582
|
};
|
|
@@ -10862,6 +11601,8 @@ type PutServiceBuildData = {
|
|
|
10862
11601
|
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
10863
11602
|
'deploymentPlan': string;
|
|
10864
11603
|
};
|
|
11604
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
11605
|
+
'disabledCI'?: boolean;
|
|
10865
11606
|
'vcsData': {
|
|
10866
11607
|
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
10867
11608
|
'projectUrl': string;
|
|
@@ -10871,6 +11612,8 @@ type PutServiceBuildData = {
|
|
|
10871
11612
|
'selfHostedVcsId'?: string;
|
|
10872
11613
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
10873
11614
|
'accountLogin'?: string;
|
|
11615
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
11616
|
+
'vcsLinkId'?: string;
|
|
10874
11617
|
};
|
|
10875
11618
|
'buildSettings': {
|
|
10876
11619
|
'dockerfile': {
|
|
@@ -10940,6 +11683,8 @@ type PatchServiceBuildResult = {
|
|
|
10940
11683
|
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
10941
11684
|
'deploymentPlan': string;
|
|
10942
11685
|
};
|
|
11686
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
11687
|
+
'disabledCI'?: boolean;
|
|
10943
11688
|
'vcsData': {
|
|
10944
11689
|
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
10945
11690
|
'projectUrl': string;
|
|
@@ -10949,6 +11694,8 @@ type PatchServiceBuildResult = {
|
|
|
10949
11694
|
'selfHostedVcsId'?: string;
|
|
10950
11695
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
10951
11696
|
'accountLogin'?: string;
|
|
11697
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
11698
|
+
'vcsLinkId'?: string;
|
|
10952
11699
|
};
|
|
10953
11700
|
'buildSettings': {
|
|
10954
11701
|
'dockerfile': {
|
|
@@ -11012,7 +11759,7 @@ type PatchServiceBuildResult = {
|
|
|
11012
11759
|
/** Details about the status of the most recent build. */
|
|
11013
11760
|
'build'?: {
|
|
11014
11761
|
/** The current status of the build. Example: "SUCCESS" */
|
|
11015
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
11762
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
11016
11763
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
11017
11764
|
'lastTransitionTime'?: string;
|
|
11018
11765
|
};
|
|
@@ -11037,6 +11784,8 @@ type PatchServiceBuildData = {
|
|
|
11037
11784
|
/** The ID of the deployment plan to use. Example: "nf-compute-20" */
|
|
11038
11785
|
'deploymentPlan'?: string;
|
|
11039
11786
|
};
|
|
11787
|
+
/** Whether CI (continuous integration) should be disabled. */
|
|
11788
|
+
'disabledCI'?: boolean;
|
|
11040
11789
|
'vcsData'?: {
|
|
11041
11790
|
/** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
11042
11791
|
'projectUrl'?: string;
|
|
@@ -11046,6 +11795,8 @@ type PatchServiceBuildData = {
|
|
|
11046
11795
|
'selfHostedVcsId'?: string;
|
|
11047
11796
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
11048
11797
|
'accountLogin'?: string;
|
|
11798
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `vcsLinkId` is provided, Northflank will instead use your linked account with that ID. */
|
|
11799
|
+
'vcsLinkId'?: string;
|
|
11049
11800
|
};
|
|
11050
11801
|
'buildSettings'?: {
|
|
11051
11802
|
'dockerfile'?: {
|
|
@@ -11125,7 +11876,7 @@ type GetServiceResult = {
|
|
|
11125
11876
|
/** Details about the status of the most recent build. */
|
|
11126
11877
|
'build'?: {
|
|
11127
11878
|
/** The current status of the build. Example: "SUCCESS" */
|
|
11128
|
-
'status': 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
11879
|
+
'status': 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
11129
11880
|
/** The timestamp of when the build reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
11130
11881
|
'lastTransitionTime'?: string;
|
|
11131
11882
|
};
|
|
@@ -11975,7 +12726,7 @@ type GetServiceBuildsResult = {
|
|
|
11975
12726
|
/** ID of the pull request the commit belongs to. */
|
|
11976
12727
|
'pullRequestId'?: number;
|
|
11977
12728
|
/** The status of the build. Example: "SUCCESS" */
|
|
11978
|
-
'status'?: 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
12729
|
+
'status'?: 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
11979
12730
|
/** The sha of the built commit. Example: "12c15e7ee25fd78f567ebf87f9178b8ad70025b3" */
|
|
11980
12731
|
'sha'?: string;
|
|
11981
12732
|
/** Whether the build has finished. Example: true */
|
|
@@ -12080,7 +12831,7 @@ type GetServiceBuildResult = {
|
|
|
12080
12831
|
/** ID of the pull request the commit belongs to. */
|
|
12081
12832
|
'pullRequestId'?: number;
|
|
12082
12833
|
/** The status of the build. Example: "SUCCESS" */
|
|
12083
|
-
'status'?: 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
12834
|
+
'status'?: 'QUEUED' | 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUBMISSION_FAILURE' | 'SUCCESS' | 'CRASHED';
|
|
12084
12835
|
/** The sha of the built commit. Example: "12c15e7ee25fd78f567ebf87f9178b8ad70025b3" */
|
|
12085
12836
|
'sha'?: string;
|
|
12086
12837
|
/** Whether the build has finished. Example: true */
|
|
@@ -12284,6 +13035,8 @@ type ListTemplatesResult = {
|
|
|
12284
13035
|
'apiVersion': 'v1';
|
|
12285
13036
|
/** Identifier for the template Example: "example-template" */
|
|
12286
13037
|
'id': string;
|
|
13038
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13039
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12287
13040
|
/** time of creation */
|
|
12288
13041
|
'createdAt'?: string;
|
|
12289
13042
|
/** time of update */
|
|
@@ -12366,6 +13119,8 @@ type CreateTemplateResult = {
|
|
|
12366
13119
|
/** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
|
|
12367
13120
|
'templateSha': string;
|
|
12368
13121
|
};
|
|
13122
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13123
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12369
13124
|
'options': {
|
|
12370
13125
|
/** Whether autorun is enabled */
|
|
12371
13126
|
'autorun': boolean;
|
|
@@ -12415,12 +13170,14 @@ type CreateTemplateResult = {
|
|
|
12415
13170
|
'id': string;
|
|
12416
13171
|
/** Identifier for the template Example: "example-template" */
|
|
12417
13172
|
'templateId': string;
|
|
12418
|
-
/** Status of the template run Example: "
|
|
12419
|
-
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
12420
|
-
/**
|
|
12421
|
-
'
|
|
12422
|
-
/**
|
|
12423
|
-
'
|
|
13173
|
+
/** Status of the template run Example: "success" */
|
|
13174
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
13175
|
+
/** Whether the run has concluded (aborted, success, failed) Example: true */
|
|
13176
|
+
'concluded': boolean;
|
|
13177
|
+
/** Timestamp the run was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13178
|
+
'createdAt': string;
|
|
13179
|
+
/** Timestamp the run was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13180
|
+
'updatedAt': string;
|
|
12424
13181
|
};
|
|
12425
13182
|
};
|
|
12426
13183
|
type CreateTemplateCall = (opts: CreateTemplateRequest) => Promise<ApiCallResponse<CreateTemplateResult>>;
|
|
@@ -12462,6 +13219,8 @@ type CreateTemplateData = {
|
|
|
12462
13219
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
12463
13220
|
'arguments'?: any;
|
|
12464
13221
|
'spec': any;
|
|
13222
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13223
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12465
13224
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
12466
13225
|
'argumentOverrides'?: any;
|
|
12467
13226
|
/** Additional options for the template creation. */
|
|
@@ -12508,6 +13267,8 @@ type CreateTemplateData = {
|
|
|
12508
13267
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
12509
13268
|
'arguments'?: any;
|
|
12510
13269
|
'spec': any;
|
|
13270
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13271
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12511
13272
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
12512
13273
|
'argumentOverrides'?: any;
|
|
12513
13274
|
/** Additional options for the template creation. */
|
|
@@ -12539,6 +13300,8 @@ type CreateTemplateData = {
|
|
|
12539
13300
|
'name': string;
|
|
12540
13301
|
/** Description of the template. Example: "This is a sample template." */
|
|
12541
13302
|
'description'?: string;
|
|
13303
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13304
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12542
13305
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
12543
13306
|
'argumentOverrides'?: any;
|
|
12544
13307
|
/** Additional options for the template creation. */
|
|
@@ -12628,6 +13391,8 @@ type GetTemplateResult = {
|
|
|
12628
13391
|
/** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
|
|
12629
13392
|
'templateSha': string;
|
|
12630
13393
|
};
|
|
13394
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13395
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12631
13396
|
'options': {
|
|
12632
13397
|
/** Whether autorun is enabled */
|
|
12633
13398
|
'autorun': boolean;
|
|
@@ -12717,6 +13482,8 @@ type UpdateTemplateResult = {
|
|
|
12717
13482
|
/** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
|
|
12718
13483
|
'templateSha': string;
|
|
12719
13484
|
};
|
|
13485
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13486
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12720
13487
|
'options': {
|
|
12721
13488
|
/** Whether autorun is enabled */
|
|
12722
13489
|
'autorun': boolean;
|
|
@@ -12766,12 +13533,14 @@ type UpdateTemplateResult = {
|
|
|
12766
13533
|
'id': string;
|
|
12767
13534
|
/** Identifier for the template Example: "example-template" */
|
|
12768
13535
|
'templateId': string;
|
|
12769
|
-
/** Status of the template run Example: "
|
|
12770
|
-
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
12771
|
-
/**
|
|
12772
|
-
'
|
|
12773
|
-
/**
|
|
12774
|
-
'
|
|
13536
|
+
/** Status of the template run Example: "success" */
|
|
13537
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
13538
|
+
/** Whether the run has concluded (aborted, success, failed) Example: true */
|
|
13539
|
+
'concluded': boolean;
|
|
13540
|
+
/** Timestamp the run was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13541
|
+
'createdAt': string;
|
|
13542
|
+
/** Timestamp the run was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13543
|
+
'updatedAt': string;
|
|
12775
13544
|
};
|
|
12776
13545
|
};
|
|
12777
13546
|
type UpdateTemplateCall = (opts: UpdateTemplateRequest) => Promise<ApiCallResponse<UpdateTemplateResult>>;
|
|
@@ -12817,6 +13586,8 @@ type UpdateTemplateData = {
|
|
|
12817
13586
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
12818
13587
|
'arguments'?: any;
|
|
12819
13588
|
'spec': any;
|
|
13589
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13590
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12820
13591
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
12821
13592
|
'argumentOverrides'?: any;
|
|
12822
13593
|
/** Additional options for the template creation. */
|
|
@@ -12859,6 +13630,8 @@ type UpdateTemplateData = {
|
|
|
12859
13630
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
12860
13631
|
'arguments'?: any;
|
|
12861
13632
|
'spec': any;
|
|
13633
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13634
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12862
13635
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
12863
13636
|
'argumentOverrides'?: any;
|
|
12864
13637
|
/** Additional options for the template creation. */
|
|
@@ -12886,6 +13659,8 @@ type UpdateTemplateData = {
|
|
|
12886
13659
|
'name': string;
|
|
12887
13660
|
/** Description of the template. Example: "This is a sample template." */
|
|
12888
13661
|
'description'?: string;
|
|
13662
|
+
/** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
|
|
13663
|
+
'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
|
|
12889
13664
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
12890
13665
|
'argumentOverrides'?: any;
|
|
12891
13666
|
/** Additional options for the template creation. */
|
|
@@ -12975,12 +13750,14 @@ type RunTemplateResult = {
|
|
|
12975
13750
|
'id': string;
|
|
12976
13751
|
/** Identifier for the template Example: "example-template" */
|
|
12977
13752
|
'templateId': string;
|
|
12978
|
-
/** Status of the template run Example: "
|
|
12979
|
-
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
12980
|
-
/**
|
|
12981
|
-
'
|
|
12982
|
-
/**
|
|
12983
|
-
'
|
|
13753
|
+
/** Status of the template run Example: "success" */
|
|
13754
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
13755
|
+
/** Whether the run has concluded (aborted, success, failed) Example: true */
|
|
13756
|
+
'concluded': boolean;
|
|
13757
|
+
/** Timestamp the run was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13758
|
+
'createdAt': string;
|
|
13759
|
+
/** Timestamp the run was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13760
|
+
'updatedAt': string;
|
|
12984
13761
|
};
|
|
12985
13762
|
type RunTemplateCall = (opts: RunTemplateRequest) => Promise<ApiCallResponse<RunTemplateResult>>;
|
|
12986
13763
|
type RunTemplateRequest = {
|
|
@@ -13016,12 +13793,18 @@ type ListTemplaterunsResult = {
|
|
|
13016
13793
|
'id': string;
|
|
13017
13794
|
/** Identifier for the template Example: "example-template" */
|
|
13018
13795
|
'templateId': string;
|
|
13019
|
-
/** Status of the template run Example: "
|
|
13020
|
-
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
13021
|
-
/**
|
|
13022
|
-
'
|
|
13023
|
-
/**
|
|
13024
|
-
'
|
|
13796
|
+
/** Status of the template run Example: "success" */
|
|
13797
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
13798
|
+
/** Timestamp the run started at. Example: "2021-01-01 12:01:00.000Z" */
|
|
13799
|
+
'startedAt'?: string;
|
|
13800
|
+
/** Whether the run has concluded (aborted, success, failed) Example: true */
|
|
13801
|
+
'concluded': boolean;
|
|
13802
|
+
/** Timestamp the run concluded at. Example: "2021-01-01 12:10:00.000Z" */
|
|
13803
|
+
'concludedAt'?: string;
|
|
13804
|
+
/** Timestamp the run was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13805
|
+
'createdAt': string;
|
|
13806
|
+
/** Timestamp the run was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13807
|
+
'updatedAt': string;
|
|
13025
13808
|
}[];
|
|
13026
13809
|
};
|
|
13027
13810
|
type ListTemplaterunsCall = (opts: ListTemplaterunsRequest) => Promise<ApiCallResponse<ListTemplaterunsResult>>;
|
|
@@ -13089,12 +13872,14 @@ type GetTemplaterunResult = {
|
|
|
13089
13872
|
'id': string;
|
|
13090
13873
|
/** Identifier for the template Example: "example-template" */
|
|
13091
13874
|
'templateId': string;
|
|
13092
|
-
/** Status of the template run Example: "
|
|
13093
|
-
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
13094
|
-
/**
|
|
13095
|
-
'
|
|
13096
|
-
/**
|
|
13097
|
-
'
|
|
13875
|
+
/** Status of the template run Example: "success" */
|
|
13876
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
13877
|
+
/** Whether the run has concluded (aborted, success, failed) Example: true */
|
|
13878
|
+
'concluded': boolean;
|
|
13879
|
+
/** Timestamp the run was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13880
|
+
'createdAt': string;
|
|
13881
|
+
/** Timestamp the run was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13882
|
+
'updatedAt': string;
|
|
13098
13883
|
};
|
|
13099
13884
|
type GetTemplaterunCall = (opts: GetTemplaterunRequest) => Promise<ApiCallResponse<GetTemplaterunResult>>;
|
|
13100
13885
|
type GetTemplaterunRequest = {
|
|
@@ -13114,6 +13899,73 @@ declare class GetTemplaterunEndpoint extends GetApiEndpoint<GetTemplaterunReques
|
|
|
13114
13899
|
body: () => undefined;
|
|
13115
13900
|
}
|
|
13116
13901
|
|
|
13902
|
+
type AbortTemplaterunResult = {
|
|
13903
|
+
/** Name of the template. Example: "Example Template" */
|
|
13904
|
+
'name': string;
|
|
13905
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
13906
|
+
'description'?: string;
|
|
13907
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
13908
|
+
'apiVersion': 'v1';
|
|
13909
|
+
/** Details of the project the template will run in. */
|
|
13910
|
+
'project': {
|
|
13911
|
+
/** The ID of the project to use. */
|
|
13912
|
+
'id': string;
|
|
13913
|
+
} | {
|
|
13914
|
+
'spec': {
|
|
13915
|
+
/** The name of the project. Example: "New Project" */
|
|
13916
|
+
'name': string;
|
|
13917
|
+
/** The description of the project. Example: "This is a new project." */
|
|
13918
|
+
'description'?: string;
|
|
13919
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
13920
|
+
'color'?: string;
|
|
13921
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
13922
|
+
'region'?: string;
|
|
13923
|
+
} | {
|
|
13924
|
+
/** The name of the project. Example: "New Project" */
|
|
13925
|
+
'name': string;
|
|
13926
|
+
/** The description of the project. Example: "This is a new project." */
|
|
13927
|
+
'description'?: string;
|
|
13928
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
13929
|
+
'color'?: string;
|
|
13930
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
13931
|
+
'clusterId'?: string;
|
|
13932
|
+
};
|
|
13933
|
+
};
|
|
13934
|
+
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
13935
|
+
'arguments'?: any;
|
|
13936
|
+
'spec': any;
|
|
13937
|
+
'refs'?: any;
|
|
13938
|
+
/** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
|
|
13939
|
+
'id': string;
|
|
13940
|
+
/** Identifier for the template Example: "example-template" */
|
|
13941
|
+
'templateId': string;
|
|
13942
|
+
/** Status of the template run Example: "success" */
|
|
13943
|
+
'status': 'pending' | 'running' | 'success' | 'failure' | 'aborted' | 'aborting';
|
|
13944
|
+
/** Whether the run has concluded (aborted, success, failed) Example: true */
|
|
13945
|
+
'concluded': boolean;
|
|
13946
|
+
/** Timestamp the run was created at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13947
|
+
'createdAt': string;
|
|
13948
|
+
/** Timestamp the run was last updated at. Example: "2021-01-01 12:00:00.000Z" */
|
|
13949
|
+
'updatedAt': string;
|
|
13950
|
+
};
|
|
13951
|
+
type AbortTemplaterunCall = (opts: AbortTemplaterunRequest) => Promise<ApiCallResponse<AbortTemplaterunResult>>;
|
|
13952
|
+
type AbortTemplaterunRequest = {
|
|
13953
|
+
parameters: AbortTemplaterunParameters;
|
|
13954
|
+
};
|
|
13955
|
+
type AbortTemplaterunParameters = {
|
|
13956
|
+
/** ID of the template */ 'templateId': string;
|
|
13957
|
+
/** ID of the template run */
|
|
13958
|
+
'templateRunId': string;
|
|
13959
|
+
};
|
|
13960
|
+
/** Abort the given template run. */
|
|
13961
|
+
declare class AbortTemplaterunEndpoint extends PostApiEndpoint<AbortTemplaterunRequest, AbortTemplaterunResult> {
|
|
13962
|
+
description: string;
|
|
13963
|
+
withAuth: boolean;
|
|
13964
|
+
requiredPermissions: string;
|
|
13965
|
+
endpointUrl: (opts: AbortTemplaterunRequest) => string;
|
|
13966
|
+
body: () => undefined;
|
|
13967
|
+
}
|
|
13968
|
+
|
|
13117
13969
|
type ListReposResult = {
|
|
13118
13970
|
/** A list of accessible repositories. */
|
|
13119
13971
|
'repos'?: {
|
|
@@ -13155,6 +14007,8 @@ type ListReposOptions = {
|
|
|
13155
14007
|
'self_hosted_vcs_id'?: string;
|
|
13156
14008
|
/** If provided, only returns repositories that can be accessed by the linked version control account with this name. */
|
|
13157
14009
|
'account_login'?: string;
|
|
14010
|
+
/** If provided, only returns repositories belong to that VCS link. */
|
|
14011
|
+
'vcs_link_id'?: string;
|
|
13158
14012
|
};
|
|
13159
14013
|
/** Gets a list of repositories accessible to this account */
|
|
13160
14014
|
declare class ListReposEndpoint extends GetApiEndpoint<ListReposRequest, ListReposResult> {
|
|
@@ -13166,26 +14020,14 @@ declare class ListReposEndpoint extends GetApiEndpoint<ListReposRequest, ListRep
|
|
|
13166
14020
|
}
|
|
13167
14021
|
|
|
13168
14022
|
type ListBranchesResult = {
|
|
13169
|
-
/**
|
|
13170
|
-
'
|
|
13171
|
-
|
|
13172
|
-
|
|
13173
|
-
|
|
13174
|
-
|
|
13175
|
-
|
|
13176
|
-
|
|
13177
|
-
'sha': string;
|
|
13178
|
-
/** Details about the commit author. */
|
|
13179
|
-
'author': {
|
|
13180
|
-
/** The login of the commit author. Example: "northflank" */
|
|
13181
|
-
'login': string;
|
|
13182
|
-
};
|
|
13183
|
-
/** Commit message of the commit. Example: "Initial commit" */
|
|
13184
|
-
'message'?: string;
|
|
13185
|
-
/** Timestamp of the commit. Example: "2021-09-17T14:04:39.000Z" */
|
|
13186
|
-
'date'?: string;
|
|
13187
|
-
};
|
|
13188
|
-
}[];
|
|
14023
|
+
/** The number of results to display per request. Maximum of 100 results per page. Example: 50 */
|
|
14024
|
+
'per_page'?: number;
|
|
14025
|
+
/** The page number to access. Example: 1 */
|
|
14026
|
+
'page'?: number;
|
|
14027
|
+
/** The cursor returned from the previous page of results, used to request the next page. */
|
|
14028
|
+
'cursor'?: string;
|
|
14029
|
+
/** If provided, uses the given VCS link to access the repository's data. */
|
|
14030
|
+
'vcs_link_id'?: string;
|
|
13189
14031
|
};
|
|
13190
14032
|
type ListBranchesCall = (opts: ListBranchesRequest) => Promise<ApiCallResponse<ListBranchesResult>>;
|
|
13191
14033
|
type ListBranchesRequest = {
|
|
@@ -13216,6 +14058,34 @@ declare class ListBranchesEndpoint extends GetApiEndpoint<ListBranchesRequest, L
|
|
|
13216
14058
|
body: () => undefined;
|
|
13217
14059
|
}
|
|
13218
14060
|
|
|
14061
|
+
type CreateCustomvcsTokenResult = {
|
|
14062
|
+
/** VCS provider the token belongs to. Example: "github" */
|
|
14063
|
+
'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
14064
|
+
/** Installation ID of the GitHub installation the token belongs to (GitHub only) Example: 1234567 */
|
|
14065
|
+
'installationId'?: number;
|
|
14066
|
+
/** Installation token (GitHub only). Example: "ghs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" */
|
|
14067
|
+
'installationToken'?: string;
|
|
14068
|
+
/** OAuth token. Example: "ghu_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" */
|
|
14069
|
+
'token': string;
|
|
14070
|
+
};
|
|
14071
|
+
type CreateCustomvcsTokenCall = (opts: CreateCustomvcsTokenRequest) => Promise<ApiCallResponse<CreateCustomvcsTokenResult>>;
|
|
14072
|
+
type CreateCustomvcsTokenRequest = {
|
|
14073
|
+
parameters: CreateCustomvcsTokenParameters;
|
|
14074
|
+
};
|
|
14075
|
+
type CreateCustomvcsTokenParameters = {
|
|
14076
|
+
/** ID of the custom VCS */ 'customVCSId': string;
|
|
14077
|
+
/** ID of the version control link */
|
|
14078
|
+
'vcsLinkId': string;
|
|
14079
|
+
};
|
|
14080
|
+
/** Generate a token for a specific VCS link. */
|
|
14081
|
+
declare class CreateCustomvcsTokenEndpoint extends PostApiEndpoint<CreateCustomvcsTokenRequest, CreateCustomvcsTokenResult> {
|
|
14082
|
+
description: string;
|
|
14083
|
+
withAuth: boolean;
|
|
14084
|
+
requiredPermissions: string;
|
|
14085
|
+
endpointUrl: (opts: CreateCustomvcsTokenRequest) => string;
|
|
14086
|
+
body: () => undefined;
|
|
14087
|
+
}
|
|
14088
|
+
|
|
13219
14089
|
type ListVolumesResult = {
|
|
13220
14090
|
/** Identifier for the volume Example: "example-volume" */
|
|
13221
14091
|
'id': string;
|
|
@@ -13757,6 +14627,8 @@ declare class ApiClient {
|
|
|
13757
14627
|
contextProvider: ApiClientContextProvider;
|
|
13758
14628
|
forwarding: NorthflankPortForwarder;
|
|
13759
14629
|
exec: NorthflankExecCommand;
|
|
14630
|
+
logs: NorthflankLogFetch;
|
|
14631
|
+
metrics: NorthflankMetricFetch;
|
|
13760
14632
|
list: {
|
|
13761
14633
|
projects: ListProjectsCall;
|
|
13762
14634
|
addons: ListAddonsCall;
|
|
@@ -13801,6 +14673,9 @@ declare class ApiClient {
|
|
|
13801
14673
|
build: CreateServiceBuildCall;
|
|
13802
14674
|
};
|
|
13803
14675
|
template: CreateTemplateCall;
|
|
14676
|
+
customVcs: {
|
|
14677
|
+
token: CreateCustomvcsTokenCall;
|
|
14678
|
+
};
|
|
13804
14679
|
volume: CreateVolumeCall;
|
|
13805
14680
|
};
|
|
13806
14681
|
get: {
|
|
@@ -13989,9 +14864,11 @@ declare class ApiClient {
|
|
|
13989
14864
|
run: AbortJobRunCall;
|
|
13990
14865
|
build: AbortJobBuildCall;
|
|
13991
14866
|
};
|
|
14867
|
+
releaseFlowRun: AbortReleaseflowrunCall;
|
|
13992
14868
|
service: {
|
|
13993
14869
|
build: AbortServiceBuildCall;
|
|
13994
14870
|
};
|
|
14871
|
+
templateRun: AbortTemplaterunCall;
|
|
13995
14872
|
};
|
|
13996
14873
|
retain: {
|
|
13997
14874
|
addon: {
|
|
@@ -14086,6 +14963,9 @@ declare class ApiClient {
|
|
|
14086
14963
|
build: CreateServiceBuildEndpoint;
|
|
14087
14964
|
};
|
|
14088
14965
|
template: CreateTemplateEndpoint;
|
|
14966
|
+
customVcs: {
|
|
14967
|
+
token: CreateCustomvcsTokenEndpoint;
|
|
14968
|
+
};
|
|
14089
14969
|
volume: CreateVolumeEndpoint;
|
|
14090
14970
|
};
|
|
14091
14971
|
get: {
|
|
@@ -14274,9 +15154,11 @@ declare class ApiClient {
|
|
|
14274
15154
|
run: AbortJobRunEndpoint;
|
|
14275
15155
|
build: AbortJobBuildEndpoint;
|
|
14276
15156
|
};
|
|
15157
|
+
releaseFlowRun: AbortReleaseflowrunEndpoint;
|
|
14277
15158
|
service: {
|
|
14278
15159
|
build: AbortServiceBuildEndpoint;
|
|
14279
15160
|
};
|
|
15161
|
+
templateRun: AbortTemplaterunEndpoint;
|
|
14280
15162
|
};
|
|
14281
15163
|
retain: {
|
|
14282
15164
|
addon: {
|
|
@@ -14335,4 +15217,4 @@ type ApiClientOpts = {
|
|
|
14335
15217
|
customUserAgent?: string;
|
|
14336
15218
|
};
|
|
14337
15219
|
|
|
14338
|
-
export { AbortAddonBackupCall, AbortAddonBackupEndpoint, AbortAddonBackupParameters, AbortAddonBackupRequest, AbortAddonBackupResult, AbortAddonRestoreCall, AbortAddonRestoreData, AbortAddonRestoreEndpoint, AbortAddonRestoreParameters, AbortAddonRestoreRequest, AbortAddonRestoreResult, AbortJobBuildCall, AbortJobBuildEndpoint, AbortJobBuildParameters, AbortJobBuildRequest, AbortJobBuildResult, AbortJobRunCall, AbortJobRunEndpoint, AbortJobRunParameters, AbortJobRunRequest, AbortJobRunResult, AbortServiceBuildCall, AbortServiceBuildEndpoint, AbortServiceBuildParameters, AbortServiceBuildRequest, AbortServiceBuildResult, AddDomainSubdomainCall, AddDomainSubdomainData, AddDomainSubdomainEndpoint, AddDomainSubdomainParameters, AddDomainSubdomainRequest, AddDomainSubdomainResult, AddRegistryCall, AddRegistryData, AddRegistryEndpoint, AddRegistryRequest, AddRegistryResult, ApiCallError, ApiCallResponse, ApiClient, ApiClientContext, ApiClientContextProvider, ApiClientContextWrapper, ApiClientFileContextProvider, ApiClientInMemoryContextProvider, ApiClientOpts, ApiEndpoint, AssignSubdomainServiceCall, AssignSubdomainServiceData, AssignSubdomainServiceEndpoint, AssignSubdomainServiceParameters, AssignSubdomainServiceRequest, AssignSubdomainServiceResult, AttachVolumeCall, AttachVolumeData, AttachVolumeEndpoint, AttachVolumeParameters, AttachVolumeRequest, AttachVolumeResult, BackupAddonCall, BackupAddonData, BackupAddonEndpoint, BackupAddonParameters, BackupAddonRequest, BackupAddonResult, CommandResult, CreateAddonBackupscheduleCall, CreateAddonBackupscheduleData, CreateAddonBackupscheduleEndpoint, CreateAddonBackupscheduleParameters, CreateAddonBackupscheduleRequest, CreateAddonBackupscheduleResult, CreateAddonCall, CreateAddonData, CreateAddonEndpoint, CreateAddonParameters, CreateAddonRequest, CreateAddonResult, CreateClusterCall, CreateClusterData, CreateClusterEndpoint, CreateClusterRequest, CreateClusterResult, CreateDomainCall, CreateDomainData, CreateDomainEndpoint, CreateDomainRequest, CreateDomainResult, CreateIntegrationCall, CreateIntegrationData, CreateIntegrationEndpoint, CreateIntegrationRequest, CreateIntegrationResult, CreateJobCronCall, CreateJobCronData, CreateJobCronEndpoint, CreateJobCronParameters, CreateJobCronRequest, CreateJobCronResult, CreateJobManualCall, CreateJobManualData, CreateJobManualEndpoint, CreateJobManualParameters, CreateJobManualRequest, CreateJobManualResult, CreateLogsinkCall, CreateLogsinkData, CreateLogsinkEndpoint, CreateLogsinkRequest, CreateLogsinkResult, CreateProjectCall, CreateProjectData, CreateProjectEndpoint, CreateProjectRequest, CreateProjectResult, CreateSecretCall, CreateSecretData, CreateSecretEndpoint, CreateSecretParameters, CreateSecretRequest, CreateSecretResult, CreateServiceBuildCall, CreateServiceBuildData, CreateServiceBuildEndpoint, CreateServiceBuildParameters, CreateServiceBuildRequest, CreateServiceBuildResult, CreateServiceCombinedCall, CreateServiceCombinedData, CreateServiceCombinedEndpoint, CreateServiceCombinedParameters, CreateServiceCombinedRequest, CreateServiceCombinedResult, CreateServiceDeploymentCall, CreateServiceDeploymentData, CreateServiceDeploymentEndpoint, CreateServiceDeploymentParameters, CreateServiceDeploymentRequest, CreateServiceDeploymentResult, CreateTemplateCall, CreateTemplateData, CreateTemplateEndpoint, CreateTemplateRequest, CreateTemplateResult, CreateVolumeCall, CreateVolumeData, CreateVolumeEndpoint, CreateVolumeParameters, CreateVolumeRequest, CreateVolumeResult, DeleteAddonBackupscheduleCall, DeleteAddonBackupscheduleEndpoint, DeleteAddonBackupscheduleParameters, DeleteAddonBackupscheduleRequest, DeleteAddonBackupscheduleResult, DeleteAddonCall, DeleteAddonEndpoint, DeleteAddonParameters, DeleteAddonRequest, DeleteAddonResult, DeleteApiEndpoint, DeleteBackupCall, DeleteBackupEndpoint, DeleteBackupParameters, DeleteBackupRequest, DeleteBackupResult, DeleteClusterCall, DeleteClusterEndpoint, DeleteClusterParameters, DeleteClusterRequest, DeleteClusterResult, DeleteDomainCall, DeleteDomainEndpoint, DeleteDomainParameters, DeleteDomainRequest, DeleteDomainResult, DeleteIntegrationCall, DeleteIntegrationEndpoint, DeleteIntegrationParameters, DeleteIntegrationRequest, DeleteIntegrationResult, DeleteJobCall, DeleteJobEndpoint, DeleteJobParameters, DeleteJobRequest, DeleteJobResult, DeleteLogsinkCall, DeleteLogsinkEndpoint, DeleteLogsinkParameters, DeleteLogsinkRequest, DeleteLogsinkResult, DeleteProjectCall, DeleteProjectEndpoint, DeleteProjectParameters, DeleteProjectRequest, DeleteProjectResult, DeleteRegistryCall, DeleteRegistryEndpoint, DeleteRegistryParameters, DeleteRegistryRequest, DeleteRegistryResult, DeleteSecretCall, DeleteSecretEndpoint, DeleteSecretParameters, DeleteSecretRequest, DeleteSecretResult, DeleteSecretlinkCall, DeleteSecretlinkEndpoint, DeleteSecretlinkParameters, DeleteSecretlinkRequest, DeleteSecretlinkResult, DeleteServiceCall, DeleteServiceEndpoint, DeleteServiceParameters, DeleteServiceRequest, DeleteServiceResult, DeleteSubdomainCall, DeleteSubdomainEndpoint, DeleteSubdomainParameters, DeleteSubdomainRequest, DeleteSubdomainResult, DeleteTemplateCall, DeleteTemplateEndpoint, DeleteTemplateParameters, DeleteTemplateRequest, DeleteTemplateResult, DeleteVolumeCall, DeleteVolumeEndpoint, DeleteVolumeParameters, DeleteVolumeRequest, DeleteVolumeResult, DetachVolumeCall, DetachVolumeData, DetachVolumeEndpoint, DetachVolumeParameters, DetachVolumeRequest, DetachVolumeResult, ExecCommand, ExecCommandData, ExecCommandStandard, ExecSessionData, GetAddonBackupCall, GetAddonBackupDownloadCall, GetAddonBackupDownloadEndpoint, GetAddonBackupDownloadParameters, GetAddonBackupDownloadRequest, GetAddonBackupDownloadResult, GetAddonBackupEndpoint, GetAddonBackupParameters, GetAddonBackupRequest, GetAddonBackupResult, GetAddonBackupsCall, GetAddonBackupsEndpoint, GetAddonBackupsOptions, GetAddonBackupsParameters, GetAddonBackupsRequest, GetAddonBackupsResult, GetAddonBackupschedulesCall, GetAddonBackupschedulesEndpoint, GetAddonBackupschedulesOptions, GetAddonBackupschedulesParameters, GetAddonBackupschedulesRequest, GetAddonBackupschedulesResult, GetAddonCall, GetAddonContainersCall, GetAddonContainersEndpoint, GetAddonContainersOptions, GetAddonContainersParameters, GetAddonContainersRequest, GetAddonContainersResult, GetAddonCredentialsCall, GetAddonCredentialsEndpoint, GetAddonCredentialsParameters, GetAddonCredentialsRequest, GetAddonCredentialsResult, GetAddonEndpoint, GetAddonParameters, GetAddonPitrwindowCall, GetAddonPitrwindowEndpoint, GetAddonPitrwindowParameters, GetAddonPitrwindowRequest, GetAddonPitrwindowResult, GetAddonRequest, GetAddonRestoresCall, GetAddonRestoresEndpoint, GetAddonRestoresOptions, GetAddonRestoresParameters, GetAddonRestoresRequest, GetAddonRestoresResult, GetAddonResult, GetAddonTypesCall, GetAddonTypesEndpoint, GetAddonTypesRequest, GetAddonTypesResult, GetAddonVersionCall, GetAddonVersionEndpoint, GetAddonVersionParameters, GetAddonVersionRequest, GetAddonVersionResult, GetApiEndpoint, GetClusterCall, GetClusterEndpoint, GetClusterParameters, GetClusterRequest, GetClusterResult, GetDnsidCall, GetDnsidEndpoint, GetDnsidRequest, GetDnsidResult, GetDomainCall, GetDomainEndpoint, GetDomainParameters, GetDomainRequest, GetDomainResult, GetIntegrationCall, GetIntegrationEndpoint, GetIntegrationParameters, GetIntegrationRequest, GetIntegrationResult, GetInvoiceDetailsCall, GetInvoiceDetailsEndpoint, GetInvoiceDetailsOptions, GetInvoiceDetailsRequest, GetInvoiceDetailsResult, GetJobBranchesCall, GetJobBranchesEndpoint, GetJobBranchesOptions, GetJobBranchesParameters, GetJobBranchesRequest, GetJobBranchesResult, GetJobBuildCall, GetJobBuildEndpoint, GetJobBuildParameters, GetJobBuildRequest, GetJobBuildResult, GetJobBuildargumentdetailsCall, GetJobBuildargumentdetailsEndpoint, GetJobBuildargumentdetailsParameters, GetJobBuildargumentdetailsRequest, GetJobBuildargumentdetailsResult, GetJobBuildargumentsCall, GetJobBuildargumentsEndpoint, GetJobBuildargumentsOptions, GetJobBuildargumentsParameters, GetJobBuildargumentsRequest, GetJobBuildargumentsResult, GetJobBuildsCall, GetJobBuildsEndpoint, GetJobBuildsOptions, GetJobBuildsParameters, GetJobBuildsRequest, GetJobBuildsResult, GetJobCall, GetJobContainersCall, GetJobContainersEndpoint, GetJobContainersOptions, GetJobContainersParameters, GetJobContainersRequest, GetJobContainersResult, GetJobDeploymentCall, GetJobDeploymentEndpoint, GetJobDeploymentParameters, GetJobDeploymentRequest, GetJobDeploymentResult, GetJobEndpoint, GetJobHealthchecksCall, GetJobHealthchecksEndpoint, GetJobHealthchecksParameters, GetJobHealthchecksRequest, GetJobHealthchecksResult, GetJobParameters, GetJobPullrequestsCall, GetJobPullrequestsEndpoint, GetJobPullrequestsOptions, GetJobPullrequestsParameters, GetJobPullrequestsRequest, GetJobPullrequestsResult, GetJobRequest, GetJobResult, GetJobRunCall, GetJobRunEndpoint, GetJobRunParameters, GetJobRunRequest, GetJobRunResult, GetJobRunsCall, GetJobRunsEndpoint, GetJobRunsOptions, GetJobRunsParameters, GetJobRunsRequest, GetJobRunsResult, GetJobRuntimeenvironmentCall, GetJobRuntimeenvironmentEndpoint, GetJobRuntimeenvironmentOptions, GetJobRuntimeenvironmentParameters, GetJobRuntimeenvironmentRequest, GetJobRuntimeenvironmentResult, GetJobRuntimeenvironmentdetailsCall, GetJobRuntimeenvironmentdetailsEndpoint, GetJobRuntimeenvironmentdetailsParameters, GetJobRuntimeenvironmentdetailsRequest, GetJobRuntimeenvironmentdetailsResult, GetLogsinkCall, GetLogsinkEndpoint, GetLogsinkParameters, GetLogsinkRequest, GetLogsinkResult, GetPipelineCall, GetPipelineEndpoint, GetPipelineParameters, GetPipelineRequest, GetPipelineResult, GetProjectCall, GetProjectEndpoint, GetProjectParameters, GetProjectRequest, GetProjectResult, GetRegistryCall, GetRegistryEndpoint, GetRegistryParameters, GetRegistryRequest, GetRegistryResult, GetReleaseflowCall, GetReleaseflowEndpoint, GetReleaseflowParameters, GetReleaseflowRequest, GetReleaseflowResult, GetReleaseflowrunCall, GetReleaseflowrunEndpoint, GetReleaseflowrunParameters, GetReleaseflowrunRequest, GetReleaseflowrunResult, GetSecretCall, GetSecretEndpoint, GetSecretOptions, GetSecretParameters, GetSecretRequest, GetSecretResult, GetSecretdetailsCall, GetSecretdetailsEndpoint, GetSecretdetailsParameters, GetSecretdetailsRequest, GetSecretdetailsResult, GetSecretlinkCall, GetSecretlinkEndpoint, GetSecretlinkParameters, GetSecretlinkRequest, GetSecretlinkResult, GetServiceBranchesCall, GetServiceBranchesEndpoint, GetServiceBranchesOptions, GetServiceBranchesParameters, GetServiceBranchesRequest, GetServiceBranchesResult, GetServiceBuildCall, GetServiceBuildEndpoint, GetServiceBuildParameters, GetServiceBuildRequest, GetServiceBuildResult, GetServiceBuildargumentdetailsCall, GetServiceBuildargumentdetailsEndpoint, GetServiceBuildargumentdetailsParameters, GetServiceBuildargumentdetailsRequest, GetServiceBuildargumentdetailsResult, GetServiceBuildargumentsCall, GetServiceBuildargumentsEndpoint, GetServiceBuildargumentsOptions, GetServiceBuildargumentsParameters, GetServiceBuildargumentsRequest, GetServiceBuildargumentsResult, GetServiceBuildsCall, GetServiceBuildsEndpoint, GetServiceBuildsOptions, GetServiceBuildsParameters, GetServiceBuildsRequest, GetServiceBuildsResult, GetServiceCall, GetServiceContainersCall, GetServiceContainersEndpoint, GetServiceContainersOptions, GetServiceContainersParameters, GetServiceContainersRequest, GetServiceContainersResult, GetServiceDeploymentCall, GetServiceDeploymentEndpoint, GetServiceDeploymentParameters, GetServiceDeploymentRequest, GetServiceDeploymentResult, GetServiceEndpoint, GetServiceHealthchecksCall, GetServiceHealthchecksEndpoint, GetServiceHealthchecksParameters, GetServiceHealthchecksRequest, GetServiceHealthchecksResult, GetServiceParameters, GetServicePortsCall, GetServicePortsEndpoint, GetServicePortsParameters, GetServicePortsRequest, GetServicePortsResult, GetServicePullrequestsCall, GetServicePullrequestsEndpoint, GetServicePullrequestsOptions, GetServicePullrequestsParameters, GetServicePullrequestsRequest, GetServicePullrequestsResult, GetServiceRequest, GetServiceResult, GetServiceRuntimeenvironmentCall, GetServiceRuntimeenvironmentEndpoint, GetServiceRuntimeenvironmentOptions, GetServiceRuntimeenvironmentParameters, GetServiceRuntimeenvironmentRequest, GetServiceRuntimeenvironmentResult, GetServiceRuntimeenvironmentdetailsCall, GetServiceRuntimeenvironmentdetailsEndpoint, GetServiceRuntimeenvironmentdetailsParameters, GetServiceRuntimeenvironmentdetailsRequest, GetServiceRuntimeenvironmentdetailsResult, GetSubdomainCall, GetSubdomainEndpoint, GetSubdomainParameters, GetSubdomainRequest, GetSubdomainResult, GetTemplateCall, GetTemplateEndpoint, GetTemplateOptions, GetTemplateParameters, GetTemplateRequest, GetTemplateResult, GetTemplaterunCall, GetTemplaterunEndpoint, GetTemplaterunParameters, GetTemplaterunRequest, GetTemplaterunResult, GetVolumeCall, GetVolumeEndpoint, GetVolumeParameters, GetVolumeRequest, GetVolumeResult, ImportAddonBackupCall, ImportAddonBackupData, ImportAddonBackupEndpoint, ImportAddonBackupParameters, ImportAddonBackupRequest, ImportAddonBackupResult, ListAddonsCall, ListAddonsEndpoint, ListAddonsOptions, ListAddonsParameters, ListAddonsRequest, ListAddonsResult, ListBranchesCall, ListBranchesEndpoint, ListBranchesOptions, ListBranchesParameters, ListBranchesRequest, ListBranchesResult, ListClustersCall, ListClustersEndpoint, ListClustersOptions, ListClustersRequest, ListClustersResult, ListDomainsCall, ListDomainsEndpoint, ListDomainsOptions, ListDomainsRequest, ListDomainsResult, ListIntegrationsCall, ListIntegrationsEndpoint, ListIntegrationsOptions, ListIntegrationsRequest, ListIntegrationsResult, ListInvoicesCall, ListInvoicesEndpoint, ListInvoicesOptions, ListInvoicesRequest, ListInvoicesResult, ListJobsCall, ListJobsEndpoint, ListJobsOptions, ListJobsParameters, ListJobsRequest, ListJobsResult, ListLogsinksCall, ListLogsinksEndpoint, ListLogsinksOptions, ListLogsinksRequest, ListLogsinksResult, ListPipelinesCall, ListPipelinesEndpoint, ListPipelinesOptions, ListPipelinesParameters, ListPipelinesRequest, ListPipelinesResult, ListPlansCall, ListPlansEndpoint, ListPlansRequest, ListPlansResult, ListProjectsCall, ListProjectsEndpoint, ListProjectsOptions, ListProjectsRequest, ListProjectsResult, ListProvidersCall, ListProvidersEndpoint, ListProvidersRequest, ListProvidersResult, ListRegionsCall, ListRegionsEndpoint, ListRegionsRequest, ListRegionsResult, ListRegistriesCall, ListRegistriesEndpoint, ListRegistriesOptions, ListRegistriesRequest, ListRegistriesResult, ListReleaseflowrunsCall, ListReleaseflowrunsEndpoint, ListReleaseflowrunsOptions, ListReleaseflowrunsParameters, ListReleaseflowrunsRequest, ListReleaseflowrunsResult, ListReposCall, ListReposEndpoint, ListReposOptions, ListReposRequest, ListReposResult, ListSecretsCall, ListSecretsEndpoint, ListSecretsOptions, ListSecretsParameters, ListSecretsRequest, ListSecretsResult, ListServicesCall, ListServicesEndpoint, ListServicesOptions, ListServicesParameters, ListServicesRequest, ListServicesResult, ListTemplaterunsCall, ListTemplaterunsEndpoint, ListTemplaterunsOptions, ListTemplaterunsParameters, ListTemplaterunsRequest, ListTemplaterunsResult, ListTemplatesCall, ListTemplatesEndpoint, ListTemplatesOptions, ListTemplatesRequest, ListTemplatesResult, ListVcsCall, ListVcsEndpoint, ListVcsRequest, ListVcsResult, ListVolumesCall, ListVolumesEndpoint, ListVolumesParameters, ListVolumesRequest, ListVolumesResult, NorthflankApiCallError, NorthflankExecCommand, NorthflankPortForwarder, PatchAddonCall, PatchAddonData, PatchAddonEndpoint, PatchAddonParameters, PatchAddonRequest, PatchAddonResult, PatchApiEndpoint, PatchJobCronCall, PatchJobCronData, PatchJobCronEndpoint, PatchJobCronParameters, PatchJobCronRequest, PatchJobCronResult, PatchJobManualCall, PatchJobManualData, PatchJobManualEndpoint, PatchJobManualParameters, PatchJobManualRequest, PatchJobManualResult, PatchSecretCall, PatchSecretData, PatchSecretEndpoint, PatchSecretParameters, PatchSecretRequest, PatchSecretResult, PatchServiceBuildCall, PatchServiceBuildData, PatchServiceBuildEndpoint, PatchServiceBuildParameters, PatchServiceBuildRequest, PatchServiceBuildResult, PatchServiceCombinedCall, PatchServiceCombinedData, PatchServiceCombinedEndpoint, PatchServiceCombinedParameters, PatchServiceCombinedRequest, PatchServiceCombinedResult, PatchServiceDeploymentCall, PatchServiceDeploymentData, PatchServiceDeploymentEndpoint, PatchServiceDeploymentParameters, PatchServiceDeploymentRequest, PatchServiceDeploymentResult, PauseAddonCall, PauseAddonEndpoint, PauseAddonParameters, PauseAddonRequest, PauseAddonResult, PauseJobCall, PauseJobEndpoint, PauseJobParameters, PauseJobRequest, PauseJobResult, PauseLogsinkCall, PauseLogsinkEndpoint, PauseLogsinkParameters, PauseLogsinkRequest, PauseLogsinkResult, PauseServiceCall, PauseServiceEndpoint, PauseServiceParameters, PauseServiceRequest, PauseServiceResult, PortForwardingInfo, PortForwardingResult, PostApiEndpoint, PutAddonCall, PutAddonData, PutAddonEndpoint, PutAddonParameters, PutAddonRequest, PutAddonResult, PutApiEndpoint, PutJobCronCall, PutJobCronData, PutJobCronEndpoint, PutJobCronParameters, PutJobCronRequest, PutJobCronResult, PutJobManualCall, PutJobManualData, PutJobManualEndpoint, PutJobManualParameters, PutJobManualRequest, PutJobManualResult, PutSecretCall, PutSecretData, PutSecretEndpoint, PutSecretParameters, PutSecretRequest, PutSecretResult, PutServiceBuildCall, PutServiceBuildData, PutServiceBuildEndpoint, PutServiceBuildParameters, PutServiceBuildRequest, PutServiceBuildResult, PutServiceCombinedCall, PutServiceCombinedData, PutServiceCombinedEndpoint, PutServiceCombinedParameters, PutServiceCombinedRequest, PutServiceCombinedResult, PutServiceDeploymentCall, PutServiceDeploymentData, PutServiceDeploymentEndpoint, PutServiceDeploymentParameters, PutServiceDeploymentRequest, PutServiceDeploymentResult, RestartAddonCall, RestartAddonEndpoint, RestartAddonParameters, RestartAddonRequest, RestartAddonResult, RestartServiceCall, RestartServiceEndpoint, RestartServiceParameters, RestartServiceRequest, RestartServiceResult, RestoreAddonBackupCall, RestoreAddonBackupEndpoint, RestoreAddonBackupParameters, RestoreAddonBackupRequest, RestoreAddonBackupResult, ResumeAddonCall, ResumeAddonEndpoint, ResumeAddonParameters, ResumeAddonRequest, ResumeAddonResult, ResumeJobCall, ResumeJobData, ResumeJobEndpoint, ResumeJobParameters, ResumeJobRequest, ResumeJobResult, ResumeLogsinkCall, ResumeLogsinkEndpoint, ResumeLogsinkParameters, ResumeLogsinkRequest, ResumeLogsinkResult, ResumeServiceCall, ResumeServiceData, ResumeServiceEndpoint, ResumeServiceParameters, ResumeServiceRequest, ResumeServiceResult, RetainAddonBackupCall, RetainAddonBackupEndpoint, RetainAddonBackupParameters, RetainAddonBackupRequest, RetainAddonBackupResult, RunReleaseflowCall, RunReleaseflowData, RunReleaseflowEndpoint, RunReleaseflowParameters, RunReleaseflowRequest, RunReleaseflowResult, RunTemplateCall, RunTemplateData, RunTemplateEndpoint, RunTemplateParameters, RunTemplateRequest, RunTemplateResult, ScaleAddonCall, ScaleAddonData, ScaleAddonEndpoint, ScaleAddonParameters, ScaleAddonRequest, ScaleAddonResult, ScaleJobCall, ScaleJobData, ScaleJobEndpoint, ScaleJobParameters, ScaleJobRequest, ScaleJobResult, ScaleServiceCall, ScaleServiceData, ScaleServiceEndpoint, ScaleServiceParameters, ScaleServiceRequest, ScaleServiceResult, StartAddonPitrCall, StartAddonPitrData, StartAddonPitrEndpoint, StartAddonPitrParameters, StartAddonPitrRequest, StartAddonPitrResult, StartJobBuildCall, StartJobBuildData, StartJobBuildEndpoint, StartJobBuildParameters, StartJobBuildRequest, StartJobBuildResult, StartJobRunCall, StartJobRunData, StartJobRunEndpoint, StartJobRunParameters, StartJobRunRequest, StartJobRunResult, StartServiceBuildCall, StartServiceBuildData, StartServiceBuildEndpoint, StartServiceBuildParameters, StartServiceBuildRequest, StartServiceBuildResult, SuspendJobCall, SuspendJobData, SuspendJobEndpoint, SuspendJobParameters, SuspendJobRequest, SuspendJobResult, UnassignSubdomainCall, UnassignSubdomainEndpoint, UnassignSubdomainParameters, UnassignSubdomainRequest, UnassignSubdomainResult, UpdateAddonNetworksettingsCall, UpdateAddonNetworksettingsData, UpdateAddonNetworksettingsEndpoint, UpdateAddonNetworksettingsParameters, UpdateAddonNetworksettingsRequest, UpdateAddonNetworksettingsResult, UpdateAddonSecurityCall, UpdateAddonSecurityData, UpdateAddonSecurityEndpoint, UpdateAddonSecurityParameters, UpdateAddonSecurityRequest, UpdateAddonSecurityResult, UpdateAddonVersionCall, UpdateAddonVersionData, UpdateAddonVersionEndpoint, UpdateAddonVersionParameters, UpdateAddonVersionRequest, UpdateAddonVersionResult, UpdateClusterCall, UpdateClusterData, UpdateClusterEndpoint, UpdateClusterParameters, UpdateClusterRequest, UpdateClusterResult, UpdateIntegrationCall, UpdateIntegrationData, UpdateIntegrationEndpoint, UpdateIntegrationParameters, UpdateIntegrationRequest, UpdateIntegrationResult, UpdateJobBuildargumentsCall, UpdateJobBuildargumentsData, UpdateJobBuildargumentsEndpoint, UpdateJobBuildargumentsParameters, UpdateJobBuildargumentsRequest, UpdateJobBuildargumentsResult, UpdateJobBuildoptionsCall, UpdateJobBuildoptionsData, UpdateJobBuildoptionsEndpoint, UpdateJobBuildoptionsParameters, UpdateJobBuildoptionsRequest, UpdateJobBuildoptionsResult, UpdateJobBuildsourceCall, UpdateJobBuildsourceData, UpdateJobBuildsourceEndpoint, UpdateJobBuildsourceParameters, UpdateJobBuildsourceRequest, UpdateJobBuildsourceResult, UpdateJobDeploymentCall, UpdateJobDeploymentData, UpdateJobDeploymentEndpoint, UpdateJobDeploymentParameters, UpdateJobDeploymentRequest, UpdateJobDeploymentResult, UpdateJobHealthchecksCall, UpdateJobHealthchecksData, UpdateJobHealthchecksEndpoint, UpdateJobHealthchecksParameters, UpdateJobHealthchecksRequest, UpdateJobHealthchecksResult, UpdateJobRuntimeenvironmentCall, UpdateJobRuntimeenvironmentData, UpdateJobRuntimeenvironmentEndpoint, UpdateJobRuntimeenvironmentParameters, UpdateJobRuntimeenvironmentRequest, UpdateJobRuntimeenvironmentResult, UpdateJobSettingsCall, UpdateJobSettingsData, UpdateJobSettingsEndpoint, UpdateJobSettingsParameters, UpdateJobSettingsRequest, UpdateJobSettingsResult, UpdateLogsinkCall, UpdateLogsinkData, UpdateLogsinkEndpoint, UpdateLogsinkParameters, UpdateLogsinkRequest, UpdateLogsinkResult, UpdateRegistryCall, UpdateRegistryData, UpdateRegistryEndpoint, UpdateRegistryParameters, UpdateRegistryRequest, UpdateRegistryResult, UpdateReleaseflowCall, UpdateReleaseflowData, UpdateReleaseflowEndpoint, UpdateReleaseflowParameters, UpdateReleaseflowRequest, UpdateReleaseflowResult, UpdateSecretCall, UpdateSecretData, UpdateSecretEndpoint, UpdateSecretParameters, UpdateSecretRequest, UpdateSecretResult, UpdateSecretlinkCall, UpdateSecretlinkData, UpdateSecretlinkEndpoint, UpdateSecretlinkParameters, UpdateSecretlinkRequest, UpdateSecretlinkResult, UpdateServiceBuildargumentsCall, UpdateServiceBuildargumentsData, UpdateServiceBuildargumentsEndpoint, UpdateServiceBuildargumentsParameters, UpdateServiceBuildargumentsRequest, UpdateServiceBuildargumentsResult, UpdateServiceBuildoptionsCall, UpdateServiceBuildoptionsData, UpdateServiceBuildoptionsEndpoint, UpdateServiceBuildoptionsParameters, UpdateServiceBuildoptionsRequest, UpdateServiceBuildoptionsResult, UpdateServiceBuildsourceCall, UpdateServiceBuildsourceData, UpdateServiceBuildsourceEndpoint, UpdateServiceBuildsourceParameters, UpdateServiceBuildsourceRequest, UpdateServiceBuildsourceResult, UpdateServiceDeploymentCall, UpdateServiceDeploymentData, UpdateServiceDeploymentEndpoint, UpdateServiceDeploymentParameters, UpdateServiceDeploymentRequest, UpdateServiceDeploymentResult, UpdateServiceHealthchecksCall, UpdateServiceHealthchecksData, UpdateServiceHealthchecksEndpoint, UpdateServiceHealthchecksParameters, UpdateServiceHealthchecksRequest, UpdateServiceHealthchecksResult, UpdateServicePortsCall, UpdateServicePortsData, UpdateServicePortsEndpoint, UpdateServicePortsParameters, UpdateServicePortsRequest, UpdateServicePortsResult, UpdateServiceRuntimeenvironmentCall, UpdateServiceRuntimeenvironmentData, UpdateServiceRuntimeenvironmentEndpoint, UpdateServiceRuntimeenvironmentParameters, UpdateServiceRuntimeenvironmentRequest, UpdateServiceRuntimeenvironmentResult, UpdateTemplateCall, UpdateTemplateData, UpdateTemplateEndpoint, UpdateTemplateParameters, UpdateTemplateRequest, UpdateTemplateResult, UpdateVolumeCall, UpdateVolumeData, UpdateVolumeEndpoint, UpdateVolumeParameters, UpdateVolumeRequest, UpdateVolumeResult, VerifyDomainCall, VerifyDomainEndpoint, VerifyDomainParameters, VerifyDomainRequest, VerifyDomainResult, VerifySubdomainCall, VerifySubdomainEndpoint, VerifySubdomainParameters, VerifySubdomainRequest, VerifySubdomainResult };
|
|
15220
|
+
export { AbortAddonBackupCall, AbortAddonBackupEndpoint, AbortAddonBackupParameters, AbortAddonBackupRequest, AbortAddonBackupResult, AbortAddonRestoreCall, AbortAddonRestoreData, AbortAddonRestoreEndpoint, AbortAddonRestoreParameters, AbortAddonRestoreRequest, AbortAddonRestoreResult, AbortJobBuildCall, AbortJobBuildEndpoint, AbortJobBuildParameters, AbortJobBuildRequest, AbortJobBuildResult, AbortJobRunCall, AbortJobRunEndpoint, AbortJobRunParameters, AbortJobRunRequest, AbortJobRunResult, AbortReleaseflowrunCall, AbortReleaseflowrunEndpoint, AbortReleaseflowrunParameters, AbortReleaseflowrunRequest, AbortReleaseflowrunResult, AbortServiceBuildCall, AbortServiceBuildEndpoint, AbortServiceBuildParameters, AbortServiceBuildRequest, AbortServiceBuildResult, AbortTemplaterunCall, AbortTemplaterunEndpoint, AbortTemplaterunParameters, AbortTemplaterunRequest, AbortTemplaterunResult, AddDomainSubdomainCall, AddDomainSubdomainData, AddDomainSubdomainEndpoint, AddDomainSubdomainParameters, AddDomainSubdomainRequest, AddDomainSubdomainResult, AddRegistryCall, AddRegistryData, AddRegistryEndpoint, AddRegistryRequest, AddRegistryResult, ApiCallError, ApiCallResponse, ApiClient, ApiClientContext, ApiClientContextProvider, ApiClientContextWrapper, ApiClientFileContextProvider, ApiClientInMemoryContextProvider, ApiClientOpts, ApiEndpoint, AssignSubdomainServiceCall, AssignSubdomainServiceData, AssignSubdomainServiceEndpoint, AssignSubdomainServiceParameters, AssignSubdomainServiceRequest, AssignSubdomainServiceResult, AttachVolumeCall, AttachVolumeData, AttachVolumeEndpoint, AttachVolumeParameters, AttachVolumeRequest, AttachVolumeResult, BackupAddonCall, BackupAddonData, BackupAddonEndpoint, BackupAddonParameters, BackupAddonRequest, BackupAddonResult, CommandResult, CreateAddonBackupscheduleCall, CreateAddonBackupscheduleData, CreateAddonBackupscheduleEndpoint, CreateAddonBackupscheduleParameters, CreateAddonBackupscheduleRequest, CreateAddonBackupscheduleResult, CreateAddonCall, CreateAddonData, CreateAddonEndpoint, CreateAddonParameters, CreateAddonRequest, CreateAddonResult, CreateClusterCall, CreateClusterData, CreateClusterEndpoint, CreateClusterRequest, CreateClusterResult, CreateCustomvcsTokenCall, CreateCustomvcsTokenEndpoint, CreateCustomvcsTokenParameters, CreateCustomvcsTokenRequest, CreateCustomvcsTokenResult, CreateDomainCall, CreateDomainData, CreateDomainEndpoint, CreateDomainRequest, CreateDomainResult, CreateIntegrationCall, CreateIntegrationData, CreateIntegrationEndpoint, CreateIntegrationRequest, CreateIntegrationResult, CreateJobCronCall, CreateJobCronData, CreateJobCronEndpoint, CreateJobCronParameters, CreateJobCronRequest, CreateJobCronResult, CreateJobManualCall, CreateJobManualData, CreateJobManualEndpoint, CreateJobManualParameters, CreateJobManualRequest, CreateJobManualResult, CreateLogsinkCall, CreateLogsinkData, CreateLogsinkEndpoint, CreateLogsinkRequest, CreateLogsinkResult, CreateProjectCall, CreateProjectData, CreateProjectEndpoint, CreateProjectRequest, CreateProjectResult, CreateSecretCall, CreateSecretData, CreateSecretEndpoint, CreateSecretParameters, CreateSecretRequest, CreateSecretResult, CreateServiceBuildCall, CreateServiceBuildData, CreateServiceBuildEndpoint, CreateServiceBuildParameters, CreateServiceBuildRequest, CreateServiceBuildResult, CreateServiceCombinedCall, CreateServiceCombinedData, CreateServiceCombinedEndpoint, CreateServiceCombinedParameters, CreateServiceCombinedRequest, CreateServiceCombinedResult, CreateServiceDeploymentCall, CreateServiceDeploymentData, CreateServiceDeploymentEndpoint, CreateServiceDeploymentParameters, CreateServiceDeploymentRequest, CreateServiceDeploymentResult, CreateTemplateCall, CreateTemplateData, CreateTemplateEndpoint, CreateTemplateRequest, CreateTemplateResult, CreateVolumeCall, CreateVolumeData, CreateVolumeEndpoint, CreateVolumeParameters, CreateVolumeRequest, CreateVolumeResult, DeleteAddonBackupscheduleCall, DeleteAddonBackupscheduleEndpoint, DeleteAddonBackupscheduleParameters, DeleteAddonBackupscheduleRequest, DeleteAddonBackupscheduleResult, DeleteAddonCall, DeleteAddonEndpoint, DeleteAddonParameters, DeleteAddonRequest, DeleteAddonResult, DeleteApiEndpoint, DeleteBackupCall, DeleteBackupEndpoint, DeleteBackupParameters, DeleteBackupRequest, DeleteBackupResult, DeleteClusterCall, DeleteClusterEndpoint, DeleteClusterParameters, DeleteClusterRequest, DeleteClusterResult, DeleteDomainCall, DeleteDomainEndpoint, DeleteDomainParameters, DeleteDomainRequest, DeleteDomainResult, DeleteIntegrationCall, DeleteIntegrationEndpoint, DeleteIntegrationParameters, DeleteIntegrationRequest, DeleteIntegrationResult, DeleteJobCall, DeleteJobEndpoint, DeleteJobParameters, DeleteJobRequest, DeleteJobResult, DeleteLogsinkCall, DeleteLogsinkEndpoint, DeleteLogsinkParameters, DeleteLogsinkRequest, DeleteLogsinkResult, DeleteProjectCall, DeleteProjectEndpoint, DeleteProjectParameters, DeleteProjectRequest, DeleteProjectResult, DeleteRegistryCall, DeleteRegistryEndpoint, DeleteRegistryParameters, DeleteRegistryRequest, DeleteRegistryResult, DeleteSecretCall, DeleteSecretEndpoint, DeleteSecretParameters, DeleteSecretRequest, DeleteSecretResult, DeleteSecretlinkCall, DeleteSecretlinkEndpoint, DeleteSecretlinkParameters, DeleteSecretlinkRequest, DeleteSecretlinkResult, DeleteServiceCall, DeleteServiceEndpoint, DeleteServiceParameters, DeleteServiceRequest, DeleteServiceResult, DeleteSubdomainCall, DeleteSubdomainEndpoint, DeleteSubdomainParameters, DeleteSubdomainRequest, DeleteSubdomainResult, DeleteTemplateCall, DeleteTemplateEndpoint, DeleteTemplateParameters, DeleteTemplateRequest, DeleteTemplateResult, DeleteVolumeCall, DeleteVolumeEndpoint, DeleteVolumeParameters, DeleteVolumeRequest, DeleteVolumeResult, DetachVolumeCall, DetachVolumeData, DetachVolumeEndpoint, DetachVolumeParameters, DetachVolumeRequest, DetachVolumeResult, ExecCommand, ExecCommandData, ExecCommandStandard, ExecSessionData, GetAddonBackupCall, GetAddonBackupDownloadCall, GetAddonBackupDownloadEndpoint, GetAddonBackupDownloadParameters, GetAddonBackupDownloadRequest, GetAddonBackupDownloadResult, GetAddonBackupEndpoint, GetAddonBackupParameters, GetAddonBackupRequest, GetAddonBackupResult, GetAddonBackupsCall, GetAddonBackupsEndpoint, GetAddonBackupsOptions, GetAddonBackupsParameters, GetAddonBackupsRequest, GetAddonBackupsResult, GetAddonBackupschedulesCall, GetAddonBackupschedulesEndpoint, GetAddonBackupschedulesOptions, GetAddonBackupschedulesParameters, GetAddonBackupschedulesRequest, GetAddonBackupschedulesResult, GetAddonCall, GetAddonContainersCall, GetAddonContainersEndpoint, GetAddonContainersOptions, GetAddonContainersParameters, GetAddonContainersRequest, GetAddonContainersResult, GetAddonCredentialsCall, GetAddonCredentialsEndpoint, GetAddonCredentialsParameters, GetAddonCredentialsRequest, GetAddonCredentialsResult, GetAddonEndpoint, GetAddonParameters, GetAddonPitrwindowCall, GetAddonPitrwindowEndpoint, GetAddonPitrwindowParameters, GetAddonPitrwindowRequest, GetAddonPitrwindowResult, GetAddonRequest, GetAddonRestoresCall, GetAddonRestoresEndpoint, GetAddonRestoresOptions, GetAddonRestoresParameters, GetAddonRestoresRequest, GetAddonRestoresResult, GetAddonResult, GetAddonTypesCall, GetAddonTypesEndpoint, GetAddonTypesRequest, GetAddonTypesResult, GetAddonVersionCall, GetAddonVersionEndpoint, GetAddonVersionParameters, GetAddonVersionRequest, GetAddonVersionResult, GetApiEndpoint, GetClusterCall, GetClusterEndpoint, GetClusterParameters, GetClusterRequest, GetClusterResult, GetDnsidCall, GetDnsidEndpoint, GetDnsidRequest, GetDnsidResult, GetDomainCall, GetDomainEndpoint, GetDomainParameters, GetDomainRequest, GetDomainResult, GetIntegrationCall, GetIntegrationEndpoint, GetIntegrationParameters, GetIntegrationRequest, GetIntegrationResult, GetInvoiceDetailsCall, GetInvoiceDetailsEndpoint, GetInvoiceDetailsOptions, GetInvoiceDetailsRequest, GetInvoiceDetailsResult, GetJobBranchesCall, GetJobBranchesEndpoint, GetJobBranchesOptions, GetJobBranchesParameters, GetJobBranchesRequest, GetJobBranchesResult, GetJobBuildCall, GetJobBuildEndpoint, GetJobBuildParameters, GetJobBuildRequest, GetJobBuildResult, GetJobBuildargumentdetailsCall, GetJobBuildargumentdetailsEndpoint, GetJobBuildargumentdetailsParameters, GetJobBuildargumentdetailsRequest, GetJobBuildargumentdetailsResult, GetJobBuildargumentsCall, GetJobBuildargumentsEndpoint, GetJobBuildargumentsOptions, GetJobBuildargumentsParameters, GetJobBuildargumentsRequest, GetJobBuildargumentsResult, GetJobBuildsCall, GetJobBuildsEndpoint, GetJobBuildsOptions, GetJobBuildsParameters, GetJobBuildsRequest, GetJobBuildsResult, GetJobCall, GetJobContainersCall, GetJobContainersEndpoint, GetJobContainersOptions, GetJobContainersParameters, GetJobContainersRequest, GetJobContainersResult, GetJobDeploymentCall, GetJobDeploymentEndpoint, GetJobDeploymentParameters, GetJobDeploymentRequest, GetJobDeploymentResult, GetJobEndpoint, GetJobHealthchecksCall, GetJobHealthchecksEndpoint, GetJobHealthchecksParameters, GetJobHealthchecksRequest, GetJobHealthchecksResult, GetJobParameters, GetJobPullrequestsCall, GetJobPullrequestsEndpoint, GetJobPullrequestsOptions, GetJobPullrequestsParameters, GetJobPullrequestsRequest, GetJobPullrequestsResult, GetJobRequest, GetJobResult, GetJobRunCall, GetJobRunEndpoint, GetJobRunParameters, GetJobRunRequest, GetJobRunResult, GetJobRunsCall, GetJobRunsEndpoint, GetJobRunsOptions, GetJobRunsParameters, GetJobRunsRequest, GetJobRunsResult, GetJobRuntimeenvironmentCall, GetJobRuntimeenvironmentEndpoint, GetJobRuntimeenvironmentOptions, GetJobRuntimeenvironmentParameters, GetJobRuntimeenvironmentRequest, GetJobRuntimeenvironmentResult, GetJobRuntimeenvironmentdetailsCall, GetJobRuntimeenvironmentdetailsEndpoint, GetJobRuntimeenvironmentdetailsParameters, GetJobRuntimeenvironmentdetailsRequest, GetJobRuntimeenvironmentdetailsResult, GetLogsinkCall, GetLogsinkEndpoint, GetLogsinkParameters, GetLogsinkRequest, GetLogsinkResult, GetPipelineCall, GetPipelineEndpoint, GetPipelineParameters, GetPipelineRequest, GetPipelineResult, GetProjectCall, GetProjectEndpoint, GetProjectParameters, GetProjectRequest, GetProjectResult, GetRegistryCall, GetRegistryEndpoint, GetRegistryParameters, GetRegistryRequest, GetRegistryResult, GetReleaseflowCall, GetReleaseflowEndpoint, GetReleaseflowParameters, GetReleaseflowRequest, GetReleaseflowResult, GetReleaseflowrunCall, GetReleaseflowrunEndpoint, GetReleaseflowrunParameters, GetReleaseflowrunRequest, GetReleaseflowrunResult, GetSecretCall, GetSecretEndpoint, GetSecretOptions, GetSecretParameters, GetSecretRequest, GetSecretResult, GetSecretdetailsCall, GetSecretdetailsEndpoint, GetSecretdetailsParameters, GetSecretdetailsRequest, GetSecretdetailsResult, GetSecretlinkCall, GetSecretlinkEndpoint, GetSecretlinkParameters, GetSecretlinkRequest, GetSecretlinkResult, GetServiceBranchesCall, GetServiceBranchesEndpoint, GetServiceBranchesOptions, GetServiceBranchesParameters, GetServiceBranchesRequest, GetServiceBranchesResult, GetServiceBuildCall, GetServiceBuildEndpoint, GetServiceBuildParameters, GetServiceBuildRequest, GetServiceBuildResult, GetServiceBuildargumentdetailsCall, GetServiceBuildargumentdetailsEndpoint, GetServiceBuildargumentdetailsParameters, GetServiceBuildargumentdetailsRequest, GetServiceBuildargumentdetailsResult, GetServiceBuildargumentsCall, GetServiceBuildargumentsEndpoint, GetServiceBuildargumentsOptions, GetServiceBuildargumentsParameters, GetServiceBuildargumentsRequest, GetServiceBuildargumentsResult, GetServiceBuildsCall, GetServiceBuildsEndpoint, GetServiceBuildsOptions, GetServiceBuildsParameters, GetServiceBuildsRequest, GetServiceBuildsResult, GetServiceCall, GetServiceContainersCall, GetServiceContainersEndpoint, GetServiceContainersOptions, GetServiceContainersParameters, GetServiceContainersRequest, GetServiceContainersResult, GetServiceDeploymentCall, GetServiceDeploymentEndpoint, GetServiceDeploymentParameters, GetServiceDeploymentRequest, GetServiceDeploymentResult, GetServiceEndpoint, GetServiceHealthchecksCall, GetServiceHealthchecksEndpoint, GetServiceHealthchecksParameters, GetServiceHealthchecksRequest, GetServiceHealthchecksResult, GetServiceParameters, GetServicePortsCall, GetServicePortsEndpoint, GetServicePortsParameters, GetServicePortsRequest, GetServicePortsResult, GetServicePullrequestsCall, GetServicePullrequestsEndpoint, GetServicePullrequestsOptions, GetServicePullrequestsParameters, GetServicePullrequestsRequest, GetServicePullrequestsResult, GetServiceRequest, GetServiceResult, GetServiceRuntimeenvironmentCall, GetServiceRuntimeenvironmentEndpoint, GetServiceRuntimeenvironmentOptions, GetServiceRuntimeenvironmentParameters, GetServiceRuntimeenvironmentRequest, GetServiceRuntimeenvironmentResult, GetServiceRuntimeenvironmentdetailsCall, GetServiceRuntimeenvironmentdetailsEndpoint, GetServiceRuntimeenvironmentdetailsParameters, GetServiceRuntimeenvironmentdetailsRequest, GetServiceRuntimeenvironmentdetailsResult, GetSubdomainCall, GetSubdomainEndpoint, GetSubdomainParameters, GetSubdomainRequest, GetSubdomainResult, GetTemplateCall, GetTemplateEndpoint, GetTemplateOptions, GetTemplateParameters, GetTemplateRequest, GetTemplateResult, GetTemplaterunCall, GetTemplaterunEndpoint, GetTemplaterunParameters, GetTemplaterunRequest, GetTemplaterunResult, GetVolumeCall, GetVolumeEndpoint, GetVolumeParameters, GetVolumeRequest, GetVolumeResult, ImportAddonBackupCall, ImportAddonBackupData, ImportAddonBackupEndpoint, ImportAddonBackupParameters, ImportAddonBackupRequest, ImportAddonBackupResult, ListAddonsCall, ListAddonsEndpoint, ListAddonsOptions, ListAddonsParameters, ListAddonsRequest, ListAddonsResult, ListBranchesCall, ListBranchesEndpoint, ListBranchesOptions, ListBranchesParameters, ListBranchesRequest, ListBranchesResult, ListClustersCall, ListClustersEndpoint, ListClustersOptions, ListClustersRequest, ListClustersResult, ListDomainsCall, ListDomainsEndpoint, ListDomainsOptions, ListDomainsRequest, ListDomainsResult, ListIntegrationsCall, ListIntegrationsEndpoint, ListIntegrationsOptions, ListIntegrationsRequest, ListIntegrationsResult, ListInvoicesCall, ListInvoicesEndpoint, ListInvoicesOptions, ListInvoicesRequest, ListInvoicesResult, ListJobsCall, ListJobsEndpoint, ListJobsOptions, ListJobsParameters, ListJobsRequest, ListJobsResult, ListLogsinksCall, ListLogsinksEndpoint, ListLogsinksOptions, ListLogsinksRequest, ListLogsinksResult, ListPipelinesCall, ListPipelinesEndpoint, ListPipelinesOptions, ListPipelinesParameters, ListPipelinesRequest, ListPipelinesResult, ListPlansCall, ListPlansEndpoint, ListPlansRequest, ListPlansResult, ListProjectsCall, ListProjectsEndpoint, ListProjectsOptions, ListProjectsRequest, ListProjectsResult, ListProvidersCall, ListProvidersEndpoint, ListProvidersRequest, ListProvidersResult, ListRegionsCall, ListRegionsEndpoint, ListRegionsRequest, ListRegionsResult, ListRegistriesCall, ListRegistriesEndpoint, ListRegistriesOptions, ListRegistriesRequest, ListRegistriesResult, ListReleaseflowrunsCall, ListReleaseflowrunsEndpoint, ListReleaseflowrunsOptions, ListReleaseflowrunsParameters, ListReleaseflowrunsRequest, ListReleaseflowrunsResult, ListReposCall, ListReposEndpoint, ListReposOptions, ListReposRequest, ListReposResult, ListSecretsCall, ListSecretsEndpoint, ListSecretsOptions, ListSecretsParameters, ListSecretsRequest, ListSecretsResult, ListServicesCall, ListServicesEndpoint, ListServicesOptions, ListServicesParameters, ListServicesRequest, ListServicesResult, ListTemplaterunsCall, ListTemplaterunsEndpoint, ListTemplaterunsOptions, ListTemplaterunsParameters, ListTemplaterunsRequest, ListTemplaterunsResult, ListTemplatesCall, ListTemplatesEndpoint, ListTemplatesOptions, ListTemplatesRequest, ListTemplatesResult, ListVcsCall, ListVcsEndpoint, ListVcsRequest, ListVcsResult, ListVolumesCall, ListVolumesEndpoint, ListVolumesParameters, ListVolumesRequest, ListVolumesResult, LogLine, MetricType, MetricUnit, MetricValue, MetricsEntry, MetricsRangeRequestData, MetricsSingleRequestData, NorthflankApiCallError, NorthflankExecCommand, NorthflankLogFetch, NorthflankMetricFetch, NorthflankPortForwarder, PatchAddonCall, PatchAddonData, PatchAddonEndpoint, PatchAddonParameters, PatchAddonRequest, PatchAddonResult, PatchApiEndpoint, PatchJobCronCall, PatchJobCronData, PatchJobCronEndpoint, PatchJobCronParameters, PatchJobCronRequest, PatchJobCronResult, PatchJobManualCall, PatchJobManualData, PatchJobManualEndpoint, PatchJobManualParameters, PatchJobManualRequest, PatchJobManualResult, PatchSecretCall, PatchSecretData, PatchSecretEndpoint, PatchSecretParameters, PatchSecretRequest, PatchSecretResult, PatchServiceBuildCall, PatchServiceBuildData, PatchServiceBuildEndpoint, PatchServiceBuildParameters, PatchServiceBuildRequest, PatchServiceBuildResult, PatchServiceCombinedCall, PatchServiceCombinedData, PatchServiceCombinedEndpoint, PatchServiceCombinedParameters, PatchServiceCombinedRequest, PatchServiceCombinedResult, PatchServiceDeploymentCall, PatchServiceDeploymentData, PatchServiceDeploymentEndpoint, PatchServiceDeploymentParameters, PatchServiceDeploymentRequest, PatchServiceDeploymentResult, PauseAddonCall, PauseAddonEndpoint, PauseAddonParameters, PauseAddonRequest, PauseAddonResult, PauseJobCall, PauseJobEndpoint, PauseJobParameters, PauseJobRequest, PauseJobResult, PauseLogsinkCall, PauseLogsinkEndpoint, PauseLogsinkParameters, PauseLogsinkRequest, PauseLogsinkResult, PauseServiceCall, PauseServiceEndpoint, PauseServiceParameters, PauseServiceRequest, PauseServiceResult, PortForwardingInfo, PortForwardingResult, PostApiEndpoint, PutAddonCall, PutAddonData, PutAddonEndpoint, PutAddonParameters, PutAddonRequest, PutAddonResult, PutApiEndpoint, PutJobCronCall, PutJobCronData, PutJobCronEndpoint, PutJobCronParameters, PutJobCronRequest, PutJobCronResult, PutJobManualCall, PutJobManualData, PutJobManualEndpoint, PutJobManualParameters, PutJobManualRequest, PutJobManualResult, PutSecretCall, PutSecretData, PutSecretEndpoint, PutSecretParameters, PutSecretRequest, PutSecretResult, PutServiceBuildCall, PutServiceBuildData, PutServiceBuildEndpoint, PutServiceBuildParameters, PutServiceBuildRequest, PutServiceBuildResult, PutServiceCombinedCall, PutServiceCombinedData, PutServiceCombinedEndpoint, PutServiceCombinedParameters, PutServiceCombinedRequest, PutServiceCombinedResult, PutServiceDeploymentCall, PutServiceDeploymentData, PutServiceDeploymentEndpoint, PutServiceDeploymentParameters, PutServiceDeploymentRequest, PutServiceDeploymentResult, RestartAddonCall, RestartAddonEndpoint, RestartAddonParameters, RestartAddonRequest, RestartAddonResult, RestartServiceCall, RestartServiceEndpoint, RestartServiceParameters, RestartServiceRequest, RestartServiceResult, RestoreAddonBackupCall, RestoreAddonBackupEndpoint, RestoreAddonBackupParameters, RestoreAddonBackupRequest, RestoreAddonBackupResult, ResumeAddonCall, ResumeAddonEndpoint, ResumeAddonParameters, ResumeAddonRequest, ResumeAddonResult, ResumeJobCall, ResumeJobData, ResumeJobEndpoint, ResumeJobParameters, ResumeJobRequest, ResumeJobResult, ResumeLogsinkCall, ResumeLogsinkEndpoint, ResumeLogsinkParameters, ResumeLogsinkRequest, ResumeLogsinkResult, ResumeServiceCall, ResumeServiceData, ResumeServiceEndpoint, ResumeServiceParameters, ResumeServiceRequest, ResumeServiceResult, RetainAddonBackupCall, RetainAddonBackupEndpoint, RetainAddonBackupParameters, RetainAddonBackupRequest, RetainAddonBackupResult, RunReleaseflowCall, RunReleaseflowData, RunReleaseflowEndpoint, RunReleaseflowParameters, RunReleaseflowRequest, RunReleaseflowResult, RunTemplateCall, RunTemplateData, RunTemplateEndpoint, RunTemplateParameters, RunTemplateRequest, RunTemplateResult, ScaleAddonCall, ScaleAddonData, ScaleAddonEndpoint, ScaleAddonParameters, ScaleAddonRequest, ScaleAddonResult, ScaleJobCall, ScaleJobData, ScaleJobEndpoint, ScaleJobParameters, ScaleJobRequest, ScaleJobResult, ScaleServiceCall, ScaleServiceData, ScaleServiceEndpoint, ScaleServiceParameters, ScaleServiceRequest, ScaleServiceResult, StartAddonPitrCall, StartAddonPitrData, StartAddonPitrEndpoint, StartAddonPitrParameters, StartAddonPitrRequest, StartAddonPitrResult, StartJobBuildCall, StartJobBuildData, StartJobBuildEndpoint, StartJobBuildParameters, StartJobBuildRequest, StartJobBuildResult, StartJobRunCall, StartJobRunData, StartJobRunEndpoint, StartJobRunParameters, StartJobRunRequest, StartJobRunResult, StartServiceBuildCall, StartServiceBuildData, StartServiceBuildEndpoint, StartServiceBuildParameters, StartServiceBuildRequest, StartServiceBuildResult, SuspendJobCall, SuspendJobData, SuspendJobEndpoint, SuspendJobParameters, SuspendJobRequest, SuspendJobResult, UnassignSubdomainCall, UnassignSubdomainEndpoint, UnassignSubdomainParameters, UnassignSubdomainRequest, UnassignSubdomainResult, UpdateAddonNetworksettingsCall, UpdateAddonNetworksettingsData, UpdateAddonNetworksettingsEndpoint, UpdateAddonNetworksettingsParameters, UpdateAddonNetworksettingsRequest, UpdateAddonNetworksettingsResult, UpdateAddonSecurityCall, UpdateAddonSecurityData, UpdateAddonSecurityEndpoint, UpdateAddonSecurityParameters, UpdateAddonSecurityRequest, UpdateAddonSecurityResult, UpdateAddonVersionCall, UpdateAddonVersionData, UpdateAddonVersionEndpoint, UpdateAddonVersionParameters, UpdateAddonVersionRequest, UpdateAddonVersionResult, UpdateClusterCall, UpdateClusterData, UpdateClusterEndpoint, UpdateClusterParameters, UpdateClusterRequest, UpdateClusterResult, UpdateIntegrationCall, UpdateIntegrationData, UpdateIntegrationEndpoint, UpdateIntegrationParameters, UpdateIntegrationRequest, UpdateIntegrationResult, UpdateJobBuildargumentsCall, UpdateJobBuildargumentsData, UpdateJobBuildargumentsEndpoint, UpdateJobBuildargumentsParameters, UpdateJobBuildargumentsRequest, UpdateJobBuildargumentsResult, UpdateJobBuildoptionsCall, UpdateJobBuildoptionsData, UpdateJobBuildoptionsEndpoint, UpdateJobBuildoptionsParameters, UpdateJobBuildoptionsRequest, UpdateJobBuildoptionsResult, UpdateJobBuildsourceCall, UpdateJobBuildsourceData, UpdateJobBuildsourceEndpoint, UpdateJobBuildsourceParameters, UpdateJobBuildsourceRequest, UpdateJobBuildsourceResult, UpdateJobDeploymentCall, UpdateJobDeploymentData, UpdateJobDeploymentEndpoint, UpdateJobDeploymentParameters, UpdateJobDeploymentRequest, UpdateJobDeploymentResult, UpdateJobHealthchecksCall, UpdateJobHealthchecksData, UpdateJobHealthchecksEndpoint, UpdateJobHealthchecksParameters, UpdateJobHealthchecksRequest, UpdateJobHealthchecksResult, UpdateJobRuntimeenvironmentCall, UpdateJobRuntimeenvironmentData, UpdateJobRuntimeenvironmentEndpoint, UpdateJobRuntimeenvironmentParameters, UpdateJobRuntimeenvironmentRequest, UpdateJobRuntimeenvironmentResult, UpdateJobSettingsCall, UpdateJobSettingsData, UpdateJobSettingsEndpoint, UpdateJobSettingsParameters, UpdateJobSettingsRequest, UpdateJobSettingsResult, UpdateLogsinkCall, UpdateLogsinkData, UpdateLogsinkEndpoint, UpdateLogsinkParameters, UpdateLogsinkRequest, UpdateLogsinkResult, UpdateRegistryCall, UpdateRegistryData, UpdateRegistryEndpoint, UpdateRegistryParameters, UpdateRegistryRequest, UpdateRegistryResult, UpdateReleaseflowCall, UpdateReleaseflowData, UpdateReleaseflowEndpoint, UpdateReleaseflowParameters, UpdateReleaseflowRequest, UpdateReleaseflowResult, UpdateSecretCall, UpdateSecretData, UpdateSecretEndpoint, UpdateSecretParameters, UpdateSecretRequest, UpdateSecretResult, UpdateSecretlinkCall, UpdateSecretlinkData, UpdateSecretlinkEndpoint, UpdateSecretlinkParameters, UpdateSecretlinkRequest, UpdateSecretlinkResult, UpdateServiceBuildargumentsCall, UpdateServiceBuildargumentsData, UpdateServiceBuildargumentsEndpoint, UpdateServiceBuildargumentsParameters, UpdateServiceBuildargumentsRequest, UpdateServiceBuildargumentsResult, UpdateServiceBuildoptionsCall, UpdateServiceBuildoptionsData, UpdateServiceBuildoptionsEndpoint, UpdateServiceBuildoptionsParameters, UpdateServiceBuildoptionsRequest, UpdateServiceBuildoptionsResult, UpdateServiceBuildsourceCall, UpdateServiceBuildsourceData, UpdateServiceBuildsourceEndpoint, UpdateServiceBuildsourceParameters, UpdateServiceBuildsourceRequest, UpdateServiceBuildsourceResult, UpdateServiceDeploymentCall, UpdateServiceDeploymentData, UpdateServiceDeploymentEndpoint, UpdateServiceDeploymentParameters, UpdateServiceDeploymentRequest, UpdateServiceDeploymentResult, UpdateServiceHealthchecksCall, UpdateServiceHealthchecksData, UpdateServiceHealthchecksEndpoint, UpdateServiceHealthchecksParameters, UpdateServiceHealthchecksRequest, UpdateServiceHealthchecksResult, UpdateServicePortsCall, UpdateServicePortsData, UpdateServicePortsEndpoint, UpdateServicePortsParameters, UpdateServicePortsRequest, UpdateServicePortsResult, UpdateServiceRuntimeenvironmentCall, UpdateServiceRuntimeenvironmentData, UpdateServiceRuntimeenvironmentEndpoint, UpdateServiceRuntimeenvironmentParameters, UpdateServiceRuntimeenvironmentRequest, UpdateServiceRuntimeenvironmentResult, UpdateTemplateCall, UpdateTemplateData, UpdateTemplateEndpoint, UpdateTemplateParameters, UpdateTemplateRequest, UpdateTemplateResult, UpdateVolumeCall, UpdateVolumeData, UpdateVolumeEndpoint, UpdateVolumeParameters, UpdateVolumeRequest, UpdateVolumeResult, VerifyDomainCall, VerifyDomainEndpoint, VerifyDomainParameters, VerifyDomainRequest, VerifyDomainResult, VerifySubdomainCall, VerifySubdomainEndpoint, VerifySubdomainParameters, VerifySubdomainRequest, VerifySubdomainResult };
|