GCP Setup Guide

The following demonstrates how to deploy Puddle on GCP. The process involves steps that need to be taken via the GCP console/gcloud command, as well as steps that will be taken on the Puddle Linux VM. As such, please make sure you have permissions to do the following:

  • Activate APIs
  • Allocate a (preferably static) external IP address
  • (Optional) Create a network/subnetwork and edit routes and firewall rules
  • Configure firewall rules
  • Configure VPC peering for private services access
  • (Optional) Create service accounts and change project IAM policies
  • (Optional) Create KMS key rings and keys
  • Create a Cloud SQL for Postgres instance
  • Create a Cloud Memorystore for Redis instance
  • Create a VM

After the above has been verified, you are now ready to proceed.

GCP Resources

The first step is to set up GCP resources. All of these operations require a GCP project and an initialized gcloud installation (see official documentation):

PROJECT=<your project **id**>
PROJECT_NUMBER=<your project **number**>
gcloud auth login
gcloud config set core/project $PROJECT

The puddle deployment runs in a single GCE zone/region:

ZONE=<deployment zone>
REGION=<deployment region>

To simplify the deployment, let’s also standardize the naming:

DEPLOYMENT=<name of the deployment>

Project Setup

First you need to make sure that the required APIs are enabled on the project by running:

gcloud services enable compute.googleapis.com
gcloud services enable servicenetworking.googleapis.com
gcloud services enable sql-component.googleapis.com
gcloud services enable redis.googleapis.com

Also make sure that you have enabled billing on the project.

Let’s also initialize the default configuration options:

NETWORK=default  # default GCE network
SUBNET=default
BACKEND_SA=""    # will use default GCE service account
PACKER_SA=""     # will use default GCE service account
SYSTEM_SA=""     # will use default GCE service account

Allocate Public IP

You will need to allocate a public IP for the Puddle backend VM.

gcloud compute addresses create "${DEPLOYMENT}-ip" --region=$REGION

(Optional) Custom VPC Network Setup

If you don’t want to use the default GCP network/subnet, you can create your own by running:

NETWORK="${DEPLOYMENT}-network"
SUBNET="${DEPLOYMENT}-subnet"

gcloud compute networks create $NETWORK --subnet-mode=custom
gcloud compute networks subnets create $SUBNET \
    --network=$NETWORK \
    --range=10.128.0.0/20 \
    --enable-private-ip-google-access \
    --region=$REGION

If you intend to disable public IPs for the Puddle-managed VMs, you have to configure Cloud NAT so that the VMs can access the Internet:

gcloud compute routers create "${DEPLOYMENT}-nat-router" \
    --network $NETWORK \
    --region $REGION

gcloud compute routers nats create "${DEPLOYMENT}-nat-config" \
    --router-region $REGION \
    --router "${DEPLOYMENT}-nat-router" \
    --nat-all-subnet-ip-ranges \
    --auto-allocate-nat-external-ips

Note that technically the Puddle backend VM can be in a different network/subnet than the rest of Puddle-provisioned VMs (image builds and systems). However, appropriate routing and firewall rules between the networks need to be ensured.

Firewall Setup

Puddle requires a few firewall rules to function correctly:

  • TCP port 22 (SSH access) for all VMs; this is required for Puddle to function (already allowed by the default network).
  • TCP ports 80/443 (HTTP/HTTPs) for the Puddle backend VM (already allowed by the default network).
  • TCP ports 54321, 12345, and 8888 (H2O-3, Driverless AI, and Jupyter, respectively) for all system VMs.

If you’re using a custom network, run:

gcloud compute firewall-rules create "${DEPLOYMENT}-allow-icmp" \
    --network=$NETWORK --allow icmp
gcloud compute firewall-rules create "${DEPLOYMENT}-allow-ssh" \
    --network=$NETWORK --allow tcp:22
gcloud compute firewall-rules create "${DEPLOYMENT}-allow-http" \
    --network=$NETWORK --allow tcp:80 --target-tags=http-server
gcloud compute firewall-rules create "${DEPLOYMENT}-allow-https" \
    --network=$NETWORK --allow tcp:443 --target-tags=https-server

For both default and custom networks, run:

gcloud compute firewall-rules create "${DEPLOYMENT}-allow-h2o" \
    --network=$NETWORK --allow tcp:54321,tcp:12345,tcp:8888

VPC Peering setup

Next, set up private services access so that we can access our Cloud SQL and Cloud Memorystore instances via private IP addresses. (See Cloud SQL private IP documentation.)

If you don’t want to use private services access, you can skip this step.

gcloud beta compute addresses create "${DEPLOYMENT}-peering-range" \
    --global \
    --prefix-length=20 \
    --description="Private services access connection" \
    --network=$NETWORK \
    --purpose=vpc_peering

gcloud services vpc-peerings connect \
    --service=servicenetworking.googleapis.com \
    --ranges="${DEPLOYMENT}-peering-range" \
    --network=$NETWORK \
    --project=$PROJECT

(Optional) Custom Service Account Setup

Puddle can run perfectly fine under the GCE default service account. (This is the default configuration.)

However, it might be better to create a designated service account for the Puddle backend VM as well as a designated service account for the VMs launched by Puddle (image builds and systems). To create the two accounts, run:

gcloud iam service-accounts create "${DEPLOYMENT}-backend" \
    --display-name="Puddle Backend Service Account"
gcloud iam service-accounts create "${DEPLOYMENT}-packer" \
    --display-name="Puddle Packer Service Account"
gcloud iam service-accounts create "${DEPLOYMENT}-system" \
    --display-name="Puddle Systems Service Account"

BACKEND_SA="${DEPLOYMENT}-backend@${PROJECT}.iam.gserviceaccount.com"
PACKER_SA="${DEPLOYMENT}-packer@${PROJECT}.iam.gserviceaccount.com"
SYSTEM_SA="${DEPLOYMENT}-system@${PROJECT}.iam.gserviceaccount.com"

After that, you need to grant the backend service account required IAM permissions. First, allow Puddle backend to use the packer/system service accounts for new VMs:

gcloud iam service-accounts add-iam-policy-binding "${PACKER_SA}" \
    --member="serviceAccount:${BACKEND_SA}" \
    --role=roles/iam.serviceAccountUser
gcloud iam service-accounts add-iam-policy-binding "${SYSTEM_SA}" \
    --member="serviceAccount:${BACKEND_SA}" \
    --role=roles/iam.serviceAccountUser

Then allow Puddle backend to control the relevant GCP resources. By default, the Puddle Backend requires the following project permissions:

PERMISSIONS="
compute.disks.create
compute.disks.createSnapshot
compute.disks.delete
compute.disks.get
compute.disks.setLabels
compute.disks.use
compute.disks.useReadOnly
compute.globalOperations.get
compute.images.create
compute.images.delete
compute.images.get
compute.images.setLabels
compute.images.useReadOnly
compute.instances.create
compute.instances.delete
compute.instances.get
compute.instances.setLabels
compute.instances.setMachineResources
compute.instances.setMachineType
compute.instances.setMetadata
compute.instances.setTags
compute.instances.setScheduling
compute.instances.setServiceAccount
compute.instances.start
compute.instances.stop
compute.machineTypes.get
compute.snapshots.create
compute.snapshots.delete
compute.snapshots.get
compute.snapshots.setLabels
compute.snapshots.useReadOnly
compute.subnetworks.use
compute.subnetworks.useExternalIp
compute.zoneOperations.get
compute.zones.get
"

gcloud iam roles create puddleBackend \
    --project=$PROJECT  \
    --title="Puddle backend" \
    --description="Contains permissions required for Puddle backend to function." \
    --stage=GA \
    --permissions=$(echo $PERMISSIONS | tr " " ",")

gcloud projects add-iam-policy-binding $PROJECT \
    --member="serviceAccount:${BACKEND_SA}" \
    --role=projects/${PROJECT}/roles/puddleBackend

Note that you could also use the pre-defined role roles/compute.instanceAdmin.v1; however, it grants many unnecessary permissions.

If you plan on using custom Packer startup scripts, give $PACKER_SA the required permissions:

gcloud iam service-accounts add-iam-policy-binding "${PACKER_SA}" \
    --member="serviceAccount:${PACKER_SA}" \
    --role=roles/iam.serviceAccountUser

gcloud iam roles create packerStartupScriptRunner \
    --project=$PROJECT  \
    --title="Packer startup script runner" \
    --description="Allows running custom startup script in Packer VMs." \
    --stage=GA \
    --permissions=compute.instances.get,compute.instances.setMetadata,compute.zoneOperations.get

gcloud beta projects add-iam-policy-binding $PROJECT \
    --member="serviceAccount:${PACKER_SA}" \
    --role="projects/${PROJECT}/roles/packerStartupScriptRunner" \
    --condition=title="Only apply to Packer VMs",expression="resource.name.startsWith(\"projects/${PROJECT}/zones/${ZONE}/instances/packer-\")"

(Optional) KMS Setup

