Create a cluster

Any user can create a cluster, providing it's within their quota. The size of the instances is from a list of sizes.

Clusters are created by sending a POST request to https://api.civo.com/v2/kubernetes/clusters.

Request

The following parameter(s) should be sent along with the request:

Response

The response is a JSON object that describes the initial setup of the cluster, future calls to get clusters may return more information (as underlying nodes are created, applications are installed, etc).

{
  "id": "69a23478-a89e-41d2-97b1-6f4c341cee70",
  "name": "your-cluster-name",
  "version": "2",
  "status": "ACTIVE",
  "ready": true,
  "num_target_nodes": 1,
  "target_nodes_size": "g2.xsmall",
  "built_at": "2019-09-23T13:04:23.000+01:00",
  "kubeconfig": "YAML_VERSION_OF_KUBECONFIG_HERE\n",
  "kubernetes_version": "0.8.1",
  "api_endpoint": "https://your.cluster.ip.address:6443",
  "dns_entry": "69a23478-a89e-41d2-97b1-6f4c341cee70.k8s.civo.com",
  "tags": [],
  "created_at": "2019-09-23T13:02:59.000+01:00",
  "instances": [{
    "hostname": "kube-master-HEXDIGITS",
    "size": "g2.xsmall",
    "region": "lon1",
    "created_at": "2019-09-23T13:03:00.000+01:00",
    "status": "ACTIVE",
    "firewall_id": "5f0ba9ed-5ca7-4e14-9a09-449a84196d64",
    "public_ip": "your.cluster.ip.address",
    "tags": ["civo-kubernetes:installed", "civo-kubernetes:master"]
  }],
  "installed_applications": [{
    "application": "Traefik",
    "title": null,
    "version": "(default)",
    "dependencies": null,
    "maintainer": "@Rancher_Labs",
    "description": "A reverse proxy/load-balancer that's easy, dynamic, automatic, fast, full-featured, open source, production proven and provides metrics.",
    "post_install": "Some documentation here\n",
    "installed": true,
    "url": "https://traefik.io",
    "category": "architecture",
    "updated_at": "2019-09-23T13:02:59.000+01:00",
    "image_url": "https://api.civo.com/k3s-marketplace/traefik.png",
    "plan": null,
    "configuration": {}
  }]
}

Example of creating a Kubernetes cluster

• Curl
• Node.js
• Ruby

curl -H "Authorization: bearer 12345" https://api.civo.com/v2/kubernetes/clusters \
  -d "name=mycluster&num_target_nodes=3&target_nodes_size=g2.small"

// At a shell prompt run:
// npm init -y
// npm i --save request

var request = require('request');

request.post(
  'https://api.civo.com/v2/kubernetes/clusters',
  {
    form: {
      name: "mycluster",
      target_nodes_size: "g2.small",
      num_target_nodes: 3
    }
  },
  function (error, response, body) {
    if (!error && response.statusCode == 200) {
      console.log(body)
    }
  }
).auth(null, null, true, '12345');

require 'net/http'

http = Net::HTTP.new('api.civo.com', 443)
http.use_ssl = true

headers = {
  'Authorization' => 'bearer 12345',
  'Content-Type' => 'application/x-www-form-urlencoded'
}

resp, data = http.post('/v2/kubernetes/clusters',
  'name=mycluster&target_nodes_size=g2.small&num_target_nodes=3',
  headers)

List clusters

A list of clusters accessible from an account is available by sending a GET request to https://api.civo.com/v2/kubernetes/clusters.

Request

This request requires no parameters.

Response

The response is a JSON array of cluster objects, like the JSON described for the `create` call above.

Example of listing clusters

• Curl
• Node.js
• Ruby

curl -H "Authorization: bearer 12345" https://api.civo.com/v2/kubernetes/clusters

// At a shell prompt run:
// npm init -y
// npm i --save request

var request = require('request');

request.get(
  'https://api.civo.com/v2/kubernetes/clusters',
  {},
  function (error, response, body) {
    if (!error && response.statusCode == 200) {
      console.log(body)
    }
  }
).auth(null, null, true, '12345');

require 'net/http'

http = Net::HTTP.new('api.civo.com', 443)
http.use_ssl = true

headers = {
  'Authorization' => 'bearer 12345',
  'Content-Type' => 'application/x-www-form-urlencoded'
}

resp, data = http.get('/v2/kubernetes/clusters', headers)

Retrieving a cluster

A single cluster's details are available by sending a GET request to https://api.civo.com/v2/kubernetes/clusters/:id.

Request

This request requires only the ID parameter in the URL.

Response

The response is a JSON object that describes the details for the cluster as described under the `create` call above.

Example of retrieving a cluster

• Curl
• Node.js
• Ruby

curl -H "Authorization: bearer 12345" https://api.civo.com/v2/kubernetes/clusters/12345
    

// At a shell prompt run:
// npm init -y
// npm i --save request

var request = require('request');

request.get(
  'https://api.civo.com/v2/kubernetes/clusters/12345',
  {},
  function (error, response, body) {
    if (!error && response.statusCode == 200) {
      console.log(body)
    }
  }
).auth(null, null, true, '12345');

require 'net/http'

http = Net::HTTP.new('api.civo.com', 443)
http.use_ssl = true

headers = {
  'Authorization' => 'bearer 12345',
  'Content-Type' => 'application/x-www-form-urlencoded'
}

resp, data = http.get('/v2/kubernetes/clusters/12345', headers)

List available versions

A list of versions available to install isavailable by sending a GET request to https://api.civo.com/v2/kubernetes/versions.

Request

This request requires no parameters.

Response

The response is a JSON array of versions available, containing at minimum:

[
  {
    version: "0.9.1",
    type: "stable",
    default: true
  },
  {
    version: "0.8.1",
    type: "legacy",
  }
]

Example of listing versions

• Curl
• Node.js
• Ruby

curl -H "Authorization: bearer 12345" https://api.civo.com/v2/kubernetes/versions

// At a shell prompt run:
// npm init -y
// npm i --save request

var request = require('request');

request.get(
  'https://api.civo.com/v2/kubernetes/versions',
  {},
  function (error, response, body) {
    if (!error && response.statusCode == 200) {
      console.log(body)
    }
  }
).auth(null, null, true, '12345');

require 'net/http'

http = Net::HTTP.new('api.civo.com', 443)
http.use_ssl = true

headers = {
  'Authorization' => 'bearer 12345',
  'Content-Type' => 'application/x-www-form-urlencoded'
}

resp, data = http.get('/v2/kubernetes/versions', headers)