Skip to content

Commit c753f59

Browse files
committed
docs: added terraform options and pre-requisites
Signed-off-by: Ali Mukadam <ali.mukadam@oracle.com>
1 parent a1975ad commit c753f59

File tree

11 files changed

+105
-24
lines changed

11 files changed

+105
-24
lines changed

docs/src/advanced/advanced.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
# Advanced Customizations
2+
3+
- [Customize DNS](./customizedns.md)

docs/src/css/general.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ h6:target::before {
9595
.content main {
9696
margin-left: auto;
9797
margin-right: auto;
98-
min-width: 90%;
99-
max-width: 90%;
98+
min-width: 80%;
99+
max-width: 80%;
100100
}
101101
.content p { line-height: 1.45em; }
102102
.content ol { line-height: 1.45em; }

docs/src/introduction.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,22 @@ This module automates the installation of the [Verrazzano Container Platform][ur
1414
This module is currently in technical preview. Your ideas and feedback are most welcome.
1515
```
1616

17+
## Related Documentation
18+
1719
* [Verrazzano Documentation][uri-verrazzano]
1820
* [Verrazzano on Medium][uri-verrazzano-medium]
1921
* [Verrazzano on Slack][uri-verrazzano-slack]
2022
* [Verrazzano on YouTube][uri-verrazzano-youtube]
2123
* [Terraform module for OKE][uri-terraform-oci-oke]
2224

2325
## Changelog
24-
2526
View the [CHANGELOG][uri-changelog].
2627

2728
## Security
28-
2929
Please consult the [security guide](./docs/SECURITY.md) for our responsible security vulnerability disclosure process
3030

3131

3232
## License
33-
3433
Copyright (c) 2019-2023 Oracle and/or its affiliates.
3534

3635
Released under the Universal Permissive License v1.0 as shown at

docs/src/multi/multi.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
11
# Multi Cluster
2+
3+
- [With Public Endpoints](./pub-ep.md)
4+
- [With Private Endpoints](./pri-ep.md)
5+
- [With Public Load Balancers](./pub-lb.md)
6+
- [With Private Load Balancers](./pri-lb.md)

docs/src/multi/pub-ep.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
## Creating the clusters
99
1. Copy terraform.tfvars.example to terraform.tfvars
1010

11-
```
11+
```bash, editable
1212
cp terraform.tfvars.example terraform.tfvars
1313
1414
```
@@ -56,7 +56,7 @@ If you change the CIDR values above, it is your responsibility to ensure they do
5656
```
5757
5. To create managed clusters in your preferred regions, set your preferred regions' values to `true` e.g. `ashburn=true` in the `clusters` parameter. Leave those that you do not use to `false` e.g.
5858

59-
```
59+
```terraform, editable
6060
clusters = {
6161
# Africa
6262
johannesburg = false
@@ -115,7 +115,7 @@ Do not remove those that you are not using.
115115

116116
6. For the regions you enable, uncomment them in `modules\clusters\outputs.tf` for `cluster_ids`, `int_nsg_ids` and `pub_nsg_ids`. For the clusters that you do not use, leave them commented e.g.
117117

118-
```terraform
118+
```terraform,editable
119119
output "cluster_ids" {
120120
value = {
121121
# "johannesburg" = join(",", module.johannesburg[*].cluster_id)
@@ -162,7 +162,7 @@ output "cluster_ids" {
162162
```
163163
6. Configure the following input variables:
164164

165-
```terraform
165+
```terraform,editable
166166
configure_clusters = false
167167
install_verrazzano = false
168168
```
@@ -173,7 +173,7 @@ When provisioning the cluster, the above 2 variables must set to `false`.
173173

174174
7. Create the cluster by running Terraform:
175175

176-
```bash
176+
```bash,editable
177177
terraform init
178178
terraform plan
179179
terraform apply
@@ -191,14 +191,14 @@ You will now generate the installation script.
191191

192192
1. Configure the following input variables:
193193

194-
```
194+
```terraform,editable
195195
configure_clusters = true
196196
install_verrazzano = true
197197
```
198198

199199
2. Configure the Verrazzano profile:
200200

201-
```
201+
```terraform,editable
202202
verrazzano_profile = "prod"
203203
```
204204

@@ -258,7 +258,7 @@ You will now install Verrazzano in all clusters and register the managed cluster
258258

259259
1. Install the Verrazzano Platform Operator:
260260

261-
```
261+
```bash,editable
262262
cd /home/opc/vz/operator
263263
264264
for cluster in admin phoenix ; do
@@ -293,7 +293,7 @@ The Admin cluster has more components to install and takes longer, so we install
293293
4. While the Admin cluster is being installed in the background, you can install the managed clusters in parallel:
294294

295295
```bash, editable
296-
for cluster in sydney melbourne ; do
296+
for cluster in phoenix ; do
297297
bash install_vz_cluster_$cluster.sh
298298
done
299299
```

docs/src/prerequisites.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
[uri-kubernetes]: https://kubernetes.io/
2+
[uri-oci]: https://docs.oracle.com/en-us/iaas/Content/home.htm
3+
[uri-terraform]: https://www.terraform.io/
14
# Pre-requisites
25

3-
1. Your user must be part of a group that can create dynamic groups.
6+
1. Local development tools: git, terraform, a terminal.
7+
2. Varying levels knowledge of:
8+
- Linux.
9+
- [Terraform][uri-terraform].
10+
- [Kubernetes][uri-kubernetes].
11+
3. Understanding of [OCI][uri-oci] and its services.
12+
4. Your Terraform user must be part of a group that can:
13+
- manage dynamic groups
14+
- manage VCN
15+
- manage OKE clusters
16+
- manage load balancers

docs/src/single/dev.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44

55
1. Copy terraform.tfvars.example to terraform.tfvars
66

7-
```
7+
```bash, editable
88
cp terraform.tfvars.example terraform.tfvars
9-
109
```
1110
2. Provide values for the following input variables:
1211
- `api_fingerprint`

docs/src/single/production.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66

77
```
88
cp terraform.tfvars.example terraform.tfvars
9-
109
```
1110
2. Provide values for the following input variables:
1211
- `api_fingerprint`

docs/src/single/single.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
# Single Cluster
2+
3+
- [Create a single Verrazzano Cluster for Development](./dev.md)
4+
- [Create a single Verrazzano Cluster for production](./production.md)
5+
- [Create a single customized Verrazzano Cluster](./customized.md)

docs/src/terraformoptions.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,61 @@
11
# Terraform Options
2+
3+
### Provider
4+
5+
| Parameter | Description | Type | Default |
6+
| --------- | ----------- | ----------- | ------- |
7+
| api_fingerprint | Fingerprint of the API private key to use with OCI API. | string | "" |
8+
| api_private_key_path | The path to the OCI API private key. | string | "" |
9+
| home_region | The tenancy's home region. | string | "" |
10+
| tenancy_id | The tenancy id of the OCI Cloud Account in which to create the resources. | string | "" |
11+
| user_id | The id of the user that terraform will use to create the resources. | string | "" |
12+
| compartment_id | The compartment id where to create all resources. | string | "" |
13+
| label_prefix | A string that will be prepended to all resources. | string | "" |
14+
15+
### ssh keys
16+
17+
| Parameter | Description | Type | Default |
18+
| --------- | ----------- | ----------- | ------- |
19+
| ssh_private_key_path | The path to ssh private key. | string | "none" |
20+
| ssh_public_key_path | The path to ssh public key. | string | "none" |
21+
22+
### Networking
23+
24+
| Parameter | Description | Type | Default |
25+
| --------- | ----------- | ----------- | ------- |
26+
| cidrs | A map of cidrs for vcns, pods and services for each region | map(any)| |
27+
| connectivity_mode | Whether to keep set up connectivity in mesh or star mode. Admin is always connected to everybody | string | star |
28+
29+
30+
### clusters
31+
32+
| Parameter | Description | Type | Default |
33+
| --------- | ----------- | ----------- | ------- |
34+
| admin_region | The region parameters of the Admin cluster. In case a single cluster is created, the Admin region is used for the single cluster. | map(any)| |
35+
| kubernetes_version | The version of Kubernetes to use. | string | v1.24.1 |
36+
| oke_control_plane | Whether to keep all OKE control planes public or private | public/private | public |
37+
| clusters | A map of OCI regions where managed clusters will be created | map(bool) | |
38+
| nodepools | Node pool specification for all clusters | map(bool) | |
39+
| cloudinit_nodepool_common | Path to custom cloud init file for OKE workner nodes | string | |
40+
41+
### Verrazzano
42+
43+
| Parameter | Description | Type | Default |
44+
| --------- | ----------- | ----------- | ------- |
45+
| configure_clusters | Whether to set up access to the clusters. Set to false on cluster creation. | bool | false |
46+
| install_verrazzano | Whether ready to install Verrazzano. Set to false on cluster creation | string | false |
47+
| verrazzano_version | Verrazzano version to install | 1.5.3 | 1.5.3 |
48+
| verrazzano_profile | Verrazzano profile to install | dev/prod | dev |
49+
| verrazzano_control_plane | Whether to keep all Verrazzano control planes public or private | public/private | public |
50+
| verrazzano_data_plane | Whether to keep all Verrazzano data planes public or private | public/private | public |
51+
| verrazzano_load_balancer | Load Balancer Shape | map(string) | |
52+
53+
### DNS
54+
55+
| Parameter | Description | Type | Default |
56+
| --------- | ----------- | ----------- | ------- |
57+
| configure_dns | Whether to configure DNS. If not configured, nip.io will be used | bool | false |
58+
| secret_id | OCID of OCI secret to be used for OCI DNS authentication. | string | |
59+
| dns_zone_id | DNS Zone OCID in OCI DNS | string | |
60+
| dns_compartment_id | DNS Zone's Compartment id | string | |
61+
| dns_zone_name | DNS Zone Name | string | |

0 commit comments

Comments
 (0)