Connect to NuoDB Control Plane

This section describes how to connect to the NuoDB Control Plane REST service via CLI tools.

Prerequisites#

• nuodb-cp or cURL
• jq
• (Optional) terraform

Access and Authentication#

This guide uses port forwarding to access the REST API and provisioned databases.

kubectl port-forward svc/ingress-nginx-controller -n nginx 8443:443 2>&1 >/dev/null &

Download NuoDB Control Plain CLI tool#

curl -sL https://github.com/nuodb/nuodb-cp-releases/releases/latest/download/nuodb-cp -o /usr/local/bin/nuodb-cp
chmod a+x /usr/local/bin/nuodb-cp

Setup DBaaS credentials#

To successfully authenticate with the REST API, configure the credentials as environment variables.

export NUODB_CP_URL_BASE="https://localhost:8443/nuodb-cp"
export NUODB_CP_USER="system/admin"
export NUODB_CP_PASSWORD="$(kubectl get secret dbaas-user-system-admin -n nuodb-cp-system -o jsonpath='{.data.password}' | base64 -d)"

If the Nginx TLS certificate is not signed by a public CA, configure nuodb-cp to trust it.

kubectl get secret ingress-nginx-default-cert -n nginx -o jsonpath='{.data.ca\.crt}' | base64 -d > /tmp/ingress.pem
export NUODB_CP_TRUSTED_CERT=/tmp/ingress.pem

Configure cURL with DBaaS credentials.

alias curl="curl -s -k -u \"${NUODB_CP_USER}:${NUODB_CP_PASSWORD}\""

Setting up the Terraform Provider#

To use terraform to manage your databases, you will want to use the nuodbaas provider. The provider documentation covers all of the available attributes. All of them are optional. For any that you do not specify, the provider will try to infer a value from the environment variables set above before exiting with an error.

terraform {
  required_providers {
    nuodbaas = {
      source  = "registry.terraform.io/nuodb/nuodbaas"
      version = "1.2.0"
    }
  }
}

provider "nuodbaas" {
    # If your Control Plane certificate is not signed by a trusted CA, disable certificate validation .
    skip_verify = true
}