Creates a virtual cluster
POST/v1/spectroclusters/virtual
Creates a virtual cluster
Request
Header Parameters
Scope the request to the specified project uid
- application/json
Body
Array [
]
Array [
Array [
Array [
]
]
]
Array [
]
Array [
Array [
Array [
]
]
]
metadata
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations
object
Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.
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.
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
Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag
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.
Name of the resource.
UID is the unique identifier generated for the resource. This is not an input field for any request.
spec
object
cloudConfig
object
Cluster level configuration for virtual cluster
controlPlaneEndpoint
object
APIEndpoint represents a reachable Kubernetes API endpoint.
The hostname on which the API server is serving.
The port on which the API server is serving.
helmRelease
object
chart
object
clusterConfig
object
required
ClusterMetaAttribute can be used to set additional cluster metadata information.
hostClusterConfig
clusterEndpoint
config
ingressConfig
Ingress configuration for exposing the virtual cluster's kube-apiserver
loadBalancerConfig
Load balancer configuration for exposing the virtual cluster's kube-apiserver
Possible values: [Ingress, LoadBalancer]
is enabled as host cluster
clusterGroup
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
hostCluster
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
Default value: false
is enabled as host cluster
lifecycleConfig
Default value: false
enable pause life cycle config
location
object
Cluster location information
country code for cluster location
country name for cluster location
geoLoc
object
Geolocation Latlong entity
Latitude of a resource
Longitude of a resource
region code for cluster location
region name for cluster location
machineManagementConfig
object
osPatchConfig
object
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.
PatchOnBoot indicates need to do patch when node first boot up, only once
Reboot once the OS patch is applied
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[]
metadata
object
ObjectMeta update entity with uid as input
annotations
object
labels
object
spec
Cluster namespace spec
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
resourceAllocation
Cluster namespace resource allocation
rbacs
object[]
metadata
object
ObjectMeta update entity with uid as input
annotations
object
labels
object
spec
object
Cluster RBAC spec
bindings
object[]
role
object
Cluster role ref
Possible values: [Role, ClusterRole]
subjects
object[]
Possible values: [User, Group, ServiceAccount]
Possible values: [RoleBinding, ClusterRoleBinding]
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
machinepoolconfig
object[]
cloudConfig
object
required
instanceType
object
required
Maximum CPU cores
Maximum memory in MiB
Maximum storage in GiB
Minimum CPU cores
Minimum memory in MiB
Minimum storage in GiB
policies
object
Cluster policies
backupPolicy
Cluster backup config
schedule
Cluster feature schedule
scanPolicy
Cluster compliance scan schedule configuration
kubeBench
Cluster compliance scan schedule config for kube bench driver
schedule
Cluster feature schedule
kubeHunter
Cluster compliance scan schedule config for kube hunter driver
schedule
Cluster feature schedule
sonobuoy
Cluster compliance scan schedule config for sonobuoy driver
schedule
Cluster feature schedule
profiles
object[]
packValues
object[]
Cluster profile packs array
manifests
undefined[]
Pack manifests are additional content as part of the profile
Manifest content in yaml
Manifest name
Manifest uid
Pack name
Pack version tag
Possible values: [spectro, helm, manifest, oci]
Default value: spectro
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
Cluster profile uid to be replaced with new profile
Cluster profile uid
Responses
- 201
Created successfully
Response Headers
AuditUid
string
Audit uid for the request
- application/json
- Schema
- Example (from schema)
Schema
{
"uid": "string"
}