Skip to content

Latest commit

 

History

History
120 lines (88 loc) · 3.36 KB

ocp4_gcp.md

File metadata and controls

120 lines (88 loc) · 3.36 KB
Raw

OpenShift 4 IPI GCP Install Documentation

The OpenShift 4 IPI GCP variable file can be found at OCP-4.X/vars/install-on-gcp.yml. It will configure the deployment playbook at OCP-4.X/deploy-cluster.yml to perform a cluster installation on GCP. In addition to installing a cluster, the playbook can also perform day 2 operations to include deploying three infra nodes and deploying a workload node to isolate workload driver pods from openshift-scale/workloads repo.

Usage

Running from the CLI:

$ cp OCP-4.X/inventory.example inventory
$ # Edit inventory and add your expected orchestration host
$ # Edit deployment variables (Ex vi OCP-4.X/vars/install-on-gcp.yml) or define env variables
$ ansible-playbook -v -i inventory OCP-4.X/deploy-cluster.yml -e platform=gcp

Environment variables

Variables which are common to various cloud providers needs to be initialised first.

Documents for initializing can be found here - ocp4_common_env_var.md

After that initialize the following variables -

GCP_SERVICE_ACCOUNT

Default: No default. The service account is needed for GCP API access.

GCP_SERVICE_ACCOUNT_EMAIL

Default: No default. Service account email.

GCP_AUTH_KEY_FILE

Default: No default. Path to the GCP auth key file, this is need to authenticate to google cloud.

GCP_PROJECT

Default: No default. Project to use.

GCP_REGION

Default: No default. The GCP region to install on to. Example: us-central1

OPENSHIFT_BASE_DOMAIN

Default: No default. The base domain for the cluster.

OPENSHIFT_CLUSTER_NAME

Default: No default. The name of the cluster.

OPENSHIFT_MASTER_COUNT

Default: 3 The number of master nodes.

OPENSHIFT_WORKER_COUNT

Default: 5 The number of worker nodes to install.

OPENSHIFT_MASTER_VM_SIZE

Default: n1-standard-4 The vm size of the masters.

OPENSHIFT_WORKER_VM_SIZE

Default: n1-standard-4 The vm size of the worker nodes.

OPENSHIFT_MASTER_ROOT_VOLUME_SIZE

Default: 64 The root volume disk size for the masters.

OPENSHIFT_WORKER_ROOT_VOLUME_SIZE

Default: 64 The root volume size for worker nodes.

MACHINESET_METADATA_LABEL_PREFIX

Default: machine.openshift.io The prefix used in machinesets. Usually this is machine.openshift.io however it might be sigs.k8s.io depending on version installed.

OPENSHIFT_INFRA_NODE_VM_SIZE

Default: n1-standard-4 The vm size for infra nodes.

OPENSHIFT_WORKLOAD_NODE_VM_SIZE

Default: n1-standard-4 The vm size for the workload node.

OPENSHIFT_INFRA_NODE_VOLUME_SIZE

Default: 64 The root volume size for the infra nodes.

OPENSHIFT_INFRA_NODE_VOLUME_TYPE

Default: pd-ssd The root volume type for infra nodes.

OPENSHIFT_WORKLOAD_NODE_VOLUME_SIZE

Default: 64 The root volume size for the workload node.

OPENSHIFT_WORKLOAD_NODE_VOLUME_TYPE

Default: pd-ssd The root volume type for workload node.

OPENSHIFT_PROMETHEUS_RETENTION_PERIOD

Default: 15d The retention period for the Prometheus server.

OPENSHIFT_PROMETHEUS_STORAGE_CLASS

Default: pd-ssd The storage class for Prometheus server.

OPENSHIFT_PROMETHEUS_STORAGE_SIZE

Default: 10Gi The storage size for Prometheus server.

OPENSHIFT_ALERTMANAGER_STORAGE_CLASS

Default: pd-ssd The storage class for the alertmanager servers.

OPENSHIFT_ALERTMANAGER_STORAGE_SIZE

Default: 2Gi