Pivotal Cloud Foundry

This tutorial walks through the steps to create service instance of YugabyteDB in PCF.

Prerequisites

Before creating the Service Instance, you need to have YugabyteDB tile installed in your PCF marketplace. Follow the instructionshere.

Also in your YugaWare instance that you brought up in your PCF environment you have configured cloud provider. If not follow theinstructions here to setup appropriate cloudproviders

After installing the tile, you have two ways to create a YugabyteDB instance, one is through the App Manager UI, and other is throughCloud Foundry CLI (cf).

Using PCF App Manager

In your PCF App manager, go to marketplace and pick YugabyteDB, it will present you with different service plans,each service plan has a small description on what the resource requirements and what it is the intended environment.

Yugabyte Service Plans

Once you pick the service plan you would be provided with the service instance configuration screen as belowApp Manager Config

Using Cloud Foundry (cf) CLI

You can view the marketplace and plan description in cf cli by executing the below command.

  1. $ cf marketplace -s yugabyte-db

you would see a table as shown below.

  1. service plan   description                  free or paid
  2. x-small        Cores: 2, Memory (GB): 4     paid
  3. small          Cores: 4, Memory (GB): 7     paid
  4. medium         Cores: 8, Memory (GB): 15    paid
  5. large          Cores: 16, Memory (GB): 15   paid
  6. x-large        Cores: 32, Memory (GB): 30   paid

Once you decide on the service plan you can launch the YugabyteDB service instance by executing the below command.

  1. $ cf create-service yugabyte-db x-small yb-demo -c '{"universe_name": "yb-demo"}'

Service broker override options

This section lists various override options that you can specify when creating a service instance using yugabyte-db service broker.

Overriding cloud provider

Based on what cloud providers you have setup in your YugaWare, you can create Yugabyte service instances by providingthe overrides as below.

To provision in AWS/GCP cloud, your overrides would include the appropriate provider_type and region_codes as a array

  1. {
  2.  "universe_name": "cloud-override-demo",
  3.  "provider_type": "gcp", # gcp for Google Cloud, aws for Amazon Web Service
  4.  "region_codes": ["us-west1"] # this the comma delimited list of regions
  5. }

To provision in Kubernetes, your overrides would include the appropriate provider_type and kube_provider type

  1. {
  2.  "universe_name": "cloud-override-demo",
  3.  "provider_type": "kubernetes",
  4.  "kube_provider": "gke" # gke for Google Compute Engine, pks for Pivotal Container Service (default)
  5. }

Overriding number of nodes

To override the number of nodes, just include the num_nodes with desired value, include this parameter with along withother parameters for the cloud provider.

  1. {
  2.  "universe_name": "cloud-override-demo",
  3.  "num_nodes": 4 # default is 3 nodes.
  4. }

Overriding replication factor

To override the replication factor, just include the replication with a desired value, include this parameter with along withother parameters for the cloud provider. Make sure the replication factor is one of the following 1, 3, 5, 7.

  1. {
  2.  "universe_name": "cloud-override-demo",
  3.  "replication": 5,
  4.  "num_nodes": 5 # since you change the replication factor to 5, you need to override the num_nodes to be 5 minimum.
  5. }

Overriding volume specifications

To override the volume specs, just include num_volumes with the desired value, and also the volume_size with the volume sizein GB for each of those volumes, lets say if you want to have 2 volumes with 100GB each, you would specify the overrides as below.

  1. {
  2.  "universe_name": "cloud-override-demo",
  3.  "num_volumes": 2,
  4.  "volume_size": 100
  5. }

Overriding the YugabyteDB software version to use

To override the YugabyteDB software version to use, just include yb_version with the desired value. Just make sure that particularversion exists in YugaWare.

  1. {
  2.  "universe_name": "cloud-override-demo",
  3.  "yb_version": "1.1.6.0-b4"
  4. }