Skip to content
This repository was archived by the owner on Oct 31, 2019. It is now read-only.

Add a warning to README.md about intended use cases for this installer #200

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add a warning to README.md about intended use cases for this installer #200

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d4b307
Add a warning to README.md about intended use cases for this installer
owainlewis Apr 30, 2018
03909c2
Update README based on review feedback
owainlewis May 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@

## About

The Kubernetes Installer for Oracle Cloud Infrastructure provides a Terraform-based Kubernetes installation for Oracle
Cloud Infrastructure. It consists of a set of [Terraform][terraform] modules and an example base configuration that is
The Kubernetes Installer for Oracle Cloud Infrastructure provides a Terraform-based Kubernetes installation for Oracle
Cloud Infrastructure. It consists of a set of [Terraform][terraform] modules and an example base configuration that is
used to provision and configure the resources needed to run a highly available and configurable Kubernetes cluster on [Oracle Cloud Infrastructure][oci] (OCI).

**Warning: Not for production use. This installer is intended as a quickstart only and we do not offer any official support.**

## Cluster Overview

Expand All @@ -31,7 +32,7 @@ Terraform is used to _provision_ the cloud infrastructure and any required local

#### Cluster Configuration

Terraform uses cloud-init scripts to handle the instance-level _configuration_ for instances in the Control Plane to
Terraform uses cloud-init scripts to handle the instance-level _configuration_ for instances in the Control Plane to
configure:

- Highly Available (HA) Kubernetes master configuration
Expand Down Expand Up @@ -86,7 +87,7 @@ Initialize Terraform:

```
$ terraform init
```
```

View what Terraform plans do before actually doing it:

Expand All @@ -110,7 +111,7 @@ Your network access settings determine whether your cluster is accessible from t

#### Verify the cluster:

If you've chosen to configure a public cluster, you can do a quick and automated verification of your cluster from
If you've chosen to configure a public cluster, you can do a quick and automated verification of your cluster from
your local machine by running the `cluster-check.sh` located in the `scripts` directory. Note that this script requires your KUBECONFIG environment variable to be set (above), and SSH and HTTPs access to be open to etcd and worker nodes.

To temporarily open access SSH and HTTPs access for `cluster-check.sh`, add the following to your `terraform.tfvars` file:
Expand Down