Sign in
Cluster

post/api/v1/clusters/{cluster_name}

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

Changed in 4 of the 10 revisions of this API.61721

  • 58206cc1645448See the full diff
    • ▲

      added api.cluster.v1.ComponentsList to the components_list request property allOf list

      request-property-all-of-added

    • ▲

      added api.cluster.v1.Vcluster to the vcluster request property allOf list

      request-property-all-of-added

    • ▲

      the components_list request property type/format changed from object/ to /

      request-property-type-changed

    • ▲

      the vcluster request property type/format changed from object/ to /

      request-property-type-changed

    • ●

      removed the request property components_list/deployment

      request-property-removed

    • ●

      removed the request property components_list/event_listener

      request-property-removed

    • ●

      removed the request property components_list/gateway

      request-property-removed

    • ●

      removed the request property components_list/multi_tenant

      request-property-removed

    • ●

      removed the request property components_list/pipeline

      request-property-removed

    • ●

      removed the request property components_list/progressive_delivery

      request-property-removed

    • ●

      removed the request property components_list/secret_sync

      request-property-removed

    • ●

      removed the request property vcluster/https_node_port

      request-property-removed

  • 55de8d9ba1941See the full diff
    • ●

      removed the request property components_list/cert_management

      request-property-removed

  • 2bd9e337f83668See the full diff
    • ●

      removed the request property argocd_host

      request-property-removed

    • ●

      removed the request property components_list/cert_mgt

      request-property-removed

    • ●

      removed the request property components_list/ingress_controller

      request-property-removed

    • ●

      removed the request property components_list/secret_mgt

      request-property-removed

    • ●

      removed the request property tekton_host

      request-property-removed

    • ●

      removed the request property traefik

      request-property-removed

    • ○

      added the new optional request property components_list/cert_management

      new-optional-request-property

    • ○

      added the new optional request property components_list/deployment/additions

      new-optional-request-property

    • ○

      added the new optional request property components_list/event_listener/additions

      new-optional-request-property

    • ○

      added the new optional request property components_list/gateway

      new-optional-request-property

    • ○

      added the new optional request property components_list/multi_tenant/additions

      new-optional-request-property

    • ○

      added the new optional request property components_list/pipeline/additions

      new-optional-request-property

    • ○

      added the new optional request property components_list/progressive_delivery/additions

      new-optional-request-property

    • ○

      added the new optional request property components_list/secret_sync/additions

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9c89db0ede4e2213See the full diff
    • ▲

      the components_list request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the vcluster request property type/format changed from / to object/

      request-property-type-changed

    • ●

      removed api.cluster.v1.ComponentsList from the components_list request property allOf list

      request-property-all-of-removed

    • ●

      removed api.cluster.v1.Vcluster from the vcluster request property allOf list

      request-property-all-of-removed

    • ○

      added the new optional request property argocd_host

      new-optional-request-property

    • ○

      added the new optional request property components_list/cert_mgt

      new-optional-request-property

    • ○

      added the new optional request property components_list/deployment

      new-optional-request-property

    • ○

      added the new optional request property components_list/event_listener

      new-optional-request-property

    • ○

      added the new optional request property components_list/ingress_controller

      new-optional-request-property

    • ○

      added the new optional request property components_list/multi_tenant

      new-optional-request-property

    • ○

      added the new optional request property components_list/pipeline

      new-optional-request-property

    • ○

      added the new optional request property components_list/progressive_delivery

      new-optional-request-property

    • ○

      added the new optional request property components_list/secret_mgt

      new-optional-request-property

    • ○

      added the new optional request property components_list/secret_sync

      new-optional-request-property

    • ○

      added the new optional request property tekton_host

      new-optional-request-property

    • ○

      added the new optional request property traefik

      new-optional-request-property

    • ○

      added the new optional request property vcluster/https_node_port

      new-optional-request-property

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog