Skip to content

Commit 1d0b0ff

Browse files
ocofaighocofaigh
authored
fix: Onboard to IBM Cloud catalog registry (#300)
1 parent 3208f2d commit 1d0b0ff

File tree

10 files changed

+205
-5
lines changed

10 files changed

+205
-5
lines changed

‎.catalog-onboard-pipeline.yaml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
apiVersion: v1
3+
offerings:
4+
- name: terraform-ibm-base-ocp-vpc
5+
kind: module
6+
catalog_id: 7df1e4ca-d54c-4fd0-82ce-3d13247308cd
7+
offering_id: 8531b562-91d5-4974-a195-5dff72ef2a5d
8+
examples:
9+
- name: basic
10+
mark_ready: true
11+
- name: advanced
12+
mark_ready: true
13+
- name: fscloud
14+
mark_ready: true
15+
- name: multiple_mzr_clusters
16+
mark_ready: true
17+
- name: add_rules_to_sg
18+
mark_ready: true

‎.github/settings.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ repository:
1919
# The description is displayed under the repository name on the
2020
# organization page and in the 'About' section of the repository.
2121

22-
description: "Provision an IBM Cloud Red Hat OpenShift cluster on VPC Gen2"
22+
description: "Provisions a Red Hat OpenShift VPC cluster on IBM Cloud"
2323

2424
topics: core-team, terraform, ibm-cloud, terraform-module, openshift-cluster, vpc-cluster, ocp, supported, graduated

‎.secrets.baseline‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"files": "go.sum|^.secrets.baseline$",
44
"lines": null
55
},
6-
"generated_at": "2023-11-23T15:12:20Z",
6+
"generated_at": "2023-11-29T12:01:25Z",
77
"plugins_used": [
88
{
99
"name": "AWSKeyDetector"
@@ -82,7 +82,17 @@
8282
"hashed_secret": "dce1f02ca7cc4b63ac43008b7a3ce96e702a0c24",
8383
"is_secret": false,
8484
"is_verified": false,
85-
"line_number": 37,
85+
"line_number": 39,
86+
"type": "Secret Keyword",
87+
"verified_result": null
88+
}
89+
],
90+
"ibm_catalog.json": [
91+
{
92+
"hashed_secret": "a03815a5700107eb9f0d1a9608d2fcbdc48b7f5d",
93+
"is_secret": false,
94+
"is_verified": false,
95+
"line_number": 19,
8696
"type": "Secret Keyword",
8797
"verified_result": null
8898
}

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
77
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
88

9-
A module for provisioning an IBM Cloud Red Hat OpenShift cluster on VPC Gen2. The module either creates the required Cloud Object Storage instance or uses an existing instance. The module also supports optionally passing a key management configuration for secret encryption and boot volume encryption.
9+
Use this module to provision an [IBM Cloud Red Hat OpenShift cluster](https://cloud.ibm.com/docs/openshift?topic=openshift-getting-started) on VPC Gen2. The module either creates the required Cloud Object Storage instance or uses an existing instance. The module also supports optionally passing a key management configuration for secret encryption and boot volume encryption.
1010

1111
### Before you begin
1212

@@ -34,9 +34,9 @@ A module for provisioning an IBM Cloud Red Hat OpenShift cluster on VPC Gen2. Th
3434
### Usage
3535
```hcl
3636
module "ocp_base" {
37-
ibmcloud_api_key = "XXXXXXXXXXXXXXXXXXX"
3837
source = "terraform-ibm-modules/base-ocp-vpc/ibm"
3938
version = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
39+
ibmcloud_api_key = "XXXXXXXXXXXXXXXXXXX"
4040
cluster_name = "example-cluster-name"
4141
resource_group_id = "xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX"
4242
region = "us-south"

‎examples/add_rules_to_sg/catalogValidationValues.json.template‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"ibmcloud_api_key": $VALIDATION_APIKEY,
3+
"region": "au-syd",
4+
"resource_tags": $TAGS,
5+
"prefix": $PREFIX
6+
}

‎examples/advanced/catalogValidationValues.json.template‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"ibmcloud_api_key": $VALIDATION_APIKEY,
3+
"region": "au-syd",
4+
"resource_tags": $TAGS,
5+
"prefix": $PREFIX
6+
}

‎examples/basic/catalogValidationValues.json.template‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"ibmcloud_api_key": $VALIDATION_APIKEY,
3+
"region": "au-syd",
4+
"resource_tags": $TAGS,
5+
"prefix": $PREFIX
6+
}

‎examples/fscloud/catalogValidationValues.json.template‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"ibmcloud_api_key": $VALIDATION_APIKEY,
3+
"region": "au-syd",
4+
"resource_tags": $TAGS,
5+
"prefix": $PREFIX,
6+
"hpcs_instance_guid": $HPCS_US_SOUTH_GUID,
7+
"hpcs_key_crn_cluster": $HPCS_US_SOUTH_ROOT_KEY_CRN,
8+
"hpcs_key_crn_worker_pool": $HPCS_US_SOUTH_ROOT_KEY_CRN,
9+
"existing_at_instance_crn": $AT_CRN
10+
}

‎examples/multiple_mzr_clusters/catalogValidationValues.json.template‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"ibmcloud_api_key": $VALIDATION_APIKEY,
3+
"region": "ca-tor",
4+
"resource_tags": $TAGS,
5+
"prefix": $PREFIX
6+
}

‎ibm_catalog.json‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
{
2+
"products": [
3+
{
4+
"name": "terraform-ibm-base-ocp-vpc",
5+
"label": "Red Hat OpenShift VPC cluster on IBM Cloud module",
6+
"product_kind": "module",
7+
"tags": [
8+
"dev_ops",
9+
"target_terraform",
10+
"terraform",
11+
"module"
12+
],
13+
"keywords": [
14+
"terraform",
15+
"ocp",
16+
"cluster"
17+
],
18+
"short_description": "Provisions a Red Hat OpenShift VPC cluster on IBM Cloud",
19+
"long_description": "Use this module to provision an [IBM Cloud Red Hat OpenShift cluster](https:\/\/cloud.ibm.com\/docs\/openshift?topic=openshift-getting-started) on VPC Gen2. The module either creates the required Cloud Object Storage instance or uses an existing instance. The module also supports optionally passing a key management configuration for secret encryption and boot volume encryption.\r\n\r\n### Before you begin\r\n\r\n- Make sure that you have a recent version of the [IBM Cloud CLI](https:\/\/cloud.ibm.com\/docs\/cli?topic=cli-getting-started)\r\n- Make sure that you have a recent version of the [IBM Cloud Kubernetes service CLI](https:\/\/cloud.ibm.com\/docs\/containers?topic=containers-kubernetes-service-cli)\r\n\r\n### Usage\r\n```hcl\r\nmodule \"ocp_base\" {\r\n # Replace \"X.X.X\" with a release version to lock into a specific release\r\n source = \"https:\/\/cm.globalcatalog.cloud.ibm.com\/api\/v1-beta\/offering\/source?archive=tgz&kind=terraform&name=terraform-ibm-base-ocp-vpc&version=X.X.X\"\r\n ibmcloud_api_key = \"XXXXXXXXXXXXXXXXXXX\"\r\n cluster_name = \"example-cluster-name\"\r\n resource_group_id = \"xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX\"\r\n region = \"us-south\"\r\n force_delete_storage = true\r\n vpc_id = \"79cxxxx-xxxx-xxxx-xxxx-xxxxxXX8667\"\r\n # obtain the below values from the targeted VPC and adjust to the number of zones, subnets, subnet name, cidr_block, id, zone\r\n vpc_subnets = {\r\n zone-1 = [\r\n {\r\n cidr_block = \"192.168.32.0\/22\"\r\n id = \"0717-afc29fbb-0dbe-493a-a5b9-f3c5899cb8b9\"\r\n zone = \"us-south-1\"\r\n },\r\n {\r\n cidr_block = \"192.168.36.0\/22\"\r\n id = \"0727-d65c1eda-9e38-4200-8452-cb8ff5bb3140\"\r\n zone = \"us-south-2\"\r\n },\r\n {\r\n cidr_block = \"192.168.40.0\/22\"\r\n id = \"0737-9a823cd3-16bf-4ba4-a429-9e1fc7db74b8\"\r\n zone = \"us-south-3\"\r\n }\r\n ]\r\n zone-2 = [\r\n {\r\n cidr_block = \"192.168.0.0\/22\"\r\n id = \"0717-846b9490-34ae-4a6c-8288-28112dca1ba3\"\r\n zone = \"us-south-1\"\r\n },\r\n {\r\n cidr_block = \"192.168.4.0\/22\"\r\n id = \"0727-ef8db7f6-ffa5-4d8b-a317-4631741a45ee\"\r\n zone = \"us-south-2\"\r\n },\r\n {\r\n cidr_block = \"192.168.8.0\/22\"\r\n id = \"0737-c9a6d871-d95b-4914-abf5-82c22f4161d1\"\r\n zone = \"us-south-3\"\r\n }\r\n ]\r\n zone-3 = [\r\n {\r\n cidr_block = \"192.168.16.0\/22\"\r\n id = \"0717-d46e227c-89d4-4b02-9008-d03907a275b6\"\r\n zone = \"us-south-1\"\r\n },\r\n {\r\n cidr_block = \"192.168.20.0\/22\"\r\n id = \"0727-93b1edcb-966c-4517-a7af-6ac63cd93adf\"\r\n zone = \"us-south-2\"\r\n },\r\n {\r\n cidr_block = \"192.168.24.0\/22\"\r\n id = \"0737-807ec4f1-4d84-484e-b2f4-62dd5e431065\"\r\n zone = \"us-south-3\"\r\n }\r\n ]\r\n }\r\n}\r\n```",
20+
"offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-base-ocp-vpc/blob/main/README.md",
21+
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/RH_OpenShift.svg",
22+
"provider_name": "IBM",
23+
"features": [
24+
{
25+
"title": "Create a Red Hat OpenShift VPC cluster on IBM Cloud",
26+
"description": "Create a Red Hat OpenShift VPC cluster on IBM Cloud."
27+
},
28+
{
29+
"title": "Autoscaling",
30+
"description": "Configure worker autoscaling."
31+
},
32+
{
33+
"title": "Optionally create a Cloud Object Storage instance",
34+
"description": "Optionally create a Cloud Object Storage instance which is required by OCP VPC clusters. Also supports using existing instance."
35+
},
36+
{
37+
"title": "Attach access tags",
38+
"description": "Attach access tags to the cluster resources."
39+
},
40+
{
41+
"title": "Enable cluster managed add-ons",
42+
"description": "Enable any of the supported [managed cluster addons](https://cloud.ibm.com/docs/containers?topic=containers-managed-addons)."
43+
},
44+
{
45+
"title": "Encrypt data with key management services",
46+
"description": "Supports key management encryption (BYOK and KYOK) for boot volumes and cluster data."
47+
}
48+
],
49+
"flavors": [
50+
{
51+
"label": "Basic",
52+
"name": "basic",
53+
"working_directory": "examples/basic",
54+
"architecture": {
55+
"diagrams": [
56+
{
57+
"diagram": {
58+
"caption": "Basic example",
59+
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
60+
"type": "image/svg+xml"
61+
},
62+
"description": "A simple example that shows how to provision a basic single zone OCP VPC cluster."
63+
}
64+
]
65+
}
66+
},
67+
{
68+
"label": "Advanced",
69+
"name": "advanced",
70+
"working_directory": "examples/advanced",
71+
"architecture": {
72+
"diagrams": [
73+
{
74+
"diagram": {
75+
"caption": "Advanced example",
76+
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
77+
"type": "image/svg+xml"
78+
},
79+
"description": "An advanced example which shows how to create a multi-zone KMS encrypted OCP VPC cluster with custom worker node taints."
80+
}
81+
]
82+
}
83+
},
84+
{
85+
"label": "Financial Services compliant",
86+
"name": "fscloud",
87+
"working_directory": "examples/fscloud",
88+
"architecture": {
89+
"diagrams": [
90+
{
91+
"diagram": {
92+
"caption": "Financial Services compliant example",
93+
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
94+
"type": "image/svg+xml"
95+
},
96+
"description": "This example uses the Profile for IBM Cloud Framework for Financial Services to provision an instance of the base OCP VPC module in a compliant manner."
97+
}
98+
]
99+
}
100+
},
101+
{
102+
"label": "2 MZR clusters in same VPC",
103+
"name": "multiple_mzr_clusters",
104+
"working_directory": "examples/multiple_mzr_clusters",
105+
"architecture": {
106+
"diagrams": [
107+
{
108+
"diagram": {
109+
"caption": "2 MZR clusters in same VPC example",
110+
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
111+
"type": "image/svg+xml"
112+
},
113+
"description": "This is an example of creating 2 MZR clusters in same VPC, and deploying the observability agents in the clusters."
114+
}
115+
]
116+
}
117+
},
118+
{
119+
"label": "Cluster security group rules",
120+
"name": "add_rules_to_sg",
121+
"working_directory": "examples/add_rules_to_sg",
122+
"architecture": {
123+
"diagrams": [
124+
{
125+
"diagram": {
126+
"caption": "Cluster security group rules example",
127+
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
128+
"type": "image/svg+xml"
129+
},
130+
"description": "This example will add security rules to the `kube-<vpcid>` and `kube-<clusterId>` security groups."
131+
}
132+
]
133+
}
134+
}
135+
]
136+
}
137+
]
138+
}

0 commit comments

Comments
 (0)