...

Text file src/edge-infra.dev/pkg/edge/api/graph/schema/cluster_queries.graphql

Documentation: edge-infra.dev/pkg/edge/api/graph/schema

     1extend type Query {
     2  """
     3  GetClusters get store from sql database.
     4  """
     5  clusters(
     6    """
     7    banner name of the expected clusters
     8    """
     9    bannerEdgeId: String! @hasBannerAccess(field: "bannerEdgeId")
    10    """
    11    a list of labels (optional) used to filter clusters
    12    """
    13    labels: [String!]
    14  ): [Cluster]
    15    @hasRole(
    16      roles: [
    17        EDGE_BANNER_VIEWER
    18        EDGE_ORG_ADMIN
    19        EDGE_BANNER_ADMIN
    20        EDGE_BANNER_OPERATOR
    21      ]
    22    )
    23
    24  """
    25  GetClusters get store from sql database.
    26  """
    27  cluster(
    28    """
    29    cluster edge id of the cluster to return
    30    """
    31    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
    32  ): Cluster
    33    @hasRole(
    34      roles: [
    35        EDGE_BANNER_VIEWER
    36        EDGE_ORG_ADMIN
    37        EDGE_BANNER_ADMIN
    38        EDGE_BANNER_OPERATOR
    39      ]
    40    )
    41
    42  """
    43  GetStoreStatus get store status from Big Query.
    44  """
    45  storeStatus(
    46    """
    47    store name of the expected store status
    48    """
    49    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
    50  ): StoreStatusInfo
    51    @hasRole(
    52      roles: [
    53        EDGE_BANNER_VIEWER
    54        EDGE_ORG_ADMIN
    55        EDGE_BANNER_ADMIN
    56        EDGE_BANNER_OPERATOR
    57      ]
    58    )
    59
    60  """
    61  Site get store BSL site.
    62  """
    63  site(
    64    """
    65    clusterEdgeID of the expected cluster
    66    """
    67    clusterEdgeID: String! @hasClusterAccess(field: "clusterEdgeID")
    68  ): StoreSiteInfo
    69    @hasRole(
    70      roles: [
    71        EDGE_BANNER_VIEWER
    72        EDGE_ORG_ADMIN
    73        EDGE_BANNER_ADMIN
    74        EDGE_BANNER_OPERATOR
    75      ]
    76    )
    77
    78  """
    79  get the configuration for a cluster
    80  """
    81  clusterConfig(
    82    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
    83  ): ClusterConfig
    84    @hasRole(
    85      roles: [
    86        EDGE_BANNER_VIEWER
    87        EDGE_ORG_ADMIN
    88        EDGE_BANNER_ADMIN
    89        EDGE_BANNER_OPERATOR
    90      ]
    91    )
    92}
    93
    94extend type Mutation {
    95  """
    96  deleteCluster deletes a cluster. For gke clusters resources will be cleaned up.
    97  """
    98  deleteCluster(
    99    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   100    deleteBSLSite: Boolean
   101  ): Boolean!
   102    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   103
   104  """
   105  UpdateSite updates a store's BSL site.
   106  """
   107  updateSite(
   108    """
   109    clusterEdgeId of the expected cluster
   110    """
   111    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   112    """
   113    site is the BSL site input data
   114    """
   115    site: Site!
   116  ): StoreSiteInfo!
   117    @hasRole(
   118      roles: [
   119        EDGE_BANNER_VIEWER
   120        EDGE_ORG_ADMIN
   121        EDGE_BANNER_ADMIN
   122        EDGE_BANNER_OPERATOR
   123      ]
   124    )
   125
   126  """
   127  CreateClusterNetworkServices creates new store network services (i.e. DNS and NTP servers)
   128  """
   129  createClusterNetworkServices(
   130    """
   131    clusterEdgeId of the expected cluster
   132    """
   133    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   134    """
   135    networkServicesInfo is a list of network service input data
   136    """
   137    networkServicesInfo: [CreateNetworkServiceInfo!]!
   138  ): [ClusterNetworkServiceInfo!]!
   139    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   140
   141  """
   142  UpdateClusterNetworkServices updates a store's network services (i.e. DNS and NTP servers)
   143  """
   144  updateClusterNetworkServices(
   145    """
   146    clusterEdgeId of the expected cluster
   147    """
   148    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   149    """
   150    networkServicesInfo is a list of network service input data
   151    """
   152    networkServicesInfo: [UpdateNetworkServiceInfo!]!
   153  ): [ClusterNetworkServiceInfo!]!
   154    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   155
   156  """
   157  deleteClusterNetworkService Deletes a store's network services (i.e. DNS and NTP servers)
   158  """
   159  deleteClusterNetworkService(
   160    """
   161    clusterEdgeId of the expected cluster
   162    """
   163    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   164    """
   165    networkServicesInfo is a list of network service input data
   166    """
   167    networkServiceId: String!
   168  ): Boolean!
   169    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   170
   171  """
   172  UpdateClusterName updates a cluster's display name.
   173  """
   174  updateClusterName(
   175    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   176    """
   177    name is the new display name for the given clusterEdgeId
   178    """
   179    name: String!
   180  ): Cluster
   181    @hasRole(
   182      roles: [
   183        EDGE_BANNER_VIEWER
   184        EDGE_ORG_ADMIN
   185        EDGE_BANNER_ADMIN
   186        EDGE_BANNER_OPERATOR
   187      ]
   188    )
   189
   190  """
   191  create config for a cluster
   192  """
   193  createClusterConfig(
   194    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   195    createClusterConfig: CreateClusterConfig!
   196  ): ClusterConfig!
   197    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   198
   199  """
   200  update an existing config for a cluster
   201  """
   202  updateClusterConfig(
   203    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   204    updateClusterConfig: UpdateClusterConfig!
   205  ): ClusterConfig!
   206    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   207  """
   208  deleteClusters deletes an array of clusters. For gke clusters resources will be cleaned up.
   209  """
   210  deleteClusters(
   211    clusterEdgeIds: [String!]! @hasClusterAccess(field: "clusterEdgeIds")
   212    deleteBSLSite: Boolean
   213  ): Boolean!
   214    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   215  """
   216  addSiteToStore will add the site to a store if the siteID is provided, else it will create a new site and added to the store
   217  """
   218  addSiteToStore(
   219    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   220    siteID: String
   221  ): RegistrationResponse
   222    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   223  """
   224  updateClusterFleetVersion updates the version of the fleet pallet that will be applied, e.g. store
   225  """
   226  updateClusterFleetVersion(
   227    clusterEdgeId: String! @hasClusterAccess(field: "clusterEdgeId")
   228    fleetVersion: String!
   229  ): Cluster
   230    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   231}

View as plain text