-
Notifications
You must be signed in to change notification settings - Fork 35
/
metadata.yaml
1215 lines (1215 loc) · 42.1 KB
/
metadata.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
id: "terraform-ibm-modules/satellite/ibm/1.0.8"
name: "satellite"
namespace: "terraform-ibm-modules"
version: "1.0.8"
providers: ["ibm"]
provider_logo_url: "/images/providers/satellite.png"
description: "Terraform modules to create and work with IBM Cloud Satellite resources"
source: "https://github.com/terraform-ibm-modules/terraform-ibm-satellite"
owner: "umarali.nagoor@in.ibm.com"
published_at: "2021-11-17T14:54:28.979568Z"
registry: "https://registry.terraform.io/modules/terraform-ibm-modules/satellite/ibm/latest"
alias: "satellite"
tags: ["satellite", "terraform", "ibm-cloud", "v1.0.8"]
root:
- path: "github.com/terraform-ibm-modules/terraform-ibm-satellite"
name: "satellite"
provider_dependencies:
- name: "ibm"
namespace: "IBM-Cloud"
source: "IBM-Cloud/ibm"
version: ""
###################################
# input_variables
###################################
inputs:
- name: "region"
type: string
is_required: false
default_value: "us-east"
description: "Region of the IBM Cloud account. Currently supported regions for satellite are us-east and eu-gb region"
example: "us-east"
is_sensitive: false
is_nullable: false
is_force_new: true
is_provision_controller: false
is_count_controller: false
- name: "resource_group"
type: string
is_required: true
default_value: "default"
description: "Name of the resource group on which location has to be created"
example: "default"
is_sensitive: false
is_nullable: false
is_force_new: true
is_provision_controller: false
is_count_controller: false
- name: "location"
type: string
is_required: false
default_value: "satellite-ibm"
description: "location name must begin and end with a letter and contain only letters, numbers, and - characters"
example: "satellite-ibm"
is_sensitive: false
related_to: ["satellite-location"]
is_nullable: false
is_force_new: false
regex: "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$"
is_provision_controller: false
is_count_controller: false
- name: "managed_from"
type: string
is_required: false
default_value: "wdc"
description: "The IBM Cloud region to manage your Satellite location from. Choose a region close to your on-prem data center for better performance"
example: "wdc"
is_sensitive: false
related_to: ["satellite-location"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "location_zones"
type: list(string)
is_required: false
default_value: ["us-east-1", "us-east-2", "us-east-3"]
description: "Allocate your hosts across these three zones"
example: ["us-east-1", "us-east-2", "us-east-3"]
is_sensitive: false
related_to: ["satellite-location"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "location_bucket"
type: string
is_required: false
description: "COS bucket name"
is_sensitive: false
related_to: ["satellite-location"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "is_location_exist"
type: bool
is_required: false
default_value: false
description: "Determines if the location has to be created or not"
example: false
is_sensitive: false
related_to: ["satellite-location"]
is_nullable: false
is_force_new: false
is_provision_controller: true
is_count_controller: true
- name: "host_labels"
type : list(string)
is_required: false
default_value: ["env:prod"]
description: "Labels to add to attach host script"
example: ["env:prod"]
is_sensitive: false
related_to: ["satellite-location", "host", "cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
##################################################
# IBMCLOUD VPC VSI Variables
##################################################
- name: "host_count"
type: number
is_required: true
default_value: 3
description: "The total number of ibm host to create for control plane"
example: 3
is_sensitive: false
related_to: ["host"]
is_nullable: false
is_force_new: false
is_provision_controller: true
is_count_controller: false
- name: "addl_host_count"
type: number
is_required: true
default_value: 3
description: "The total number of additional aws host"
example: 3
is_sensitive: false
related_to: ["cluster"]
is_nullable: false
is_force_new: false
is_provision_controller: true
is_count_controller: false
- name: "is_prefix"
type: string
is_required: false
default_value: "satellite-ibm"
description: "Determines if the location has to be created or not"
example: "satellite-ibm"
is_sensitive: false
related_to: ["satellite-location", "satellite-host", "satellite-cluster", "ibm_is_vpc", "ibm_is_subnet", "default_sg_rules", "ibm_is_instance", "ibm_is_floating_ip"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "public_key"
type: string
is_required: false
description: "SSH Public Key. Get your ssh key by running `ssh-key-gen` command"
is_sensitive: false
related_to: ["satellite-location", "satellite-host", "satellite-cluster", "ibm_is_vpc"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "location_profile"
type: string
is_required: false
default_value: "mx2-8x64"
description: "Profile information of location hosts"
example: "mx2-8x64"
is_sensitive: false
related_to: ["ibm_is_vpc", "satellite-cluster"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "cluster_profile"
type: string
is_required: false
default_value: "mx2-8x64"
description: "Profile information of Cluster hosts"
example: "mx2-8x64"
is_sensitive: false
related_to: ["ibm_is_vpc", "satellite-cluster"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
##################################################
# satellite-cluster variables
##################################################
- name: "create_cluster"
type: bool
is_required: false
default_value: true
description: "Create Cluster"
example: true
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: false
is_force_new: false
is_provision_controller: true
is_count_controller: true
- name: "cluster"
type: string
is_required: false
default_value: "satellite-ibm-cluster"
description: "Create Cluster"
example: "satellite-ibm-cluster"
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: true
is_force_new: false
regex: "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$"
is_provision_controller: true
is_count_controller: false
- name: "kube_version"
type: string
is_required: false
default_value: "4.7_openshift"
description: "Kube Version"
example: "4.7_openshift"
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "cluster_host_labels"
type: list(string)
is_required: false
default_value: ["env:prod"]
description: "Labels to add to attach host script"
example: ["env:prod"]
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "worker_count"
type: number
is_required: false
default_value: 1
description: "Worker Count for default pool"
example: 1
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "wait_for_worker_update"
type: bool
is_required: false
default_value: true
description: "Wait for worker update"
example: true
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "default_worker_pool_labels"
type: map(any)
is_required: false
description: "Label to add default worker pool"
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "tags"
type: list(string)
is_required: false
description: "List of tags associated with cluster"
example: ["env:prod"]
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "create_timeout"
type : string
is_required: false
default_value: "10m"
description: "Timeout duration for create."
example: "10m"
is_sensitive: false
related_to: ["satellite-cluster","satellite-cluster-worker-pool"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "update_timeout"
type : string
is_required: false
default_value: "10m"
description: "Timeout duration for update."
example: "10m"
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "delete_timeout"
type : string
is_required: false
default_value: "10m"
description: "Timeout duration for delete."
example: "10m"
is_sensitive: false
related_to: ["satellite-cluster","satellite-cluster-worker-pool"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
##################################################
# satellite-cluster-worker-pool variables
##################################################
- name: "create_cluster_worker_pool"
type: bool
is_required: false
default_value: false
description: "Create Cluster worker pool"
example: false
is_sensitive: false
related_to: ["satellite-cluster-worker-pool"]
is_nullable: true
is_force_new: false
is_provision_controller: true
is_count_controller: true
- name: "worker_pool_name"
type: string
is_required: false
default_value: "tf-worker-pool"
description: "Workerpool name"
example: "tf-worker-pool"
is_sensitive: false
related_to: ["satellite-cluster-worker-pool"]
is_nullable: true
is_force_new: false
regex: "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$"
is_provision_controller: false
is_count_controller: false
- name: "worker_pool_host_labels"
type: list(string)
is_required: false
default_value: ["env:prod"]
description: "Labels to add to attach host script"
example: ["env:prod"]
is_sensitive: false
related_to: ["satellite-cluster-worker-pool"]
is_nullable: true
is_force_new: false
regex: "^[a-zA-Z0-9:]+$"
is_provision_controller: false
is_count_controller: false
###################################
# output variables
###################################
outputs:
- name: "location_id"
type : string
description : "location ID"
example: "qwdfrtyfg34ee"
is_sensitive: false
related_to: ["satellite-location"]
- name: "host_script"
type : string
description : "Downloads attach host scripts of location"
is_sensitive: false
related_to: ["satellite-location"]
- name: "host_ids"
type : list(string)
description : "Host Id's"
is_sensitive: false
related_to: ["satellite-location"]
- name: "floating_ip_ids"
type : list(string)
description : "Floating IP Id's"
is_sensitive: false
related_to: ["ibm_is_floating_ip"]
- name: "floating_ip_addresses"
type : list(string)
description : "Floating IP addresses"
is_sensitive: false
related_to: ["ibm_is_floating_ip"]
- name: "vpc"
type : string
description : "VPC Id"
is_sensitive: false
related_to: ["ibm_is_vpc"]
- name: "default_security_group"
type : string
description : "Default security group"
is_sensitive: false
related_to: ["bm_is_vpc"]
- name: "subnets"
type : string
description : "Subnets Id"
is_sensitive: false
related_to: ["ibm_is_subnet"]
- name: "cluster_id"
type : string
description : "Cluster Id"
is_sensitive: false
related_to: ["satellite-cluster"]
- name: "cluster_crn"
type : string
description : "Cluster CRN"
is_sensitive: false
related_to: ["satellite-cluster"]
- name: "server_url"
type : string
description : "Cluster master server URL"
is_sensitive: false
related_to: ["satellite-cluster"]
- name: "cluster_state"
type : string
description : "Cluster state"
is_sensitive: false
related_to: ["satellite-cluster"]
- name: "cluster_status"
type : string
description : "Cluster status"
is_sensitive: false
related_to: ["satellite-cluster"]
- name: "ingress_hostname"
type : string
description : "Cluster ingress hostname"
is_sensitive: false
related_to: ["satellite-cluster"]
- name: "cluster_worker_pool_id"
type : string
description : "Cluster workerpool ID"
is_sensitive: false
related_to: ["satellite-cluster-worker-pool"]
- name: "worker_pool_zones"
type : list(string)
description : "Cluster workerpool zones"
is_sensitive: false
related_to: ["satellite-cluster-worker-pool"]
- name: "worker_pool_worker_count"
type : number
description : "Cluster worker count per zone"
is_sensitive: false
related_to: ["satellite-cluster-worker-pool"]
##########################################################
# local variables
##########################################################
locals:
- name: "location_zones"
type : list(string)
example: ["us-east-1", "us-east-2", "us-east-3"]
description : "Satellite location zones"
is_hardcoded : false
related_to: ["satellite-location"]
derived_from: ["var.location_zones", "var.region"]
- name: "subnet_ids"
type: list(string)
example: ["0757-dc45976a-0c33-4e06-b242-6462eadc58db"]
description : "List of subnet ID's"
is_hardcoded : false
related_to: ["ibm_is_subnet.satellite_subnet[0].id"]
- name: "sg_rules"
type: map
description : "List of security group rules"
is_hardcoded : true
related_to: ["default_sg_rules"]
derived_from: [local.sg_rules]
- name: "rules"
type: map
description : "List of rules defined for each protocal"
is_hardcoded : true
related_to: ["default_sg_rules"]
derived_from: ["var.is_prefix"]
###################################
# Resources
###################################
resources:
- type: "ibm_is_vpc"
name: "satellite_vpc"
description: "provision VPC resource"
provider: "ibm"
dependent_on: [data.ibm_resource_group.resource_group]
- type: "ibm_is_subnet"
name: "satellite_subnet"
description: "provision subnets"
provider: "ibm"
dependent_on: [data.ibm_resource_group.resource_group, ibm_is_vpc.satellite_vpc]
- type: "tls_private_key"
name: "example"
description: "provision subnets"
provider: "hashicorp"
- type: "ibm_is_ssh_key"
name: "satellite_ssh"
description: "Create SSH key"
provider: "ibm"
dependent_on: [module.satellite-location, data.ibm_resource_group.resource_group, tls_private_key.example]
- type: "ibm_is_instance"
name: "satellite_instance"
description: "provision VSI instances"
provider: "ibm"
dependent_on: [data.ibm_resource_group.resource_group, ibm_is_vpc.satellite_vpc, ibm_is_ssh_key.satellite_ssh, data.ibm_is_image.rhel7]
- type: "ibm_is_instance"
name: "satellite_cluster_instance"
description: "provision VSI instances"
provider: "ibm"
dependent_on: [data.ibm_resource_group.resource_group, ibm_is_vpc.satellite_vpc, ibm_is_ssh_key.satellite_ssh, data.ibm_is_image.rhel7]
- type: "ibm_is_floating_ip"
name: "satellite_ip"
description: "provision floating ip for satellite control plane hosts"
provider: "ibm"
dependent_on: [data.ibm_resource_group.resource_group, ibm_is_instance.satellite_instance]
- type: "ibm_is_floating_ip"
name: "satellite_cluster_ip"
description: "provision floating ip for satellite cluster hosts"
provider: "ibm"
dependent_on: [data.ibm_resource_group.resource_group, ibm_is_instance.satellite_cluster_instance]
###################################
# Data sources
###################################
datasources:
- type: ibm_resource_group
name: "resource_group"
description: "resource group"
provider: "ibm"
- type: ibm_is_image
name: "rhel7"
description: "Retrieve information of an existing IBM Cloud Infrastructure image "
provider: "ibm"
###################################
# List of modules
###################################
modules:
- name: "satellite-location"
id: "terraform-ibm-modules/satellite/ibm/1.8.0/modules/location"
source: "https://github.com/terraform-ibm-modules/terraform-ibm-satellite/tree/main/modules/location"
description: "Used to provision satellite location"
- name: "satellite-host"
id: "terraform-ibm-modules/satellite/ibm/1.8.0/modules/host"
source: "https://github.com/terraform-ibm-modules/terraform-ibm-satellite/tree/main/modules/host"
description: "Used to assign host to control plane cluster"
- name: "satellite-cluster"
id: "terraform-ibm-modules/satellite/ibm/1.8.0/modules/cluster"
source: "https://github.com/terraform-ibm-modules/terraform-ibm-satellite/tree/main/modules/cluster"
description: "Used to provision ROKS satellite cluster"
- name: "satellite-cluster-worker-pool"
id: "terraform-ibm-modules/satellite/ibm/1.8.0/modules/configure-cluster-worker-pool"
source: "https://github.com/terraform-ibm-modules/terraform-ibm-satellite/tree/main/modules/configure-cluster-worker-pool"
description: "Use to configure worker pool on existing ROKS satellite cluster"
###################################
# List of sub modules
###################################
submodules:
- path: "modules/location"
name: "location"
provider_dependencies:
- name: "ibm"
namepspace: "IBM-Cloud"
source: "IBM-Cloud/ibm"
version: "1.36.0"
inputs:
- name: "region"
type: string
is_required: false
default_value: "us-east"
description: "Region of the IBM Cloud account. Currently supported regions for satellite are us-east and eu-gb region"
example: "us-east"
is_sensitive: false
is_nullable: false
is_force_new: true
is_provision_controller: false
is_count_controller: false
- name: "resource_group"
type: string
is_required: true
default_value: "default"
description: "Name of the resource group on which location has to be created"
example: "default"
is_sensitive: false
is_nullable: false
is_force_new: true
is_provision_controller: false
is_count_controller: false
- name: "location"
type: string
is_required: true
default_value: "satellite-ibm"
description: "location name must begin and end with a letter and contain only letters, numbers, and - characters"
example: "satellite-ibm"
is_sensitive: false
related_to: ["location"]
is_nullable: false
is_force_new: false
regex: "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$"
is_provision_controller: false
is_count_controller: false
- name: "managed_from"
type: string
is_required: true
default_value: "wdc"
description: "The IBM Cloud region to manage your Satellite location from. Choose a region close to your on-prem data center for better performance"
example: "wdc"
is_sensitive: false
related_to: ["ibm_satellite_location"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "location_zones"
type: list(string)
is_required: false
default_value: false
description: "Allocate your hosts across these three zones"
example: ["us-east-1", "us-east-2", "us-east-3"]
is_sensitive: false
related_to: ["location"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "location_bucket"
type: string
is_required: false
description: "COS bucket name"
is_sensitive: false
related_to: ["satellite-location"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "is_location_exist"
type: bool
is_required: false
default_value: false
description: "Determines if the location has to be created or not"
example: false
is_sensitive: false
related_to: ["location"]
is_nullable: false
is_force_new: false
is_provision_controller: true
is_count_controller: true
- name: "host_labels"
type : list(string)
is_required: false
default_value: ["env:prod"]
description: "Labels to add to attach host script"
example: ["env:prod"]
is_sensitive: false
related_to: ["location", "host", "cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "host_provider"
type: string
is_required: false
default_value: "ibm"
description: "host provider name for downloading attach host script"
example: "ibm"
is_sensitive: false
related_to: ["location"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
outputs:
- name: "location_id"
type : string
description : "location ID"
example: "qwdfrtyfg34ee"
is_sensitive: false
related_to: ["location"]
- name: "host_script"
type : string
description : "Downloads attach host scripts of location"
is_sensitive: false
related_to: ["location"]
resources:
- type: "ibm_satellite_location"
name: "create_location"
description: "provision satellite location"
provider: "ibm"
dependent_on: [data.ibm_resource_group.res_group]
datasources:
- type: ibm_resource_group
name: "res_group"
description: "resource group"
provider: "ibm"
- type: ibm_satellite_location
name: "location"
description: "satellite location"
provider: "ibm"
- type: ibm_satellite_attach_host_script
name: "script"
description: "Download attach host script for satellite location"
provider: "ibm"
####################################
# host submodule
####################################
- path: "modules/host"
name: "host"
provider_dependencies:
- name: "ibm"
namespace: ""
source: "IBM-Cloud/ibm"
version: ""
inputs:
- name: "location"
type: string
is_required: true
default_value: "satellite-ibm"
description: "location name must begin and end with a letter and contain only letters, numbers, and - characters"
example: "satellite-ibm"
is_sensitive: false
related_to: ["satellite-location"]
is_nullable: false
is_force_new: false
regex: "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$"
is_provision_controller: false
is_count_controller: false
- name: "location_zones"
type: list(string)
is_required: false
default_value: ["us-east-1", "us-east-2", "us-east-3"]
description: "Allocate your hosts across these three zones"
example: ["us-east-1", "us-east-2", "us-east-3"]
is_sensitive: false
related_to: ["ibm_satellite_host.host"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "host_labels"
type : list(string)
is_required: false
description: "Labels to add to attach host script"
is_sensitive: false
related_to: ["ibm_satellite_host.host"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "host_vms"
type: list(string)
is_required: false
description: "A list of hostnames to attach for setting up location control plane"
example: ["env:prod"]
is_sensitive: false
related_to: ["ibm_satellite_host.host"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "host_count"
type: number
is_required: true
default_value: 3
description: "The total number of ibm host assign to control plane"
example: 3
is_sensitive: false
related_to: ["ibm_satellite_host.host"]
is_nullable: false
is_force_new: false
is_provision_controller: true
is_count_controller: true
- name: "host_provider"
type: string
is_required: false
default_value: "ibm"
description: "host provider name for downloading attach host script"
example: "ibm"
is_sensitive: false
related_to: ["ibm_satellite_host.host"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
resources:
- type: "ibm_satellite_host"
name: "assign_host"
description: "Assign host to control plane"
provider: "ibm"
####################################
# cluster submodule
####################################
- path: "modules/cluster"
name: "cluster"
provider_dependencies:
- name: "ibm"
namespace: ""
source: "IBM-Cloud/ibm"
version: ""
inputs:
- name: "create_cluster"
type: bool
is_required: false
default_value: true
description: "Create Cluster provision controller"
example: true
is_sensitive: false
related_to: ["ibm_satellite_cluster"]
is_nullable: false
is_force_new: false
is_provision_controller: true
is_count_controller: true
- name: "cluster"
type: string
is_required: true
description: "Create Cluster"
example: "satellite-ibm-cluster"
is_sensitive: false
related_to: ["ibm_satellite_cluster"]
is_nullable: true
is_force_new: false
regex: "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$"
is_provision_controller: false
is_count_controller: false
- name: "location"
type: string
is_required: true
description: "location name must begin and end with a letter and contain only letters, numbers, and - characters"
is_sensitive: false
related_to: ["ibm_satellite_cluster"]
is_nullable: false
is_force_new: false
regex: "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$"
is_provision_controller: false
is_count_controller: false
- name: "zones"
type: list(string)
is_required: false
description: "Allocate your hosts across these three zones"
example: ["us-east-1", "us-east-2", "us-east-3"]
is_sensitive: false
related_to: ["ibm_satellite_cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "kube_version"
type: string
is_required: false
description: "Kube Version"
example: "4.7_openshift"
is_sensitive: false
related_to: ["ibm_satellite_cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "host_labels"
type: list(string)
is_required: false
description: "Labels to add to attach host script"
example: ["env:prod"]
is_sensitive: false
related_to: ["ibm_satellite_cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "worker_count"
type: number
is_required: false
default_value: 1
description: "Worker Count for default pool"
example: 1
is_sensitive: false
related_to: ["cluster"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "wait_for_worker_update"
type: bool
is_required: false
default_value: true
description: "Wait for worker update"
example: true
is_sensitive: false
related_to: ["cluster"]
is_nullable: false
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "default_worker_pool_labels"
type: map(any)
is_required: false
description: "Label to add default worker pool"
is_sensitive: false
related_to: ["cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "tags"
type: list(string)
is_required: false
description: "List of tags associated with cluster"
is_sensitive: false
related_to: ["cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "create_timeout"
type : string
is_required: false
default_value: "10m"
description: "Timeout duration for create."
example: "10m"
is_sensitive: false
related_to: ["satellite-cluster","satellite-cluster-worker-pool"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "update_timeout"
type : string
is_required: false
default_value: "10m"
description: "Timeout duration for update."
example: "10m"
is_sensitive: false
related_to: ["satellite-cluster"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
- name: "delete_timeout"
type : string
is_required: false
default_value: "10m"
description: "Timeout duration for delete."
example: "10m"
is_sensitive: false
related_to: ["satellite-cluster","satellite-cluster-worker-pool"]
is_nullable: true
is_force_new: false
is_provision_controller: false
is_count_controller: false
outputs:
- name: "cluster_id"
type : string
description : "Cluster Id"
is_sensitive: false
related_to: ["ibm_satellite_cluster.create_cluster"]
- name: "cluster_crn"
type : string
description : "Cluster CRN"
is_sensitive: false
related_to: ["ibm_satellite_cluster.create_cluster"]
- name: "server_url"
type : string
description : "Cluster master server URL"
is_sensitive: false
related_to: ["ibm_satellite_cluster.create_cluster"]
- name: "cluster_state"
type : string
description : "Cluster state"
is_sensitive: false
related_to: ["ibm_satellite_cluster.create_cluster"]
- name: "cluster_status"
type : string
description : "Cluster status"
is_sensitive: false
related_to: ["ibm_satellite_cluster.create_cluster"]
- name: "ingress_hostname"
type : string
description : "Cluster ingress hostname"
is_sensitive: false
related_to: ["ibm_satellite_cluster.create_cluster"]
resources:
- type: "ibm_satellite_cluster"
name: "create_cluster"
description: "provision satellite ROKS cluster"
provider: "ibm"
dependent_on: [data.ibm_resource_group.rg_cluster]
datasources:
- type: "ibm_resource_group"
name: "rg_cluster"
description: "Get resource group information"
provider: "ibm"
- type: "ibm_satellite_cluster"
name: "read_cluster"
description: "Get satellite ROKS cluster information"
provider: "ibm"
####################################
# configure-cluster-worker-pool submodule