Overview

This documentation is for the cluster resource for multicluster engine for Kubernetes. Cluster resource has four possible requests: create, query, delete and update.

Contact information

Contact Email : apiteam@swagger.io

License information

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/

URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

Tags

  • cluster.open-cluster-management.io : Create and manage clusters

External Docs

Description : Find out more about Swagger.
URL : http://swagger.io

Paths

Query all clusters

GET /cluster.open-cluster-management.io/v1/managedclusters

Description

Query your clusters for more details.

Parameters

Type Name Description Schema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Responses

HTTP Code Description Schema

200

Success

No Content

403

Access forbidden

No Content

404

Resource not found

No Content

500

Internal service error

No Content

503

Service unavailable

No Content

Consumes

  • cluster/yaml

Tags

  • cluster.open-cluster-management.io

Create a cluster

POST /cluster.open-cluster-management.io/v1/managedclusters

Description

Create a cluster

Parameters

Type Name Description Schema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Body

body
required

Parameters describing the cluster to be created.

Cluster

Responses

HTTP Code Description Schema

200

Success

No Content

403

Access forbidden

No Content

404

Resource not found

No Content

500

Internal service error

No Content

503

Service unavailable

No Content

Consumes

  • cluster/yaml

Tags

  • cluster.open-cluster-management.io

Example HTTP request

Request body
{
  "apiVersion" : "cluster.open-cluster-management.io/v1",
  "kind" : "ManagedCluster",
  "metadata" : {
    "labels" : {
      "vendor" : "OpenShift"
    },
    "name" : "cluster1"
  },
  "spec": {
    "hubAcceptsClient": true,
    "managedClusterClientConfigs": [
      {
        "caBundle": "test",
        "url": "https://test.com"
      }
    ]
  },
  "status" : { }
}

Query a single cluster

GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

Description

Query a single cluster for more details.

Parameters

Type Name Description Schema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Path

cluster_name
required

Name of the cluster that you want to query.

string

Responses

HTTP Code Description Schema

200

Success

No Content

403

Access forbidden

No Content

404

Resource not found

No Content

500

Internal service error

No Content

503

Service unavailable

No Content

Tags

  • cluster.open-cluster-management.io

Delete a cluster

DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

Description

Delete a single cluster

Parameters

Type Name Description Schema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Path

cluster_name
required

Name of the cluster that you want to delete.

string

Responses

HTTP Code Description Schema

200

Success

No Content

403

Access forbidden

No Content

404

Resource not found

No Content

500

Internal service error

No Content

503

Service unavailable

No Content

Tags

  • cluster.open-cluster-management.io

Definitions

Cluster

Name Schema

apiVersion
required

string

kind
required

string

metadata
required

object

spec
required

spec

spec

Name Schema

hubAcceptsClient
required

bool

managedClusterClientConfigs
optional

< managedClusterClientConfigs > array

leaseDurationSeconds
optional

integer (int32)

managedClusterClientConfigs

Name Description Schema

URL
required

string

CABundle
optional

Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

string (byte)