Skip to content

Commit

Permalink
Remove memoryInGBs from our templates
Browse files Browse the repository at this point in the history 
We are removing this from our main templates otherwise we have to set
a default which users might not set when changing the OCPU and could
cause issues.
  • Loading branch information
@joekr
joekr committed Mar 11, 2022
1 parent 251e0ce commit 1b27ff8
Show file tree
Hide file tree
Showing 9 changed files with 32 additions and 48 deletions.
54 changes: 27 additions & 27 deletions docs/src/gs/create-workload-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,36 @@ Choose one of the available templates for to create your workload clusters from

## Workload Cluster Parameters

The following Oracle Cloud Infrastructure (OCI) configuration parameters are available when creating a workload cluster on OCI:

| Parameter | Default Value | Description |
|-------------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `OCI_COMPARTMENT_ID` | | The OCID of the compartment where the OCI resources are to be created |
| `OCI_IMAGE_ID` | | The OCID of the Compute Image (Oracle Linux or <br/>Ubuntu) with which to create the Kubernetes nodes. This same image is used for both the control plane and the worker nodes. |
| `OCI_CONTROL_PLANE_SHAPE` | VM.Standard.E4.Flex | The shape of the Kubernetes nodes |
| `OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS` | | The amount of memory in GBs to be allocated to the control plane instances. If not provided, the memory is automatically computed by compute API. |
| `OCI_CONTROL_PLANE_SHAPE_OCPUS` | 1 | The number of OCPUs allocated to the control plane instance |
| `OCI_WORKER_SHAPE` | VM.Standard.E4.Flex | The shape of the Kubernetes worker nodes |
| `OCI_WORKER_SHAPE_MEMORY_IN_GBS` | | The amount of memory in GBs to be allocated to the worker instances. If not provided, the memory is automatically computed by compute API. |
| `OCI_WORKER_SHAPE_OCPUS` | 1 | The number of OCPUs allocated to the worker instance |
| `OCI_SSH_KEY` | | The public SSH key to be added to the Kubernetes nodes. It can be used to login to the node and troubleshoot failures. |
| `OCI_CONTROL_PLANE_PV_TRANSIT_ENCRYPTION` | true | [In-transit encryption](https://docs.oracle.<br/>com/en-us/iaas/Content/File/Tasks/intransitencryption.htm) provides a way to secure your data between instances and mounted file systems using TLS v.1.2 (Transport Layer Security) encryption. Only [some bare metal instances](https://docs.oracle.com/en-us/iaas/releasenotes/changes/60d602f5-abb3-4639-aa19-292a5744a808/) support In-transit encryption |
| `OCI_WORKER_PV_TRANSIT_ENCRYPTION` | true | [In-transit encryption](https://docs.oracle.com/en-us/iaas/Content/File/Tasks/intransitencryption.htm) provides a way to secure your data between instances and mounted file systems using TLS v.1.2 (Transport Layer Security) encryption. Only [some bare metal instances](https://docs.oracle.com/en-us/iaas/releasenotes/changes/60d602f5-abb3-4639-aa19-292a5744a808/) support In-transit encryption |
The following Oracle Cloud Infrastructure (OCI) configuration parameters are available when creating a workload
cluster on OCI using one of our predefined templates:

| Parameter | Default Value | Description |
|-------------------------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `OCI_COMPARTMENT_ID` | | The OCID of the compartment where the OCI resources in which the resources are created |
| `OCI_IMAGE_ID` | | The OCID of the image (Oracle Linux or <br/>Ubuntu) with which to create the Kubernetes nodes. This same image is used for both the control plane and the worker nodes. |
| `OCI_CONTROL_PLANE_SHAPE` | VM.Standard.E4.Flex | The shape of the Kubernetes nodes |
| `OCI_CONTROL_PLANE_SHAPE_OCPUS` | 1 | The number of OCPUs allocated to the control plane instance |
| `OCI_WORKER_SHAPE` | VM.Standard.E4.Flex | The shape of the Kubernetes worker nodes |
| `OCI_WORKER_SHAPE_OCPUS` | 1 | The number of OCPUs allocated to the worker instance |
| `OCI_SSH_KEY` | | The public SSH key to be added to the Kubernetes nodes. It can be used to login to the node and troubleshoot failures. |
| `OCI_CONTROL_PLANE_PV_TRANSIT_ENCRYPTION` | true | [In-transit encryption](https://docs.oracle.<br/>com/en-us/iaas/Content/File/Tasks/intransitencryption.htm) provides a way to secure your data between instances and mounted file systems using TLS 1.2 (Transport Layer Security) encryption. Only [some bare metal instances](https://docs.oracle.com/en-us/iaas/releasenotes/changes/60d602f5-abb3-4639-aa19-292a5744a808/) support in-transit encryption |
| `OCI_WORKER_PV_TRANSIT_ENCRYPTION` | true | [In-transit encryption](https://docs.oracle.com/en-us/iaas/Content/File/Tasks/intransitencryption.htm) provides a way to secure your data between instances and mounted file systems using TLS 1.2 (Transport Layer Security) encryption. Only [some bare metal instances](https://docs.oracle.com/en-us/iaas/releasenotes/changes/60d602f5-abb3-4639-aa19-292a5744a808/) support in-transit encryption |

*NOTE:* Using the predefined templates the machine's memory size is automatically allocated based on the chosen shape
and OCPU count.

The following Cluster API parameters are also available:

| Parameter | Default Value | Description |
| ---------------------------- | ---------------------- | ----------- |
| `CLUSTER_NAME` | | The name of the workload cluster to create |
| `CONTROL_PLANE_MACHINE_COUNT` | 1 | The number of control plane machines for the workload cluster.|
| `KUBERNETES_VERSION` | | The Kubernetes version to use for the workload cluster. If unspecified, the value from OS environment variables or the .cluster-api/clusterctl.yaml config file will be used. |
| `NAMESPACE` | | The namespace to use for the workload cluster. If unspecified, the current namespace will be used |
| `POD_CIDR` | 1 | The CIDR range for the Kubernetes POD network. |
| `SERVICE_CIDR` | | The CIDR for the Kubernetes services network. |
| `SERVICE_DOMAIN` | | |
| `WORKER_MACHINE_COUNT` | | The number of worker machines for the workload cluster. |
| Parameter | Default Value | Description |
| ---------------------------- |----------------| ----------- |
| `CLUSTER_NAME` | | The name of the workload cluster to create |
| `CONTROL_PLANE_MACHINE_COUNT` | 1 | The number of control plane machines for the workload cluster.|
| `KUBERNETES_VERSION` | | The Kubernetes version to use for the workload cluster. If unspecified, the value from OS environment variables or the .cluster-api/clusterctl.yaml config file will be used. |
| `NAMESPACE` | | The namespace to use for the workload cluster. If unspecified, the current namespace will be used |
| `POD_CIDR` | 192.168.0.0/16 | The CIDR range for the Kubernetes POD network. |
| `SERVICE_CIDR` | | The CIDR for the Kubernetes services network. |
| `SERVICE_DOMAIN` | | |
| `WORKER_MACHINE_COUNT` | | The number of worker machines for the workload cluster. |

## Create a new workload cluster on virtual instances using an Ubuntu custom image

Expand Down Expand Up @@ -66,11 +68,9 @@ OCI_IMAGE_ID=<ubuntu-custom-image-id> \
OCI_SSH_KEY=<ssh-key> \
OCI_CONTROL_PLANE_SHAPE=BM.Standard2.52 \
OCI_CONTROL_PLANE_SHAPE_OCPUS=52 \
OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS= \
OCI_CONTROL_PLANE_PV_TRANSIT_ENCRYPTION=false \
OCI_WORKER_SHAPE=BM.Standard2.52 \
OCI_WORKER_SHAPE_OCPUS=52 \
OCI_WORKER_SHAPE_MEMORY_IN_GBS= \
OCI_WORKER_PV_TRANSIT_ENCRYPTION=false \
CONTROL_PLANE_MACHINE_COUNT=1 \
KUBERNETES_VERSION=v1.20.10 \
Expand Down
2 changes: 0 additions & 2 deletions scripts/ci-conformance.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,8 @@ export GINKGO_NODES=3
export OCI_SSH_KEY="${OCI_SSH_KEY:-""}"
export OCI_CONTROL_PLANE_SHAPE="${OCI_CONTROL_PLANE_SHAPE:-"VM.Standard.E3.Flex"}"
export OCI_CONTROL_PLANE_SHAPE_OCPUS="${OCI_CONTROL_PLANE_SHAPE_OCPUS:-"1"}"
export OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS="${OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS:-"16"}"
export OCI_WORKER_SHAPE="${OCI_WORKER_SHAPE:-"VM.Standard.E3.Flex"}"
export OCI_WORKER_SHAPE_OCPUS="${OCI_WORKER_SHAPE_OCPUS:-"1"}"
export OCI_WORKER_SHAPE_MEMORY_IN_GBS="${OCI_WORKER_SHAPE_MEMORY_IN_GBS:-"16"}"
export KIND_EXPERIMENTAL_DOCKER_NETWORK="bridge"

# Generate SSH key.
Expand Down
2 changes: 0 additions & 2 deletions scripts/ci-e2e.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,8 @@ export GINKGO_NODES=3
export OCI_SSH_KEY="${OCI_SSH_KEY:-""}"
export OCI_CONTROL_PLANE_SHAPE="${OCI_CONTROL_PLANE_SHAPE:-"VM.Standard.E3.Flex"}"
export OCI_CONTROL_PLANE_SHAPE_OCPUS="${OCI_CONTROL_PLANE_SHAPE_OCPUS:-"1"}"
export OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS="${OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS:-"16"}"
export OCI_WORKER_SHAPE="${OCI_WORKER_SHAPE:-"VM.Standard.E3.Flex"}"
export OCI_WORKER_SHAPE_OCPUS="${OCI_WORKER_SHAPE_OCPUS:-"1"}"
export OCI_WORKER_SHAPE_MEMORY_IN_GBS="${OCI_WORKER_SHAPE_MEMORY_IN_GBS:-"16"}"
export KIND_EXPERIMENTAL_DOCKER_NETWORK="bridge"

# Generate SSH key.
Expand Down
2 changes: 0 additions & 2 deletions templates/cluster-template-antrea.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,6 @@ spec:
shape: "${OCI_CONTROL_PLANE_SHAPE=VM.Standard.E4.Flex}"
shapeConfig:
ocpus: "${OCI_CONTROL_PLANE_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
isPvEncryptionInTransitEnabled: ${OCI_CONTROL_PLANE_PV_TRANSIT_ENCRYPTION=true}
Expand All @@ -314,7 +313,6 @@ spec:
shape: "${OCI_WORKER_SHAPE=VM.Standard.E4.Flex}"
shapeConfig:
ocpus: "${OCI_WORKER_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_WORKER_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
isPvEncryptionInTransitEnabled: ${OCI_NODE_PV_TRANSIT_ENCRYPTION=true}
Expand Down
2 changes: 0 additions & 2 deletions templates/cluster-template-arm-free-tier.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ spec:
assignPublicIp: true
shapeConfig:
ocpus: "${OCI_CONTROL_PLANE_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
IsPvEncryptionInTransitEnabled: ${OCI_CONTROL_PLANE_PV_TRANSIT_ENCRYPTION=true}
Expand All @@ -126,7 +125,6 @@ spec:
assignPublicIp: true
shapeConfig:
ocpus: "${OCI_WORKER_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_WORKER_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
IsPvEncryptionInTransitEnabled: ${OCI_NODE_PV_TRANSIT_ENCRYPTION=true}
Expand Down
2 changes: 0 additions & 2 deletions templates/cluster-template-failure-domain-spread.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ spec:
shape: "${OCI_CONTROL_PLANE_SHAPE=VM.Standard.E4.Flex}"
shapeConfig:
ocpus: "${OCI_CONTROL_PLANE_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
isPvEncryptionInTransitEnabled: ${OCI_CONTROL_PLANE_PV_TRANSIT_ENCRYPTION=true}
Expand All @@ -100,7 +99,6 @@ spec:
shape: "${OCI_WORKER_SHAPE=VM.Standard.E4.Flex}"
shapeConfig:
ocpus: "${OCI_WORKER_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_WORKER_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
isPvEncryptionInTransitEnabled: ${OCI_NODE_PV_TRANSIT_ENCRYPTION=true}
Expand Down
2 changes: 0 additions & 2 deletions templates/cluster-template-oci-addons.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ spec:
shape: "${OCI_CONTROL_PLANE_SHAPE=VM.Standard.E4.Flex}"
shapeConfig:
ocpus: "${OCI_CONTROL_PLANE_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
isPvEncryptionInTransitEnabled: ${OCI_CONTROL_PLANE_PV_TRANSIT_ENCRYPTION=true}
Expand All @@ -100,7 +99,6 @@ spec:
shape: "${OCI_WORKER_SHAPE=VM.Standard.E4.Flex}"
shapeConfig:
ocpus: "${OCI_WORKER_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_WORKER_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
isPvEncryptionInTransitEnabled: ${OCI_NODE_PV_TRANSIT_ENCRYPTION=true}
Expand Down
2 changes: 0 additions & 2 deletions templates/cluster-template-oraclelinux.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ spec:
shape: "${OCI_CONTROL_PLANE_SHAPE=VM.Standard.E4.Flex}"
shapeConfig:
ocpus: "${OCI_CONTROL_PLANE_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_CONTROL_PLANE_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
isPvEncryptionInTransitEnabled: ${OCI_CONTROL_PLANE_PV_TRANSIT_ENCRYPTION=true}
Expand All @@ -102,7 +101,6 @@ spec:
shape: "${OCI_WORKER_SHAPE=VM.Standard.E4.Flex}"
shapeConfig:
ocpus: "${OCI_WORKER_SHAPE_OCPUS=1}"
memoryInGBs: "${OCI_WORKER_SHAPE_MEMORY_IN_GBS=16}"
metadata:
ssh_authorized_keys: "${OCI_SSH_KEY}"
isPvEncryptionInTransitEnabled: ${OCI_NODE_PV_TRANSIT_ENCRYPTION=true}
Expand Down

0 comments on commit 1b27ff8

Please sign in to comment.