Skip to content

Commit e440d22

Browse files
marinakogrjeberhard
authored andcommitted
corrected format
1 parent 3fcb582 commit e440d22

File tree

1 file changed

+29
-39
lines changed
  • kubernetes/samples/scripts/terraform

1 file changed

+29
-39
lines changed

kubernetes/samples/scripts/terraform/README.md

Lines changed: 29 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,61 +2,51 @@
22

33
The provided sample will create:
44

5-
A new Virtual Cloud Network (VCN) for the cluster
6-
7-
Two LoadBalancer subnets with security lists
8-
9-
Three Worker subnets with security lists
10-
11-
A Kubernetes Cluster with one Node Pool
12-
13-
A `kubeconfig` file to allow access using `kubectl`
5+
* A new Virtual Cloud Network (VCN) for the cluster
6+
* Two LoadBalancer subnets with security lists
7+
* Three Worker subnets with security lists
8+
* A Kubernetes Cluster with one Node Pool
9+
* A `kubeconfig` file to allow access using `kubectl`
1410

1511
Nodes and network settings will be configured to allow SSH access, and the cluster networking policies will allow `NodePort` services to be exposed. This cluster can be used for testing and development purposes only. The provided samples of Terraform scripts should not be considered for creating production clusters, without more of a review.
1612

1713
All OCI Container Engine masters are Highly Available (HA) and fronted by load balancers.
1814

1915

2016

21-
###Prerequisites
17+
##Prerequisites
2218

2319
To use these Terraform scripts, you will need fulfill the following prerequisites:
24-
25-
Have an existing tenancy with enough compute and networking resources available for the desired cluster.
26-
27-
Have an [Identity and Access Management](https://docs.cloud.oracle.com/iaas/Content/ContEng/Concepts/contengpolicyconfig.htm#PolicyPrerequisitesService) policy in place within that tenancy to allow the OCI Container Engine for Kubernetes service to manage tenancy resources.
28-
29-
Have a user defined within that tenancy.
30-
31-
Have an API key defined for use with the OCI API, as documented [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).
32-
33-
Have an [SSH key pair](https://docs.oracle.com/en/cloud/iaas/compute-iaas-cloud/stcsg/generating-ssh-key-pair.html) for configuring SSH access to the nodes in the cluster.
34-
20+
* Have an existing tenancy with enough compute and networking resources available for the desired cluster.
21+
* Have an [Identity and Access Management](https://docs.cloud.oracle.com/iaas/Content/ContEng/Concepts/contengpolicyconfig.htm#PolicyPrerequisitesService) policy in place within that tenancy to allow the OCI Container Engine for Kubernetes service to manage tenancy resources.
22+
* Have a user defined within that tenancy.
23+
* Have an API key defined for use with the OCI API, as documented [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).
24+
* Have an [SSH key pair](https://docs.oracle.com/en/cloud/iaas/compute-iaas-cloud/stcsg/generating-ssh-key-pair.html) for configuring SSH access to the nodes in the cluster.
3525

3626
Copy provided `oci.props.template` file to `oci.props` and add all required values:
37-
* `user.ocid` - OCID for the tenancy user - can be obtained from the user settings in the OCI console.
38-
* `tfvars.filename` - File name for generated tfvar file.
39-
* `okeclustername` - The name for OCI Container Engine for Kubernetes cluster.
40-
* `tenancy.ocid` - OCID for the target tenancy.
41-
* `region` - name of region in the target tenancy.
42-
* `compartment.ocid` - OCID for the target compartment.
43-
* `compartment.name` - Name for the target compartment.
44-
* `ociapi.pubkey.fingerprint` - Fingerprint of the OCI user's public key.
45-
* `ocipk.path` - API Private Key -- local path to the private key for the API key pair.
46-
* `vcn.cidr.prefix` - Prefix for VCN CIDR, used when creating subnets -- you should examine the target compartment find a CIDR that is available.
47-
* `vcn.cidr` - Full CIDR for the VCN, must be unique within the compartment, first 2 octets should match the vcn_cidr_prefix.
48-
* `nodepool.shape` - A valid OCI VM Shape for the cluster nodes.
49-
* `k8s.version` - SSH public key (key contents as a string).
50-
* `nodepool.imagename - A valid image name for Node Pool creation.
51-
* `terraform.installdir` - Location to install Terraform binaries.
27+
* `user.ocid` - OCID for the tenancy user - can be obtained from the user settings in the OCI console.
28+
* `tfvars.filename` - File name for generated tfvar file.
29+
* `okeclustername` - The name for OCI Container Engine for Kubernetes cluster.
30+
* `tenancy.ocid` - OCID for the target tenancy.
31+
* `region` - name of region in the target tenancy.
32+
* `compartment.ocid` - OCID for the target compartment.
33+
* `compartment.name` - Name for the target compartment.
34+
* `ociapi.pubkey.fingerprint` - Fingerprint of the OCI user's public key.
35+
* `ocipk.path` - API Private Key -- local path to the private key for the API key pair.
36+
* `vcn.cidr.prefix` - Prefix for VCN CIDR, used when creating subnets -- you should examine the target compartment find a CIDR that is available.
37+
* `vcn.cidr` - Full CIDR for the VCN, must be unique within the compartment, first 2 octets should match the vcn_cidr_prefix.
38+
* `nodepool.shape` - A valid OCI VM Shape for the cluster nodes.
39+
* `k8s.version` - SSH public key (key contents as a string).
40+
* `nodepool.imagename - A valid image name for Node Pool creation.
41+
* `terraform.installdir` - Location to install Terraform binaries.
5242

5343
To run the script, use the command:
5444
```
5545
$ kubernetes/samples/scripts/terraform/oke.create.sh oci.props
5646
```
5747
The script collects the values from `oci.props` file and performs the following steps:
58-
* Creates a new tfvars file based on the values from the provided `oci.props` file.
59-
* Downloads and installs all needed binaries for Terraform, Terraform OCI Provider, based on OS system (macOS or Linux)
60-
* Applies the configuration and creates OKE Cluster using Terraform
48+
* Creates a new tfvars file based on the values from the provided `oci.props` file.
49+
* Downloads and installs all needed binaries for Terraform, Terraform OCI Provider, based on OS system (macOS or Linux)
50+
* Applies the configuration and creates OKE Cluster using Terraform
6151

6252

0 commit comments

Comments
 (0)