Optionally, you can opt to encrypt system volumes using KMS keys.

First, you need give GCE permission to use KMS keys when creating disks by assigning the Cloud KMS CryptoKey Encrypter/Decrypter role to the Compute Engine Service Agent. (See KMS how-to guide.)

KMS_PROJECT=$PROJECT
gcloud projects add-iam-policy-binding $KMS_PROJECT \
    --member "serviceAccount:service-${PROJECT_NUMBER}@compute-system.iam.gserviceaccount.com" \
    --role roles/cloudkms.cryptoKeyEncrypterDecrypter

If you intend to use KMS keys from another project, change KMS_PROJECT accordingly.

If you want to create a unique key for each Puddle system, you need a KMS key ring.

Important: KMS key rings and key versions CANNOT BE DELETED, so create them carefully. See KMS object lifetime documentation for details. To create one in the deployment project, run:

gcloud services enable cloudkms.googleapis.com
gcloud kms keyrings create "${DEPLOYMENT}-key-ring" --location $REGION

See KMS documentation on how to create key rings/keys for more details. Note that disks can be encrypted only by keys in the same region or in the global location.

Finally, allow Puddle to control the KMS resources:

PERMISSIONS="$PERMISSIONS
cloudkms.cryptoKeys.create
cloudkms.cryptoKeys.get
cloudkms.cryptoKeyVersions.destroy
cloudkms.cryptoKeyVersions.list
cloudkms.keyRings.get
"

gcloud iam roles update puddleBackend \
    --project=$PROJECT \
    --permissions=$(echo $PERMISSIONS | tr " " ",")

Note that you could also use the pre-defined role roles/cloudkms.admin.

Cloud SQL for Postgres Setup

Now proceed to creating the Postgres database that is required for this Puddle setup:

gcloud beta sql instances create "$DEPLOYMENT-postgres" \
    --database-version=POSTGRES_11 \
    --no-assign-ip \
    --no-storage-auto-increase \
    --availability-type=regional \
    --network="projects/${PROJECT}/global/networks/${NETWORK}" \
    --region=$REGION \
    --storage-size=50 \
    --cpu=2 \
    --memory=4 \
    --backup \
    --backup-start-time=00:00

read -s -p "Enter password:" PASSWORD
gcloud sql users create puddle \
    --instance="$DEPLOYMENT-postgres" --password="${PASSWORD}"

Take note of the PRIVATE_ADDRESS value. It’ll be required to start Puddle later.

Cloud Memorystore for Redis Setup

Next, create the Redis database that is required for this Puddle setup:

gcloud redis instances create "$DEPLOYMENT-redis" \
    --region=$REGION \
    --redis-version=redis_4_0 \
    --tier=STANDARD \
    --network="projects/${PROJECT}/global/networks/${NETWORK}" \
    --connect-mode=private-service-access

gcloud redis instances describe "$DEPLOYMENT-redis" --region=$REGION

Take note of the host value. It’ll be required to start Puddle later.

Puddle Backend VM Setup

While the RDS and Redis instances are starting, create a new VM for the Puddle backend server. We will not go into detail when it comes to creating a VM in GCP. However, we recommend the following configuration for the Puddle backend VM:

  • OS: Ubuntu
  • Memory: 8GB
  • Storage: 100 GB

Create the VM by running:

gcloud compute instances create "${DEPLOYMENT}-backend" \
    --image-family ubuntu-1804-lts \
    --image-project ubuntu-os-cloud \
    --boot-disk-size=100GB \
    --boot-disk-type=pd-ssd \
    --machine-type=n1-standard-2 \
    --address="${DEPLOYMENT}-ip" \
    --network=$NETWORK \
    --subnet=$SUBNET \
    --zone=$ZONE \
    --scopes=cloud-platform \
    ${BACKEND_SA:+--service-account="${BACKEND_SA}"} \
    --tags=http-server,https-server

Remove the http-server and https-server tags if you don’t want to allow traffic on ports 80 and 443, respectively, while the VM is on the default network/firewall.

If you want to use a custom SSH key pair, add the following argument:

--metadata="ssh-keys=${SSH_USERNAME}:${SSH_PUBKEY}"

Review the GCP Resources

The newly created Resource group should now contain these items. (Some of them are created implicitly):

  • GCE Virtual machine
  • PD SSD Disk
  • Public IP address
  • Firewall rules for ICMP, SSH, HTTP(S), Jupyter, and H2O products
  • Cloud SQL for PostgreSQL isntance
  • Cloud Memorystore for Redis instance
  • VPC network peering and IP address range for private services access
  • (optional) Custom VPC network/subnetwork and Cloud Router/NAT
  • (optional) 3 service accounts, 2 custom IAM roles, and related IAM policies
  • (optional) KMS key ring

Puddle Application

For this part, we will configure the VM created above.

To SSH onto the VM using your gcloud credentials, run:

gcloud beta compute ssh --zone $ZONE "${DEPLOYMENT}-backend"

Installation

Install Ansible, redis-cli, psql and the Puddle application:

sudo apt update
sudo apt upgrade
sudo apt-add-repository --yes --update ppa:ansible/ansible
sudo apt install -y wget unzip redis-tools postgresql-client ansible
wget https://s3.amazonaws.com/puddle-release.h2o.ai/1.7.11/x86_64-ubuntu18/puddle_1.7.11_amd64.deb
sudo apt install -y ./puddle_1.7.11_amd64.deb

sudo bash
dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
yum install epel-release ansible @postgresql:10 redis wget
wget https://s3.amazonaws.com/puddle-release.h2o.ai/1.7.11/x86_64-centos7/puddle-1.7.11-1.x86_64.rpm
rpm -i puddle-1.7.11-1.x86_64.rpm

[Optional] Test that you can connect to Redis (this will work only if TLS is disabled for Redis):

redis-cli -h <redis_address> PING
# Confirm that the returned value is "PONG"

Test that you can connect to PostgreSQL database:

pg_isready -h <postgres_address> -p 5432
# Confirm that the database is "accepting connections"

Reverse Proxy Setup

In this section we will set up Traefik reverse proxy.

Generate certificates

First generate self signed certificate for use as root Certificate Authority:

sudo mkdir -p /opt/h2oai/puddle/certs/ca
cd /opt/h2oai/puddle/certs/ca
sudo openssl genrsa -out key.pem 4096
sudo openssl req -x509 -new -nodes -key key.pem -sha256 -days 1825 -out cert.pem -subj '/CN=Pudle - H2O.ai'

Warning

You could get the following warning when running the openssl genrsa command:

Can't load /home/ubuntu/.rnd into RNG
...RAND_load_file:Cannot open file...

This is caused by the missing default random file. You can ignore this warning (or comment out RANDFILE variable in /etc/ssl/openssl.cnf config file to get rid of the warning.)

Generate server certificate:

sudo mkdir -p /opt/h2oai/puddle/certs/server
cd /opt/h2oai/puddle/certs/server
sudo openssl genrsa -out key.pem 4096
# Make sure to specify correct CN when asked, in this case it should be localhost
# You may get a warning about a missing random file (you can ignore it)
sudo openssl req -new -key key.pem -out localhost.csr -subj '/CN=localhost'
sudo openssl x509 -req -in localhost.csr -CA ../ca/cert.pem -CAkey ../ca/key.pem -CAcreateserial -out cert.pem -days 1825

Generate client certificate:

sudo mkdir -p /opt/h2oai/puddle/certs/client
cd /opt/h2oai/puddle/certs/client
sudo openssl genrsa -out key.pem 4096
# You may get a warning about a missing random file (you can ignore it)
sudo openssl req -new -key key.pem -out traefik.csr -subj '/CN=Puddle Traefik - H2O.ai'
sudo openssl x509 -req -in traefik.csr -CA ../ca/cert.pem -CAkey ../ca/key.pem -CAcreateserial -out cert.pem -days 1825

Configure Traefik

When the certificates are prepared, we can configure Traefik:

  • Put external certificate (certificate shown to users, must be trusted) to /opt/h2oai/puddle/certs/proxy-public/cert.pem
  • Put the corresponding private key to /opt/h2oai/puddle/certs/proxy-public/key.pem
  • Both files have to be PEM encoded, password protection is not supported

Start Traefik

sudo systemctl stop puddle         # make sure Puddle is stopped before starting traefik
sudo systemctl enable puddle-proxy # start Traefik on boot
sudo systemctl start puddle-proxy  # start Traefik
journalctl -u puddle-proxy | less  # check that everything is ok

At this point Traefik reverse proxy should be running. In Configure Traefik - Puddle part we will finish configuration of Traefik so Puddle will be configured to use this running Traefik reverse proxy.

Create the License File

  1. ssh into the Virtual Machine.
  2. Create a file /opt/h2oai/puddle/license.sig containing the license. Different path might be used, but this is the default.

Configuring Puddle

We will need to fill the /etc/puddle/config.yaml file:

redis:
  connection:
    protocol: tcp
    address:
    password:
    tls: true

db:
  connection:
    drivername: postgres
    host:
    port: 5432
    user:
    dbname: puddle
    sslmode: require
    password:

tls:
  certFile: /opt/h2oai/puddle/certs/server/cert.pem
  keyFile: /opt/h2oai/puddle/certs/server/key.pem

connection:
  port: 8081

license:
  file: /opt/h2oai/puddle/license.sig

ssh:
  publicKey: /opt/h2oai/puddle/ssh/id_rsa.pub
  privateKey: /opt/h2oai/puddle/ssh/id_rsa

auth:
  token:
    secret:
  apiKeys:
    enabled: true
  activeDirectory:
    enabled: false
    server:
    port: 389
    baseDN:
    security: tls
    objectGUIDAttr: objectGUID
    displayNameAttr: displayName
    administratorsGroup: Puddle-Administrators
    usersGroup: Puddle-Users
    implicitGrant: false
  azureAD:
    enabled: false
    useAADLoginExtension: true
  awsCognito:
    enabled: false
    userPoolId:
    userPoolWebClientId:
    domain:
    redirectSignIn:
    redirectSignOut:
    adminsGroup: Puddle-Administrators
    usersGroup: Puddle-Users
    implicitGrant: false
  ldap:
    enabled: false
    host:
    port: 389
    skipTLS: false
    useSSL: true
    insecureSkipVerify: false
    serverName:
    baseDN:
    bindDN:
    bindPassword:
    bindAllowAnonymousLogin: false
    authenticationFilter: "(uid=%s)"
    authorizationFlow: userAttribute
    authorizationFilter: "(memberOf=%s)"
    authorizationSearchValueAttribute: dn
    uidAttributeName: uid
    uidNumberAttributeName: uidnumber
    emailAttributeName: email
    implicitGrant: false
    adminsGroup: Puddle-Administrators
    usersGroup: Puddle-Users
  oidc:
    enabled: false
    issuer:
    clientId:
    clientSecret:
    redirectUrl: /oidc/authorization-code/callback
    logoutUrl:
    scopes:
      - openid
      - profile
      - email
      - offline_access
    implicitGrant: false
    adminRole: Puddle-Administrators
    userRole: Puddle-Users
    tokenRefreshInterval: 15m
    clientBearerTokenAuth:
      enabled: false
      issuer:
      clientId:
      scopes:
        - openid
        - offline_access

packer:
  path: /opt/h2oai/puddle/deps/packer
  usePublicIP: true
  buildTimeoutHours: 1
  imageNameFormat: '%s'
  nvidiaDriversURL:
  terraformURL:
  driverlessAIURLPrefix:
  h2o3URLPrefix:

terraform:
  path: /opt/h2oai/puddle/deps/terraform
  usePublicIP: true
  pluginDir: /opt/h2oai/puddle/deps/terraform_plugins/

reverseProxy:
  enabled: true
  port: 443
  caCertificate: /opt/h2oai/puddle/certs/ca/cert.pem
  caPrivateKey: /opt/h2oai/puddle/certs/ca/key.pem
  clientCertificate: /opt/h2oai/puddle/certs/client/cert.pem
  clientPrivateKey: /opt/h2oai/puddle/certs/client/key.pem

backend:
  baseURL:
  connections:
    usePublicIP: true

webclient:
  usePublicIP: true
  userSshAccessEnabled: true

providers:
  azure:
    enabled: false
    authority:
    location:
    rg:
    vnetrg:
    vnet:
    sg:
    subnet:
    enterpriseApplicationObjectId:
    adminRoleId:
    publicIpEnabled: true
    packerInstanceType:
    sshUsername: puddle
    sourceSharedImageGallery:
      subscriptionId:
      rg:
      name:
      imageName:
      imageVersion:
    sourceImageRG:
    sourceImageName:
    sourceImagePublisher: Canonical
    sourceImageOffer: UbuntuServer
    sourceImageSku: 16.04-LTS
    imageTags:
    plan:
      name:
      publisher:
      product:
    customDataScriptPath:
    preflightScriptPath:
    packerCustomDataScriptPath:
    packerPreflightScriptPath:
    packerPostflightScriptPath:
    storageDiskLun: 0
    storageDiskFileSystem: ext4
    storageDiskDevice: /dev/sdc
    vmNamePrefix: puddle-
    vmNameRegexp: "^[-0-9a-z]*[0-9a-z]$" # starts with -, number or letter, ends with number or letter
    vmOwnerTagKey:
    vmTags:
      # foo: bar
  aws:
    enabled: false
    owner:
    vpcId:
    sgIds:
    subnetId:
    iamInstanceProfile:
    publicIpEnabled: true
    packerInstanceType:
    encryptEBSVolume: true
    ebsKMSKeyArn:
    metadataEndpointIAMRole: http://169.254.169.254/latest/meta-data/iam/info
    suppressIAMRoleCheck: false
    sshUsername: ubuntu
    sourceAMIOwner: '099720109477'
    sourceAMINameFilter: ubuntu/images/*ubuntu-xenial-16.04-amd64-server-*
    packerRunTags:
    amiTags:
    userDataScriptPath:
    preflightScriptPath:
    packerUserDataScriptPath:
    packerPreflightScriptPath:
    packerPostflightScriptPath:
    storageEBSDeviceName: /dev/sdf
    storageDiskFileSystem: ext4
    storageDiskDevice: /dev/nvme1n1
    storageDiskDeviceGpu: /dev/xvdf
    vmNamePrefix: puddle-
    vmNameRegexp: "^[-0-9a-z]*[0-9a-z]$" # starts with -, number or letter, ends with number or letter
    vmOwnerTagKey:
    vmTags:
      # foo: bar
    orphanedInstancesFinder:
      enabled: true
      action: stopAndTag
      findBy:
        key: ai.h2o.puddle.system.managed
        value: true
      marker:
        key: ai.h2o.puddle.system.orphaned
        value: true

  gcp:
    enabled: false
    project:
    zone:
    network: default
    subnetwork: ""
    publicIpEnabled: true
    encryptVolume: true
    volumeKmsKeyId: ""
    volumeKmsKeyRingName:
    volumeKmsKeyRingLocation:
    serviceAccountEmail: ""
    sshUsername: puddle
    storageDiskFileSystem: ext4
    startupScriptPath: ""
    preflightScriptPath: ""
    imageLabels:
    packerServiceAccountEmail: ""
    packerSourceImageProject: ubuntu-os-cloud
    packerSourceImageFamily: ubuntu-1604-lts
    packerInstanceType: n1-highmem-8
    packerAcceleratorType: nvidia-tesla-v100
    packerAcceleratorCount: 1
    packerStartupScriptPath: ""
    packerPreflightScriptPath: ""
    packerPostflightScriptPath: ""
    packerRunLabels:
    packerRunNetworkTags:
    vmNamePrefix: puddle-
    vmNameRegexp: "^[-0-9a-z]*[0-9a-z]$" # starts with -, number or letter, ends with number or letter
    runNetworkTags:
    backendServiceAccountEmail:
    useOsLogin: false
    vmOwnerTagKey:
    vmTags:
      # foo: bar

products:
  dai:
    configTomlTemplatePath: "/opt/h2oai/puddle/configs/dai/config.toml"
    license:
    authType: local
    openid:
      baseURL:
      configurationURL:
      introspectionURL:
      authURLSuffix: "/auth"
      tokenURLSuffix: "/token"
      userinfoURLSuffix: "/userinfo"
      endSessionURLSuffix: "/logout"
      clientId:
      clientSecret:
      scope:
        - openid
        - profile
        - email
      usernameFieldName: name
      userinfoAuthKey: sub
      clientTokens:
        clientId:
        issuer:
        scope:
          - openid
          - offline_access
    googleAnalytics:
      usageStatsOptIn: true
      exceptionTrackerOptIn: false
      autodlMessagesTrackerOptIn: true
  h2o3:
    authEnabled: true

logs:
  dir: /opt/h2oai/puddle/logs
  maxSize: 1000
  maxBackups: 15
  maxAge: 60
  compress: true
  level: trace
  colored: true

mailing:
  enabled: true
  server:
  username:
  password:
  fromAddress: puddle@h2o.ai
  fromName: Puddle
  recipients:
  offsetHours: 24

idleTimeout:
  options:
    30min: 30
    1h: 60
    2h: 120
    3h: 180
    4h: 240
    Never: -1

Description of all configuration fields can be found in the subsection Configuration fields overview.

Configuration fields overview

Below is the description of all configuration fields:

  • Values for redis.connection.* can be found in following way:

    • Microsoft Azure:
    • Search for Azure Cache for Redis.
    • Select the newly created Redis instance.
    • Select Access keys.
    • Amazon AWS:
    • Go to ElastiCache Dashboard.
    • Select Redis.
    • Select the cluster used by Puddle.
    • Select Description tab.
    • Google GCP:
    • Go to Memorystore > Redis
    • Select the instance used by Puddle.
    • See Connection properties
    • For redis.connection.address use format <hostname:port> (e.g. redis.xyk5qk.0001.euw3.cache.amazonaws.com:6379)

  • redis.workersCount number of workers to spin up. It must be a positive integer and is 10 by default

  • Values for db.connection.* can be found in following way:

    • Microsoft Azure:
    • Search for Azure Database for PostgreSQL servers.
    • Select the newly created PostgreSQL instance.
    • Select Connection strings.
    • Use the password that was provided when creating the PostgreSQL database.
    • Amazon AWS:
    • Go to Amazon RDS.
    • Select Databases.
    • Select the database used by Puddle.
    • Google GCP:
    • Go to SQL
    • Select the instance used by Puddle.
    • See Connect to this instance
    • For db.connection.host use only <hostname of Postgres instance> (e.g. postgres.cibba0yphezo.eu-west-3.rds.amazonaws.com)

  • tls.certFile should point to the PEM encoded certificate file if you want to use HTTPS. If you don’t want to use HTTPS, leave this property empty. If you set this property, then tls.keyFile must be set as well.

  • tls.keyFile should point to the PEM encoded private key file if you want to use HTTPS. The private key must be not encrypted by password. If you don’t want to use HTTPS, leave this property empty. If you set this property, then tls.certFile must be set as well.

  • connection.port should be the port where Puddle backend should be running. Defaults to 80 or 443 based on TLS config.

  • license.file should be a path to the file containing the license (created in previous step).

  • ssh.publicKey should be the path to ssh public key (for example /opt/h2oai/puddle/ssh/id_rsa.pub), which will be used by Puddle to talk to the Systems. If this ssh key is changed, Puddle won’t be able to talk to the Systems created with old key, and these will have to be destroyed.

  • ssh.privateKey should be the path to ssh private key (for example /opt/h2oai/puddle/ssh/id_rsa), which will be used by Puddle to talk to the Systems. If this ssh key is changed, Puddle won’t be able to talk to the Systems created with old key, and these will have to be destroyed.

  • auth.token.secret should be a random string. It is used to encrypt the tokens between the backend and frontend. For example the following could be used to generate the secret:

    tr -cd '[:alnum:]' < /dev/urandom | fold -w32 | head -n1

  • auth.apiKeys.enabled should be true/false and is true by default. If true the clients can authenticate using API Keys.

  • auth.activeDirectory.enabled should be true/false and is false by default. If true then authentication using ActiveDirectory is enabled.

  • auth.activeDirectory.server should be the hostname of the ActiveDirectory server, for example puddle-ad.h2o.ai.

  • auth.activeDirectory.port should be the port where ActiveDirectory is accessible, defaults to 389.

  • auth.activeDirectory.baseDN should be the BaseDN used for search.

  • auth.activeDirectory.security should be the security level used in communication with AD server. Could be none, start_tls, tls, defaults to tls.

  • auth.activeDirectory.objectGUIDAttr should be the name of the attribute used as ID of the user, defaults to objectGUID.

  • auth.activeDirectory.displayNameAttr should be the name of the attribute used to determine groups where user is member, defaults to memberOf.

  • auth.activeDirectory.administratorsGroup should be the name of the Administrators group. Users in this group are assigned Administrator role in Puddle, users in Administrators group and Users group are considered Administrators.

  • auth.activeDirectory.usersGroup should be the name of the Users group. Users in this group are assigned User role in Puddle, users in Administrators group and Users group are considered Administrators.

  • auth.activeDirectory.implicitGrant should be true/false and is false by default. If true, then users are allowed access to Puddle (using user role) even if they are not members of Administrators nor Users group. If false, then users must be members of at least one group to be allowed access to Puddle.

  • auth.azureAD.enabled should be true/false and is false by default. If true, then authentication using Azure Active Directory is enabled. Also, if true, you have to set provider.azure.authority, provider.azure.enterpriseApplicationObjectId, and provider.azure.adminRoleId (provider.azure.enabled can be remain false); you also have to set AZURE_SUBSCRIPTION_ID, AZURE_TENANT_ID, and AZURE_CLIENT_ID (see below).

  • auth.azureAD.useAADLoginExtension should be true/false and is false by default. If true, then ssh access to provisioned Virtual machines will use the Azure AD for authentication. Check https://docs.microsoft.com/en-us/azure/virtual-machines/linux/login-using-aad for more information. Cannot be enabled, if using proxy for egress.

  • auth.awsCognito.enabled should be true/false and is false by default. If true, then authentication using AWS Cognito is enabled.

  • auth.awsCognito.userPoolId should be the Pool Id, for example us-east-1_SlxxxxML1.

  • auth.awsCognito.userPoolWebClientId should be the App client id. The App client id can be found in following way:

    • Go to the AWS Cognito User Pool used by Puddle.
    • Select the App client settings.
    • Use the value under ID.

  • auth.awsCognito.domain should be the domain of the AWS Cognito User Pool, for example puddle.auth.<REGION>.amazoncognito.com (no https:// in the beginning). The domain can be found in following way:

    • Go to the AWS Cognito User Pool used by Puddle.
    • Select the Domain name.

  • auth.awsCognito.redirectSignIn should be https://<SERVER_ADDRESS>/aws-cognito-callback, please replace <SERVER_ADDRESS> with hostname where Puddle is running.

  • auth.awsCognito.redirectSignOut should be https://<SERVER_ADDRESS>/logout, please replace <SERVER_ADDRESS> with hostname where Puddle is running.

  • auth.awsCognito.adminsGroup should be the name of a group in AWS Cognito User Pool. If users are members of this group, they are assigned Administrator role in Puddle.

  • auth.awsCognito.usersGroup should be the name of a group in AWS Cognito User Pool. If users are members of this group, they are assigned User role in Puddle.

  • auth.awsCognito.implicitGrant should be true/false and is false by default. If true, then users are allowed access to Puddle (using user role) even if they are not members of Administrators nor Users group. If false, then users must be members of at least one group to be allowed access to Puddle.

  • auth.ldap.enabled should be true/false and is false by default. If true, then authentication using LDAP is enabled.

  • auth.ldap.host should be the LDAP server hostname.

  • auth.ldap.port should be the port where LDAP is accessible, defaults to 389.

  • auth.ldap.skipTLS should be true/false and is false by default. If true then do not use TLS.

  • auth.ldap.useSSL should be true/false and is true by default. If true, then use SSL.

  • auth.ldap.insecureSkipVerify should be true/false and is false by default. If true, then skip the server’s certificate verification.

  • auth.ldap.serverName should be the server name from server’s certificate. Defaults to auth.ldap.host.

  • auth.ldap.baseDN should be the BaseDN where authentication search will start.

  • auth.ldap.bindDN should be the BindDN used by Puddle to query LDAP.

  • auth.ldap.bindPassword should be the password of the user used by Puddle to query LDAP.

  • auth.ldap.bindAllowAnonymousLogin should be true/false and is false by default. If true, then bind won’t be executed before getting user’s groups.

  • auth.ldap.authenticationFilter should be the filter used when authenticating user. Defaults to "(uid=%s)".

  • auth.ldap.authorizationFlow should be userAttribute | groupAttribute. Defaults to userAttribute. Based on the value, either attribute of group (for example member) of attribute of user (for example memberOf) will be used in authorization.

  • auth.ldap.authorizationFilter should be the filter used when querying user’s groups. Defaults to "(memberOf=%s)".

  • auth.ldap.authorizationSearchValueAttribute should be name of the attribute used during authorization. Defaults to dn.

  • auth.ldap.uidAttributeName should be the name of the uid attribute. Defaults to uid. Value of uid attribute cannot be empty. Values of uid and uid number create unique identifier of the user.

  • auth.ldap.uidNumberAttributeName should be the name of the uid number attribute. Defaults to uidnumber. Value of uid number attribute cannot be empty. Values of uid and uid number create unique identifier of the user.

  • auth.ldap.emailAttributeName should be the name of the email attribute. Defaults to email. Value of email attribute might be empty.

  • auth.ldap.implicitGrant should be true/false and is false by default. If true, then users are allowed access to Puddle (using user role) even if they are not members of Administrators nor Users group. If false, then users must be members of at least one group to be allowed access to Puddle.

  • auth.ldap.adminsGroup should be the name of the Administrators group. Users in this group are assigned Administrator role in Puddle, users in Administrators group and Users group are considered Administrators.

  • auth.ldap.usersGroup should be the name of the Users group. Users in this group are assigned User role in Puddle, users in Administrators group and Users group are considered Administrators.

  • auth.ldap.cloudResourcesTagsMapping should be a mapping from LDAP attributes to tags of provisioned cloud resources. The values of the specified LDAP tags are used as values for the specified cloud tags. User cannot change these and they are applied to every system a user launches.

  • auth.oidc.enabled should be true/false and is false by default. If true, then authentication using OpenID Connect is enabled.

  • auth.oidc.issuer should be the issuer of the tokens.

  • auth.oidc.clientId should be the clientId used by Puddle.

  • auth.oidc.clientSecret optional clientSecret used by Puddle.

  • auth.oidc.redirectUrl should be the redirect URL, defaults to /oidc/authorization-code/callback.

  • auth.oidc.logoutUrl should be the URL used to sign out users. end_session_endpoint value from the /.well-known/openid-configuration should be used.

  • auth.oidc.scopes should be the list of required scopes, defaults to openid, profile, email, offline_access

  • auth.oidc.implicitGrant should be true/false and is false by default. If true, then users are allowed access to Puddle (using user role) even if they are not members of Administrators nor Users group. If false, then users must be members of at least one group to be allowed access to Puddle.

  • auth.oidc.adminRole should be the name of the Administrators role. Users with this role are assigned Administrator role in Puddle, users with Administrator role and User role are considered Administrators.

  • auth.oidc.userRole should be the name of the Users role. Users with this role are assigned User role in Puddle, users with Administrator role and User role are considered Administrators.

  • auth.oidc.tokenRefreshInterval should be the interval how often the OAuth2 tokens should be refreshed. Defaults to 15m.

  • auth.oidc.clientBearerTokenAuth.enabled should be true/false and is false by default. If true, then clients authentication using bearer token is enabled. If enabled, all of the auth.oidc.clientBearerTokenAuth.* is required.

  • auth.oidc.clientBearerTokenAuth.issuer should be the issuer of the tokens.

  • auth.oidc.clientBearerTokenAuth.clientId should be the clientId used by Puddle when validating the client tokens. This client must support PKCE flow.

  • auth.oidc.clientBearerTokenAuth.scopes should be the list of required scopes, defaults to openid, offline_access.

  • packer.path should point to the packer binary. Defaults to /opt/h2oai/puddle/deps/packer.

  • packer.usePublicIP should be true/false and is true by default. If true then packer will create VMs with public IP addresses, otherwise private IP will be used.

  • packer.buildTimeoutHours should be the number of hours after which the packer build times out. Default is 1 hour.

  • packer.imageNameFormat optional format string used to compute the name of the images. The format string has to contain exactly one %s placeholder. The %s will be substituted by <PRODUCT>-<VERSION>-<TIMESTAMP>. For example if the format string is cust-%s-image and Puddle is building Driverless AI image of version 1.8.0, then the name of the resulting image will be cust-dai-1.8.0-<TIMESTAMP>-image.

  • packer.nvidiaDriversURL if some custom URL for downloading NVIDIA drivers is required, for example because of internet access restrictions, set it here. Make sure to use version 440.59. Defaults to http://us.download.nvidia.com/XFree86/Linux-x86_64/440.59/NVIDIA-Linux-x86_64-440.59.run. For local files use file:///absolute-path/to/required.file.

  • packer.terraformURL if custom URL for downloading Terraform is required, for example because of internet access restrictions, set it here. Make sure to use version 0.11.14. Defaults to https://releases.hashicorp.com/terraform/0.11.14/terraform_0.11.14_linux_amd64.zip. For local files use file:///absolute-path/to/required.file.

  • packer.driverlessAIURLPrefix if custom URL for downloading Driverless AI is required, for example because of internet access restrictions, set it here. For local directory containing Driverless AI installers use file:///absolute-path/to/dir/.

  • packer.h2o3URLPrefix if custom URL for downloading H2O-3 is required, for example because of internet access restrictions, set it here. For local directory containing H2O-3 installers use file:///absolute-path/to/dir/.

  • terraform.path should point to the terraform binary. Defaults to /opt/h2oai/puddle/deps/terraform.

  • terraform.usePublicIP should be true/false and is true by default. If true then terraform will use public IP to communicate with the provisioned Virtual machines, otherwise private IP will be used.

  • terraform.pluginDir optional path where Terraform plugins are stored. If set, Terraform will not try to download plugins during initialization.

  • reverseProxy.enabled should be true/false and is false by default. If true then reverse proxy is used.

  • reverseProxy.port should be port where reverse proxy is running, defaults to 1234.

  • reverseProxy.caCertificate should be path to the CA certificate used to issue HTTPS certificates for systems provisioned by Puddle. Must be a PEM encoded certificate with no password protection.

  • reverseProxy.caPrivateKey should be path to the CA private key. Must be a PEM encoded private key with no password protection.

  • reverseProxy.clientCertificate should be path to the certificate used when doing forward auth (relevant for H2O-3 systems). Must be a PEM encoded certificate with no password protection.

  • reverseProxy.clientPrivateKey should be path to the private key used when doing forward auth (relevant for H2O-3 systems). Must be a PEM encoded private key with no password protection.

  • backend.baseURL should be the URL where Puddle is running (including port), for example https://puddle.h2o.ai:443

  • backend.openFilesWarningThreshold should be a number and defaults to 300. If more than this number of files are open by Puddle, then an Alert is created in the UI.

  • backend.connections.usePublicIp should be true/false and is true by default. If true then backend will use public IP to communicate with the provisioned Virtual machines, otherwise private IP will be used.

  • webclient.usePublicIp should be true/false and is true by default. If true then public IP is shown in UI, otherwise private IP is displayed.

  • webclient.outOfCUsUserMsg should be a message displayed to users when they try to create or start a system, but there are not enough Compute Units available.

  • webclient.userSshAccessEnabled should be true/false and is true by default. If true then users are able to download SSH keys of the provisioned VMs.

  • providers.azure.enabled should be true/false and is false by default. If true then Microsoft Azure is enabled as provider in Puddle. All variables under providers.azure must be set if enabled.

  • providers.azure.authority should be set to https://login.microsoftonline.com/<Azure ActiveDirectory Name>.onmicrosoft.com. The Azure Active Directory name can be found in following way:

    • Go to Azure Active Directory blade.
    • Select Overview.

  • providers.azure.location should be set to the same value that was specified for the Resource group, for example eastus.

  • providers.azure.rg should be set to the name of the newly created Resource group.

  • providers.azure.vnetrg should be set to the name of the Resource group where VNET and Subnet are present.

  • providers.azure.vnet should be set to the id of the newly created Virtual network.

  • providers.azure.sg should be set to the id of the newly created Network security group.

  • providers.azure.subnet should be set to the id of the newly created Subnet.

  • providers.azure.enterpriseApplicationObjectId should be the Object ID of the Enterprise Application. The Enterprose Application Object ID can be found in following way:

    • Go to the Azure Active Directory blade.
    • Select Enterprise Applications.
    • Select the newly created Enterprise Application.
    • Use the Object ID.

  • providers.azure.adminRoleId should be set to the ID of the newly created Administator Role in the Application Registration Manifest. The Administator Role ID can be found in following way:

    • Go to the Azure Active Directory blade.
    • Select App registrations (preview).
    • Select the newly created App registration.
    • Select Manifest.
    • Search for Administator role under appRoles and use the ID of this role.

  • providers.azure.publicIpEnabled should be true/false and is true by default. Public IP is created if and only if this is set to true. Must be set to true if at least one of packer, terraform, backend or webclient uses public IP.

  • providers.azure.packerInstanceType should be the instance type used by Packer to build images. Defaults to Standard_NC6.

  • providers.azure.sshUsername should be the username used when doing SSH/SCP from backend. Defaults to puddle.

  • providers.azure.sourceSharedImageGallery.subscriptionId ID of the subscription where the Shared Image Gallery with image used as source is present. Leave empty or remove if other image source should be used.

  • providers.azure.sourceSharedImageGallery.rg name of the resource group where the Shared Image Gallery with image used as source is present. Leave empty or remove if other image source should be used.

  • providers.azure.sourceSharedImageGallery.name name of the Shared Image Gallery with image used as source is present. Leave empty or remove if other source should be used.

  • providers.azure.sourceSharedImageGallery.imageName name of the Image from Shared Image Gallery to use as source. Leave empty or remove if other source should be used.

  • providers.azure.sourceSharedImageGallery.imageVersion version of the Image from Shared Image Gallery to use as source. Leave empty or remove if other source should be used.

  • providers.azure.sourceImageRG name of the resource group containing the private image used as the source for newly built Puddle images. Leave empty or remove if other source should be used.

  • providers.azure.sourceImageName name of the private image which should be used as the source for newly built Puddle images. Leave empty or remove if other source should be used.

  • providers.azure.sourceImagePublisher ignored if other source image is set as well (for example private image, or image from Shared Image Gallery). Should be the name of the publisher of the image used as source for newly built Puddle images. Defaults to Canonical. Leave empty or remove if other source should be used.

  • providers.azure.sourceImageOffer ignored if other source image is set as well (for example private image, or image from Shared Image Gallery). Should be the name of the offering of the publisher used as source for newly build Puddle images. Defaults to UbuntuServer. Leave empty or remove if other source should be used.

  • providers.azure.sourceImageSku ignored if other source image is set as well (for example private image, or image from Shared Image Gallery). Should be the image sku used as source for newly built Puddle images. Defaults to 16.04-LTS. Leave empty or remove if other source should be used.

  • providers.azure.imageTags map of tags used for all Packer resources and produced Image.

  • providers.azure.plan.name optional name of Plan to use when building images and provisioning VMs. If set, all of providers.azure.plan.* are required.

  • providers.azure.plan.publisher optional publisher of Plan to use when building images and provisioning VMs. If set, all of providers.azure.plan.* are required.

  • providers.azure.plan.product optional product of Plan to use when building images and provisioning VMs. If set, all of providers.azure.plan.* are required.

  • providers.azure.customDataScriptPath optional path to script with custom data to supply to the machine when provisioning new system. This can be used as a cloud-init script.

  • providers.azure.preflightScriptPath optional path to script which will be executed during System provisioning by Puddle. This is not a cloud-init script, but a shell script which is executed after cloud init is finished.

  • providers.azure.packerVmNames optional list of VM names used by Packer. Should be used, if custom naming policies are enforced. Defaults to list from “packer-builder-01” to “packer-builder-10”. Number of elements in this list determines how many images can be built in parallel.

  • providers.azure.packerCustomDataScriptPath optional path to script with custom data to supply to the machine when building new image. This can be used as a cloud-init script.

  • providers.azure.packerPreflightScriptPath optional path to script which will be executed at the beginning of image build process. This is not a cloud-init script, but a shell script which is executed after cloud init is finished.

  • providers.azure.packerRebootAfterPreflight should be true/false and is false by default. If true, then the Packer VM is rebooted after executing preflight script (even if there no script configured).

  • providers.azure.packerPostflightScriptPath optional path to script which will be executed at the end of image build process. This is not a cloud-init script, but a shell script which is executed after cloud init is finished.

  • providers.azure.packerRebootAfterPostflight should be true/false and is false by default. If true, then the Packer VM is rebooted after executing postflight script (even if there no script configured).

  • providers.azure.storageDiskLun should be the LUN of the storage data disk, defaults to 0.

  • providers.azure.storageDiskFileSystem should be the filesystem used with storage data disk, default to ext4.

  • providers.azure.storageDiskDevice should be the path to the device used as a storage data disk, defaults to /dev/sdc.

  • providers.azure.vmNamePrefix should be prefix added to every VM name, might be empty, defaults to “puddle-“.

  • providers.azure.vmNameRegexp should be the regexp used to validate VM name (before the prefix is added). Defaults to “^[-0-9a-z]*[0-9a-z]$”.

  • providers.azure.vmNameRegexpDescription should be the human-readable explanation of the regexp used to validate VM name. Defaults to “lowercase letters, numbers and hyphens only, cannot end with hyphen”.

  • providers.azure.vmOwnerTagKey should be a string and is empty by default, Unless empty, a tag will be added to the new VMs created by Puddle, the value is owner’s email. If owner has no email, the this tag is not added.

  • providers.azure.vmTags contains any additional tags which should be applied to the provisioned VMs.

  • providers.aws.enabled should be true/false and is false by default. If true then Amazon AWS is enabled as provider in Puddle. All variables under providers.aws must be set if enabled.

  • providers.aws.owner should be the owner of the newly created resources (if you followed AWS setup guide then use value of ${ACCOUNT}).

  • providers.aws.vpcId should be the ID of the VPC where Virtual machines will be launched (if you followed AWS setup guide then use value of ${VPC_ID}).

  • providers.aws.sgIds should be the list of IDs of the Security Groups applied to provisioned Virtual machines (if you followed AWS setup guide then use value of ${VM_SG_ID}).

  • providers.aws.subnetId should be the ID of the Subnet where Virtual machines will be placed (if you followed AWS setup guide then use value of ${SUBNET_PRIVATE_ID}).

  • providers.aws.iamInstanceProfile should be the name of the IAM Instance Profile assigned to the Virtual machines (if you followed AWS setup guide then use value of ${MVM_INSTANCE_PROFILE_NAME}).

  • providers.aws.publicIpEnabled should be true/false and is false by default. If true, then no public IP will be assigned. Must be set to true if at least one of packer, terraform, backend or webclient uses public IP.

  • providers.aws.packerInstanceType should be the instance type used by packer to build images, defaults to p3.2xlarge.

  • providers.aws.encryptEBSVolume should be true/false and is false by default. If true then EBS Volumes are encrypted using KMS Key. The KMS Key is unique for every system.

  • providers.aws.ebsKMSKeyArn` should be the arn of KMS key used to encrypt all VMs. If this is empty then a new KMS is created for every VM.

  • providers.aws.metadataEndpointIAMRole should be URL which is used to check assigned IAM role. Defaults to http://169.254.169.254/latest/meta-data/iam/info.

  • providers.aws.suppressIAMRoleCheck should be true/false and is false by default. If true then Puddle does not try to obtain assigned IAM role from AWS Metadata endpoint.

  • providers.aws.sourceAMIOwner owner of the AMI used as source for newly built Puddle AMIs. Defaults to 099720109477 (Canonical).

  • providers.aws.sourceAMINameFilter name of the image, with wildcards, which should be used as source for newly built Puddle images. Defaults to ubuntu/images/ubuntu-xenial-16.04-amd64-server-.

  • providers.aws.packerRunTags map of tags used for Packer EC2 instance and Volume. These tags are not applied to produced AMI.

  • providers.aws.amiTags map of tags used for AMIs built by Puddle.

  • providers.aws.userDataScriptPath optional path to script with custom user data script which should be used when launching new systems.

  • providers.aws.preflightScriptPath optional path to script which will be executed during System provisioning by Puddle. This is not a cloud-init script, but a shell script which is executed after cloud init is finished.

  • providers.aws.packerVmNames optional list of VM names used by Packer. Should be used, if custom naming policies are enforced. Defaults to list from “packer-builder-01” to “packer-builder-10”. Number of elements in this list determines how many images can be built in parallel.

  • providers.aws.packerUserDataScriptPath optional path to script with custom user data script which should be used when building new images.

  • providers.aws.packerPreflightScriptPath optional path to script which will be executed at the beginning of image build process. This is not a cloud-init script, but a shell script which is executed after cloud init is finished.

  • providers.aws.packerRebootAfterPreflight should be true/false and is false by default. If true, then the Packer VM is rebooted after executing preflight script (even if there no script configured).

  • providers.aws.packerPostflightScriptPath optional path to script which will be executed at the end of image build process. This is not a cloud-init script, but a shell script which is executed after cloud init is finished.

  • providers.aws.packerRebootAfterPostflight should be true/false and is false by default. If true, then the Packer VM is rebooted after executing postflight script (even if there no script configured).

  • providers.aws.storageEBSDeviceName should be the device name used when attaching EBS Volume, defaults to /dev/sdf

  • providers.aws.storageDiskFileSystem should be the filesystem used with storage data disk, default to ext4.

  • providers.aws.storageDiskDevice should be the path to the device used as a storage data disk, defaults to /dev/nvme1n1.

  • providers.aws.vmNamePrefix should be prefix added to every VM name, might be empty, defaults to “puddle-“.

  • providers.aws.vmNameRegexp should be the regexp used to validate VM name (before the prefix is added). Defaults to “^[-0-9a-z]*[0-9a-z]$”.

  • providers.aws.vmNameRegexpDescription should be the human-readable explanation of the regexp used to validate VM name. Defaults to “lowercase letters, numbers and hyphens only, cannot end with hyphen”.

  • providers.aws.disableFSR.checkInterval interval how often should Puddle check available snapshots and disable their enabled FSRs. Defaults to 15 minutes.

  • providers.aws.disableFSR.snapshotsBatchSize how many snapshots should be checked in one batch. Defaults to 20.

  • providers.aws.disableFSR.snapshotsBatchInterval interval how long should Puddle wait before processing next snapshots batch. Defaults to 5 seconds.

  • providers.aws.vmOwnerTagKey should be a string and is empty by default, Unless empty, a tag will be added to the new VMs created by Puddle, the value is owner’s email. If owner has no email, the this tag is not added.

  • providers.aws.vmTags contains any additional tags which should be applied to the provisioned VMs.

  • providers.aws.orphanedInstancesFinder.enabled should be true/false and is true by default. If true, then Puddle searches for orphaned instances every hour.

  • providers.aws.orphanedInstancesFinder.action should be one of none, stopAndTag and is stopAndTag by default. none action just logs the orphaned instances and does nothing about them. stopAndTag in addition stops them and adds the marker tag.

  • providers.aws.orphanedInstancesFinder.findBy.key should be tag name by which Puddle searches for orphaned instances. Injected to vmTags if not there.

  • providers.aws.orphanedInstancesFinder.findBy.value should be tag value by which Puddle searches for orphaned instances.

  • providers.aws.orphanedInstancesFinder.marker.key should be name of the tag added after an orphaned instance is stopped by Puddle.

  • providers.aws.orphanedInstancesFinder.marker.value should be value of the tag added after an orphaned instance is stopped by Puddle.

  • providers.gcp.enabled should be true/false and is false by default. If true then Google GCP is enabled as provider in Puddle. At least the variables providers.gcp.project and providers.gcp.zone must be set if enabled.

  • providers.gcp.project should be id of the project that will host the newly created resources.

  • providers.gcp.zone should be the GCE Zone that will host the newly created resources.

  • providers.gcp.network should be the name of the network that will host the newly created VMs, defaults to “default”. Optional if providers.gcp.subnetwork is set (needs to point to the subnet’s network).

  • providers.gcp.subnetwork should the name of the subnetwork that will host the newly created VMs, required for custom subnetmode networks, has to be in a region that includes providers.gcp.zone, has to be in providers.gcp.network if specified (incl. the default), defaults to empty.

  • providers.gcp.publicIpEnabled should be true/false and is false by default. If true, then no public IP will be assigned to Puddle-managed VMs. Must be set to true if at least one of packer, terraform, backend or webclient uses public IP.

  • providers.gcp.encryptVolume should be true/false and is false by default. If true, all systems’ VM volumes will be encrypted. If true, either providers.gcp.volumeKmsKeyId or providers.gcp.volumeKmsKeyRingName and providers.gcp.volumeKmsKeyRingLocation have to be set.

  • providers.gcp.volumeKmsKeyId should be the full resource name of the key used to encrypt all VMs, for example projects/XXX/locations/XXX/keyRings/XXX/cryptoKeys/XXX. If empty and providers.gcp.encryptVolume is true then a new KMS is created for every system, defaults to empty.

  • providers.gcp.volumeKmsKeyRingName should be the name of the KMS key ring in which unique volume KMS keys will be created. Ignored if providers.gcp.volumeKmsKeyId is set.

  • providers.gcp.volumeKmsKeyRingLocation should be the location of the KMS key ring in which unique volume KMS keys will be created. Ignored if providers.gcp.volumeKmsKeyId is set.

  • providers.gcp.serviceAccountEmail should be the service account used for Puddle system VMs, uses the default GCE service account if empty, defaults to empty.

  • providers.gcp.sshUsername should be the username for SSH/SCP, defaults to “puddle”.

  • providers.gcp.storageDiskFileSystem should be the file system name used for storage disks (must be compatible with mkfs on the image), defaults to “ext4”.

  • providers.gcp.startupScriptPath optional path to script used as input for startup script (cloud init).

  • providers.gcp.preflightScriptPath optional path to script which will be executed during System provisioning by Puddle. This is not a cloud-init script, but a shell script which is executed after cloud init is finished.

  • providers.gcp.imageLabels should be map of labels to be applied to the images built by Puddle, see https://cloud.google.com/compute/docs/labeling-resources for value restrictions.

  • providers.gcp.packerVmNames optional list of VM names used by Packer. Should be used, if custom naming policies are enforced. Defaults to list from “packer-builder-01” to “packer-builder-10”. Number of elements in this list determines how many images can be built in parallel.

  • providers.gcp.packerServiceAccountEmail should be the service account used for Puddle Packer VMs, uses the default GCE service account if empty, defaults to empty.

  • providers.gcp.packerSourceImageProject should be the project that hosts the image family to be used as source for newly built Puddle images, defaults to “ubuntu-os-cloud”.

  • providers.gcp.packerSourceImageFamily should be the image family that should be used as source for newly built Puddle images, defaults to “ubuntu-1604-lts”.

  • providers.gcp.packerInstanceType should be the machine type used by Packer to build images, defaults to “n1-highmem-8”.

  • providers.gcp.packerAcceleratorType should be the type of accelerators to be attached to the VM used by Packer to build images, defaults to “nvidia-tesla-v100”. Needs to be available in providers.gcp.zone.

  • providers.gcp.packerAcceleratorCount should be the number of accelerators to be attached to the VM used by Packer to build images, must be >= 0, defaults to 1.

  • providers.gcp.packerStartupScriptPath optional path to script used as input for startup script (cloud init) in packer VMs.

  • providers.gcp.packerPreflightScriptPath optional path to script which will be executed at the beginning of image build process. This is not a cloud-init script, but a shell script which is executed after cloud init is finished.

  • providers.gcp.packerRebootAfterPreflight should be true/false and is false by default. If true, then the Packer VM is rebooted after executing preflight script (even if there no script configured).

  • providers.gcp.packerPostflightScriptPath optional path to script which will be executed at the end of image build process. This is not a cloud-init script, but a shell script which is executed after cloud init is finished.

  • providers.gcp.packerRebootAfterPostflight should be true/false and is false by default. If true, then the Packer VM is rebooted after executing postflight script (even if there no script configured).

  • providers.gcp.packerRunLabels should be map of labels used for Packer VMs and Volumes, these labels are not applied to the resulting image, see https://cloud.google.com/compute/docs/labeling-resources for value restrictions.

  • providers.gcp.packerRunNetworkTags should be list of network tags applied to Packer VMs. See https://cloud.google.com/vpc/docs/add-remove-network-tags for more details.

  • providers.gcp.vmNamePrefix should be prefix added to every VM name, might be empty, defaults to “puddle-“.

  • providers.gcp.vmNameRegexp should be the regexp used to validate VM name (before the prefix is added). Defaults to “^[-0-9a-z]*[0-9a-z]$”.

  • providers.gcp.vmNameRegexpDescription should be the human-readable explanation of the regexp used to validate VM name. Defaults to “lowercase letters, numbers and hyphens only, cannot end with hyphen”.

  • providers.gcp.runNetworkTags should be list of network tags applied to all VMs managed by Puddle (except Packer VMs, use providers.gcp.packerRunTags to configure network tags for Packer VMs).

  • providers.gcp.backendServiceAccountEmail should be the service account used for Puddle Backend VM. Must be set if providers.gcp.useOsLogin is true.

  • providers.gcp.useOsLogin should be true/false and is false by default. If true, OS Login is used for SSH connections. OS Login must be configured on project level before enabling this option.

  • providers.gcp.vmOwnerTagKey should be a string and is empty by default, Unless empty, a tag will be added to the new VMs created by Puddle, the value is owner’s email. If owner has no email, the this tag is not added.

  • providers.gcp.vmTags contains any additional tags which should be applied to the provisioned VMs.

  • products.dai.configTomlTemplatePath should be the path to custom config.toml file, which will be used as default configuration for all new Driverless AI Systems. If not set, the default file is used.

  • products.dai.license should be the path to DriverlessAI license file. If set, then this license will be automatically installed on all provisioned systems.

  • products.dai.authType should be local/openid and defaults to local. Local auth uses the htpasswd file injected by Puddle. OpenID auth uses the OpenID Connect. If openid is set, then all of the products.dai.openid.* values are required.

  • products.dai.openid.baseURL should be the base url of all the OpenID endpoints. For example if the authorization endpoint is https://example.com/auth/realms/master/protocol/openid-connect/auth then the baseURL should be https://example.com/auth/realms/master/protocol/openid-connect.

  • products.dai.openid.configurationURL should be the absolute url of configuration endpoint, for example https://example.com/auth/realms/master/.well-known/openid-configuration

  • products.dai.openid.introspectionURL should be the absolute url of introspection endpoint, for example https://example.com/auth/realms/master/protocol/openid-connect/token/introspect

  • products.dai.openid.authURLSuffix should be the URL suffix for the authorization endpoint. It can be obtained from the configuration URL response.

  • products.dai.openid.tokenURLSuffix should be the URL suffix for the token endpoint. It can be obtained from the configuration URL response.

  • products.dai.openid.userinfoURLSuffix should be the URL suffix for the userinfo endpoint. It can be obtained from the configuration URL response.

  • products.dai.openid.endSessionURLSuffix should be the URL suffix for the logout endpoint. It can be obtained from the configuration URL response.

  • products.dai.openid.clientId should be the client id used by Driverless AI to query the identity provider.

  • products.dai.openid.clientSecret should be the client secret used by Driverless AI to query the identity provider.

  • products.dai.openid.scope should be array of required scopes. Usually [openid, profile, email] is sufficient.

  • products.dai.openid.usernameFieldName should be the name of the field in the ID token. Value of this field is then used as username.

  • products.dai.openid.userinfoAuthKey should be the name of the field in Access Token. Value of this field is then used to authorize the user access. Please note, that the value of this field must match the sub from ID token. In most cases this should be sub.

  • products.dai.openid.clientTokens.clientId should be the client id used by Driverless AI Python Client. This client must support PKCE flow without client secret.

  • products.dai.openid.clientTokens.issuer should be the issuer of tokens used by Driverless AI Python Client.

  • products.dai.openid.clientTokens.scope should be the scopes used by Driverless AI Python Client. Usually [openid, offline_access] is sufficient.

  • products.dai.googleAnalytics.usageStatsOptIn should be true/false and is true by default. If true, opt-in for usage statistics and bug reporting.

  • products.dai.googleAnalytics.exceptionTrackerOptIn should be true/false and is false by default. If true, opt-in for full tracebacks tracking.

  • products.dai.googleAnalytics.autodlMessagesTrackerOptIn should be true/false and is true by default. If true, opt-in for experiment preview and summary messages tracking.

  • products.h2o3.authEnabled should be true/false and is false by default. If true the H2O-3 has Basic Auth enabled. Use of reverse proxy is recommended in this case to enable one-click login to H2O-3.

  • logs.dir should be set to a directory where logs should be placed.

  • logs.maxSize should be the max size of log file, in MB, defaults to 1000.

  • logs.maxBackups should be the number of old files retained, defaults to 15.

  • logs.maxAge should be the max age of retained files, in days, defaults to 60. Older files are always deleted.

  • logs.compress should be true/false and is true by default. If true then the files will be compressed when rotating.

  • logs.level log level to use, should be trace/debug/info/warning/error/fatal and is trace by default.

  • logs.colored should be true/false and is true by default. If true, logs will be color coded.

  • mailing.enabled should be true/false. If true then mailing is enabled. All fields under mailing are mandatory if this is set to true.

  • mailing.server should be the hostname and port of the SMTP server, for example smtp.example.com:587.

  • mailing.username should be the client username.

  • mailing.password should be the client password.

  • mailing.fromAddress should be the email address used as FROM, for example in case of an address ‘<Puddle> puddle@h2o.ai’ this field should be set to puddle@h2o.ai.

  • mailing.fromName should be the name used as FROM, defaults to Puddle, for example in case of an address ‘<Puddle> puddle@h2o.ai’ this field should be set to Puddle.

  • mailing.recipients should be the space-separated list of recipients.

  • mailing.offsetHours should be a number of hours between repeated email notifications, defaults to 24, does not apply to FAILED system notifications.

  • idleTimeout.options should be a mapping from labels to values (in minutes) of possible idle timeout options. Use -1 as value for option to never time out.

Configure Traefik - Puddle part

In Reverse Proxy Setup section we have configured and started the Traefik reverse proxy. Now, we will finish the reverse proxy setup on Puddle side.

Since HTTPS is required between ReverseProxy <-> Puddle, make sure the following is set in /etc/puddle/config.yaml:

tls:
    certFile: /opt/h2oai/puddle/certs/server/cert.pem
    keyFile: /opt/h2oai/puddle/certs/server/key.pem

Set in /opt/h2oai/puddle/data/traefik/puddle.yaml a field http.services.puddle.loadBalancer.servers to contain an element - url: https://localhost:8081:

http:
    routers:
        puddle:
            rule: "PathPrefix(`/`, `/api-token/`) || Path(`/api-keys`)"
            service: puddle
            tls: {}
            priority: 1
    services:
        puddle:
            loadBalancer:
                servers:
                    - url: https://localhost:8081

Puddle should run on a custom port. This port has to match the port in Puddle Default Rule in Traefik config (/opt/h2oai/puddle/data/traefik/puddle.yaml). Make sure that port in connection.port (in /etc/puddle/config.yaml) and the one used in Puddle Default Rule matches. By default the port should be 8081.

Finally, make sure that reverseProxy.* is configured correctly in /etc/puddle/config.yaml. By default the reverse proxy should be enabled (reverseProxy.enabled: true) and the paths to keys and certificates should match paths from the keys and certificates generated from section Generate certificates in Reverse Proxy Setup:

reverseProxy:
    enabled: true
    port: 443
    caCertificate: /opt/h2oai/puddle/certs/ca/cert.pem
    caPrivateKey: /opt/h2oai/puddle/certs/ca/key.pem
    clientCertificate: /opt/h2oai/puddle/certs/client/cert.pem
    clientPrivateKey: /opt/h2oai/puddle/certs/client/key.pem

Now the Traefik reverse proxy is configured on Puddle side.

Configuring Environment Variables

The next step is to to fill in the variables in EnvironmentFile file, which is located at /etc/puddle/EnvironmentFile. The EnvironmentFile should contain the following:

# Should point to dir with config.yaml
PUDDLE_config_dir='/etc/puddle/'

# AzureRM Provider should skip registering the Resource Providers
ARM_SKIP_PROVIDER_REGISTRATION=true

# Azure related environment variables, please fill-in all values if you use Azure as provider
# AZURE_SUBSCRIPTION_ID='YOUR-SUBSCRIPTION-ID'
# AZURE_TENANT_ID='YOUR-TENANT-ID'
# AZURE_CLIENT_ID='YOUR-CLIENT-ID'
# AZURE_CLIENT_SECRET='YOUR-CLIENT-SECRET'

# AWS related environment variables
# Fill-in the following credentials, unless you use IAM role attached to EC2 instance
# AWS_ACCESS_KEY_ID='YOUR-AWS-ACCESS-KEY-ID'
# AWS_SECRET_ACCESS_KEY='YOUR-AWS-SECRET-ACCESS-KEY'
# [Required] region is always required when using AWS as provider
# AWS_REGION='AWS-REGION'

# General variables, delete those which are not necessary
# http_proxy=http://10.0.0.100:3128
# https_proxy=http://10.0.0.100:3128
# no_proxy=localhost,127.0.0.1

  • PUDDLE_config_dir directory where the config.yaml file is present.

  • ARM_SKIP_PROVIDER_REGISTRATION - AzureRM Provider should skip registering the Resource Providers. This should be left as true.

  • AZURE_SUBSCRIPTION_ID is the ID of the subscription that should be used. This value can be found in following way:

    • Search for Subscriptions.
    • Use the SUBSCRIPTION ID of the subscription you want to use.

  • AZURE_TENANT_ID is ID of tenant that should be used. This value can be found in following way:

    • Select Azure Active Directory blade.
    • Select App registrations (preview).
    • Select the newly created App registration.
    • Use Directory (tenant) ID.

  • AZURE_CLIENT_ID is the Application ID that should be used. This value can be found in following way:

    • Select Azure Active Directory blade.
    • Select App registrations (preview).
    • Select the newly created App registration.
    • Use Application (client) ID.

  • AZURE_CLIENT_SECRET client secret that should be used. This value can be found in following way:

    • Select the Azure Active Directory blade.
    • Select App registrations (preview).
    • Select the newly created App registration.
    • Select Certificates & Secrets.
    • Click New client secret.
    • Fill in the form and click Add.
    • The secret value should be visible. Copy it because after refreshing the page, this value is gone and cannot be restored.

  • AWS_ACCESS_KEY_ID AWS Access Key Id used by Puddle to access the AWS services.

  • AWS_SECRET_ACCESS_KEY AWS Secret Access Key used by Puddle to access the AWS services.

  • AWS_REGION AWS Region used by Puddle to access the AWS services.

  • http_proxy is the URL of proxy server to be used (if required), for example http://10.0.0.3:3128.

  • https_proxy is the URL of proxy server to be used (if required), for example http://10.0.0.3:3128.

  • no_proxy is the comma-separated list of hosts that should be excluded from proxying, for example localhost,127.0.0.1.

Note that you don’t need to enter credentials on GCP by default, since Puddle uses application default credentials (i.e., the VM service account).

Running Puddle

After all of the previous steps are successfully completed, we can now start Puddle. Execute the following command to start the server and web UI:

systemctl start puddle

Puddle is accessible on port 443 if HTTPS is enabled, or on port 80 if HTTP is being used.

First Steps

At first, you will have to perform some initialization steps:

  1. Log in to Puddle as the Administrator.
  2. Go to Administration > Check Updates.
  3. Either use the update plan from the default URL location, or specify a custom update plan file.
  4. Click Submit.
  5. Review the plan and click Apply.
  6. Go to Administration > Images.
  7. Build all the images you want to use. Please be aware this can take up to 1 hour.

Once the images are built, your Puddle instance is ready.

Stats Board (Optional)

The stats board is an optional component. It’s distributed as Python wheel, and it requires Python 3.6. It’s recommended (although not necessary) to run the board inside a virtual environment.

Use the following to install the required dependencies:

apt install gcc libpq-dev python3.6-dev python-virtualenv

yum install epel-release
yum install gcc postgresql-devel python36-devel python-virtualenv

Use the following to create the virtualenv:

mkdir -p /opt/h2oai/puddle/envs
cd /opt/h2oai/puddle/envs
virtualenv -p python3.6 puddle-stats-env

Please make sure that the virtualenv uses the same name and is available at the same path as in this provided snippet. Otherwise the systemd script used to manage Stats Board will not work.

Use the following to install the stats board. Please note that this command will install dependencies as well:

source /opt/h2oai/puddle/envs/puddle-stats-env/bin/activate
pip install puddle_stats_board-<VERSION>-py3-none-any.whl

Use the following to run the stats board:

systemctl start puddle-dashboard

The stats board is running on port 8050 and is accessible from Puddle UI at http://<PUDDLE_SERVER_ADDRESS>/board. There is a link in the Administration menu as well.