-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathreference.html.md.erb
1671 lines (1406 loc) · 64.8 KB
/
reference.html.md.erb
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
---
title: Service Plan Reference
owner: Cloud Service Broker
---
<strong><%= modified_date %></strong>
This topic provides reference information about the plans and configuration
parameters used for configuring service instances.
See the section below for your desired service:
- [Azure SQL (MSSQL)](#azure-mssql)
- [Azure SQL (MSSQL) Database](#azure-mssql-db)
- [Azure SQL (MSSQL) Server](#azure-mssql-server)
- [Azure SQL (MSSQL) Failover Group](#azure-mssql-fog)
- [Pre-configured Server Pairs for Azure SQL (MSSQL) Failover Groups](#azure-mssql-fog-preconfig)
- [Azure SQL Failover Group Failover Runner](#azure-mssql-fog-runner)
- [Azure PostgreSQL](#azure-postgresql)
- [Azure Storage Account](#azure-storage-account)
## <a id="azure-mssql"></a> Azure SQL (MSSQL)
This section applies to the csb-azure-mssql service.
This section lists default plans and configuration options for Azure SQL on Azure.
### <a id="azure-mssql-plans"></a> Plans
The table below lists the plans for the csb-azure-mssql service:
| Plan | CPUs | Storage Size |
|------------|------|--------------|
| small | 2 | 50 GB |
| medium | 8 | 200 GB |
| large | 32 | 500 GB |
| extra-large | 64 | 1 TB |
### <a id="azure-mssql-plans-config"></a> Plan Configuration Parameters
<%# What are these and when/how do you configure these? %>
The table below lists the plan parameters you can configure:
| Option Name | Values | Default |
|-------------|---------------------|---------|
| max\_storage\_gb | | 50 |
| cores | 1–64, multiples of 2 | 2 |
#### <a id="azure-mssql-skus"></a> SKUs
SKUs are usually formatted as <code>TIER\_FAMILY\_NUMBER-OF-CORES</code>. Where:
<ul>
<li>Examples of <code>TIER</code> are <code>GP\_S</code>, <code>GP</code>, and <code>HS</code></li>
<li>Examples of <code>FAMILY</code> are <code>Gen4</code> and <code>Gen5</code></li>
</ul>
Example SKUs are <code>GP\_S\_Gen4\_1</code> and <code>GP\_Gen5\_8</code>.
If you do not define a SKU using the <code>sku_name</code> parameter, the SKU is
computed from the number of cores in your plan.
See [Plans](#azure-mssql-db-plans) above.
For a list of all valid SKUs, run:
<pre><code>az sql db list-editions -l LOCATION -o table</code></pre>
The table below shows the mapping of number of cores to the corresponding Azure
stock-keeping unit (SKU):
| Cores | SKU |
|-------|-----|
| 1 | GP\_Gen5\_1 |
| 2 | GP\_Gen5\_2 |
| 4 | GP\_Gen5\_4 |
| 8 | GP\_Gen5\_8 |
| 16 | GP\_Gen5\_16 |
| 32 | GP\_Gen5\_32 |
| 80 | GP\_Gen5\_80 |
<%# Is this table necessary? Can we get this information from the links below? %>
For information about the the vCore purchasing model, see the
<a href="https://docs.microsoft.com/en-us/azure/azure-sql/database/resource-limits-vcore-single-databases">Microsoft documentation</a>.<br>
For information about the the DTU purchasing model, see the
<a href="https://docs.microsoft.com/en-us/azure/azure-sql/database/resource-limits-dtu-single-databases">Microsoft documentation</a>.
<p class="note">
<strong>Note:</strong> Azure SQL service instances use the vCore model and the Gen5
hardware generation unless you override this default using the <code>sku_name</code> parameter.
For more information about the vCore model, see the
<a href="https://docs.microsoft.com/en-us/azure/sql-database/sql-database-service-tiers-vcore?tabs=azure-portal">Microsoft documentation</a>.
</p>
<p class="note">
<strong>Note:</strong> When updating a service instance, the SKU for the updated
service instance must remain in the same family (<code>GP_S</code>, <code>GP</code>, or <code>HS</code>).
<%# Should this say tier or family? GP_S is a tier. Can you only use the tiers listed here? %>
If you update to a different family, Azure refuses the update request.
</p>
### <a id="azure-mssql-parameters"></a> Configuration Parameters
You can provision a service by running:
```
cf create-service csb-azure-mssql PLAN-NAME SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
```
You can update the plan or configuration parameters for a service instance by running:
```
cf update-service SERVICE-INSTANCE [-p NEW-PLAN] -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
```
<%# Could this be moved to a generic section about provisioning a service?
Should you use the parameters listed below in the -c flag? -- YES
Can we have an example? -- $ cf create-service csb-azure-mssql small my-instance -c '{"sku_name": "GP_Gen4_1"}
See also similar sections below. %>
The table below lists the parameters you can configure, using the `-c` flag, when
provisioning a csb-azure-mssql service:
<%# This table is for developers. It gives the params that they can put in the -c flag. See also similar sections below. %>
<style>
main table {
table-layout: fixed;
}
</style>
<table>
<thead>
<tr>
<th width="20%">Parameter Name</th>
<th width="10%">Type</th>
<th width="50%">Description</th>
<th width="20%">Default</th>
</tr>
</thead>
<tr>
<td><code>instance_name</code></td>
<td>string</td>
<td>The name of the service instance.</td>
<td><code>csb-azsql-INSTANCE-ID</code> </td>
</tr>
<tr>
<td><code>resource_group</code></td>
<td>string</td>
<td>The Azure resource group in which to create the instance.</td>
<td><code>rg-INSTANCE-NAME</code></td>
</tr>
<tr>
<td><code>db_name</code></td>
<td>string</td>
<td>The name of the database.</td>
<td><code>csb-db</code></td>
</tr>
<tr>
<td><code>location</code></td>
<td>string</td>
<td>
The Azure region in which to deploy the service instance.
<p class="note">
<strong>Note:</strong> Currently Azure SQL is not available in all regions.
If you configure a region that is unavailable, <%= vars.product_short %> fails.
</p>
</td>
<td><code>westus</code></td>
</tr>
<tr>
<td><code>azure_tenant_id</code></td>
<td>string</td>
<td>The ID of the Azure tenant for the service instance.</td>
<td>The value the operator entered for <strong>Tenant ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_subscription_id</code></td>
<td>string</td>
<td>The ID of the Azure subscription for the service instance.</td>
<td>The value the operator entered for <strong>Subscription ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_client_id</code></td>
<td>string</td>
<td>The ID of the Azure service principal to authenticate for service instance creation.</td>
<td>The value the operator entered for <strong>Client ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_client_secret</code></td>
<td>string</td>
<td>The secret (password) for the Azure service principal to authenticate for service instance creation.</td>
<td>The value the operator entered for <strong>Client Secret</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>sku_name</code></td>
<td>string</td>
<td>
The Azure stock-keeping unit (SKU).
For more information about configuring this parameter, see <a href="#azure-mssql-skus">SKUs</a> above.
</td>
<td></td>
</tr>
<tr>
<td><code>authorized_network</code></td>
<td>string</td>
<td>The Azure subnet ID, in long form, that the instance is connected to through a service endpoint.
The subnet must have the <code>Microsoft.sql</code> service enabled.</td>
<td></td>
</tr>
<tr>
<tr>
<td><code>skip_provider_registration</code></td>
<td>boolean</td>
<td>Set to <code>true</code> to skip automatic Azure provider registration.
Set if the service principal being used does not have the rights to register providers.</td>
<td><code>false</code></td>
</tr>
</table>
### <a id="azure-mssql-binding-creds"></a> Binding Credentials
<%# Who is this section for? Developers or Operators? When should it be used? See also similar sections below. %>
The format for binding credentials for Azure SQL is as follows:
```json
{
"name" : "DATABASE NAME",
"hostname" : "DATABASE-SERVER-HOST",
"port" : "DATABASE-SERVER-PORT",
"username" : "AUTHENTICATION-USERNAME",
"password" : "AUTHENTICATION-PASSWORD",
"uri" : "DATABASE CONNECTION-URI",
"jdbcUrl" : "JDBC-FORMAT-CONNECTION-URI",
"sqldbName" : "DATABASE-NAME",
"sqlServerName" : "SERVER-NAME",
"sqlServerFullyQualifiedDomainName" : "SERVER-FQDN",
"databaseLogin" : "AUTHENTICATION-USERNAME",
"databaseLoginPassword" : "AUTHENTICATION-PASSWORD"
}
```
## <a id="azure-mssql-db"></a>Azure SQL (MSSQL) Database
This section applies to the service csb-azure-mssql-db.
The csb-azure-mssql-db servicde manages Azure SQL databases on pre-configured
database servers on Azure.
### <a id="azure-mssql-db-plans"></a> Plans
The table below lists the plans for the csb-azure-mssql-db service:
| Plan | CPUs | Maximumum Storage Size |
|------------|------|--------------|
|small | 2 | 50 GB |
|medium | 8 | 200 GB |
|large | 32 | 500 GB |
|extra-large | 80 | 1 TB |
### <a id="azure-mssql-db-plans-config"></a> Plan Configuration Parameters
The table below lists the plan parameters you can configure:
| Parameter Name | Values | Default |
|-------------|------------------------|---------|
| max\_storage\_gb | | 50 |
| cores | 1–64, multiples of 2 | 2 |
#### <a id="azure-mssql-db-skus"></a> SKUs
SKUs are usually formatted as <code>TIER\_FAMILY\_NUMBER-OF-CORES</code>. Where:
<ul>
<li>Examples of <code>TIER</code> are <code>GP\_S</code>, <code>GP</code>, and <code>HS</code></li>
<li>Examples of <code>FAMILY</code> are <code>Gen4</code> and <code>Gen5</code></li>
</ul>
Example SKUs are <code>GP\_S\_Gen4\_1</code> and <code>GP\_Gen5\_8</code>.
If you do not define a SKU using the <code>sku_name</code> parameter, the SKU is
computed from the number of cores in your plan.
See [Plans](#azure-mssql-db-plans) above.
For a list of all valid SKUs, run:
<pre><code>az sql db list-editions -l LOCATION -o table</code></pre>
The table below shows the mapping of number of cores to the corresponding SKU:
| Cores | SKU |
|-------|-----|
| 1 | GP\_Gen5\_1 |
| 2 | GP\_Gen5\_2 |
| 4 | GP\_Gen5\_4 |
| 8 | GP\_Gen5\_8 |
| 16 | GP\_Gen5\_16 |
| 32 | GP\_Gen5\_32 |
| 80 | GP\_Gen5\_80 |
<%# Is this table necessary? Can we get this information from the links below? %>
For information about the the vCore purchasing model, see the
<a href="https://docs.microsoft.com/en-us/azure/azure-sql/database/resource-limits-vcore-single-databases">Microsoft documentation</a>.<br>
For information about the the DTU purchasing model, see the
<a href="https://docs.microsoft.com/en-us/azure/azure-sql/database/resource-limits-dtu-single-databases">Microsoft documentation</a>.
<p class="note">
<strong>Note:</strong> Azure SQL service instances use the vCore model and the Gen5
hardware generation unless you override this default using the <code>sku_name</code> parameter.
For more information about the vCore model, see the
<a href="https://docs.microsoft.com/en-us/azure/sql-database/sql-database-service-tiers-vcore?tabs=azure-portal">Microsoft documentation</a>.
</p>
<p class="note">
<strong>Note:</strong> When updating a service instance, the SKU for the updated
service instance must remain in the same family (<code>GP_S</code>, <code>GP</code>, or <code>HS</code>).
<%# Should this say tier or family? GP_S is a tier. Can you only use the tiers listed here? %>
If you update to a different family, Azure refuses the update request.
</p>
### <a id="azure-mssql-db-parameters"></a> Configuration Parameters
You can provision a service by running:
```
cf create-service csb-azure-mssql-db PLAN-NAME SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
```
You can update the plan or configuration parameters for a service instance by running:
```
cf update-service SERVICE-INSTANCE [-p NEW-PLAN] -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
```
The table below lists the parameters you can configure, using the `-c` flag, when
provisioning a csb-azure-mssql-db service:
<table>
<thead>
<tr>
<th width="20%">Parameter Name</th>
<th width="10%">Type</th>
<th width="50%">Description</th>
<th width="20%">Default</th>
</tr>
</thead>
<tr>
<td><code>db_name</code></td>
<td>string</td>
<td>The name of the database.</td>
<td><code>csb-fog-db-INSTANCE-ID</code></td>
</tr>
<tr>
<td><code>server</code></td>
<td>string</td>
<td>
The name of the server on which to create the database.
This must match one of the <code>SERVER</code> parameters in <code>server_credentials</code>.
For example, <code>SERVER-1</code> in the code snippet in the <code>server_credentials</code> row below.
</td>
<td></td>
</tr>
<tr>
<td><code>server_credentials</code></td>
<td>JSON</td>
<td>
A list of server credentials on which databases can be created.
Format: <pre><code>{ "SERVER-1": { "server_name":"...", "server_resource_group":"...", "admin_username":"...", "admin_password":"..."}, "SERVER-2":{"server_name":..., ...}...}</code></pre>
One of the values you use for <code>SERVER</code> must match the <code>server</code> parameter above.
</td>
<td></td>
</tr>
<tr>
<td><code>azure_tenant_id</code></td>
<td>string</td>
<td>The ID of the Azure tenant for the service instance.</td>
<td>The value the operator entered for <strong>Tenant ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_subscription_id</code></td>
<td>string</td>
<td>The ID of the Azure subscription for the service instance.</td>
<td>The value the operator entered for <strong>Subscription ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_client_id</code></td>
<td>string</td>
<td>The ID of the Azure service principal to authenticate for service instance creation. <%# Clarification needed %></td>
<td>The value the operator entered for <strong>Client ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_client_secret</code></td>
<td>string</td>
<td>The secret (password) for the Azure service principal to authenticate for service instance creation.</td>
<td>The value the operator entered for <strong>Client Secret</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>sku_name</code></td>
<td>string</td>
<td>
The Azure stock-keeping unit (SKU).
For more information about configuring this parameter, see <a href="#azure-mssql-db-skus">SKUs</a> above.
</td>
<td></td>
</tr>
<tr>
<td><code>skip_provider_registration</code></td>
<td>boolean</td>
<td>Set to <code>true</code> to skip automatic Azure provider registration.
Set if the service principal being used does not have the rights to register providers.</td>
<td><code>false</code></td>
</tr>
</table>
### <a id="azure-mssql-db-global-defaults"></a> Configure Global Defaults
<%# Who is this section for? Developers or Operators? When should it be used? See also similar sections below. %>
Operators usually configure `server_credentials` for developers to use.
<%# See [configuration documentation](./configuration.md) and
[Azure installation documentation](azure-installation.md) for reference.
-- Need proper link for configuration.md and azure-installation.md and further clarification. %>
To globally configure `server_credentials`, include the following in the configuration file for the
broker:
<%# Where is this config file? How to do this? %>
```yaml
service:
csb-azure-mssql-db:
provision:
defaults: '{
"server_credentials": {
"server1": {
"admin_username":"ADMIN-USERNAME",
"admin_password":"ADMIN-PASSWORD",
"server_name":"SERVER_NAME",
"server_resource_group":"SERVER-RESOURCE-GROUP"
},
"server2": {
"admin_username":"ADMIN-USERNAME",
...
}
}
}'
```
<%# does it matter that this file has admin_username, admin_password, server_name,
server_resource_group in a different order to the server_credentials row of the table? %>
Developers can create a new failover group database on `server1` by running, for example:
<pre class="terminal">$ cf create-service csb-azure-mssql-db medium medium-sql -c '{"server":"server1"}'</pre>
### <a id="azure-mssql-db-binding-creds"></a> Binding Credentials
The format for binding credentials for an Azure SQL database is as follows:
```json
{
"name" : "DATABASE-NAME",
"hostname" : "DATABASE-SERVER-HOST",
"port" : "DATABASE-SERVER-PORT",
"username" : "AUTHENTICATION-USERNAME",
"password" : "AUTHENTICATION-PASSWORD",
"uri" : "DATABASE-CONNECTION-URI",
"jdbcUrl" : "JDBC-FORMAT-CONNECTION-URI",
"sqldbName" : "DATABASE-NAME",
"sqlServerName" : "SERVER-NAME",
"sqlServerFullyQualifiedDomainName" : "SERVER-FQDN",
"databaseLogin" : "AUTHENTICATION-USERNAME",
"databaseLoginPassword" : "AUTHENTICATION-PASSWORD"
}
```
<%# Do we need to define placeholders here? %>
## <a id="azure-mssql-server"></a> Azure SQL (MSSQL) Server
This section applies to the csb-azure-mssql-server service.
The csb-azure-mssql-server service manages stand alone Azure SQL server service instances on Azure.
No databases are created or managed.
### <a id="azure-mssql-server-plans"></a> Plans
The only plan is `standard`.
### <a id="azure-mssql-server-parameters"></a> Configuration Parameters
You can provision a service by running:
```
cf create-service csb-azure-mssql-server standard SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
```
You can update the configuration parameters for a service instance by running:
```
cf update-service SERVICE-INSTANCE -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
```
The table below lists the parameters you can configure, using the `-c` flag, when
provisioning a csb-azure-mssql-server service:
<table>
<thead>
<tr>
<th width="20%">Parameter Name</th>
<th width="10%">Type</th>
<th width="50%">Description</th>
<th width="20%">Default</th>
</tr>
</thead>
<tr>
<td><code>instance_name</code></td>
<td>string</td>
<td>The name of the service instance for the server.</td>
<td><code>csb-azsql-svr-INSTANCE-ID</code></td>
</tr>
<tr>
<td><code>resource_group</code></td>
<td>string</td>
<td>The Azure resource group in which to create the instance.</td>
<td><code>rg-INSTANCE-NAME</code></td>
</tr>
<tr>
<td><code>admin_username</code></td>
<td>string</td>
<td>The admin username for the server.</td>
<td>A randomly generated string.</td>
</tr>
<tr>
<td><code>admin_password</code></td>
<td>string</td>
<td>The admin password for the server.</td>
<td>A randomly generated string.</td>
</tr>
<tr>
<td><code>location</code></td>
<td>string</td>
<td>
The Azure region in which to create the server. <%# Should we add the note about not being available in all regions here like in Azure SQL above? %>
</td>
<td><code>westus</code></td>
</tr>
<tr>
<td><code>azure_tenant_id</code></td>
<td>string</td>
<td>The ID of the Azure tenant for the service instance.</td>
<td>The value the operator entered for <strong>Tenant ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_subscription_id</code></td>
<td>string</td>
<td>The ID of the Azure subscription for the service instance.</td>
<td>The value the operator entered for <strong>Subscription ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_client_id</code></td>
<td>string</td>
<td>The ID of the Azure service principal to authenticate for service instance creation.</td>
<td>The value the operator entered for <strong>Client ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_client_secret</code></td>
<td>string</td>
<td>The secret (password) for the Azure service principal to authenticate for service instance creation.</td>
<td>The value the operator entered for <strong>Client Secret</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>authorized_network</code></td>
<td>string</td>
<td>The Azure subnet ID, in long form, that the instance is connected to through a service endpoint.
The subnet must have the <code>Microsoft.sql</code> service enabled.</td>
<td></td>
</tr>
<tr>
<td><code>skip_provider_registration</code></td>
<td>boolean</td>
<td>Set to <code>true</code> to skip automatic Azure provider registration.
Set if the service principal being used does not have the rights to register providers.</td>
<td><code>false</code></td>
</tr>
</table>
### <a id="azure-mssql-server-binding-creds"></a> Binding Credentials
The format for binding credentials for Azure SQL Server is as follows:
```json
{
"hostname" : "DATABASE-SERVER-HOST<%# |BOSH-DIRECTOR-IP| is preferred. %>",
"port" : "DATABASE-SERVER-PORT",
"username" : "AUTHENTICATION-USERNAME",
"password" : "AUTHENTICATION-PASSWORD",
"sqlServerName" : "SERVER-NAME",
"sqldbResourceGroup" : "RESOURCE-GROUP-FOR-SERVER",
"sqlServerFullyQualifiedDomainName" : "SERVER-FQDN",
"databaseLogin" : "AUTHENTICATION-USERNAME",
"databaseLoginPassword" : "AUTHENTICATION-PASSWORD"
}
```
<%# Do we need to define the placeholders here? %>
## <a id="azure-mssql-fog"></a> Azure SQL (MSSQL) Failover Group
This section applies to the csb-azure-mssql-failover-group service.
This section lists the default plans and configuration options for Azure SQL Failover Group on Azure.
### <a id="azure-mssql-fog-plans"></a> Plans
The table below lists the plans for the csb-azure-mssql-failover-group service:
| Plan | CPUs | Storage Size |
|------------|------|--------------|
| small | 2 | 50 GB |
| medium | 8 | 200 GB |
| large | 32 | 500 GB |
### <a id="azure-mssql-fog-config-options"></a> Configuration Options
<%# Any reason this section is called Configuration Options and not Plan Configuration parameters
like in the other services? Which is the better name? See also PostgreSQL section below. %>
The table below lists the options you can configure:
| Option Name | Values | Default |
|-------------|---------------------|---------|
| max\_storage\_gb | | 50 |
| cores | 1–64, multiples of 2 | 2 |
#### <a id="azure-mssql-fog-skus"></a> SKUs
SKUs are usually formatted as <code>TIER\_FAMILY\_NUMBER-OF-CORES</code>. Where:
<ul>
<li>Examples of <code>TIER</code> are <code>GP\_S</code>, <code>GP</code>, and <code>HS</code></li>
<li>Examples of <code>FAMILY</code> are <code>Gen4</code> and <code>Gen5</code></li>
</ul>
Example SKUs are <code>GP\_S\_Gen4\_1</code> and <code>GP\_Gen5\_8</code>.
If you do not define a SKU using the <code>sku_name</code> parameter, the SKU is
computed from the number of cores in your plan.
See [Plans](#azure-mssql-fog-plans) above.
For a list of all valid SKUs, run:
<pre><code>az sql db list-editions -l LOCATION -o table</code></pre>
The table below shows the mapping of number of cores to the corresponding SKU:
| Cores | SKU |
|-------|-----|
| 1 | GP\_Gen5\_1 |
| 2 | GP\_Gen5\_2 |
| 4 | GP\_Gen5\_4 |
| 8 | GP\_Gen5\_8 |
| 16 | GP\_Gen5\_16 |
| 32 | GP\_Gen5\_32 |
| 80 | GP\_Gen5\_80 |
<%# Is this table necessary? Can we get this information from the links below? %>
For information about the the vCore purchasing model, see the
<a href="https://docs.microsoft.com/en-us/azure/azure-sql/database/resource-limits-vcore-single-databases">Microsoft documentation</a>.<br>
For information about the the DTU purchasing model, see the
<a href="https://docs.microsoft.com/en-us/azure/azure-sql/database/resource-limits-dtu-single-databases">Microsoft documentation</a>.
<p class="note">
<strong>Note:</strong> Azure SQL service instances use the vCore model and the Gen5
hardware generation unless you override this default using the <code>sku_name</code> parameter.
For more information about the vCore model, see the
<a href="https://docs.microsoft.com/en-us/azure/sql-database/sql-database-service-tiers-vcore?tabs=azure-portal">Microsoft documentation</a>.
</p>
<p class="note">
<strong>Note:</strong> When updating a service instance, the SKU for the updated
service instance must remain in the same family (<code>GP_S</code>, <code>GP</code>, or <code>HS</code>).
<%# Should this say tier or family? GP_S is a tier. Can you only use the tiers listed here? %>
If you update to a different family, Azure refuses the update request.
</p>
### <a id="azure-mssql-fog-parameters"></a> Configuration Parameters
Except as noted below, the configuration is generally the same as for [Azure SQL](#azure-mssql) above. <%# Which configuration is this referring to? %>
The table below lists the parameters you can configure, using the `-c` flag, when
provisioning a csb-azure-mssql-failover-group service:
<table>
<thead>
<tr>
<th width="20%">Parameter Name</th>
<th width="10%">Type</th>
<th width="50%">Description</th>
<th width="20%">Default</th>
</tr>
</thead>
<tr>
<td><code>instance_name</code></td>
<td>string</td>
<td>The name of the service instance.</td>
<td><code>csb-azsql-INSTANCE-ID</code></td>
</tr>
<tr>
<td><code>resource_group</code></td>
<td>string</td>
<td>The Azure resource group in which to create the instance.</td>
<td><code>rg-INSTANCE-NAME</code></td>
</tr>
<tr>
<td><code>location</code></td>
<td>string</td>
<td>
The Azure region in which to deploy the service instance.
<p class="note">
<strong>Note:</strong> Currently Azure SQL is not available in all regions.
If you configure a region that is unavailable, <%= vars.product_short %> fails.
</p>
</td>
<td><code>westus</code></td>
</tr>
<tr>
<td><code>failover_location</code></td>
<td>string</td>
<td>The Azure region for the failover instance.</td>
<td><code>DEFAULT-REGIONAL-PAIR</code>. For information about regional pairs, see the <a href="https://docs.microsoft.com/en-us/azure/best-practices-availability-paired-regions#azure-regional-pairs">Microsoft Documentation</a></td>
</tr>
<tr>
<td><code>read_write_endpoint_failover_policy</code></td>
<td>string</td>
<td>The Read/Write failover policy. The options are <code>Automatic</code> or <code>Manual</code></td>.
<td><code>Automatic</code></td>
</tr>
<tr>
<td><code>failover_grace_minutes</code></td>
<td>number</td>
<td>The grace period in minutes before failover with data loss is attempted.</td>
<td><code>60</code></td>
</tr>
<tr>
<td><code>azure_tenant_id</code></td>
<td>string</td>
<td>The ID of the Azure tenant for the service instance.</td>
<td>The value the operator entered for <strong>Tenant ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_subscription_id</code></td>
<td>string</td>
<td>The ID of the Azure subscription for the service instance.</td>
<td>The value the operator entered for <strong>Subscription ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_client_id</code></td>
<td>string</td>
<td>The ID of the Azure service principal to authenticate for service instance creation.</td>
<td>The value the operator entered for <strong>Client ID</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>azure_client_secret</code></td>
<td>string</td>
<td>The secret (password) for the Azure service principal to authenticate for service instance creation.</td>
<td>The value the operator entered for <strong>Client Secret</strong> in <%= vars.ops_manager %>.</td>
</tr>
<tr>
<td><code>sku_name</code></td>
<td>string</td>
<td>
The Azure stock-keeping unit (SKU).
For more information about configuring this parameter, see <a href="#azure-mssql-fog-skus">SKUs</a> above.
</td>
<td></td>
</tr>
<tr>
<td><code>authorized_network</code></td>
<td>string</td>
<td>The Azure subnet ID, in long form, that the instance is connected to through a service endpoint.
The subnet must have the <code>Microsoft.sql</code> service enabled.</td>
<td></td>
</tr>
<tr>
<td><code>skip_provider_registration</code></td>
<td>boolean</td>
<td>Set to <code>true</code> to skip automatic Azure provider registration.
Set if the service principal being used does not have the rights to register providers.</td>
<td><code>false</code></td>
</tr>
</table>
### <a id="azure-mssql-fog-binding-creds"></a> Binding Credentials
The format for binding credentials for Azure SQL Failover Group is as follows:
```json
{
"name" : "DATABASE-NAME",
"hostname" : "DATABASE-SERVER-HOST",
"port" : "DATABASE-SERVER-PORT",
"username" : "AUTHENTICATION-USERNAME",
"password" : "AUTHENTICATION-PASSWORD",
"uri" : "DATABASE-CONNECTION-URI",
"jdbcUrl" : "JDBC-FORMAT-CONNECTION-URI",
"sqldbName" : "DATABASE-NAME",
"sqlServerName" : "SERVER-NAME",
"sqlServerFullyQualifiedDomainName" : "SERVER-FQDN",
"databaseLogin" : "AUTHENTICATION-USERNAME",
"databaseLoginPassword" : "AUTHENTICATION-PASSWORD"
}
```
### <a id="azure-mssql-fog-secondry-db"></a> About the Secondary Database Created by the Failover Group
Because the secondary (failover) database is implicitly created when the failover
group is created, the broker does not currently have control over that database instance.
This manifests itself when a `cf update` is executed on the failover group.
Changes to the SKU and other parameters are not propagated to the secondary database.
The current workaround is to subsume control of the secondary database instance
that can then be managed with the cf CLI.
#### <a id="azure-mssql-fog-secondry-db"></a> Gain Control of the Secondary Database Instance
To subsume control over the secondary database:
1. Retrieve the secondary database ID from the output of the following command<%# Replace with just |run:| %>:
```
cf service FOG-INSTANCE
```
For example:
<pre class="terminal">$ cf service example-fog
Showing info of service example-fog in org pivotal / space ernie as admin...
name: example-fog
service: csb-azure-mssql-failover-group
tags:
plan: small
description: Manages auto failover group for managed Azure SQL on the Azure Platform
documentation: https<span>:</span>//docs.microsoft.com/en-us/azure/sql-database/sql-database-auto-failover-group/
dashboard:
Showing status of last operation from service example-fog...
status: create succeeded
message: created failover group csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143 (id:
/subscriptions/899bf076-632b-4143-b015-43da8179e53f/resourceGroups/broker-cf-test/providers/Microsoft.Sql/servers/csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-primary/failoverGroups/csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143), primary db csb-db (id:
/subscriptions/899bf076-632b-4143-b015-43da8179e53f/resourceGroups/broker-cf-test/providers/Microsoft.Sql/servers/csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-primary/databases/csb-db) on server csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-primary (id:
/subscriptions/899bf076-632b-4143-b015-43da8179e53f/resourceGroups/broker-cf-test/providers/Microsoft.Sql/servers/csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-primary), secondary db csb-db (id:
/subscriptions/899bf076-632b-4143-b015-43da8179e53f/resourceGroups/broker-cf-test/providers/Microsoft.Sql/servers/csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-secondary/databases/csb-db) on server csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-secondary (id:
/subscriptions/899bf076-632b-4143-b015-43da8179e53f/resourceGroups/broker-cf-test/providers/Microsoft.Sql/servers/csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-secondary) URL:
https<span>:</span>//portal.azure.com/#@29248f74-371f-4db2-9a50-c62a6877a0c1/resource/subscriptions/899bf076-632b-4143-b015-43da8179e53f/resourceGroups/broker-cf-test/providers/Microsoft.Sql/servers/csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-primary/failoverGroup
started: 2020-09-21T18:43:51Z
updated: 2020-09-21T18:49:04Z
There are no bound apps for this service.
</pre>
<%# Where is the DB ID in this output? -- in the message section %>
Record the line from `message` that ends with `secondary/databases/csb-db`.
In the example above the secondary database ID is
`/subscriptions/899bf076-632b-4143-b015-43da8179e53f/resourceGroups/broker-cf-test/providers/Microsoft.Sql/servers/csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-secondary/databases/csb-db`.
1. Subsume control of the database instance by running:
```
cf create-service csb-masb-mssql-db-subsume PLAN-NAME SERVICE-INSTANCE-NAME -c '{"azure_db_id":"DATABASE-ID"}' <%# SI name of secondary db %>
```
Where:
`PLAN-NAME` is the plan you want for your secondary database instance <%# Should this be the same plan as the primary? %>
`SERVICE-INSTANCE-NAME` is the service instance name you choose for your secondary database
`DATABASE-ID` is the database ID you recorded in the step above
For example:
<pre class="terminal">
$ cf create-service csb-masb-mssql-db-subsume current secondary-db -c '{"azure_db_id":"/subscriptions/899bf076-632b-4143-b015-43da8179e53f/resourceGroups/broker-cf-test/providers/Microsoft.Sql/servers/csb-azsql-fog-8fa66105-2796-4bed-a2a3-d1691fbba143-secondary/databases/csb-db"}' <%# SI name of secondary db %>
Creating service instance secondary-db in org pivotal / space ernie as admin...
OK
Create in progress. Use 'cf services' or 'cf service secondary-db' to check operation status.
Attention: The plan `current` of service `csb-masb-mssql-db-subsume` is not free. The instance `secondary-db` will incur a cost. Contact your administrator if you think this is in error.
</pre>
The secondary database is now under Cloud Foundry control and you can use `cf update`
to modify its configuration.
## <a id="azure-mssql-fog-preconfig"></a> Pre-configured Server Pairs for Azure SQL (MSSQL) Failover Groups
This section applies to the csb-azure-mssql-db-failover-group service, which manages
Azure SQL Failover Group databases on pre-configured server pairs on Azure.
If you already have a failover group database server pre-configured,
use this service instead of the more general Azure SQL Failover Group service.
### <a id="azure-mssql-fog-preconfig-plans"></a> Plans
The table below lists the plans for the csb-azure-mssql-db-failover-group service:
| Plan | CPUs | Storage Size |
|------------|------|--------------|
|small | 2 | 50 GB |
|medium | 8 | 200 GB |
|large | 32 | 500 GB |
|existing | n/a | n/a |
The `existing` plan connects to an existing failover group database to allow apps,
typically in a second foundation, to bind to the database.
### <a id="azure-mssql-fog-preconfig-plans-config"></a> Plan Configuration Parameters
The table below lists the plan parameters you can configure:
| Parameter Name | Values | Default |
|-------------|---------------------|---------|
| max\_storage\_gb | | 50 |
| cores | 1–64, multiples of 2 | 2 |
#### <a id="azure-mssql-fog-preconfig-skus"></a> SKU
SKUs are usually formatted as <code>TIER\_FAMILY\_NUMBER-OF-CORES</code>. Where:
<ul>
<li>Examples of <code>TIER</code> are <code>GP\_S</code>, <code>GP</code>, and <code>HS</code></li>
<li>Examples of <code>FAMILY</code> are <code>Gen4</code> and <code>Gen5</code></li>
</ul>
Example SKUs are <code>GP\_S\_Gen4\_1</code> and <code>GP\_Gen5\_8</code>.
If you do not define a SKU using the <code>sku_name</code> parameter, the SKU is
computed from the number of cores in your plan.
See [Plans](#azure-mssql-fog-preconfig-plans) above.
For a list of all valid SKUs, run:
<pre><code>az sql db list-editions -l LOCATION -o table</code></pre>
The table below shows the mapping of number of cores to the corresponding SKU:
| Cores | SKU |
|-------|-----|
| 1 | GP\_Gen5\_1 |
| 2 | GP\_Gen5\_2 |
| 4 | GP\_Gen5\_4 |
| 8 | GP\_Gen5\_8 |
| 16 | GP\_Gen5\_16 |
| 32 | GP\_Gen5\_32 |
| 80 | GP\_Gen5\_80 |
<%# Is this table necessary? Can we get this information from the links below? %>
For information about the the vCore purchasing model, see the
<a href="https://docs.microsoft.com/en-us/azure/azure-sql/database/resource-limits-vcore-single-databases">Microsoft documentation</a>.<br>
For information about the the DTU purchasing model, see the
<a href="https://docs.microsoft.com/en-us/azure/azure-sql/database/resource-limits-dtu-single-databases">Microsoft documentation</a>.
<p class="note">
<strong>Note:</strong> Azure SQL service instances use the vCore model and the Gen5
hardware generation unless you override this default using the <code>sku_name</code> parameter.
For more information about the vCore model, see the
<a href="https://docs.microsoft.com/en-us/azure/sql-database/sql-database-service-tiers-vcore?tabs=azure-portal">Microsoft documentation</a>.
</p>
### <a id="azure-mssql-fog-preconfig-parameters"></a> Configuration Parameters
You can provision a service by running:
```
cf create-service csb-azure-mssql-db-failover-group PLAN-NAME SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
```
You can update the plan or configuration parameters for a service instance by running:
```
cf update-service SERVICE-INSTANCE [-p NEW-PLAN] -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
```
The table below lists the parameters you can configure, using the `-c` flag, when
provisioning a csb-azure-mssql-db-failover-group service:
<table>
<thead>
<tr>
<th width="20%">Parameter Name</th>
<th width="10%">Type</th>
<th width="50%">Description</th>
<th width="20%">Default</th>
</tr>
</thead>
<tr>
<td><code>instance_name</code></td>
<td>string</td>
<td>The name of the failover group service instance.</td>
<td><code>csb-azsql-fog-INSTANCE-ID</code></td>
</tr>
<tr>
<td><code>db_name</code></td>
<td>string</td>
<td>The name of the database.</td>
<td><code>csb-fog-db-INSTANCE-ID</code></td>
</tr>
<tr>
<td><code>server_pair</code></td>
<td>string</td>
<td>