terraform-docs: generated by github action

deploy/oracle/README.md

@@ -0,0 +1,117 @@
+# Usage
+
+1. Clone the repo
+    ```sh
+    $ git clone https://github.com/jawabuu/kloud-3s.git
+    ```
+1. Switch to this directory.
+    ```sh
+    $ cd kloud-3s/deploy/[provider]
+    ```
+1. Copy [tfvars.example](./tfvars.example) to terraform.tfvars
+    ```sh
+    $ cp tfvars.example terraform.tfvars
+    ```
+1. Using your favourite editor, update values in terraform.tfvars
+    ```sh
+    $ nano terraform.tfvars
+    ```
+1. Run `terraform init` to initalize modules
+    ```sh
+    $ terraform init
+    ```
+1. Run `terraform plan` to view changes terraform will make 
+    ```sh
+    $ terraform plan
+    ```
+1. Run `terraform apply` to create your resources
+    ```sh
+    $ terraform apply --auto-approve
+    ```
+1. Set `KUBECONFIG` by running `$(terraform output kubeconfig)`
+    ```sh
+    $ $(terraform output kubeconfig)
+    ```
+
+<!--- BEGIN_TF_DOCS --->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.12.26 |
+
+## Providers
+
+No provider.
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| additional\_rules | add custom firewall rules during provisioning e.g. allow 1194/udp, allow ftp | `list(string)` | `[]` | no |
+| apt\_packages | Additional packages to install | `list(any)` | `[]` | no |
+| auth\_password | Traefik basic auth password | `string` | `""` | no |
+| auth\_user | Traefik basic auth username | `string` | `"kloud-3s"` | no |
+| aws\_access\_key | n/a | `string` | `""` | no |
+| aws\_region | n/a | `string` | `"eu-west-1"` | no |
+| aws\_secret\_key | n/a | `string` | `""` | no |
+| cloudflare\_api\_token | n/a | `string` | `""` | no |
+| cloudflare\_email | n/a | `string` | `""` | no |
+| cni | Choice of CNI to install e.g. flannel, weave, cilium, calico | `string` | `"cilium"` | no |
+| create\_certs | Option to create letsencrypt certs. Only enable if certain that your deployment is reachable. | `bool` | `false` | no |
+| create\_zone | n/a | `bool` | `false` | no |
+| digitalocean\_token | n/a | `string` | `""` | no |
+| domain | n/a | `string` | `"kloud3s.io"` | no |
+| enable\_floatingip | Whether to use a floating ip or not | `bool` | `false` | no |
+| enable\_volumes | Whether to use volumes or not | `bool` | `false` | no |
+| etcd\_node\_count | n/a | `number` | `3` | no |
+| fingerprint | Fingerprint for the key pair being used | `string` | `""` | no |
+| google\_credentials\_file | n/a | `string` | `""` | no |
+| google\_managed\_zone | n/a | `string` | `""` | no |
+| google\_project | n/a | `string` | `""` | no |
+| google\_region | n/a | `string` | `""` | no |
+| ha\_cluster | Create highly available cluster. Currently experimental and requires node\_count >= 3 | `bool` | `false` | no |
+| ha\_nodes | Number of controller nodes for HA cluster. Must be greater than 3 and odd-numbered. | `number` | `3` | no |
+| hostname\_format | n/a | `string` | `"kube%d"` | no |
+| install\_app | Additional apps to Install | `map(any)` | <pre>{<br>  "elastic_cloud": false,<br>  "k8dash": false,<br>  "kube_prometheus": false,<br>  "kubernetes_dashboard": true,<br>  "longhorn": false<br>}</pre> | no |
+| k3s\_version | n/a | `string` | `"latest"` | no |
+| kubeconfig\_path | n/a | `string` | `"../../.ssh/kubeconfig"` | no |
+| loadbalancer | How LoadBalancer IPs are assigned. Options are metallb(default), traefik, ccm, kube-vip & akrobateo | `string` | `"metallb"` | no |
+| mail\_config | SMTP Configuration for email services. | `map(string)` | `{}` | no |
+| node\_count | n/a | `number` | `3` | no |
+| oci\_image | n/a | `string` | `"Ubuntu 20.04"` | no |
+| oci\_shape | Literal server shape, overrides oci\_type e.g. VM.Standard.E2.1.Micro | `string` | `""` | no |
+| oci\_ssh\_keys | n/a | `list(string)` | <pre>[<br>  ""<br>]</pre> | no |
+| oci\_type | Server type format [CPU]c[RAM]g e.g. 1c6g, 2c12g, 4c24g, 2c1g | `string` | `"1c6g"` | no |
+| oidc\_config | OIDC Configuration for protecting private resources. Used by Pomerium IAP & Vault. | `list(map(string))` | `[]` | no |
+| overlay\_cidr | Cluster pod cidr | `string` | `"10.42.0.0/16"` | no |
+| private\_key\_path | The path (including filename) of the private key stored on your computer. | `string` | `""` | no |
+| region | An OCI region | `string` | `"uk-london-1"` | no |
+| registry\_password | Trow Registry password | `string` | `""` | no |
+| registry\_user | Trow Registry username | `string` | `"kloud-3s"` | no |
+| service\_cidr | Cluster service cidr | `string` | `"10.43.0.0/16"` | no |
+| ssh\_key\_path | n/a | `string` | `"../../.ssh/tf-kube"` | no |
+| ssh\_keys\_dir | n/a | `string` | `"../../.ssh"` | no |
+| ssh\_pubkey\_path | n/a | `string` | `"../../.ssh/tf-kube.pub"` | no |
+| tenancy\_ocid | OCID of your tenancy | `string` | n/a | yes |
+| test-traefik | Deploy traefik test. | `bool` | `true` | no |
+| trform\_domain | Manage this domain and it's wildcard domain using terraform. | `bool` | `false` | no |
+| user\_ocid | OCID of the user calling the API | `string` | n/a | yes |
+| volume\_size | Volume size in GB | `number` | `50` | no |
+| vpc\_cidr | CIDR for nodes provider vpc if available | `string` | `"10.115.0.0/24"` | no |
+| vpn\_iprange | CIDR for nodes wireguard vpn | `string` | `"10.0.1.0/24"` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| default\_password | n/a |
+| floating\_ip | n/a |
+| instances | n/a |
+| kubeconfig | n/a |
+| private\_key | n/a |
+| public\_key | n/a |
+| ssh-master | n/a |
+| test | n/a |
+
+<!--- END_TF_DOCS --->