Skip to content

Commit 57760cd

Browse files
authored
docs: Reuse VCN (#524)
* docs: Reuse VCN * docs: Updated for Reuse VCN
1 parent 25cd102 commit 57760cd

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

docs/reusevcn.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
= Reuse VCN
2+
:idprefix:
3+
:idseparator:
4+
:sectlinks:
5+
:sectnums:
6+
:toc: auto
7+
8+
:uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-oke
9+
10+
:uri-rel-file-base: link:{uri-repo}/blob/main
11+
:uri-rel-tree-base: link:{uri-repo}/tree/main
12+
13+
:uri-docs-reuse-vcn: {uri-rel-file-base}/docs/terraformoptions.adoc#reuse-vcn
14+
15+
:uri-ig-docs: https://docs.oracle.com/en-us/iaas/Content/Network/Tasks/managingIGs.htm
16+
17+
:uri-nat-docs: https://docs.oracle.com/en-us/iaas/Content/Network/Tasks/NATgateway.htm
18+
19+
20+
== Assumptions
21+
Internet Gateway, NAT Gateway,Service Gateway was created in the VCN and route table preexist.
22+
23+
== Instructions
24+
By default the module will create VCN ,gateways etc and then create Oracle kubernetes engine cluster. There are usecases where enduser might want to reuse their existing VCN . To do that set `create_vcn = false` and pass other required values mentioned in {uri-docs-reuse-vcn}[terraformoptions] under Reuse VCN section.
25+
26+
You can pass either the vcn_display_name or vcn_id .Recommended to use vcn_id as vcn_display name can have duplicate value. If both values are passed vcn_id will take precedence. Similarly for Internet Gateway and NAT Gateway route table you can either pass displayname(`ig_route_table_display_name` and `nat_route_table_display_name`) or pass the id (`ig_route_table_id` and `nat_route_table_id`) .
27+
28+
The internet gateway route table should have a minimum route with destination CIDR `0.0.0.0/0` and target as `Internet Gateway` . For more details please refer {uri-ig-docs}[Internet Gateway]
29+
30+
The NAT gateway route table should have a minimum route with destination CIDR to `0.0.0.0\0` or specific CIDR as per your network requirement and target as `NAT Gateway`. For more details please refer {uri-nat-docs}[NAT Gateway]

docs/terraformoptions.adoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,51 @@ EOT
250250
|
251251
|oke-vcn
252252

253+
|===
254+
== Reuse VCN
255+
256+
[stripes=odd,cols="1m,4d,2m,2m", options=header,width="100%"]
257+
|===
258+
|Parameter
259+
|Description
260+
|Values
261+
|Default
262+
263+
|create_vcn
264+
|Whether to create the VCN.
265+
|true/false
266+
|true
267+
268+
|vcn_display_name
269+
|Existing VCN display name where the resources will be created.
270+
|
271+
|
272+
273+
|vcn_id
274+
|Existing VCN OCID where the resources will be created
275+
|
276+
|
277+
278+
|ig_route_table_display_name
279+
|Existing Internet Gateway route table display name
280+
|
281+
|
282+
283+
|ig_route_table_id
284+
|Existing Internet Gateway route table OCID
285+
|
286+
|
287+
288+
|nat_route_table_display_name
289+
|Existing NAT Gateway route table OCID
290+
|
291+
|
292+
293+
|nat_route_table_id
294+
|Existing NAT Gateway route table OCID
295+
|
296+
|
297+
253298
|===
254299

255300
== Bastion Host

0 commit comments

Comments
 (0)