-
Notifications
You must be signed in to change notification settings - Fork 29
/
Copy pathmanifest-bundle.yaml
3752 lines (3750 loc) · 157 KB
/
manifest-bundle.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
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
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
# Source: ngrok-operator/templates/controller-serviceaccount.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
name: ngrok-operator
namespace: ngrok-operator
labels:
helm.sh/chart: ngrok-operator-0.15.0
app.kubernetes.io/name: ngrok-operator
app.kubernetes.io/instance: ngrok-operator
app.kubernetes.io/version: "0.12.2"
app.kubernetes.io/part-of: ngrok-operator
app.kubernetes.io/managed-by: Helm
app.kubernetes.io/component: controller
---
# Source: ngrok-operator/templates/controller-cm.yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: ngrok-operator-manager-config
namespace: ngrok-operator
data:
controller_manager_config.yaml: |
apiVersion: controller-runtime.sigs.k8s.io/v1alpha1
kind: ControllerManagerConfig
health:
healthProbeBindAddress: :8081
metrics:
bindAddress: 127.0.0.1:8080
leaderElection:
leaderElect: true
resourceName: ngrok-operator-leader
---
# Source: ngrok-operator/templates/crds/ingress.k8s.ngrok.com_domains.yaml
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.14.0
name: domains.ingress.k8s.ngrok.com
spec:
group: ingress.k8s.ngrok.com
names:
kind: Domain
listKind: DomainList
plural: domains
singular: domain
scope: Namespaced
versions:
- additionalPrinterColumns:
- description: Domain ID
jsonPath: .status.id
name: ID
type: string
- description: Region
jsonPath: .status.region
name: Region
type: string
- description: Domain
jsonPath: .status.domain
name: Domain
type: string
- description: CNAME Target
jsonPath: .status.cnameTarget
name: CNAME Target
type: string
- description: Age
jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
description: Domain is the Schema for the domains API
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: DomainSpec defines the desired state of Domain
properties:
description:
default: Created by kubernetes-ingress-controller
description: Description is a human-readable description of the object
in the ngrok API/Dashboard
type: string
domain:
description: Domain is the domain name to reserve
type: string
metadata:
default: '{"owned-by":"kubernetes-ingress-controller"}'
description: Metadata is a string of arbitrary data associated with
the object in the ngrok API/Dashboard
type: string
region:
description: Region is the region in which to reserve the domain
type: string
required:
- domain
type: object
status:
description: DomainStatus defines the observed state of Domain
properties:
cnameTarget:
description: CNAMETarget is the CNAME target for the domain
type: string
domain:
description: Domain is the domain that was reserved
type: string
id:
description: ID is the unique identifier of the domain
type: string
region:
description: Region is the region in which the domain was created
type: string
uri:
description: URI of the reserved domain API resource
type: string
type: object
type: object
served: true
storage: true
subresources:
status: {}
---
# Source: ngrok-operator/templates/crds/ingress.k8s.ngrok.com_httpsedges.yaml
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.14.0
name: httpsedges.ingress.k8s.ngrok.com
spec:
group: ingress.k8s.ngrok.com
names:
kind: HTTPSEdge
listKind: HTTPSEdgeList
plural: httpsedges
singular: httpsedge
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: HTTPSEdge is the Schema for the httpsedges API
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: HTTPSEdgeSpec defines the desired state of HTTPSEdge
properties:
description:
default: Created by kubernetes-ingress-controller
description: Description is a human-readable description of the object
in the ngrok API/Dashboard
type: string
hostports:
description: Hostports is a list of hostports served by this edge
items:
type: string
type: array
metadata:
default: '{"owned-by":"kubernetes-ingress-controller"}'
description: Metadata is a string of arbitrary data associated with
the object in the ngrok API/Dashboard
type: string
mutualTLS:
properties:
certificateAuthorities:
description: |-
List of CA IDs that will be used to validate incoming connections to the
edge.
items:
type: string
type: array
type: object
routes:
description: Routes is a list of routes served by this edge
items:
properties:
backend:
description: |-
Backend is the definition for the tunnel group backend
that serves traffic for this edge
properties:
description:
default: Created by kubernetes-ingress-controller
description: Description is a human-readable description
of the object in the ngrok API/Dashboard
type: string
labels:
additionalProperties:
type: string
description: Labels to watch for tunnels on this backend
type: object
metadata:
default: '{"owned-by":"kubernetes-ingress-controller"}'
description: Metadata is a string of arbitrary data associated
with the object in the ngrok API/Dashboard
type: string
type: object
circuitBreaker:
description: CircuitBreaker is a circuit breaker configuration
to apply to this route
properties:
errorThresholdPercentage:
anyOf:
- type: integer
- type: string
description: Error threshold percentage should be between
0 - 1.0, not 0-100.0
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
numBuckets:
description: Integer number of buckets into which metrics
are retained. Max 128.
format: int32
maximum: 128
minimum: 1
type: integer
rollingWindow:
description: Statistical rolling window duration that metrics
are retained for.
format: duration
type: string
trippedDuration:
description: Duration after which the circuit is tripped
to wait before re-evaluating upstream health
format: duration
type: string
volumeThreshold:
description: |-
Integer number of requests in a rolling window that will trip the circuit.
Helpful if traffic volume is low.
format: int32
type: integer
type: object
compression:
description: Compression is whether or not to enable compression
for this route
properties:
enabled:
description: Enabled is whether or not to enable compression
for this endpoint
type: boolean
type: object
description:
default: Created by kubernetes-ingress-controller
description: Description is a human-readable description of
the object in the ngrok API/Dashboard
type: string
headers:
description: Headers are request/response headers to apply to
this route
properties:
request:
description: Request headers are the request headers module
configuration or null
properties:
add:
additionalProperties:
type: string
description: |-
a map of header key to header value that will be injected into the HTTP Request
before being sent to the upstream application server
type: object
remove:
description: |-
a list of header names that will be removed from the HTTP Request before being
sent to the upstream application server
items:
type: string
type: array
type: object
response:
description: Response headers are the response headers module
configuration or null
properties:
add:
additionalProperties:
type: string
description: |-
a map of header key to header value that will be injected into the HTTP Response
returned to the HTTP client
type: object
remove:
description: |-
a list of header names that will be removed from the HTTP Response returned to
the HTTP client
items:
type: string
type: array
type: object
type: object
ipRestriction:
description: IPRestriction is an IPRestriction to apply to this
route
properties:
policies:
items:
type: string
type: array
type: object
match:
description: Match is the value to match against the request
path
type: string
matchType:
description: 'MatchType is the type of match to use for this
route. Valid values are:'
enum:
- exact_path
- path_prefix
type: string
metadata:
default: '{"owned-by":"kubernetes-ingress-controller"}'
description: Metadata is a string of arbitrary data associated
with the object in the ngrok API/Dashboard
type: string
oauth:
description: OAuth configuration to apply to this route
properties:
amazon:
description: configuration for using amazon as the identity
provider
properties:
authCheckInterval:
description: |-
Duration after which ngrok guarantees it will refresh user
state from the identity provider and recheck whether the user is still
authorized to access the endpoint. This is the preferred tunable to use to
enforce a minimum amount of time after which a revoked user will no longer be
able to access the resource.
format: duration
type: string
clientId:
description: |-
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, clientSecret must be present as
well.
type: string
clientSecret:
description: |-
the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for clientId.
properties:
key:
description: Key in the secret to use
type: string
name:
description: Name of the Kubernetes secret
type: string
type: object
cookiePrefix:
description: |-
the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'
type: string
emailAddresses:
description: |-
a list of email addresses of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
emailDomains:
description: |-
a list of email domains of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
inactivityTimeout:
description: |-
Duration of inactivity after which if the user has not accessed
the endpoint, their session will time out and they will be forced to
reauthenticate.
format: duration
type: string
maximumDuration:
description: |-
Integer number of seconds of the maximum duration of an authenticated session.
After this period is exceeded, a user must reauthenticate.
format: duration
type: string
optionsPassthrough:
description: |-
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
supporting CORS.
type: boolean
scopes:
description: |-
a list of provider-specific OAuth scopes with the permissions your OAuth app
would like to ask for. these may not be set if you are using the ngrok-managed
oauth app (i.e. you must pass both client_id and client_secret to set scopes)
items:
type: string
type: array
type: object
facebook:
description: configuration for using facebook as the identity
provider
properties:
authCheckInterval:
description: |-
Duration after which ngrok guarantees it will refresh user
state from the identity provider and recheck whether the user is still
authorized to access the endpoint. This is the preferred tunable to use to
enforce a minimum amount of time after which a revoked user will no longer be
able to access the resource.
format: duration
type: string
clientId:
description: |-
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, clientSecret must be present as
well.
type: string
clientSecret:
description: |-
the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for clientId.
properties:
key:
description: Key in the secret to use
type: string
name:
description: Name of the Kubernetes secret
type: string
type: object
cookiePrefix:
description: |-
the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'
type: string
emailAddresses:
description: |-
a list of email addresses of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
emailDomains:
description: |-
a list of email domains of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
inactivityTimeout:
description: |-
Duration of inactivity after which if the user has not accessed
the endpoint, their session will time out and they will be forced to
reauthenticate.
format: duration
type: string
maximumDuration:
description: |-
Integer number of seconds of the maximum duration of an authenticated session.
After this period is exceeded, a user must reauthenticate.
format: duration
type: string
optionsPassthrough:
description: |-
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
supporting CORS.
type: boolean
scopes:
description: |-
a list of provider-specific OAuth scopes with the permissions your OAuth app
would like to ask for. these may not be set if you are using the ngrok-managed
oauth app (i.e. you must pass both client_id and client_secret to set scopes)
items:
type: string
type: array
type: object
github:
description: configuration for using github as the identity
provider
properties:
authCheckInterval:
description: |-
Duration after which ngrok guarantees it will refresh user
state from the identity provider and recheck whether the user is still
authorized to access the endpoint. This is the preferred tunable to use to
enforce a minimum amount of time after which a revoked user will no longer be
able to access the resource.
format: duration
type: string
clientId:
description: |-
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, clientSecret must be present as
well.
type: string
clientSecret:
description: |-
the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for clientId.
properties:
key:
description: Key in the secret to use
type: string
name:
description: Name of the Kubernetes secret
type: string
type: object
cookiePrefix:
description: |-
the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'
type: string
emailAddresses:
description: |-
a list of email addresses of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
emailDomains:
description: |-
a list of email domains of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
inactivityTimeout:
description: |-
Duration of inactivity after which if the user has not accessed
the endpoint, their session will time out and they will be forced to
reauthenticate.
format: duration
type: string
maximumDuration:
description: |-
Integer number of seconds of the maximum duration of an authenticated session.
After this period is exceeded, a user must reauthenticate.
format: duration
type: string
optionsPassthrough:
description: |-
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
supporting CORS.
type: boolean
organizations:
description: |-
a list of github org identifiers. users who are members of any of the listed
organizations will be allowed access. identifiers should be the organization's
'slug'
items:
type: string
type: array
scopes:
description: |-
a list of provider-specific OAuth scopes with the permissions your OAuth app
would like to ask for. these may not be set if you are using the ngrok-managed
oauth app (i.e. you must pass both client_id and client_secret to set scopes)
items:
type: string
type: array
teams:
description: |-
a list of github teams identifiers. users will be allowed access to the endpoint
if they are a member of any of these teams. identifiers should be in the 'slug'
format qualified with the org name, e.g. org-name/team-name
items:
type: string
type: array
type: object
gitlab:
description: configuration for using gitlab as the identity
provider
properties:
authCheckInterval:
description: |-
Duration after which ngrok guarantees it will refresh user
state from the identity provider and recheck whether the user is still
authorized to access the endpoint. This is the preferred tunable to use to
enforce a minimum amount of time after which a revoked user will no longer be
able to access the resource.
format: duration
type: string
clientId:
description: |-
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, clientSecret must be present as
well.
type: string
clientSecret:
description: |-
the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for clientId.
properties:
key:
description: Key in the secret to use
type: string
name:
description: Name of the Kubernetes secret
type: string
type: object
cookiePrefix:
description: |-
the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'
type: string
emailAddresses:
description: |-
a list of email addresses of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
emailDomains:
description: |-
a list of email domains of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
inactivityTimeout:
description: |-
Duration of inactivity after which if the user has not accessed
the endpoint, their session will time out and they will be forced to
reauthenticate.
format: duration
type: string
maximumDuration:
description: |-
Integer number of seconds of the maximum duration of an authenticated session.
After this period is exceeded, a user must reauthenticate.
format: duration
type: string
optionsPassthrough:
description: |-
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
supporting CORS.
type: boolean
scopes:
description: |-
a list of provider-specific OAuth scopes with the permissions your OAuth app
would like to ask for. these may not be set if you are using the ngrok-managed
oauth app (i.e. you must pass both client_id and client_secret to set scopes)
items:
type: string
type: array
type: object
google:
description: configuration for using google as the identity
provider
properties:
authCheckInterval:
description: |-
Duration after which ngrok guarantees it will refresh user
state from the identity provider and recheck whether the user is still
authorized to access the endpoint. This is the preferred tunable to use to
enforce a minimum amount of time after which a revoked user will no longer be
able to access the resource.
format: duration
type: string
clientId:
description: |-
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, clientSecret must be present as
well.
type: string
clientSecret:
description: |-
the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for clientId.
properties:
key:
description: Key in the secret to use
type: string
name:
description: Name of the Kubernetes secret
type: string
type: object
cookiePrefix:
description: |-
the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'
type: string
emailAddresses:
description: |-
a list of email addresses of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
emailDomains:
description: |-
a list of email domains of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
inactivityTimeout:
description: |-
Duration of inactivity after which if the user has not accessed
the endpoint, their session will time out and they will be forced to
reauthenticate.
format: duration
type: string
maximumDuration:
description: |-
Integer number of seconds of the maximum duration of an authenticated session.
After this period is exceeded, a user must reauthenticate.
format: duration
type: string
optionsPassthrough:
description: |-
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
supporting CORS.
type: boolean
scopes:
description: |-
a list of provider-specific OAuth scopes with the permissions your OAuth app
would like to ask for. these may not be set if you are using the ngrok-managed
oauth app (i.e. you must pass both client_id and client_secret to set scopes)
items:
type: string
type: array
type: object
linkedin:
description: configuration for using linkedin as the identity
provider
properties:
authCheckInterval:
description: |-
Duration after which ngrok guarantees it will refresh user
state from the identity provider and recheck whether the user is still
authorized to access the endpoint. This is the preferred tunable to use to
enforce a minimum amount of time after which a revoked user will no longer be
able to access the resource.
format: duration
type: string
clientId:
description: |-
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, clientSecret must be present as
well.
type: string
clientSecret:
description: |-
the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for clientId.
properties:
key:
description: Key in the secret to use
type: string
name:
description: Name of the Kubernetes secret
type: string
type: object
cookiePrefix:
description: |-
the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'
type: string
emailAddresses:
description: |-
a list of email addresses of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
emailDomains:
description: |-
a list of email domains of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
inactivityTimeout:
description: |-
Duration of inactivity after which if the user has not accessed
the endpoint, their session will time out and they will be forced to
reauthenticate.
format: duration
type: string
maximumDuration:
description: |-
Integer number of seconds of the maximum duration of an authenticated session.
After this period is exceeded, a user must reauthenticate.
format: duration
type: string
optionsPassthrough:
description: |-
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
supporting CORS.
type: boolean
scopes:
description: |-
a list of provider-specific OAuth scopes with the permissions your OAuth app
would like to ask for. these may not be set if you are using the ngrok-managed
oauth app (i.e. you must pass both client_id and client_secret to set scopes)
items:
type: string
type: array
type: object
microsoft:
description: configuration for using microsoft as the identity
provider
properties:
authCheckInterval:
description: |-
Duration after which ngrok guarantees it will refresh user
state from the identity provider and recheck whether the user is still
authorized to access the endpoint. This is the preferred tunable to use to
enforce a minimum amount of time after which a revoked user will no longer be
able to access the resource.
format: duration
type: string
clientId:
description: |-
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, clientSecret must be present as
well.
type: string
clientSecret:
description: |-
the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for clientId.
properties:
key:
description: Key in the secret to use
type: string
name:
description: Name of the Kubernetes secret
type: string
type: object
cookiePrefix:
description: |-
the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'
type: string
emailAddresses:
description: |-
a list of email addresses of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
emailDomains:
description: |-
a list of email domains of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
inactivityTimeout:
description: |-
Duration of inactivity after which if the user has not accessed
the endpoint, their session will time out and they will be forced to
reauthenticate.
format: duration
type: string
maximumDuration:
description: |-
Integer number of seconds of the maximum duration of an authenticated session.
After this period is exceeded, a user must reauthenticate.
format: duration
type: string
optionsPassthrough:
description: |-
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
supporting CORS.
type: boolean
scopes:
description: |-
a list of provider-specific OAuth scopes with the permissions your OAuth app
would like to ask for. these may not be set if you are using the ngrok-managed
oauth app (i.e. you must pass both client_id and client_secret to set scopes)
items:
type: string
type: array
type: object
twitch:
description: configuration for using twitch as the identity
provider
properties:
authCheckInterval:
description: |-
Duration after which ngrok guarantees it will refresh user
state from the identity provider and recheck whether the user is still
authorized to access the endpoint. This is the preferred tunable to use to
enforce a minimum amount of time after which a revoked user will no longer be
able to access the resource.
format: duration
type: string
clientId:
description: |-
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, clientSecret must be present as
well.
type: string
clientSecret:
description: |-
the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for clientId.
properties:
key:
description: Key in the secret to use
type: string
name:
description: Name of the Kubernetes secret
type: string
type: object
cookiePrefix:
description: |-
the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'
type: string
emailAddresses:
description: |-
a list of email addresses of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
emailDomains:
description: |-
a list of email domains of users authenticated by identity provider who are
allowed access to the endpoint
items:
type: string
type: array
inactivityTimeout:
description: |-
Duration of inactivity after which if the user has not accessed
the endpoint, their session will time out and they will be forced to
reauthenticate.
format: duration
type: string
maximumDuration:
description: |-
Integer number of seconds of the maximum duration of an authenticated session.
After this period is exceeded, a user must reauthenticate.
format: duration
type: string
optionsPassthrough:
description: |-
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
supporting CORS.
type: boolean
scopes: