Creates an EdgeNative cluster
POST/v1/spectroclusters/edge-native
Creates an EdgeNative cluster
Request
Header Parameters
Scope the request to the specified project uid
- application/json
Body
- Array [
- ]
- Array [
- 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.
Populated by the system. Read-only.
spec object
cloudConfig object
EdgeNativeClusterConfig definnes Edge Native Cluster specific Spec
controlPlaneEndpoint object
ControlPlaneEndpoint is the control plane endpoint, which can be an IP or FQDN
DDNSSearchDomain is the search domain used for resolving IP addresses when the EndpointType is DDNS. This search domain is appended to the generated Hostname to obtain the complete DNS name for the endpoint. If Host is already a DDNS FQDN, DDNSSearchDomain is not required
Host is FQDN(DDNS) or IP
Type indicates DDNS or VIP
NTPServers is a list of NTP servers to use instead of the machine image's default NTP server list
SSHKeys specifies a list of ssh authorized keys to access the vms as a 'spectro' user
StaticIP indicates if IP allocation type is static IP. DHCP is the default allocation type
clusterConfig object
General cluster configuration like health, patching settings, namespace resource allocation, rbac
ClusterMetaAttribute can be used to set additional cluster metadata information.
hostClusterConfig
clusterEndpoint
host cluster configuration
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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
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.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
Default value: false
is enabled as host cluster
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
resources object
namespaces object[]
metadata object
ObjectMeta update entity with uid as input
annotations object
labels object
Name of the resource
Populated by the system. Read-only.
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
Name of the resource
Populated by the system. Read-only.
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
edgeHosts undefined[]required
Edge host name
Edge host id
Default value: false
"Set to true if edgeHost has to be selected as a candidate for promotion to a control plane node. It is a immutable field."
nic object
Edge native nic
Deprecated - Edge host nic name
Deprecated - Edge host static IP
poolConfig object
Machine pool configuration for the cluster
additionalLabels object
Additional labels to be part of the machine pool
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
Whether this pool is for control plane
Labels for this machine pool, example: master/worker, gpu, windows
machinePoolProperties object
Machine pool specific properties
Possible values: [amd64, arm64]
Default value: amd64
Architecture type of the pool. Default value is 'amd64'
Max size of the pool, for scaling
Min size of the pool, for scaling
Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster
Size of the pool, number of nodes/machines
taints object[]
Master or worker taints
Possible values: [NoSchedule, PreferNoSchedule, NoExecute]
The taint key to be applied to a node
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.
The taint value corresponding to the taint key.
updateStrategy object
Rolling update strategy for this machine pool if not specified, will use ScaleOut
Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]
update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut
If IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools
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"
}