Skip to main content

Retrieves a list of clusters

GET 
/v1/spectroclusters

Deprecated: Use POST /v1/dashboard/spectroclusters

Request​

Query Parameters

    fields string

    Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name

    filters string

    Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws

    Server will be restricted to certain fields based on the indexed data for each resource.

    orderBy string

    Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1

    limit int64

    Default value: 50

    limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.

    offset int64

    offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.

    continue string

    continue token to paginate the subsequent data items

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses​

An array of cluster items

Schema
    items object[]required
  • Array [
    • kindstring

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

    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

    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

    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

    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 of the resource

    uidstring

    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

    SpectroClusterSpec defines the desired state of SpectroCluster

    cloudConfigRef object

    ObjectReference contains enough information to let you inspect or modify the referred 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

    uidstring

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

    cloudTypestring

    Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]

    Default value: all

    clusterConfig object

    ClusterConfig is the configuration related to a general cluster. Configuration related to the health of the cluster.

    clusterMetaAttributestring

    ClusterMetaAttribute contains additional cluster metadata information.

    clusterRbac object[]

    Deprecated. Use clusterResources

  • Array [
    • kindstring
    namestring
    uidstringrequired
  • ]
    • clusterResources object

    ClusterResources defines the managment of namespace resource allocations, role bindings.

    namespaces object[]

    Cluster namespaces

  • Array [
    • kindstring
    namestring
    uidstringrequired
  • ]
    • rbacs object[]

    Cluster RBAC role bindings

  • Array [
    • kindstring
    namestring
    uidstringrequired
  • ]
    • controlPlaneHealthCheckTimeoutstring

    ControlPlaneHealthCheckTimeout is the timeout to check for ready state of the control plane nodes. If the node is not ready within the time out set, the node will be deleted and a new node will be launched.

    hostClusterConfig

    HostClusterConfiguration defines the configuration of host clusters, where virtual clusters be deployed

    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.

    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

    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.

    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

    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

    machineHealthConfig object

    MachineHealthCheckConfig defines the healthcheck timeouts for the node. The timeouts are configured by the user to overide the default healthchecks.

    healthCheckMaxUnhealthystring

    HealthCheckMaxUnhealthy is the value above which, if current nodes are unhealthy remediation will not be triggered Can be an absolute int64 number or a percentage string Default value is 100%, i.e by default it is disabled

    networkReadyHealthCheckDurationstring

    NetworkReadyHealthCheckDuration is the timeout to check for the network availability. If the network is not available in the given available time, beyond the timeout check a node will be killed and a new node will be created. Default time is 10m

    nodeReadyHealthCheckDurationstring

    NodeReadyHealthCheckDuration is the timeout to check for the node ready state. If the node is not ready within the time out set, the node will be deleted and a new node will be launched. Default time is 10m

    machineManagementConfig object

    MachineManagementConfig defines the management configurations for the node. Patching OS security updates etc can be configured by user.

    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.

    updateWorkerPoolsInParallelboolean

    UpdateWorkerPoolsInParallel is used to decide if the update of workerpools happen in parallel. When this flag is false, the workerpools are updated sequentially.

    clusterProfileTemplates object[]

    When a cluster created from a clusterprofile at t1, ClusterProfileTemplate is a copy of the draft version or latest published version of the clusterprofileSpec.clusterprofileTemplate then clusterprofile may evolve to v2 at t2, but before user decide to upgrade the cluster, it will stay as it is when user decide to upgrade, clusterProfileTemplate will be updated from the clusterprofile pointed by ClusterProfileRef

  • Array [
    • cloudTypestring

    Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]

    Default value: all

    namestring
    packServerRefs object[]

    PackServerRefs is only used on Hubble side it is reference to pack registry servers which PackRef belongs to in hubble, pack server is a top level object, so use a reference to point to it packs within a clusterprofile can come from different pack servers, so this is an array

  • Array [
    • 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

    uidstring

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

  • ]
    • packServerSecretstring

    This secret is used only on Palette side use case is similar to k8s image pull secret this single secret internally should contains all the pack servers in PackServerRefs if empty, means no credential is needed to access the pack server For spectro saas, Ally will set this field before pass to palette

    packs object[]

    Packs definitions here are final definitions. If ClonedFrom and ParamsOverwrite is present, then Packs are the final merge result of ClonedFrom and ParamsOverwrite So orchestration engine will just take the Packs and do the work, no need to worry about parameters merge

  • Array [
    • annotations object

    Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml

    property name*string
    digeststring

    digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade

    inValidReasonstring
    isInvalidboolean

    pack is invalid when the associated tag is deleted from the registry

    layerstringrequired

    Possible values: [kernel, os, k8s, cni, csi, addon]

    manifests object[]
  • Array [
    • 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

    uidstring

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

  • ]
    • namestringrequired

    pack name

    packUidstring

    PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.

    params object

    params passed as env variables to be consumed at installation time

    property name*string
    presets object[]
  • Array [
    • addstring
    displayNamestring
    groupstring
    namestring
    removestring[]
  • ]
    • registryUidstring

    pack registry uid

    schema object[]
  • Array [
    • formatstring
    hintsstring[]
    listOptionsstring[]
    namestring
    readonlyboolean
    regexstring
    requiredboolean
    typestring
  • ]
    • serverstring

    pack registry server or helm repo

    tagstring

    pack tag

    typestring

    Possible values: [spectro, helm, manifest]

    type of the pack

    valuesstring

    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

    versionstring

    pack version

  • ]
    • profileVersionstring

    version start from 1.0.0, matching the index of ClusterProfileSpec.Versions[] will be used by clusterSpec to identify which version is applied to the cluster

    relatedObject object

    ObjectReference contains enough information to let you inspect or modify the referred 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

    uidstring

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

    typestring
    uidstring
    versionint32

    Deprecated. Use profileVersion

  • ]
    • clusterTypestring

    Possible values: [PureManage, AlloyMonitor, AlloyAssist, AlloyExtend]

    status object

    SpectroClusterStatus

    abortTimestampdate-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.

    addOnServices undefined[]
  • Array [
    • endpointstring
    namestring
  • ]
    • apiEndpoints object[]
  • Array [
    • hoststringrequired

    The hostname on which the API server is serving.

    portint32required

    The port on which the API server is serving.

  • ]
    • clusterImport object
    importLinkstring

    import link to download and install ally-lite, palette-lite

    isBrownfieldboolean

    Deprecated. Use the 'spec.clusterType'

    statestring

    cluster import status

    conditions object[]
  • Array [
    • lastProbeTimedate-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.

    lastTransitionTimedate-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.

    messagestring

    Human-readable message indicating details about last transition.

    reasonstring

    Unique, one-word, CamelCase reason for the condition's last transition.

    statusstringrequired
    typestringrequired
  • ]
    • fips
    modestring

    Possible values: [full, none, partial, unknown]

    Default value: none

    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

    packs object[]
  • Array [
    • condition object
    lastProbeTimedate-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.

    lastTransitionTimedate-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.

    messagestring

    Human-readable message indicating details about last transition.

    reasonstring

    Unique, one-word, CamelCase reason for the condition's last transition.

    statusstringrequired
    typestringrequired
    endTimedate-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.

    manifests object[]
  • Array [
    • condition object
    lastProbeTimedate-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.

    lastTransitionTimedate-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.

    messagestring

    Human-readable message indicating details about last transition.

    reasonstring

    Unique, one-word, CamelCase reason for the condition's last transition.

    statusstringrequired
    typestringrequired
    namestring
    uidstring
  • ]
    • namestring
    profileUidstring
    services object[]
  • Array [
    • hoststring

    IP or Host from svc.Status.LoadBalancerStatus.Ingress

    namestring

    name of the loadbalancer service

    ports object[]

    port this service exposed

  • Array [
    • portint32required

    The port that will be exposed by this service.

    protocolstring
  • ]
  • ]
    • startTimedate-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.

    typestring
    versionstring
  • ]
    • profileStatus object
    hasUserMacrosboolean

    If it is true then profile pack values has a reference to user defined macros

    repave

    Cluster repave status

    statestring

    Possible values: [Pending, Approved, InProgress, Completed]

    Default value: Pending

    services object[]
  • Array [
    • hoststring

    IP or Host from svc.Status.LoadBalancerStatus.Ingress

    namestring

    name of the loadbalancer service

    ports object[]

    port this service exposed

  • Array [
    • portint32required

    The port that will be exposed by this service.

    protocolstring
  • ]
  • ]
    • spcApply object
    actionTypestring

    Possible values: [DownloadAndInstall, DownloadAndInstallLater]

    canBeAppliedboolean

    If it is true then Agent can apply the changes to the palette

    lastModifiedTimedate-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.

    patchAppliedTimedate-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.

    spcHashstring
    statestring

    current operational state

    upgrades object[]
  • Array [
    • reasonstring[]
    timestampdate-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.

  • ]
    • virtual
    appDeployments object[]

    list of apps deployed on the virtual cluster

  • Array [
    • kindstring
    namestring
    projectUidstring
    tenantUidstring
    uidstring
  • ]
    • clusterGroup object

    Object resource reference

    kindstring
    namestring
    projectUidstring
    tenantUidstring
    uidstring
    hostCluster object

    Object resource reference

    kindstring
    namestring
    projectUidstring
    tenantUidstring
    uidstring
    lifecycleStatus

    cluster life cycle status of virtual cluster

    msgstring

    error or success msg of lifecycle

    statusstring

    Possible values: [Pausing, Paused, Resuming, Running, Error]

    lifecycle status

    statestring

    cluster virtual host status

    virtualClusters object[]

    list of virtual clusters deployed on the cluster

  • Array [
    • kindstring
    namestring
    projectUidstring
    tenantUidstring
    uidstring
  • ]
  • ]
    • listmeta object

    ListMeta describes metadata for the resource listing

    continuestring

    Next token for the pagination. Next token is equal to empty string indicates end of result set.

    countinteger

    Total count of the resources which might change during pagination based on the resources addition or deletion

    limitinteger

    Number of records feteched

    offsetinteger

    The next offset for the pagination. Starting index for which next request will be placed.

Loading...