-
Notifications
You must be signed in to change notification settings - Fork 24
/
Copy pathibm_catalog.json
445 lines (443 loc) · 22.5 KB
/
ibm_catalog.json
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
{
"products": [
{
"name": "terraform-ibm-cos",
"label": "Cloud Object Storage module",
"product_kind": "module",
"tags": [
"dev_ops",
"target_terraform",
"terraform",
"module",
"ibm_created"
],
"keywords": [
"terraform",
"cos",
"bucket",
"storage"
],
"short_description": "Configures an IBM Cloud Object Storage instance and bucket",
"long_description": "Use this module to provision and configure an IBM [Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage) instance and bucket.\nYou can configure the following aspects of your instances:\n- [KMS encryption](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-encryption)\n- [Activity tracking](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-tracking-cos-events) and auditing\n- [Monitoring](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-monitoring-cos)\n- Data retention, [lifecycle](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-archive) and archiving options\n### Usage\n```hcl\nmodule \"cos\" {\n # Replace \"X.X.X\" with a release version to lock into a specific release\n source = \"https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/offering/source?archive=tgz&kind=terraform&name=terraform-ibm-cos&version=X.X.X\"\n resource_group_id = \"199f65xxxxxxXXXXXXxxxxxxed93c497\"\n region = \"us-south\" # set this to null and use 'cross_region_location' to create cross-region bucket\n cos_instance_name = \"my-cos-instance\"\n bucket_name = \"my-bucket\"\n retention_enabled = false # disable retention for test environments - enable for stage/prod\n kms_encryption_enabled = false # by default, all objects are encrypted by using randomly generated keys and an all-or-nothing-transform (AONT)\n}\n```",
"offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-cos/blob/main/README.md",
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/images/cos_icon.svg",
"provider_name": "IBM",
"features": [
{
"title": "Create an Object Storage instance",
"description": "Create an IBM Cloud Object Storage instance."
},
{
"title": "Create an Object Storage bucket",
"description": "Create either a cross-region or regional Object Storage bucket."
},
{
"title": "Create an IBM resource key",
"description": "Create a resource key for the Object Storage instance."
},
{
"title": "Attach access tags",
"description": "Attach access tags to the Object Storage instance."
},
{
"title": "Configure bucket retention",
"description": "Configure retention policies at the IBM Cloud Object Storage bucket level."
},
{
"title": "Enable object versioning",
"description": "Supports enabling object versioning to keep multiple versions of an object in a bucket."
},
{
"title": "Add archive policies",
"description": "Add archive policies on the bucket."
},
{
"title": "Record Activity Tracker events",
"description": "Integrate Activity Tracker to track events."
},
{
"title": "Monitor data",
"description": "Integrate with the IBM Cloud Monitoring service to monitor your Object Storage data."
},
{
"title": "Encrypt data with key management services",
"description": "Use key management services (BYOK and KYOK), including service-to-service authorization policies."
},
{
"title": "Secure access with context-based restrictions",
"description": "Create context-based restriction rules for both instances and buckets."
}
],
"flavors": [
{
"label": "Basic",
"name": "basic",
"working_directory": "examples/basic",
"architecture": {
"diagrams": [
{
"diagram": {
"caption": "Basic example",
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
"type": "image/svg+xml"
},
"description": "A simple example that shows how to provision a basic Object Storage instance and buckets."
}
]
}
},
{
"label": "Encryption and observability",
"name": "advanced",
"working_directory": "examples/advanced",
"architecture": {
"diagrams": [
{
"diagram": {
"caption": "Advanced example",
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
"type": "image/svg+xml"
},
"description": "This example creates buckets that are encrypted with your own keys (BYOK). The buckets include activity tracking, monitoring, and context-based restriction rules."
}
]
}
},
{
"label": "Financial Services compliant",
"name": "fscloud",
"working_directory": "examples/fscloud",
"architecture": {
"diagrams": [
{
"diagram": {
"caption": "Financial Services compliant example",
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
"type": "image/svg+xml"
},
"description": "This example uses a profile for IBM Cloud Framework for Financial Services to provision an Object Storage instance and a Hyper Protect Crypto Services (HPCS) bucket encrypted with KYOK. The resources include activity tracking, monitoring, and context-based restriction rules."
}
]
}
},
{
"label": "One Rate plan",
"name": "one-rate-plan",
"working_directory": "examples/one-rate-plan",
"architecture": {
"diagrams": [
{
"diagram": {
"caption": "One Rate plan example",
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
"type": "image/svg+xml"
},
"description": "This example shows how to provision an IBM Cloud Object Storage One Rate plan instance and an Object Storage bucket with One Rate active storage."
}
]
}
},
{
"label": "Bucket replication",
"name": "replication",
"working_directory": "examples/replication",
"architecture": {
"diagrams": [
{
"diagram": {
"caption": "Bucket replication example",
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
"type": "image/svg+xml"
},
"description": "This example shows how to configure replication between two buckets."
}
]
}
}
]
},
{
"name": "deploy-arch-ibm-cos",
"label": "Cloud automation for Cloud Object Storage",
"product_kind": "solution",
"tags": [
"dev_ops",
"target_terraform",
"terraform",
"solution",
"storage",
"ibm_created"
],
"keywords": [
"terraform",
"cos",
"bucket",
"storage",
"solution"
],
"short_description": "Creates and configures an IBM Cloud Object Storage instance and bucket",
"long_description": "This architecture supports creating an IBM Cloud Object Storage instance, cross-region and single-region bucket.",
"offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-cos/blob/main/README.md",
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/images/cos_icon.svg",
"provider_name": "IBM",
"features": [
{
"title": "Create an IBM Cloud Object Storage instance",
"description": "Create an IBM Cloud Object Storage instance."
},
{
"title": "Create an IBM Cloud Object Storage bucket",
"description": "Create either a cross-region or regional Object Storage bucket."
},
{
"title": "Attach access tags",
"description": "Attach access tags to the Object Storage instance."
}
],
"flavors": [
{
"label": "Single instance",
"name": "instance",
"install_type": "fullstack",
"working_directory": "solutions/instance",
"compliance": {
"authority": "scc-v3",
"profiles": [
{
"profile_name": "IBM Cloud Framework for Financial Services",
"profile_version": "1.7.0"
}
]
},
"architecture": {
"features": [
{
"title": "Create an IBM Cloud Object Storage instance",
"description": "Create and configure an IBM Cloud Object Storage instance."
},
{
"title": "Create an IBM resource key",
"description": "Create a resource key for the Object Storage instance."
}
],
"diagrams": [
{
"diagram": {
"caption": "IBM Cloud Object Storage Solution",
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/reference-architectures/instance.svg",
"type": "image/svg+xml"
},
"description": "This architecture supports creating and configuring an IBM Cloud Object Storage instance."
}
]
},
"configuration":[
{
"key": "provider_visibility",
"options": [
{
"displayname": "private",
"value": "private"
},
{
"displayname": "public",
"value": "public"
},
{
"displayname": "public-and-private",
"value": "public-and-private"
}
]
},
{
"key":"instance_cbr_rules"
},
{
"key":"prefix",
"required":true,
"description": "Prefix to add to all resources created by this solution. To not use any prefix value, you can enter the string `__NULL__`."
}
]
},
{
"label": "Secure cross-region bucket",
"name": "secure-cross-regional-bucket",
"working_directory": "solutions/secure-cross-regional-bucket",
"install_type": "extension",
"dependencies": [
{
"flavors": [
"instance"
],
"catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
"id": "68921490-2778-4930-ac6d-bae7be6cd958-global",
"name": "deploy-arch-ibm-cos",
"version": ">= v8.1.4",
"optional": true
}
],
"compliance": {
"authority": "scc-v3",
"profiles": [
{
"profile_name": "IBM Cloud Framework for Financial Services",
"profile_version": "1.7.0"
}
]
},
"architecture": {
"features": [
{
"title": "Create a secure cross-region bucket",
"description": "Create a secure cross-region Object Storage bucket."
},
{
"title": "Configure bucket retention",
"description": "Configure retention policies at the Object Storage bucket level."
},
{
"title": "Enable object versioning",
"description": "Enable object versioning to keep multiple versions of an object in a bucket."
},
{
"title": "Record Activity Tracker events",
"description": "Integrate Activity Tracker to track events."
},
{
"title": "Monitor data",
"description": "Integrate with the IBM Cloud Monitoring service to monitor your Object Storage data."
},
{
"title": "Encrypt data with key management services",
"description": "Use key management services (BYOK and KYOK), including service-to-service authorization policies."
}
],
"diagrams": [
{
"diagram": {
"caption": "IBM Cloud Object Storage solution",
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/reference-architectures/secure-cross-regional-bucket.svg",
"type": "image/svg+xml"
},
"description": "This architecture supports creating and configuring a secure cross-region bucket."
}
]
},
"configuration":[
{
"key": "provider_visibility",
"options": [
{
"displayname": "private",
"value": "private"
},
{
"displayname": "public",
"value": "public"
},
{
"displayname": "public-and-private",
"value": "public-and-private"
}
]
},
{
"key":"instance_cbr_rules"
}
]
},
{
"label": "Secure regional bucket",
"name": "secure-regional-bucket",
"working_directory": "solutions/secure-regional-bucket",
"install_type": "extension",
"dependencies": [
{
"flavors": [
"instance"
],
"catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
"id": "68921490-2778-4930-ac6d-bae7be6cd958-global",
"name": "deploy-arch-ibm-cos",
"version": ">= v8.1.4",
"optional": true
}
],
"compliance": {
"authority": "scc-v3",
"profiles": [
{
"profile_name": "IBM Cloud Framework for Financial Services",
"profile_version": "1.7.0"
}
]
},
"architecture": {
"features": [
{
"title": "Create secure regional bucket",
"description": "Create a secure regional bucket."
},
{
"title": "Configure bucket retention",
"description": "Configure retention policies at the IBM Cloud Object Storage bucket level."
},
{
"title": "Enable object versioning",
"description": "Enable object versioning to keep multiple versions of an object in a bucket."
},
{
"title": "Add archive policies",
"description": "Add archive policies on the bucket."
},
{
"title": "Record Activity Tracker events",
"description": "Integrate Activity Tracker to track events."
},
{
"title": "Monitor data",
"description": "Integrate with the IBM Cloud Monitoring service to monitor your Object Storage data."
},
{
"title": "Encrypt data with key management services",
"description": "Use key management services (BYOK and KYOK), including service-to-service authorization policies."
}
],
"diagrams": [
{
"diagram": {
"caption": "IBM Cloud Object Storage solution",
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-cos/main/reference-architectures/secure-regional-bucket.svg",
"type": "image/svg+xml"
},
"description": "This architecture supports creating and configuring a regional bucket."
}
]
},
"configuration":[
{
"key": "provider_visibility",
"options": [
{
"displayname": "private",
"value": "private"
},
{
"displayname": "public",
"value": "public"
},
{
"displayname": "public-and-private",
"value": "public-and-private"
}
]
},
{
"key":"instance_cbr_rules"
}
]
}
]
}
]
}