Creates a GCP cluster

POST 
https://api.spectrocloud.com/v1/spectroclusters/gcp

Creates a GCP cluster

Request

application/json

Body

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespacestring

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

resourceVersionstring

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

selfLinkstring

SelfLink is a URL representing this object. Populated by the system. Read-only.

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

object

cloudAccountUidstringrequired

Cloud account uid to be used for cluster provisioning

cloudConfig

object

required

Cluster level configuration for gcp cloud and applicable for all the machine pools

managedClusterConfig

object

GCP managed cluster config

enableAutoPilotboolean

EnableAutopilot indicates whether to enable autopilot for this GKE cluster

locationstring

Can be Region or Zone

networkstring

NetworkName if empty would create VPC Network in auto mode. If provided, custom VPC network will be used

projectstringrequired

Name of the project in which cluster is to be deployed

regionstringrequired

GCP region for the cluster

clusterConfig

object

General cluster configuration like health, patching settings, namespace resource allocation, rbac

fips

FIPS configuration

modestring

Possible values: [fipsEnabled, fipsDisabled]

Default value: fipsDisabled

enable or disable the FIPS complaint

hostClusterConfig

clusterEndpoint

host cluster configuration

config

ingressConfig

Ingress configuration for exposing the virtual cluster's kube-apiserver

hoststring

portint64

loadBalancerConfig

Load balancer configuration for exposing the virtual cluster's kube-apiserver

externalIPsstring[]

externalTrafficPolicystring

loadBalancerSourceRangesstring[]

typestring

Possible values: [Ingress, LoadBalancer]

is enabled as host cluster

clusterGroup

object

ObjectReference contains enough information to let you inspect or modify the referred object.

apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

hostCluster

object

ObjectReference contains enough information to let you inspect or modify the referred object.

apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

isHostClusterboolean

Default value: false

is enabled as host cluster

lifecycleConfig

pauseboolean

Default value: false

enable pause life cycle config

location

object

Cluster location information

countryCodestring

country code for cluster location

countryNamestring

country name for cluster location

geoLoc

object

Geolocation Latlong entity

latitudefloat64

Latitude of a resource

longitudefloat64

Longitude of a resource

regionCodestring

region code for cluster location

regionNamestring

region name for cluster location

machineManagementConfig

object

osPatchConfig

object

Os patch config contains properties to patch node os with latest security packages. If OsPatchConfig is not provided then node os will not be patched with latest security updates.

onDemandPatchAfterdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

patchOnBootboolean

PatchOnBoot indicates need to do patch when node first boot up, only once

rebootIfRequiredboolean

Reboot once the OS patch is applied

schedulestring

The schedule at which security patches will be applied to OS. Schedule should be in Cron format, see https://en.wikipedia.org/wiki/Cron for more help.

resources

object

namespaces

object[]

Array [

metadata

object

ObjectMeta update entity with uid as input

annotations

object

property name*string

labels

object

property name*string

namestring

uidstring

spec

Cluster namespace spec

isRegexboolean

relatedObject

object

Object for which the resource is related

kindstring

Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

namestring

uidstring

resourceAllocation

Cluster namespace resource allocation

cpuCoresnumber

memoryMiBnumber

]

rbacs

object[]

Array [

metadata

object

ObjectMeta update entity with uid as input

annotations

object

property name*string

labels

object

property name*string

namestring

uidstring

spec

object

Cluster RBAC spec

bindings

object[]

Array [

namespacestring

role

object

Cluster role ref

kindstring

Possible values: [Role, ClusterRole]

namestring

subjects

object[]

Array [

namestring

namespacestring

typestring

Possible values: [User, Group, ServiceAccount]

]

typestring

Possible values: [RoleBinding, ClusterRoleBinding]

]

relatedObject

object

Object for which the resource is related

kindstring

Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

namestring

uidstring

]

updateWorkerPoolsInParallelboolean

machinepoolconfig

object[]

Array [

cloudConfig

object

required

azsstring[]

instanceTypestringrequired

rootDeviceSizeint64

Size of root volume in GB. Default is 30GB

subnetstring

Subnet specifies the subnetwork to use for given instance. If not specified, the first subnet from the cluster region and network is used

subnets

undefined[]

Array [

azstring

idstring

]

poolConfig

object

Machine pool configuration for the cluster

additionalLabels

object

Additional labels to be part of the machine pool

property name*string

additionalTags

object

AdditionalTags is an optional set of tags to add to resources managed by the provider, in addition to the ones added by default. For eg., tags for EKS nodeGroup or EKS NodegroupIAMRole

property name*string

isControlPlaneboolean

Whether this pool is for control plane

labelsstring[]required

Labels for this machine pool, example: master/worker, gpu, windows

maxSizeint32

Max size of the pool, for scaling

minSizeint32

Min size of the pool, for scaling

namestringrequired

sizeint32required

Size of the pool, number of nodes/machines

taints

object[]

Master or worker taints

Array [

effectstring

Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

keystring

The taint key to be applied to a node

timeAddeddate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

valuestring

The taint value corresponding to the taint key.

]

updateStrategy

object

Rolling update strategy for this machine pool if not specified, will use ScaleOut

typestring

Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]

update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut

useControlPlaneAsWorkerboolean

If IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools

profileConfig

object

infraProfileUidstringrequired

InfraClusterProfile uid for the machine pool

packValues

object[]

Array [

manifests

undefined[]

Pack manifests are additional content as part of the profile

Array [

contentstring

Manifest content in yaml

namestringrequired

Manifest name

uidstring

Manifest uid

]

namestringrequired

Pack name

tagstring

Pack version tag

typestring

Possible values: [spectro, helm, manifest, oci]

Default value: spectro

valuesstring

Pack values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values

]

]

policies

object

Cluster policies

backupPolicy

Cluster backup config

backupLocationNamestring

backupLocationUidstring

backupNamestring

backupPrefixstring

durationInHoursint64

includeAllDisksboolean

includeClusterResourcesboolean

locationTypestring

namespacesstring[]

schedule

Cluster feature schedule

scheduledRunTimestring

scanPolicy

Cluster compliance scan schedule configuration

kubeBench

Cluster compliance scan schedule config for kube bench driver

schedule

Cluster feature schedule

scheduledRunTimestring

kubeHunter

Cluster compliance scan schedule config for kube hunter driver

schedule

Cluster feature schedule

scheduledRunTimestring

sonobuoy

Cluster compliance scan schedule config for sonobuoy driver

schedule

Cluster feature schedule

scheduledRunTimestring

profiles

object[]

Array [

packValues

object[]

Cluster profile packs array

Array [

manifests

undefined[]

Pack manifests are additional content as part of the profile

Array [

contentstring

Manifest content in yaml

namestringrequired

Manifest name

uidstring

Manifest uid

]

namestringrequired

Pack name

tagstring

Pack version tag

typestring

Possible values: [spectro, helm, manifest, oci]

Default value: spectro

valuesstring

Pack values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values

]

replaceWithProfilestring

Cluster profile uid to be replaced with new profile

uidstring

Cluster profile uid

]

Responses

201

Created successfully

Response Headers

• AuditUid

  string

  Audit uid for the request

application/json

Schema

Schema

uidstringrequired

Example (from schema)

{
  "uid": "string"
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/spectroclusters/gcp' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-01T22:51:14.860Z",
    "deletionTimestamp": "2024-07-01T22:51:14.860Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-01T22:51:14.860Z",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "cloudAccountUid": "string",
    "cloudConfig": {
      "managedClusterConfig": {
        "enableAutoPilot": true,
        "location": "string"
      },
      "network": "string",
      "project": "string",
      "region": "string"
    },
    "clusterConfig": {
      "fips": {
        "mode": "fipsDisabled"
      },
      "hostClusterConfig": {
        "clusterEndpoint": {
          "config": {
            "ingressConfig": {
              "host": "string",
              "port": 0
            },
            "loadBalancerConfig": {
              "externalIPs": [
                "string"
              ],
              "externalTrafficPolicy": "string",
              "loadBalancerSourceRanges": [
                "string"
              ]
            }
          },
          "type": "Ingress"
        },
        "clusterGroup": {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        },
        "hostCluster": {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        },
        "isHostCluster": false
      },
      "lifecycleConfig": {
        "pause": false
      },
      "location": {
        "countryCode": "string",
        "countryName": "string",
        "geoLoc": {
          "latitude": 0,
          "longitude": 0
        },
        "regionCode": "string",
        "regionName": "string"
      },
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "2024-07-01T22:51:14.861Z",
          "patchOnBoot": true,
          "rebootIfRequired": true,
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "isRegex": true,
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": 0,
                "memoryMiB": 0
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "Role",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "User"
                    }
                  ],
                  "type": "RoleBinding"
                }
              ],
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": true
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "rootDeviceSize": 0,
          "subnet": "string",
          "subnets": [
            {
              "az": "string",
              "id": "string"
            }
          ]
        },
        "poolConfig": {
          "additionalLabels": {},
          "additionalTags": {},
          "isControlPlane": true,
          "labels": [
            "string"
          ],
          "maxSize": 0,
          "minSize": 0,
          "name": "string",
          "size": 0,
          "taints": [
            {
              "effect": "NoSchedule",
              "key": "string",
              "timeAdded": "2024-07-01T22:51:14.861Z",
              "value": "string"
            }
          ],
          "updateStrategy": {
            "type": "RollingUpdateScaleOut"
          },
          "useControlPlaneAsWorker": true
        },
        "profileConfig": {
          "infraProfileUid": "string",
          "packValues": [
            {
              "manifests": [
                {
                  "content": "string",
                  "name": "string",
                  "uid": "string"
                }
              ],
              "name": "string",
              "tag": "string",
              "type": "spectro",
              "values": "string"
            }
          ]
        }
      }
    ],
    "policies": {
      "backupPolicy": {
        "backupLocationName": "string",
        "backupLocationUid": "string",
        "backupName": "string",
        "backupPrefix": "string",
        "durationInHours": 0,
        "includeAllDisks": true,
        "includeClusterResources": true,
        "locationType": "string",
        "namespaces": [
          "string"
        ],
        "schedule": {
          "scheduledRunTime": "string"
        }
      },
      "scanPolicy": {
        "kubeBench": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "kubeHunter": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "sonobuoy": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        }
      }
    },
    "profiles": [
      {
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "spectro",
            "values": "string"
          }
        ],
        "replaceWithProfile": "string",
        "uid": "string"
      }
    ]
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Body

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-01T22:51:14.860Z",
    "deletionTimestamp": "2024-07-01T22:51:14.860Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-01T22:51:14.860Z",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "cloudAccountUid": "string",
    "cloudConfig": {
      "managedClusterConfig": {
        "enableAutoPilot": true,
        "location": "string"
      },
      "network": "string",
      "project": "string",
      "region": "string"
    },
    "clusterConfig": {
      "fips": {
        "mode": "fipsDisabled"
      },
      "hostClusterConfig": {
        "clusterEndpoint": {
          "config": {
            "ingressConfig": {
              "host": "string",
              "port": 0
            },
            "loadBalancerConfig": {
              "externalIPs": [
                "string"
              ],
              "externalTrafficPolicy": "string",
              "loadBalancerSourceRanges": [
                "string"
              ]
            }
          },
          "type": "Ingress"
        },
        "clusterGroup": {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        },
        "hostCluster": {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        },
        "isHostCluster": false
      },
      "lifecycleConfig": {
        "pause": false
      },
      "location": {
        "countryCode": "string",
        "countryName": "string",
        "geoLoc": {
          "latitude": 0,
          "longitude": 0
        },
        "regionCode": "string",
        "regionName": "string"
      },
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "2024-07-01T22:51:14.861Z",
          "patchOnBoot": true,
          "rebootIfRequired": true,
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "isRegex": true,
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": 0,
                "memoryMiB": 0
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "Role",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "User"
                    }
                  ],
                  "type": "RoleBinding"
                }
              ],
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": true
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "rootDeviceSize": 0,
          "subnet": "string",
          "subnets": [
            {
              "az": "string",
              "id": "string"
            }
          ]
        },
        "poolConfig": {
          "additionalLabels": {},
          "additionalTags": {},
          "isControlPlane": true,
          "labels": [
            "string"
          ],
          "maxSize": 0,
          "minSize": 0,
          "name": "string",
          "size": 0,
          "taints": [
            {
              "effect": "NoSchedule",
              "key": "string",
              "timeAdded": "2024-07-01T22:51:14.861Z",
              "value": "string"
            }
          ],
          "updateStrategy": {
            "type": "RollingUpdateScaleOut"
          },
          "useControlPlaneAsWorker": true
        },
        "profileConfig": {
          "infraProfileUid": "string",
          "packValues": [
            {
              "manifests": [
                {
                  "content": "string",
                  "name": "string",
                  "uid": "string"
                }
              ],
              "name": "string",
              "tag": "string",
              "type": "spectro",
              "values": "string"
            }
          ]
        }
      }
    ],
    "policies": {
      "backupPolicy": {
        "backupLocationName": "string",
        "backupLocationUid": "string",
        "backupName": "string",
        "backupPrefix": "string",
        "durationInHours": 0,
        "includeAllDisks": true,
        "includeClusterResources": true,
        "locationType": "string",
        "namespaces": [
          "string"
        ],
        "schedule": {
          "scheduledRunTime": "string"
        }
      },
      "scanPolicy": {
        "kubeBench": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "kubeHunter": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "sonobuoy": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        }
      }
    },
    "profiles": [
      {
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "spectro",
            "values": "string"
          }
        ],
        "replaceWithProfile": "string",
        "uid": "string"
      }
    ]
  }
}