NAnautes-labs
Cluster

POST /api/v1/clusters/{cluster_name}

Changed on

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

cluster_namestring required

cluster_name specifies the name of the cluster.

Query parameters

insecure_skip_checkboolean

insecureSkipCheck specifies whether to skip the certificate check when connecting to the API server.

Request body

api_serverstring

api_server specifies the API server address of the cluster.

cluster_kindstring

cluster_kind specifies the kind of the cluster.

cluster_typestring

cluster_type specifies the type of the cluster. It can be "physical" or "virtual".

usagestring

usage specifies the usage of the cluster. It can be "host" or "worker".

host_clusterstring

host_cluster specifies the host cluster name if the cluster is a virtual cluster.

kubeconfigstring

kubeconfig specifies the Kubeconfig file of the cluster.

worker_typestring

worker_type maybe pipeline or deployment, when the cluster usage is 'worker', the WorkType is required.

primary_domainstring

primary_domain is used to build the domain of components within the cluster.

reserved_namespaces_allowed_productsobject

reserved_namespaces_allowed_products key is namespace name, value is the product name list witch can use namespace.

product_allowed_cluster_resourcesobject

product_allowed_cluster_resources key is product name, value is the list of cluster resources.

Response

OK

messagestring

msg specifies the message of the save response.

Changes

  • 58206cc16454Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from object to no type

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

  • 55de8d9ba194Revision changes
    • warning

      removed the request property /