Chapter 1. APIs

1.1. Clusters API
Copia collegamento

1.1.1. Overview
Copia collegamento

This documentation is for the cluster resource for Red Hat Advanced Cluster Management for Kubernetes. Cluster resource has four possible requests: create, query, delete and update.

1.1.1.1. Version information
Copia collegamento

Version : 2.4.0

1.1.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.1.1.3. License information
Copia collegamento

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

1.1.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.1.1.5. Tags
Copia collegamento

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

1.1.1.6. External Docs
Copia collegamento

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

1.1.2. Paths
Copia collegamento

1.1.2.1. Query all clusters
Copia collegamento

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

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

Copy to Clipboard

Toggle word wrap

1.1.2.1.1. Description
Copia collegamento

Query your clusters for more details.

1.1.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

1.1.2.1.3. Responses
Copia collegamento

Expand

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

1.1.2.1.4. Consumes
Copia collegamento

cluster/yaml

1.1.2.1.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.1.2.2. Create a cluster
Copia collegamento

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

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

Copy to Clipboard

Toggle word wrap

1.1.2.2.1. Description
Copia collegamento

Create a cluster

1.1.2.2.2. Parameters
Copia collegamento

Expand

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

1.1.2.2.3. Responses
Copia collegamento

Expand

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

1.1.2.2.4. Consumes
Copia collegamento

cluster/yaml

1.1.2.2.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.1.2.2.6. Example HTTP request
Copia collegamento

1.1.2.2.6.1. Request body
Copia collegamento

{
  "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" : { }
}

{
  "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" : { }
}

Copy to Clipboard

Toggle word wrap

1.1.2.3. Query a single cluster
Copia collegamento

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

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

Copy to Clipboard

Toggle word wrap

1.1.2.3.1. Description
Copia collegamento

Query a single cluster for more details.

1.1.2.3.2. Parameters
Copia collegamento

Expand

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

1.1.2.3.3. Responses
Copia collegamento

Expand

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

1.1.2.3.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.1.2.4. Delete a cluster
Copia collegamento

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

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

Copy to Clipboard

Toggle word wrap

DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}

DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}

Copy to Clipboard

Toggle word wrap

1.1.2.4.1. Description
Copia collegamento

Delete a single cluster

1.1.2.4.2. Parameters
Copia collegamento

Expand

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

1.1.2.4.3. Responses
Copia collegamento

Expand

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

1.1.2.4.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.1.3. Definitions
Copia collegamento

1.1.3.1. Cluster
Copia collegamento

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	object
spec required	spec

spec

Expand

Name	Schema
hubAcceptsClient required	bool
managedClusterClientConfigs optional	managedClusterClientConfigs array
leaseDurationSeconds optional	integer (int32)

managedClusterClientConfigs

Expand

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)

1.2. Clustersets API (v1beta1)
Copia collegamento

1.2.1. Overview
Copia collegamento

This documentation is for the Clusterset resource for Red Hat Advanced Cluster Management for Kubernetes. Clusterset resource has four possible requests: create, query, delete and update.

1.2.1.1. Version information
Copia collegamento

Version : 2.4.0

1.2.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.2.1.3. License information
Copia collegamento

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

1.2.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.2.1.5. Tags
Copia collegamento

cluster.open-cluster-management.io : Create and manage Clustersets

1.2.1.6. External Docs
Copia collegamento

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

1.2.2. Paths
Copia collegamento

1.2.2.1. Query all clustersets
Copia collegamento

GET /cluster.open-cluster-management.io/v1beta1/managedclustersets

GET /cluster.open-cluster-management.io/v1beta1/managedclustersets

Copy to Clipboard

Toggle word wrap

1.2.2.1.1. Description
Copia collegamento

Query your Clustersets for more details.

1.2.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

1.2.2.1.3. Responses
Copia collegamento

Expand

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

1.2.2.1.4. Consumes
Copia collegamento

clusterset/yaml

1.2.2.1.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.2.2.2. Create a clusterset
Copia collegamento

POST /cluster.open-cluster-management.io/v1beta1/managedclustersets

POST /cluster.open-cluster-management.io/v1beta1/managedclustersets

Copy to Clipboard

Toggle word wrap

1.2.2.2.1. Description
Copia collegamento

Create a Clusterset.

1.2.2.2.2. Parameters
Copia collegamento

Expand

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 clusterset to be created.	Clusterset

1.2.2.2.3. Responses
Copia collegamento

Expand

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

1.2.2.2.4. Consumes
Copia collegamento

clusterset/yaml

1.2.2.2.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.2.2.2.6. Example HTTP request
Copia collegamento

1.2.2.2.6.1. Request body
Copia collegamento

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "ManagedClusterSet",
  "metadata" : {
    "name" : "clusterset1"
  },
  "spec": { },
  "status" : { }
}

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "ManagedClusterSet",
  "metadata" : {
    "name" : "clusterset1"
  },
  "spec": { },
  "status" : { }
}

Copy to Clipboard

Toggle word wrap

1.2.2.3. Query a single clusterset
Copia collegamento

GET /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}

GET /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}

Copy to Clipboard

Toggle word wrap

1.2.2.3.1. Description
Copia collegamento

Query a single clusterset for more details.

1.2.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterset_name required	Name of the clusterset that you want to query.	string

1.2.2.3.3. Responses
Copia collegamento

Expand

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

1.2.2.3.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.2.2.4. Delete a clusterset
Copia collegamento

DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}

DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}

Copy to Clipboard

Toggle word wrap

1.2.2.4.1. Description
Copia collegamento

Delete a single clusterset.

1.2.2.4.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterset_name required	Name of the clusterset that you want to delete.	string

1.2.2.4.3. Responses
Copia collegamento

Expand

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

1.2.2.4.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.2.3. Definitions
Copia collegamento

1.2.3.1. Clusterset
Copia collegamento

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	object

1.3. Clustersetbindings API (v1beta1)
Copia collegamento

1.3.1. Overview
Copia collegamento

This documentation is for the clustersetbinding resource for Red Hat Advanced Cluster Management for Kubernetes. Clustersetbinding resource has four possible requests: create, query, delete and update.

1.3.1.1. Version information
Copia collegamento

Version : 2.4.0

1.3.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.3.1.3. License information
Copia collegamento

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

1.3.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.3.1.5. Tags
Copia collegamento

cluster.open-cluster-management.io : Create and manage clustersetbindings

1.3.1.6. External Docs
Copia collegamento

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

1.3.2. Paths
Copia collegamento

1.3.2.1. Query all clustersetbindings
Copia collegamento

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings

Copy to Clipboard

Toggle word wrap

1.3.2.1.1. Description
Copia collegamento

Query your clustersetbindings for more details.

1.3.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.3.2.1.3. Responses
Copia collegamento

Expand

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

1.3.2.1.4. Consumes
Copia collegamento

clustersetbinding/yaml

1.3.2.1.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.3.2.2. Create a clustersetbinding
Copia collegamento

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings

Copy to Clipboard

Toggle word wrap

1.3.2.2.1. Description
Copia collegamento

Create a clustersetbinding.

1.3.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the clustersetbinding to be created.	Clustersetbinding

1.3.2.2.3. Responses
Copia collegamento

Expand

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

1.3.2.2.4. Consumes
Copia collegamento

clustersetbinding/yaml

1.3.2.2.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.3.2.2.6. Example HTTP request
Copia collegamento

1.3.2.2.6.1. Request body
Copia collegamento

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

Copy to Clipboard

Toggle word wrap

1.3.2.3. Query a single clustersetbinding
Copia collegamento

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}

Copy to Clipboard

Toggle word wrap

1.3.2.3.1. Description
Copia collegamento

Query a single clustersetbinding for more details.

1.3.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	clustersetbinding_name required	Name of the clustersetbinding that you want to query.	string

1.3.2.3.3. Responses
Copia collegamento

Expand

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

1.3.2.3.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.3.2.4. Delete a clustersetbinding
Copia collegamento

DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersetbindings/{clustersetbinding_name}

DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersetbindings/{clustersetbinding_name}

Copy to Clipboard

Toggle word wrap

1.3.2.4.1. Description
Copia collegamento

Delete a single clustersetbinding.

1.3.2.4.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	clustersetbinding_name required	Name of the clustersetbinding that you want to delete.	string

1.3.2.4.3. Responses
Copia collegamento

Expand

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

1.3.2.4.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.3.3. Definitions
Copia collegamento

1.3.3.1. Clustersetbinding
Copia collegamento

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	object
spec required	spec

spec

Expand

Name	Schema
clusterSet required	string

1.4. Clusterview API (v1alpha1)
Copia collegamento

1.4.1. Overview
Copia collegamento

This documentation is for the clusterview resource for Red Hat Advanced Cluster Management for Kubernetes. The clusterview resource provides a CLI command that enables you to view a list of the managed clusters and managed cluster sets that that you can access. The three possible requests are: list, get, and watch.

1.4.1.1. Version information
Copia collegamento

Version : 2.4.0

1.4.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.4.1.3. License information
Copia collegamento

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

1.4.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.4.1.5. Tags
Copia collegamento

clusterview.open-cluster-management.io : View a list of managed clusters that your ID can access.

1.4.1.6. External Docs
Copia collegamento

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

1.4.2. Paths
Copia collegamento

1.4.2.1. Get managed clusters
Copia collegamento

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

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

Copy to Clipboard

Toggle word wrap

1.4.2.1.1. Description
Copia collegamento

View a list of the managed clusters that you can access.

1.4.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

1.4.2.1.3. Responses
Copia collegamento

Expand

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

1.4.2.1.4. Consumes
Copia collegamento

managedcluster/yaml

1.4.2.1.5. Tags
Copia collegamento

clusterview.open-cluster-management.io

1.4.2.2. List managed clusters
Copia collegamento

LIST /managedclusters.clusterview.open-cluster-management.io

LIST /managedclusters.clusterview.open-cluster-management.io

Copy to Clipboard

Toggle word wrap

1.4.2.2.1. Description
Copia collegamento

View a list of the managed clusters that you can access.

1.4.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Body	body optional	Name of the user ID for which you want to list the managed clusters.	string

1.4.2.2.3. Responses
Copia collegamento

Expand

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

1.4.2.2.4. Consumes
Copia collegamento

managedcluster/yaml

1.4.2.2.5. Tags
Copia collegamento

clusterview.open-cluster-management.io

1.4.2.2.6. Example HTTP request
Copia collegamento

1.4.2.2.6.1. Request body
Copia collegamento

{
  "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
  "kind" : "ClusterView",
  "metadata" : {
    "name" : "<user_ID>"
  },
  "spec": { },
  "status" : { }
}

{
  "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
  "kind" : "ClusterView",
  "metadata" : {
    "name" : "<user_ID>"
  },
  "spec": { },
  "status" : { }
}

Copy to Clipboard

Toggle word wrap

1.4.2.3. Watch the managed cluster sets
Copia collegamento

WATCH /managedclusters.clusterview.open-cluster-management.io

WATCH /managedclusters.clusterview.open-cluster-management.io

Copy to Clipboard

Toggle word wrap

1.4.2.3.1. Description
Copia collegamento

Watch the managed clusters that you can access.

1.4.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterview_name optional	Name of the user ID that you want to watch.	string

1.4.2.3.3. Responses
Copia collegamento

Expand

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

1.4.2.4. List the managed cluster sets.
Copia collegamento

GET /managedclustersets.clusterview.open-cluster-management.io

GET /managedclustersets.clusterview.open-cluster-management.io

Copy to Clipboard

Toggle word wrap

1.4.2.4.1. Description
Copia collegamento

List the managed clusters that you can access.

1.4.2.4.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterview_name optional	Name of the user ID that you want to watch.	string

1.4.2.4.3. Responses
Copia collegamento

Expand

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

1.4.2.5. List the managed cluster sets.
Copia collegamento

LIST /managedclustersets.clusterview.open-cluster-management.io

LIST /managedclustersets.clusterview.open-cluster-management.io

Copy to Clipboard

Toggle word wrap

1.4.2.5.1. Description
Copia collegamento

List the managed clusters that you can access.

1.4.2.5.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterview_name optional	Name of the user ID that you want to watch.	string

1.4.2.5.3. Responses
Copia collegamento

Expand

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

1.4.2.6. Watch the managed cluster sets.
Copia collegamento

WATCH /managedclustersets.clusterview.open-cluster-management.io

WATCH /managedclustersets.clusterview.open-cluster-management.io

Copy to Clipboard

Toggle word wrap

1.4.2.6.1. Description
Copia collegamento

Watch the managed clusters that you can access.

1.4.2.6.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterview_name optional	Name of the user ID that you want to watch.	string

1.4.2.6.3. Responses
Copia collegamento

Expand

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

1.5. Channels API
Copia collegamento

1.5.1. Overview
Copia collegamento

This documentation is for the Channel resource for Red Hat Advanced Cluster Management for Kubernetes. The Channel resource has four possible requests: create, query, delete and update.

1.5.1.1. Version information
Copia collegamento

Version : 2.4.0

1.5.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.5.1.3. License information
Copia collegamento

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

1.5.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.5.1.5. Tags
Copia collegamento

channels.apps.open-cluster-management.io : Create and manage deployables

1.5.1.6. External Docs
Copia collegamento

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

1.5.2. Paths
Copia collegamento

1.5.2.1. Create a channel
Copia collegamento

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels

Copy to Clipboard

Toggle word wrap

1.5.2.1.1. Description
Copia collegamento

Create a channel.

1.5.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the deployable to be created.	Channel

1.5.2.1.3. Responses
Copia collegamento

Expand

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

1.5.2.1.4. Consumes
Copia collegamento

application/yaml

1.5.2.1.5. Tags
Copia collegamento

channels.apps.open-cluster-management.io

1.5.2.1.6. Example HTTP request
Copia collegamento

1.5.2.1.6.1. Request body
Copia collegamento

{
  "apiVersion": "apps.open-cluster-management.io/v1",
  "kind": "Channel",
  "metadata": {
    "name": "sample-channel",
    "namespace": "default"
  },
  "spec": {
    "configMapRef": {
      "kind": "configmap",
      "name": "bookinfo-resource-filter-configmap"
    },
    "pathname": "https://charts.helm.sh/stable",
    "type": "HelmRepo"
  }
}

{
  "apiVersion": "apps.open-cluster-management.io/v1",
  "kind": "Channel",
  "metadata": {
    "name": "sample-channel",
    "namespace": "default"
  },
  "spec": {
    "configMapRef": {
      "kind": "configmap",
      "name": "bookinfo-resource-filter-configmap"
    },
    "pathname": "https://charts.helm.sh/stable",
    "type": "HelmRepo"
  }
}

Copy to Clipboard

Toggle word wrap

1.5.2.2. Query all channels for the target namespace
Copia collegamento

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels

Copy to Clipboard

Toggle word wrap

1.5.2.2.1. Description
Copia collegamento

Query your channels for more details.

1.5.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.5.2.2.3. Responses
Copia collegamento

Expand

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

1.5.2.2.4. Consumes
Copia collegamento

application/yaml

1.5.2.2.5. Tags
Copia collegamento

channels.apps.open-cluster-management.io

1.5.2.3. Query a single channels of a namespace
Copia collegamento

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}

Copy to Clipboard

Toggle word wrap

1.5.2.3.1. Description
Copia collegamento

Query a single channels for more details.

1.5.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	channel_name required	Name of the deployable that you wan to query.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.5.2.3.3. Responses
Copia collegamento

Expand

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

1.5.2.3.4. Tags
Copia collegamento

channels.apps.open-cluster-management.io

1.5.2.4. Delete a Channel
Copia collegamento

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}

Copy to Clipboard

Toggle word wrap

1.5.2.4.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	channel_name required	Name of the Channel that you want to delete.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.5.2.4.2. Responses
Copia collegamento

Expand

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

1.5.2.4.3. Tags
Copia collegamento

channels.apps.open-cluster-management.io

1.5.3. Definitions
Copia collegamento

1.5.3.1. Channel
Copia collegamento

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	object
spec required	spec

spec

Expand

Name	Description	Schema
configMapRef optional	ObjectReference contains enough information to let you inspect or modify the referred object.	configMapRef
gates optional	ChannelGate defines criteria for promote to channel	gates
pathname required		string
secretRef optional	ObjectReference contains enough information to let you inspect or modify the referred object.	secretRef
sourceNamespaces optional		enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) array

configMapRef

Expand

Name	Description	Schema
apiVersion optional	API version of the referent.	string
fieldPath optional	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.	string
kind optional	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds	string
name optional	Name of the referent. More info: Names	string
namespace optional	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	string
resourceVersion optional	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency	string
uid optional	UID of the referent. More info: UIDs	string

gates

Expand

Name	Description	Schema
annotations optional	typical annotations of k8s	annotations
labelSelector optional	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.	labelSelector
name optional		string

annotations

Expand

Name	Schema
key optional	string
value optional	string

labelSelector

Expand

Name	Description	Schema
matchExpressions optional	matchExpressions is a list of label selector requirements. The requirements are ANDed.	matchExpressions array
matchLabels optional	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	string, string map

matchExpressions

Expand

Name	Description	Schema
key required	key is the label key that the selector applies to.	string
operator required	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	string
values optional	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	string array

secretRef

Expand

Name	Description	Schema
apiVersion optional	API version of the referent.	string
fieldPath optional	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.	string
kind optional	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds	string
name optional	Name of the referent. More info: Names	string
namespace optional	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	string
resourceVersion optional	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency	string
uid optional	UID of the referent. More info: UIIDs	string

1.6. Subscriptions API
Copia collegamento

1.6.1. Overview
Copia collegamento

This documentation is for the Subscription resource for Red Hat Advanced Cluster Management for Kubernetes. The Subscription resource has four possible requests: create, query, delete and update.

1.6.1.1. Version information
Copia collegamento

Version : 2.4.0

1.6.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.6.1.3. License information
Copia collegamento

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

1.6.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.6.1.5. Tags
Copia collegamento

subscriptions.apps.open-cluster-management.io : Create and manage subscriptions

1.6.1.6. External Docs
Copia collegamento

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

1.6.2. Paths
Copia collegamento

1.6.2.1. Create a subscription
Copia collegamento

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

Copy to Clipboard

Toggle word wrap

1.6.2.1.1. Description
Copia collegamento

Create a subscription.

1.6.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the subscription to be created.	Subscription

1.6.2.1.3. Responses
Copia collegamento

Expand

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

1.6.2.1.4. Consumes
Copia collegamento

subscription/yaml

1.6.2.1.5. Tags
Copia collegamento

subscriptions.apps.open-cluster-management.io

1.6.2.1.6. Example HTTP request
Copia collegamento

1.6.2.1.6.1. Request body
Copia collegamento

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Subscription",
  "metadata" : {
    "name" : "sample_subscription",
    "namespace" : "default",
    "labels" : {
      "app" : "sample_subscription-app"
    },
    "annotations" : {
      "apps.open-cluster-management.io/git-path" : "apps/sample/",
      "apps.open-cluster-management.io/git-branch" : "sample_branch"
    }
  },
  "spec" : {
    "channel" : "channel_namespace/sample_channel",
    "packageOverrides" : [ {
      "packageName" : "my-sample-application",
      "packageAlias" : "the-sample-app",
      "packageOverrides" : [ {
        "path" : "spec",
        "value" : {
          "persistence" : {
            "enabled" : false,
            "useDynamicProvisioning" : false
          },
          "license" : "accept",
          "tls" : {
            "hostname" : "my-mcm-cluster.icp"
          },
          "sso" : {
            "registrationImage" : {
              "pullSecret" : "hub-repo-docker-secret"
            }
          }
        }
      } ]
    } ],
    "placement" : {
      "placementRef" : {
        "kind" : "PlacementRule",
        "name" : "demo-clusters"
      }
    }
  }
}

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Subscription",
  "metadata" : {
    "name" : "sample_subscription",
    "namespace" : "default",
    "labels" : {
      "app" : "sample_subscription-app"
    },
    "annotations" : {
      "apps.open-cluster-management.io/git-path" : "apps/sample/",
      "apps.open-cluster-management.io/git-branch" : "sample_branch"
    }
  },
  "spec" : {
    "channel" : "channel_namespace/sample_channel",
    "packageOverrides" : [ {
      "packageName" : "my-sample-application",
      "packageAlias" : "the-sample-app",
      "packageOverrides" : [ {
        "path" : "spec",
        "value" : {
          "persistence" : {
            "enabled" : false,
            "useDynamicProvisioning" : false
          },
          "license" : "accept",
          "tls" : {
            "hostname" : "my-mcm-cluster.icp"
          },
          "sso" : {
            "registrationImage" : {
              "pullSecret" : "hub-repo-docker-secret"
            }
          }
        }
      } ]
    } ],
    "placement" : {
      "placementRef" : {
        "kind" : "PlacementRule",
        "name" : "demo-clusters"
      }
    }
  }
}

Copy to Clipboard

Toggle word wrap

1.6.2.2. Query all subscriptions
Copia collegamento

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

Copy to Clipboard

Toggle word wrap

1.6.2.2.1. Description
Copia collegamento

Query your subscriptions for more details.

1.6.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.6.2.2.3. Responses
Copia collegamento

Expand

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

1.6.2.2.4. Consumes
Copia collegamento

subscription/yaml

1.6.2.2.5. Tags
Copia collegamento

subscriptions.apps.open-cluster-management.io

1.6.2.3. Query a single subscription
Copia collegamento

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

Copy to Clipboard

Toggle word wrap

1.6.2.3.1. Description
Copia collegamento

Query a single subscription for more details.

1.6.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	subscription_name required	Name of the subscription that you wan to query.	string

1.6.2.3.3. Responses
Copia collegamento

Expand

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

1.6.2.3.4. Tags
Copia collegamento

subscriptions.apps.open-cluster-management.io

1.6.2.4. Delete a subscription
Copia collegamento

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

Copy to Clipboard

Toggle word wrap

1.6.2.4.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	subscription_name required	Name of the subscription that you want to delete.	string

1.6.2.4.2. Responses
Copia collegamento

Expand

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

1.6.2.4.3. Tags
Copia collegamento

subscriptions.apps.open-cluster-management.io

1.6.3. Definitions
Copia collegamento

1.6.3.1. Subscription
Copia collegamento

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	metadata
spec required	spec
status optional	status

metadata

Expand

Name	Schema
annotations optional	object
labels optional	object
name optional	string
namespace optional	string

spec

Expand

Name	Schema
channel required	string
name optional	string
overrides optional	overrides array
packageFilter optional	packageFilter
packageOverrides optional	packageOverrides array
placement optional	placement
timewindow optional	timewindow

overrides

Expand

Name	Schema
clusterName required	string
clusterOverrides required	object array

packageFilter

Expand

Name	Description	Schema
annotations optional		string, string map
filterRef optional		filterRef
labelSelector optional		labelSelector
version optional	Pattern : `"()((\\.[0-9])(\\.)\|(\\.[0-9])?(\\.[xX]))$"`	string

filterRef

Expand

Name	Schema
name optional	string

labelSelector

Expand

Name	Schema
matchExpressions optional	matchExpressions array
matchLabels optional	string, string map

matchExpressions

Expand

Name	Schema
key required	string
operator required	string
values optional	string array

packageOverrides

Expand

Name	Schema
packageAlias optional	string
packageName required	string
packageOverrides optional	object array

placement

Expand

Name	Schema
clusterSelector optional	clusterSelector
clusters optional	clusters array
local optional	boolean
placementRef optional	placementRef

clusterSelector

Expand

Name	Schema
matchExpressions optional	matchExpressions array
matchLabels optional	string, string map

matchExpressions

Expand

Name	Schema
key required	string
operator required	string
values optional	string array

clusters

Expand

Name	Schema
name required	string

placementRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
kind optional	string
name optional	string
namespace optional	string
resourceVersion optional	string
uid optional	string

timewindow

Expand

Name	Schema
daysofweek optional	string array
hours optional	hours array
location optional	string
windowtype optional	enum (active, blocked, Active, Blocked)

hours

Expand

Name	Schema
end optional	string
start optional	string

status

Expand

Name	Schema
lastUpdateTime optional	string (date-time)
message optional	string
phase optional	string
reason optional	string
statuses optional	object

1.7. PlacementRules API
Copia collegamento

1.7.1. Overview
Copia collegamento

This documentation is for the PlacementRule resource for Red Hat Advanced Cluster Management for Kubernetes. The PlacementRule resource has four possible requests: create, query, delete and update.

1.7.1.1. Version information
Copia collegamento

Version : 2.4.0

1.7.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.7.1.3. License information
Copia collegamento

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

1.7.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.7.1.5. Tags
Copia collegamento

placementrules.apps.open-cluster-management.io : Create and manage placement rules

1.7.1.6. External Docs
Copia collegamento

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

1.7.2. Paths
Copia collegamento

1.7.2.1. Create a placement rule
Copia collegamento

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules

Copy to Clipboard

Toggle word wrap

1.7.2.1.1. Description
Copia collegamento

Create a placement rule.

1.7.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the placement rule to be created.	PlacementRule

1.7.2.1.3. Responses
Copia collegamento

Expand

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

1.7.2.1.4. Consumes
Copia collegamento

application/yaml

1.7.2.1.5. Tags
Copia collegamento

placementrules.apps.open-cluster-management.io

1.7.2.1.6. Example HTTP request
Copia collegamento

1.7.2.1.6.1. Request body
Copia collegamento

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "PlacementRule",
  "metadata" : {
    "name" : "towhichcluster",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "clusterConditions" : [ {
      "type": "ManagedClusterConditionAvailable",
      "status": "True"
    } ],
    "clusterSelector" : { }
  }
}

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "PlacementRule",
  "metadata" : {
    "name" : "towhichcluster",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "clusterConditions" : [ {
      "type": "ManagedClusterConditionAvailable",
      "status": "True"
    } ],
    "clusterSelector" : { }
  }
}

Copy to Clipboard

Toggle word wrap

1.7.2.2. Query all placement rules
Copia collegamento

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules

Copy to Clipboard

Toggle word wrap

1.7.2.2.1. Description
Copia collegamento

Query your placement rules for more details.

1.7.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.7.2.2.3. Responses
Copia collegamento

Expand

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

1.7.2.2.4. Consumes
Copia collegamento

application/yaml

1.7.2.2.5. Tags
Copia collegamento

placementrules.apps.open-cluster-management.io

1.7.2.3. Query a single placementrule
Copia collegamento

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}

Copy to Clipboard

Toggle word wrap

1.7.2.3.1. Description
Copia collegamento

Query a single placement rule for more details.

1.7.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	placementrule_name required	Name of the placementrule that you want to query.	string

1.7.2.3.3. Responses
Copia collegamento

Expand

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

1.7.2.3.4. Tags
Copia collegamento

placementrules.apps.open-cluster-management.io

1.7.2.4. Delete a placementrule
Copia collegamento

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}

Copy to Clipboard

Toggle word wrap

1.7.2.4.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	placementrule_name required	Name of the placementrule that you want to delete.	string

1.7.2.4.2. Responses
Copia collegamento

Expand

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

1.7.2.4.3. Tags
Copia collegamento

placementrules.apps.open-cluster-management.io

1.7.3. Definitions
Copia collegamento

1.7.3.1. Placementrule
Copia collegamento

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	object
spec required	spec

spec

Expand

Name	Schema
clusterConditions optional	clusterConditions array
clusterReplicas optional	integer
clusterSelector optional	clusterSelector
clusters optional	clusters array
policies optional	policies array
resourceHint optional	resourceHint
schedulerName optional	string

clusterConditions

Expand

Name	Schema
status optional	string
type optional	string

clusterSelector

Expand

Name	Schema
matchExpressions optional	matchExpressions array
matchLabels optional	string, string map

matchExpressions

Expand

Name	Schema
key optional	string
operator optional	string
values optional	string array

clusters

Expand

Name	Schema
name optional	string

policies

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
kind optional	string
name optional	string
namespace optional	string
resourceVersion optional	string
uid optional	string

resourceHint

Expand

Name	Schema
order optional	string
type optional	string

1.8. Applications API
Copia collegamento

1.8.1. Overview
Copia collegamento

This documentation is for the Application resource for Red Hat Advanced Cluster Management for Kubernetes. Application resource has four possible requests: create, query, delete and update.

1.8.1.1. Version information
Copia collegamento

Version : 2.4.0

1.8.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.8.1.3. License information
Copia collegamento

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

1.8.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.8.1.5. Tags
Copia collegamento

applications.app.k8s.io : Create and manage applications

1.8.1.6. External Docs
Copia collegamento

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

1.8.2. Paths
Copia collegamento

1.8.2.1. Create a application
Copia collegamento

POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications

POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications

Copy to Clipboard

Toggle word wrap

1.8.2.1.1. Description
Copia collegamento

Create a application.

1.8.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the application to be created.	Application

1.8.2.1.3. Responses
Copia collegamento

Expand

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

1.8.2.1.4. Consumes
Copia collegamento

application/yaml

1.8.2.1.5. Tags
Copia collegamento

applications.app.k8s.io

1.8.2.1.6. Example HTTP request
Copia collegamento

1.8.2.1.6.1. Request body
Copia collegamento

{
  "apiVersion" : "app.k8s.io/v1beta1",
  "kind" : "Application",
  "metadata" : {
    "labels" : {
      "app" : "nginx-app-details"
    },
    "name" : "nginx-app-3",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "componentKinds" : [ {
      "group" : "apps.open-cluster-management.io",
      "kind" : "Subscription"
    } ]
  },
  "selector" : {
    "matchLabels" : {
      "app" : "nginx-app-details"
    }
  },
  "status" : { }
}

{
  "apiVersion" : "app.k8s.io/v1beta1",
  "kind" : "Application",
  "metadata" : {
    "labels" : {
      "app" : "nginx-app-details"
    },
    "name" : "nginx-app-3",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "componentKinds" : [ {
      "group" : "apps.open-cluster-management.io",
      "kind" : "Subscription"
    } ]
  },
  "selector" : {
    "matchLabels" : {
      "app" : "nginx-app-details"
    }
  },
  "status" : { }
}

Copy to Clipboard

Toggle word wrap

1.8.2.2. Query all applications
Copia collegamento

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications

Copy to Clipboard

Toggle word wrap

1.8.2.2.1. Description
Copia collegamento

Query your applications for more details.

1.8.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.8.2.2.3. Responses
Copia collegamento

Expand

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

1.8.2.2.4. Consumes
Copia collegamento

application/yaml

1.8.2.2.5. Tags
Copia collegamento

applications.app.k8s.io

1.8.2.3. Query a single application
Copia collegamento

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

Copy to Clipboard

Toggle word wrap

1.8.2.3.1. Description
Copia collegamento

Query a single application for more details.

1.8.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	application_name required	Name of the application that you wan to query.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.8.2.3.3. Responses
Copia collegamento

Expand

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

1.8.2.3.4. Tags
Copia collegamento

applications.app.k8s.io

1.8.2.4. Delete a application
Copia collegamento

DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

Copy to Clipboard

Toggle word wrap

1.8.2.4.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	application_name required	Name of the application that you want to delete.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.8.2.4.2. Responses
Copia collegamento

Expand

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

1.8.2.4.3. Tags
Copia collegamento

applications.app.k8s.io

1.8.3. Definitions
Copia collegamento

1.8.3.1. Application
Copia collegamento

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	object
spec required	spec

spec

Expand

Name	Schema
assemblyPhase optional	string
componentKinds optional	object array
descriptor optional	descriptor
info optional	info array
selector optional	object

descriptor

Expand

Name	Schema
description optional	string
icons optional	icons array
keywords optional	string array
links optional	links array
maintainers optional	maintainers array
notes optional	string
owners optional	owners array
type optional	string
version optional	string

icons

Expand

Name	Schema
size optional	string
src required	string
type optional	string

links

Expand

Name	Schema
description optional	string
url optional	string

maintainers

Expand

Name	Schema
email optional	string
name optional	string
url optional	string

owners

Expand

Name	Schema
email optional	string
name optional	string
url optional	string

info

Expand

Name	Schema
name optional	string
type optional	string
value optional	string
valueFrom optional	valueFrom

valueFrom

Expand

Name	Schema
configMapKeyRef optional	configMapKeyRef
ingressRef optional	ingressRef
secretKeyRef optional	secretKeyRef
serviceRef optional	serviceRef
type optional	string

configMapKeyRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
key optional	string
kind optional	string
name optional	string
namespace optional	string
resourceVersion optional	string
uid optional	string

ingressRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
host optional	string
kind optional	string
name optional	string
namespace optional	string
path optional	string
resourceVersion optional	string
uid optional	string

secretKeyRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
key optional	string
kind optional	string
name optional	string
namespace optional	string
resourceVersion optional	string
uid optional	string

serviceRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
kind optional	string
name optional	string
namespace optional	string
path optional	string
port optional	integer (int32)
resourceVersion optional	string
uid optional	string

1.9. Helm API
Copia collegamento

1.9.1. Overview
Copia collegamento

This documentation is for the HelmRelease resource for Red Hat Advanced Cluster Management for Kubernetes. The HelmRelease resource has four possible requests: create, query, delete and update.

1.9.1.1. Version information
Copia collegamento

Version : 2.4.0

1.9.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.9.1.3. License information
Copia collegamento

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

1.9.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.9.1.5. Tags
Copia collegamento

helmreleases.apps.open-cluster-management.io : Create and manage helmreleases

1.9.1.6. External Docs
Copia collegamento

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

1.9.2. Paths
Copia collegamento

1.9.2.1. Create a helmrelease
Copia collegamento

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases

Copy to Clipboard

Toggle word wrap

1.9.2.1.1. Description
Copia collegamento

Create a helmrelease.

1.9.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the helmrelease to be created.	HelmRelease

1.9.2.1.3. Responses
Copia collegamento

Expand

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

1.9.2.1.4. Consumes
Copia collegamento

application/yaml

1.9.2.1.5. Tags
Copia collegamento

helmreleases.apps.open-cluster-management.io

1.9.2.1.6. Example HTTP request
Copia collegamento

1.9.2.1.6.1. Request body
Copia collegamento

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "HelmRelease",
  "metadata" : {
    "name" : "nginx-ingress",
    "namespace" : "default"
  },
  "repo" : {
    "chartName" : "nginx-ingress",
    "source" : {
      "helmRepo" : {
        "urls" : [ "https://kubernetes-charts.storage.googleapis.com/nginx-ingress-1.26.0.tgz" ]
      },
      "type" : "helmrepo"
    },
    "version" : "1.26.0"
  },
  "spec" : {
    "defaultBackend" : {
      "replicaCount" : 3
    }
  }
}

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "HelmRelease",
  "metadata" : {
    "name" : "nginx-ingress",
    "namespace" : "default"
  },
  "repo" : {
    "chartName" : "nginx-ingress",
    "source" : {
      "helmRepo" : {
        "urls" : [ "https://kubernetes-charts.storage.googleapis.com/nginx-ingress-1.26.0.tgz" ]
      },
      "type" : "helmrepo"
    },
    "version" : "1.26.0"
  },
  "spec" : {
    "defaultBackend" : {
      "replicaCount" : 3
    }
  }
}

Copy to Clipboard

Toggle word wrap

1.9.2.2. Query all helmreleases
Copia collegamento

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases

Copy to Clipboard

Toggle word wrap

1.9.2.2.1. Description
Copia collegamento

Query your helmreleases for more details.

1.9.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.9.2.2.3. Responses
Copia collegamento

Expand

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

1.9.2.2.4. Consumes
Copia collegamento

application/yaml

1.9.2.2.5. Tags
Copia collegamento

helmreleases.apps.open-cluster-management.io

1.9.2.3. Query a single helmrelease
Copia collegamento

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

Copy to Clipboard

Toggle word wrap

1.9.2.3.1. Description
Copia collegamento

Query a single helmrelease for more details.

1.9.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	helmrelease_name required	Name of the helmrelease that you wan to query.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.9.2.3.3. Responses
Copia collegamento

Expand

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

1.9.2.3.4. Tags
Copia collegamento

helmreleases.apps.open-cluster-management.io

1.9.2.4. Delete a helmrelease
Copia collegamento

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

Copy to Clipboard

Toggle word wrap

1.9.2.4.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	helmrelease_name required	Name of the helmrelease that you want to delete.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.9.2.4.2. Responses
Copia collegamento

Expand

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

1.9.2.4.3. Tags
Copia collegamento

helmreleases.apps.open-cluster-management.io

1.9.3. Definitions
Copia collegamento

1.9.3.1. HelmRelease
Copia collegamento

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	object
repo required	repo
spec required	object
status required	status

repo

Expand

Name	Schema
chartName optional	string
configMapRef optional	configMapRef
secretRef optional	secretRef
source optional	source
version optional	string

configMapRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
kind optional	string
name optional	string
namespace optional	string
resourceVersion optional	string
uid optional	string

secretRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
kind optional	string
name optional	string
namespace optional	string
resourceVersion optional	string
uid optional	string

source

Expand

Name	Schema
github optional	github
helmRepo optional	helmRepo
type optional	string

github

Expand

Name	Schema
branch optional	string
chartPath optional	string
urls optional	string array

helmRepo

Expand

Name	Schema
urls optional	string array

status

Expand

Name	Schema
conditions required	conditions array
deployedRelease optional	deployedRelease

conditions

Expand

Name	Schema
lastTransitionTime optional	string (date-time)
message optional	string
reason optional	string
status required	string
type required	string

deployedRelease

Expand

Name	Schema
manifest optional	string
name optional	string

1.10. Policy API
Copia collegamento

1.10.1. Overview
Copia collegamento

This documentation is for the Policy resource for Red Hat Advanced Cluster Management for Kubernetes. The Policy resource has four possible requests: create, query, delete and update.

1.10.1.1. Version information
Copia collegamento

Version : 2.4.0

1.10.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.10.1.3. License information
Copia collegamento

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

1.10.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.10.1.5. Tags
Copia collegamento

policy.open-cluster-management.io/v1 : Create and manage policies

1.10.1.6. External Docs
Copia collegamento

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

1.10.2. Paths
Copia collegamento

1.10.2.1. Create a policy
Copia collegamento

POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

Copy to Clipboard

Toggle word wrap

1.10.2.1.1. Description
Copia collegamento

Create a policy.

1.10.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the policy to be created.	Application

1.10.2.1.3. Responses
Copia collegamento

Expand

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

1.10.2.1.4. Consumes
Copia collegamento

application/json

1.10.2.1.5. Tags
Copia collegamento

policy.open-cluster-management.io

1.10.2.1.6. Example HTTP request
Copia collegamento

1.10.2.1.6.1. Request body
Copia collegamento

{
  "apiVersion": "policy.open-cluster-management.io/v1",
  "kind": "Policy",
  "metadata": {
    "name": "test-policy-swagger",
    "description": "Example body for Policy API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "policy.open-cluster-management.io/v1",
    "complianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "mustHave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patch"
              ],
            },
          ],
        },
      },
    },
  },

{
  "apiVersion": "policy.open-cluster-management.io/v1",
  "kind": "Policy",
  "metadata": {
    "name": "test-policy-swagger",
    "description": "Example body for Policy API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "policy.open-cluster-management.io/v1",
    "complianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "mustHave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patch"
              ],
            },
          ],
        },
      },
    },
  },

Copy to Clipboard

Toggle word wrap

1.10.2.2. Query all policies
Copia collegamento

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

Copy to Clipboard

Toggle word wrap

1.10.2.2.1. Description
Copia collegamento

Query your policies for more details.

1.10.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to apply the policy to, for example, default.	string

1.10.2.2.3. Responses
Copia collegamento

Expand

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

1.10.2.2.4. Consumes
Copia collegamento

application/json

1.10.2.2.5. Tags
Copia collegamento

policy.open-cluster-management.io

1.10.2.3. Query a single policy
Copia collegamento

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

Copy to Clipboard

Toggle word wrap

1.10.2.3.1. Description
Copia collegamento

Query a single policy for more details.

1.10.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	policy_name required	Name of the policy that you want to query.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.10.2.3.3. Responses
Copia collegamento

Expand

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

1.10.2.3.4. Tags
Copia collegamento

policy.open-cluster-management.io

1.10.2.4. Delete a policy
Copia collegamento

DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

Copy to Clipboard

Toggle word wrap

1.10.2.4.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	policy_name required	Name of the policy that you want to delete.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.10.2.4.2. Responses
Copia collegamento

Expand

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

1.10.2.4.3. Tags
Copia collegamento

policy.open-cluster-management.io

1.10.3. Definitions
Copia collegamento

1.10.3.1. Policy
Copia collegamento

Expand

Name	Description	Schema
apiVersion required	The versioned schema of Policy.	string
kind required	String value that represents the REST resource.	string
metadata required	Describes rules that define the policy.	object

spec

Expand

Name	Description	Schema
remediationAction optional	Value that represents how violations are handled as defined in the resource.	string
namespaceSelector required	Value that represents which namespaces the policy is applied.	string

policy-templates

Expand

Name	Description	Schema
apiVersion required	The versioned schema of Policy.	string
kind optional	String value that represents the REST resource.	string
metadata required	Describes rules that define the policy.	object
complianceType	Used to list expected behavior for roles and other Kubernetes object that must be evaluated or applied to the managed clusters.	string
clusterConditions optional	Section to define labels.	string
rules optional		string

clusterConditions

Expand

Name	Description	Schema
matchLabels optional	The label that is required for the policy to be applied to a namespace.	object
cloud optional	The label that is required for the policy to be applied to a cloud provider.	string

rules

Expand

Name	Description	Schema
apiGroups required	List of APIs that the rule applies to.	string
resources required	A list of resource types.	object
verbs required	A list of verbs.	string

1.11. Observability API
Copia collegamento

1.11.1. Overview
Copia collegamento

This documentation is for the MultiClusterObservability resource for Red Hat Advanced Cluster Management for Kubernetes. The MultiClusterObservability resource has four possible requests: create, query, delete and update.

1.11.1.1. Version information
Copia collegamento

Version : 2.4.0

1.11.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.11.1.3. License information
Copia collegamento

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

1.11.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.11.1.5. Tags
Copia collegamento

observability.open-cluster-management.io : Create and manage multiclusterobservabilities

1.11.1.6. External Docs
Copia collegamento

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

1.11.2. Paths
Copia collegamento

1.11.2.1. Create a multiclusterobservability resource
Copia collegamento

POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

Copy to Clipboard

Toggle word wrap

1.11.2.1.1. Description
Copia collegamento

Create a MultiClusterObservability resource.

1.11.2.1.2. Parameters
Copia collegamento

Expand

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 MultiClusterObservability resource to be created.	MultiClusterObservability

1.11.2.1.3. Responses
Copia collegamento

Expand

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

1.11.2.1.4. Consumes
Copia collegamento

application/yaml

1.11.2.1.5. Tags
Copia collegamento

observability.apps.open-cluster-management.io

1.11.2.1.6. Example HTTP request
Copia collegamento

1.11.2.1.6.1. Request body
Copia collegamento

{
  "apiVersion": "observability.open-cluster-management.io/v1beta2",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "observabilityAddonSpec": {}
    "storageConfig": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
       }
   }
}

{
  "apiVersion": "observability.open-cluster-management.io/v1beta2",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "observabilityAddonSpec": {}
    "storageConfig": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
       }
   }
}

Copy to Clipboard

Toggle word wrap

1.11.2.2. Query all multiclusterobservabilities
Copia collegamento

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

Copy to Clipboard

Toggle word wrap

1.11.2.2.1. Description
Copia collegamento

Query your MultiClusterObservability resources for more details.

1.11.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

1.11.2.2.3. Responses
Copia collegamento

Expand

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

1.11.2.2.4. Consumes
Copia collegamento

application/yaml

1.11.2.2.5. Tags
Copia collegamento

observability.apps.open-cluster-management.io

1.11.2.3. Query a single multiclusterobservability
Copia collegamento

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

Copy to Clipboard

Toggle word wrap

1.11.2.3.1. Description
Copia collegamento

Query a single MultiClusterObservability resource for more details.

1.11.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	multiclusterobservability_name required	Name of the multiclusterobservability that you want to query.	string

1.11.2.3.3. Responses
Copia collegamento

Expand

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

1.11.2.3.4. Tags
Copia collegamento

observability.apps.open-cluster-management.io

1.11.2.4. Delete a multiclusterobservability resource
Copia collegamento

DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

Copy to Clipboard

Toggle word wrap

1.11.2.4.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	multiclusterobservability_name required	Name of the multiclusterobservability that you want to delete.	string

1.11.2.4.2. Responses
Copia collegamento

Expand

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

1.11.2.4.3. Tags
Copia collegamento

observability.apps.open-cluster-management.io

1.11.3. Definitions
Copia collegamento

1.11.3.1. MultiClusterObservability
Copia collegamento

Expand

Name	Description	Schema
apiVersion required	The versioned schema of the MultiClusterObservability.	string
kind required	String value that represents the REST resource, MultiClusterObservability.	string
metadata required	Describes rules that define the policy.	object

spec

Expand

Name	Description	Schema
enableDownsampling optional	Enable or disable the downsample. Default value is `true`. If there is no downsample data, the query is unavailable.	boolean
imagePullPolicy optional	Pull policy for the MultiClusterObservability images. The default value is `Always`.	corev1.PullPolicy
imagePullSecret optional	Pull secret for the MultiClusterObservability images. The default value is `multiclusterhub-operator-pull-secret`	string
nodeSelector optional	Specification of the node selector.	map[string]string
observabilityAddonSpec required	The global settings for all managed clusters, which have the observability add-on installed.	observabilityAddonSpec
storageConfig required	Specifies the storage configuration to be used by observability.	StorageConfig
tolerations optional	Provided the ability for all components to tolerate any taints.	[]corev1.Toleration
advanced optional	The advanced configuration settings for observability.	advanced
resources optional	Compute resources required by MultiClusterObservability.	corev1.ResourceRequirements
replicas optional	Replicas for MultiClusterObservability.	integer

storageConfig

Expand

Name	Description	Schema
alertmanagerStorageSize optional	The amount of storage applied to the alertmanager stateful sets. Default value is `1Gi`.	string
compactStorageSize optional	The amount of storage applied to the thanos compact stateful sets. Default value is `100Gi`.	string
metricObjectStorage required	Object store to configure secrets for metrics.	metricObjectStorage
receiveStorageSize optional	The amount of storage applied to thanos receive stateful sets. Default value is `100Gi`.	string
ruleStorageSize optional	The amount of storage applied to thanos rule stateful sets. Default value is `1Gi`.	string
storageClass optional	Specify the `storageClass` stateful sets. This storage is used for the object storage if `metricObjectStorage` is configured for your operating system to create storage. Default value is `gp2`.	string
storeStorageSize optional	The amount of storage applied to thanos store stateful sets. Default value is `10Gi`.	string

metricObjectStorage

Expand

Name	Description	Schema
key required	The key of the secret to select from. Must be a valid secret key. See Thanos documentation.	string
name required	Name of the `metricObjectStorage`. See Kubernetes Names for more information.	string

observabilityAddonSpec

Expand

Name	Description	Schema
enableMetrics optional	Indicates if the observability add-on sends metrics to the hub cluster. Default value is `true`.	boolean
interval optional	Interval for when the observability add-on sends metrics to the hub cluster. Default value is 300 seconds (`300s`).	integer
resources optional	Resource for the metrics collector resource requirement. The default CPU request is `100m`, memory request is `100Mi`.	corev1.ResourceRequirements

advanced

Expand

Name	Description	Schema
retentionConfig optional	Specifies the data retention configuration to be used by observability.	`RetentionConfig`
rbacQueryProxy optional	Specifies the replicas and resources for the rbac-query-proxy deployment.	CommonSpec
grafana optional	Specifies the replicas and resources for the grafana deployment	CommonSpec
alertmanager optional	Specifies the replicas and resources for alertmanager statefulset.	CommonSpec
observatoriumAPI optional	Specifies the replicas and resources for the `observatorium-api` deployment.	CommonSpec
queryFrontend optional	Specifies the replicas and resources for the query-frontend deployment.	CommonSpec
query optional	Specifies the replicas and resources for the query deployment.	CommonSpec
receive optional	Specifies the replicas and resources for the receive statefulset.	CommonSpec
rule optional	Specifies the replicas and resources for rule statefulset.	CommonSpec
store optional	Specifies the replicas and resources for the store statefulset.	CommonSpec
compact optional	Specifies the resources for compact statefulset.	compact
storeMemcached optional	Specifies the replicas, resources, etc. for store-memcached.	storeMemcached
queryFrontendMemcached optional	Specifies the replicas, resources, etc for query-frontend-memcached.	CacheConfig

retentionConfig

Expand

Name	Description	Schema
blockDuration optional	The amount of time to block the duration for Time Series Database (TSDB) block. Default value is `2h`.	string
cleanupInterval optional	The frequency of how often partially uploaded blocks are cleaned, and how often blocks with the deletion mark that have `--wait` enabled are cleaned. Default value is `5m`.	string
deleteDelay optional	The amount of time until a block marked for deletion is deleted from a bucket. Default value is `48h`.	string
retentionInLocal optional	The amount of time to retain raw samples from the local storage. Default value is `24h`.	string
retentionResolutionRaw optional	The amount of time to retain raw samples of resolution in a bucket. Default value is 30 days (`30d`)	string
retentionResolution5m optional	The amount of time to retain samples of resolution 1 (5 minutes) in a bucket. Default value is 180 days (`180d`).	string
retentionResolution1h optional	The amount of time to retain samples of resolution 2 (1 hour) in a bucket. Default value is 0 days (`0d`).	string

compact

Expand

Name	Description	Schema
resources optional	Compute resources required by MultiCLusterObservability.	corev1.ResourceRequirements

storeMemcached

Expand

Name	Description	Schema
resources optional	Compute resources required by MultiCLusterObservability.	corev1.ResourceRequirements
replicas optional	Replicas for MultiClusterObservability.	integer
memoryLimitMb optional	Memory limit of Memcached in megabytes.	integer
maxItemSize optional	Max item size of Memcached. The default value is `1m, min:1k, max:1024m`.	string
connectionLimit optional	Max simultaneous connections of Memcached. The default value is	integer

status

Expand

Name	Description	Schema
status optional	Status contains the different condition statuses for MultiClusterObservability.	metav1.Condition

1.12. Search customization API
Copia collegamento

1.12.1. Overview
Copia collegamento

This documentation is for the searchCustomization resource for Red Hat Advanced Cluster Management for Kubernetes. The SearchCustomization resource has four possible requests: create, query, delete and update.

1.12.1.1. Version information
Copia collegamento

Version : 2.4.0

1.12.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.12.1.3. License information
Copia collegamento

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

1.12.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.12.1.5. Tags
Copia collegamento

search.open-cluster-management.io/v1 : Create and manage persistence volumes

1.12.1.6. External Docs
Copia collegamento

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

1.12.2. Paths
Copia collegamento

1.12.2.1. Create a searchCustomization
Copia collegamento

POST /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

POST /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

Copy to Clipboard

Toggle word wrap

1.12.2.1.1. Description
Copia collegamento

Create a searchCustomization.

1.12.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the policy to be created.

1.12.2.1.3. Responses
Copia collegamento

Expand

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

1.12.2.1.4. Consumes
Copia collegamento

searchCustomization/json

1.12.2.1.5. Tags
Copia collegamento

search.open-cluster-management.io

1.12.2.1.6. Example HTTP request
Copia collegamento

1.12.2.1.6.1. Request body
Copia collegamento

{
  "apiVersion": "search.open-cluster-management.io/v1",
  "kind": "SearchCustomization",
  "metadata": {
    "name": "test-search-swagger",
    "description": "Example body for SearchCustomization API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "search.open-cluster-management.io/v1alpha1",
    "complianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "mustHave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patch"
              ],
            },
          ],
        },
      },
    },
  },

{
  "apiVersion": "search.open-cluster-management.io/v1",
  "kind": "SearchCustomization",
  "metadata": {
    "name": "test-search-swagger",
    "description": "Example body for SearchCustomization API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "search.open-cluster-management.io/v1alpha1",
    "complianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "mustHave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patch"
              ],
            },
          ],
        },
      },
    },
  },

Copy to Clipboard

Toggle word wrap

1.12.2.2. Query searchCustomization
Copia collegamento

GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

Copy to Clipboard

Toggle word wrap

1.12.2.2.1. Description
Copia collegamento

Query your searchCustomization for more details.

1.12.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to apply the policy to, for example, default.	string

1.12.2.2.3. Responses
Copia collegamento

Expand

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

1.12.2.2.4. Consumes
Copia collegamento

searchCustomization/json

1.12.2.2.5. Tags
Copia collegamento

search.open-cluster-management.io

1.12.2.3. Query a single policy
Copia collegamento

GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

Copy to Clipboard

Toggle word wrap

1.12.2.3.1. Description
Copia collegamento

Query a single searchCustomization for more details.

1.12.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	policy_name required	Name of the policy that you want to query.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.12.2.3.3. Responses
Copia collegamento

Expand

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

1.12.2.3.4. Tags
Copia collegamento

search.open-cluster-management.io

1.12.2.4. Delete a searchCustomization
Copia collegamento

DELETE /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

DELETE /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

Copy to Clipboard

Toggle word wrap

1.12.2.4.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	policy_name required	Name of the policy that you want to delete.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.12.2.4.2. Responses
Copia collegamento

Expand

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

1.12.2.4.3. Tags
Copia collegamento

search.open-cluster-management.io

1.12.3. Definitions
Copia collegamento

1.12.3.1. SearchCustomization
Copia collegamento

Expand

Name	Description	Schema
apiVersion required	The versioned schema of SearchCustomization.	string
kind required	String value that represents the REST resource.	string
metadata required	Describes rules that define the policy.	object

spec

Expand

Name	Description	Schema
remediationAction optional	Value that represents how violations are handled as defined in the resource.	string
namespaces required	Value that represents which namespaces to `include` or `exclude` when the policy is applied.	string

policy-templates

Expand

Name	Description	Schema
apiVersion required	The versioned schema of SearchCustomization.	string
kind optional	String value that represents the REST resource.	string
metadata required	Describes rules that define the policy.	object
complianceType	Used to list expected behavior for roles and other Kubernetes object that must be evaluated or applied to the managed clusters.	string
clusterConditions optional	Section to define labels.	string
rules optional		string

clusterConditions

Expand

Name	Description	Schema
matchLabels optional	The label that is required for the policy to be applied to a namespace.	object
cloud optional	The label that is required for the policy to be applied to a cloud provider.	string

rules

Expand

Name	Description	Schema
apiGroups required	List of APIs that the rule applies to.	string
resources required	A list of resource types.	object
verbs required	A list of verbs.	string

1.13. MultiClusterHub API
Copia collegamento

1.13.1. Overview
Copia collegamento

This documentation is for the MultiClusterHub resource for Red Hat Advanced Cluster Management for Kubernetes. MultiClusterHub resource has four possible requests: create, query, delete and update.

1.13.1.1. Version information
Copia collegamento

Version : 2.4.0

1.13.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.13.1.3. License information
Copia collegamento

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

1.13.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.13.1.5. Tags
Copia collegamento

multiclusterhubs.operator.open-cluster-management.io : Create and manage multicluster hub operators

1.13.1.6. External Docs
Copia collegamento

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

1.13.2. Paths
Copia collegamento

1.13.2.1. Create a MultiClusterHub resource
Copia collegamento

POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch

POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch

Copy to Clipboard

Toggle word wrap

1.13.2.1.1. Description
Copia collegamento

Create a MultiClusterHub resource to define the configuration for an instance of the multicluster hub.

1.13.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the multicluster hub to be created.	Definitions

1.13.2.1.3. Responses
Copia collegamento

Expand

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

1.13.2.1.4. Consumes
Copia collegamento

multiclusterhubs/yaml

1.13.2.1.5. Tags
Copia collegamento

multiclusterhubs.operator.open-cluster-management.io

1.13.2.1.6. Example HTTP request
Copia collegamento

1.13.2.1.6.1. Request body
Copia collegamento

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "name": "multiclusterhubs.operator.open-cluster-management.io"
    },
  "spec": {
    "group": "operator.open-cluster-management.io",
    "names": {
      "kind": "MultiClusterHub",
      "listKind": "MultiClusterHubList",
      "plural": "multiclusterhubs",
      "shortNames": [
          "mch"
	  ],
     "singular": "multiclusterhub"
     },
    "scope": "Namespaced",
    "versions": [
        {
	    "additionalPrinterColumns": [
                {
		   "description": "The overall status of the multicluster hub.",
                   "jsonPath": ".status.phase",
                   "name": "Status",
                   "type": "string"
		   },
               {
	           "jsonPath": ".metadata.creationTimestamp",
                   "name": "Age",
                   "type": "date"
		   }
            ],
            "name": "v1",
            "schema": {
                "openAPIV3Schema": {
                    "description": "MultiClusterHub defines the configuration for an instance of
          the multiCluster hub.",
        "properties": {
            "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation
              of an object. Servers should convert recognized schemas to the latest
              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
            },
            "kind": {
                "description": "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. The value is in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
            },
            "metadata": {
                "type": "object"
            },
            "spec": {
                "description": "MultiClusterHubSpec defines the desired state of MultiClusterHub.",
                "properties": {
                    "availabilityConfig": {
                        "description": "Specifies deployment replication for improved availability.
                  Options are: Basic and High (default).",
                        "type": "string"
                },
                "customCAConfigmap": {
                    "description": "Provide the customized OpenShift default ingress CA certificate
                  to {product-title-short}.",
                  }
                    "type": "string"
                },
        "disableHubSelfManagement": {
                    "description": "Disable automatic import of the hub cluster as a managed
                  cluster.",
                    "type": "boolean"
                },
        "disableUpdateClusterImageSets": {
                    "description": "Disable automatic update of ClusterImageSets.",
                    "type": "boolean"
                },
                "hive": {
                    "description": "(Deprecated) Overrides for the default HiveConfig specification.",
                    "properties": {
        "additionalCertificateAuthorities": {
        "description": "(Deprecated) AdditionalCertificateAuthorities is
                      a list of references to secrets in the 'hive' namespace that
                      contain an additional Certificate Authority to use when communicating
                      with target clusters. These certificate authorities are
                      used in addition to any self-signed CA generated by each cluster
                      on installation.",
                           "items": {
                    "description": "LocalObjectReference contains the information
                        to let you locate the referenced object inside the same namespace.",
                    "properties": {
                    "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                     }
		             },
                    "type": "object"
                      },
                           "type": "array"
                    },
                       "backup": {
                    "description": "(Deprecated) Backup specifies configuration for backup
                      integration. If absent, backup integration is disabled.",
                    "properties": {
                    "minBackupPeriodSeconds": {
                    "description": "(Deprecated) MinBackupPeriodSeconds specifies
                          that a minimum of MinBackupPeriodSeconds occurs in between
                          each backup. This is used to rate limit backups. This potentially
                          batches together multiple changes into one backup. No backups
                          are lost for changes that happen during the interval
                          that is queued up, and results in a backup once
                          the interval has been completed.",
                    "type": "integer"
                        },
                    "velero": {
                    "description": "(Deprecated) Velero specifies configuration for the Velero backup integration.",
		    "properties": {
			"enabled": {
			    "description": "(Deprecated) Enabled dictates if the Velero backup integration is enabled. If not specified, the default is disabled.",
			    "type": "boolean"
			}
		   },
		    "type": "object"
				        }
				  },
				        "type": "object"
				     },
		    "externalDNS": {
		    "description": "(Deprecated) ExternalDNS specifies configuration for external-dns if it is to be deployed by Hive. If absent, external-dns is not deployed.",
		    "properties": {
		    "aws": {
		    "description": "(Deprecated) AWS contains AWS-specific settings for external DNS.",
		    "properties": {
		        "credentials": {
			    "description": "(Deprecated) Credentials reference a secret that is used to authenticate with AWS Route53. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have AWS keys named 'aws_access_key_id' and 'aws_secret_access_key'.",
			    "properties": {
				"name": {
																		            "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
																		                             "type": "string"
						    }
					},
			    "type": "object"
			}
		},
		   "type": "object"
					},
		   "gcp": {
		   "description": "(Deprecated) GCP contains Google Cloud Platform specific settings for external DNS.",
		   "properties": {
		       "credentials": {
			   "description": "(Deprecated) Credentials reference a secret that is used to authenticate with GCP DNS. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have a key names 'osServiceAccount.json'. The credentials must specify the project to use.",
			   "properties": {
			       "name": {
		   "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
				   "type": "string"
							}
						},
			   "type": "object"
			}
		},
		"type": "object"
					}
				},
				      "type": "object"
					},
		"failedProvisionConfig": {
		"description": "(Deprecated) FailedProvisionConfig is used to configure settings related to handling provision failures.",
		"properties": {
		"skipGatherLogs": {
		"description": "(Deprecated) SkipGatherLogs disables functionality that attempts to gather full logs from the cluster if an installation fails for any reason. The logs are stored in a persistent volume for up to seven days.",
	        "type": "boolean"
				   }
				},
				  "type": "object"
				  },
		"globalPullSecret": {
		"description": "(Deprecated) GlobalPullSecret is used to specify a pull secret that is used globally by all of the cluster deployments. For each cluster deployment, the contents of GlobalPullSecret are merged with the specific pull secret for a cluster deployment(if specified), with precedence given to the contents of the pull secret for the cluster deployment.",
		"properties": {
		"name": {
		"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
		"type": "string"
			                }
				},
				  "type": "object"
							},
		"maintenanceMode": {
	        "description": "(Deprecated) MaintenanceMode can be set to true to disable the Hive controllers in situations where you need to ensure nothing is running that adds or act upon finalizers on Hive types. This should rarely be needed. Sets replicas to zero for the 'hive-controllers' deployment to accomplish this.",
				  "type": "boolean"
							}
						},
			  "required": [
				         "failedProvisionConfig"
						     ],
			  "type": "object"
						 },
		"imagePullSecret": {
		    "description": "Override pull secret for accessing MultiClusterHub operand and endpoint images.",
		    "type": "string"
					},
		"ingress": {
		    "description": "Configuration options for ingress management.",
		    "properties": {
			"sslCiphers": {
	"description": "List of SSL ciphers enabled for management ingress. Defaults to full list of supported ciphers.",
			    "items": {
		    "type": "string"
					},
			    "type": "array"
						}
					},
			       "type": "object"
						},
			   "nodeSelector": {
		   "additionalProperties": {
				   "type": "string"
						},
			       "description": "Set the node selectors..",
			       "type": "object"
			},
			   "overrides": {
			       "description": "Developer overrides.",
			       "properties": {
		   "imagePullPolicy": {
		   "description": "Pull policy of the multicluster hub images.",
			               "type": "string"
							}
						},
			      "type": "object"
									},
		   "separateCertificateManagement": {
				     "description": "(Deprecated) Install cert-manager into its own namespace.",
				     "type": "boolean"
						    }
					   },
			   "type": "object"
		       },
		       "status": {
			 "description": "MulticlusterHubStatus defines the observed state of MultiClusterHub.",
			 "properties": {
			     "components": {
		      "additionalProperties": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating\ndetails about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
						},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
					},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				  "description": "Components []ComponentCondition `json:\"manifests,omitempty\"`",
				  "type": "object"
							},
			      "conditions": {
				  "description": "Conditions contain the different condition statuses for the MultiClusterHub.",
				  "items": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "lastUpdateTime": {
		      "description": "The last time this condition was updated.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating details about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
					},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
						},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				 "type": "array"
					},
			     "currentVersion": {
				 "description": "CurrentVersion indicates the current version..",
				 "type": "string"
						},
			     "desiredVersion": {
				 "description": "DesiredVersion indicates the desired version.",
				 "type": "string"
						 },
			     "phase": {
				 "description": "Represents the running phase of the MultiClusterHub",
				 "type": "string"
							}
						},
	                 "type": "object"
					   }
				   },
                "type": "object"
			        }
		         },
        "served": true,
        "storage": true,
        "subresources": {
	    "status": {}
	    }
	}
    ]
  }
}

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "name": "multiclusterhubs.operator.open-cluster-management.io"
    },
  "spec": {
    "group": "operator.open-cluster-management.io",
    "names": {
      "kind": "MultiClusterHub",
      "listKind": "MultiClusterHubList",
      "plural": "multiclusterhubs",
      "shortNames": [
          "mch"
	  ],
     "singular": "multiclusterhub"
     },
    "scope": "Namespaced",
    "versions": [
        {
	    "additionalPrinterColumns": [
                {
		   "description": "The overall status of the multicluster hub.",
                   "jsonPath": ".status.phase",
                   "name": "Status",
                   "type": "string"
		   },
               {
	           "jsonPath": ".metadata.creationTimestamp",
                   "name": "Age",
                   "type": "date"
		   }
            ],
            "name": "v1",
            "schema": {
                "openAPIV3Schema": {
                    "description": "MultiClusterHub defines the configuration for an instance of
          the multiCluster hub.",
        "properties": {
            "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation
              of an object. Servers should convert recognized schemas to the latest
              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
            },
            "kind": {
                "description": "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. The value is in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
            },
            "metadata": {
                "type": "object"
            },
            "spec": {
                "description": "MultiClusterHubSpec defines the desired state of MultiClusterHub.",
                "properties": {
                    "availabilityConfig": {
                        "description": "Specifies deployment replication for improved availability.
                  Options are: Basic and High (default).",
                        "type": "string"
                },
                "customCAConfigmap": {
                    "description": "Provide the customized OpenShift default ingress CA certificate
                  to {product-title-short}.",
                  }
                    "type": "string"
                },
        "disableHubSelfManagement": {
                    "description": "Disable automatic import of the hub cluster as a managed
                  cluster.",
                    "type": "boolean"
                },
        "disableUpdateClusterImageSets": {
                    "description": "Disable automatic update of ClusterImageSets.",
                    "type": "boolean"
                },
                "hive": {
                    "description": "(Deprecated) Overrides for the default HiveConfig specification.",
                    "properties": {
        "additionalCertificateAuthorities": {
        "description": "(Deprecated) AdditionalCertificateAuthorities is
                      a list of references to secrets in the 'hive' namespace that
                      contain an additional Certificate Authority to use when communicating
                      with target clusters. These certificate authorities are
                      used in addition to any self-signed CA generated by each cluster
                      on installation.",
                           "items": {
                    "description": "LocalObjectReference contains the information
                        to let you locate the referenced object inside the same namespace.",
                    "properties": {
                    "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                     }
		             },
                    "type": "object"
                      },
                           "type": "array"
                    },
                       "backup": {
                    "description": "(Deprecated) Backup specifies configuration for backup
                      integration. If absent, backup integration is disabled.",
                    "properties": {
                    "minBackupPeriodSeconds": {
                    "description": "(Deprecated) MinBackupPeriodSeconds specifies
                          that a minimum of MinBackupPeriodSeconds occurs in between
                          each backup. This is used to rate limit backups. This potentially
                          batches together multiple changes into one backup. No backups
                          are lost for changes that happen during the interval
                          that is queued up, and results in a backup once
                          the interval has been completed.",
                    "type": "integer"
                        },
                    "velero": {
                    "description": "(Deprecated) Velero specifies configuration for the Velero backup integration.",
		    "properties": {
			"enabled": {
			    "description": "(Deprecated) Enabled dictates if the Velero backup integration is enabled. If not specified, the default is disabled.",
			    "type": "boolean"
			}
		   },
		    "type": "object"
				        }
				  },
				        "type": "object"
				     },
		    "externalDNS": {
		    "description": "(Deprecated) ExternalDNS specifies configuration for external-dns if it is to be deployed by Hive. If absent, external-dns is not deployed.",
		    "properties": {
		    "aws": {
		    "description": "(Deprecated) AWS contains AWS-specific settings for external DNS.",
		    "properties": {
		        "credentials": {
			    "description": "(Deprecated) Credentials reference a secret that is used to authenticate with AWS Route53. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have AWS keys named 'aws_access_key_id' and 'aws_secret_access_key'.",
			    "properties": {
				"name": {
																		            "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
																		                             "type": "string"
						    }
					},
			    "type": "object"
			}
		},
		   "type": "object"
					},
		   "gcp": {
		   "description": "(Deprecated) GCP contains Google Cloud Platform specific settings for external DNS.",
		   "properties": {
		       "credentials": {
			   "description": "(Deprecated) Credentials reference a secret that is used to authenticate with GCP DNS. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have a key names 'osServiceAccount.json'. The credentials must specify the project to use.",
			   "properties": {
			       "name": {
		   "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
				   "type": "string"
							}
						},
			   "type": "object"
			}
		},
		"type": "object"
					}
				},
				      "type": "object"
					},
		"failedProvisionConfig": {
		"description": "(Deprecated) FailedProvisionConfig is used to configure settings related to handling provision failures.",
		"properties": {
		"skipGatherLogs": {
		"description": "(Deprecated) SkipGatherLogs disables functionality that attempts to gather full logs from the cluster if an installation fails for any reason. The logs are stored in a persistent volume for up to seven days.",
	        "type": "boolean"
				   }
				},
				  "type": "object"
				  },
		"globalPullSecret": {
		"description": "(Deprecated) GlobalPullSecret is used to specify a pull secret that is used globally by all of the cluster deployments. For each cluster deployment, the contents of GlobalPullSecret are merged with the specific pull secret for a cluster deployment(if specified), with precedence given to the contents of the pull secret for the cluster deployment.",
		"properties": {
		"name": {
		"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
		"type": "string"
			                }
				},
				  "type": "object"
							},
		"maintenanceMode": {
	        "description": "(Deprecated) MaintenanceMode can be set to true to disable the Hive controllers in situations where you need to ensure nothing is running that adds or act upon finalizers on Hive types. This should rarely be needed. Sets replicas to zero for the 'hive-controllers' deployment to accomplish this.",
				  "type": "boolean"
							}
						},
			  "required": [
				         "failedProvisionConfig"
						     ],
			  "type": "object"
						 },
		"imagePullSecret": {
		    "description": "Override pull secret for accessing MultiClusterHub operand and endpoint images.",
		    "type": "string"
					},
		"ingress": {
		    "description": "Configuration options for ingress management.",
		    "properties": {
			"sslCiphers": {
	"description": "List of SSL ciphers enabled for management ingress. Defaults to full list of supported ciphers.",
			    "items": {
		    "type": "string"
					},
			    "type": "array"
						}
					},
			       "type": "object"
						},
			   "nodeSelector": {
		   "additionalProperties": {
				   "type": "string"
						},
			       "description": "Set the node selectors..",
			       "type": "object"
			},
			   "overrides": {
			       "description": "Developer overrides.",
			       "properties": {
		   "imagePullPolicy": {
		   "description": "Pull policy of the multicluster hub images.",
			               "type": "string"
							}
						},
			      "type": "object"
									},
		   "separateCertificateManagement": {
				     "description": "(Deprecated) Install cert-manager into its own namespace.",
				     "type": "boolean"
						    }
					   },
			   "type": "object"
		       },
		       "status": {
			 "description": "MulticlusterHubStatus defines the observed state of MultiClusterHub.",
			 "properties": {
			     "components": {
		      "additionalProperties": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating\ndetails about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
						},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
					},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				  "description": "Components []ComponentCondition `json:\"manifests,omitempty\"`",
				  "type": "object"
							},
			      "conditions": {
				  "description": "Conditions contain the different condition statuses for the MultiClusterHub.",
				  "items": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "lastUpdateTime": {
		      "description": "The last time this condition was updated.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating details about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
					},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
						},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				 "type": "array"
					},
			     "currentVersion": {
				 "description": "CurrentVersion indicates the current version..",
				 "type": "string"
						},
			     "desiredVersion": {
				 "description": "DesiredVersion indicates the desired version.",
				 "type": "string"
						 },
			     "phase": {
				 "description": "Represents the running phase of the MultiClusterHub",
				 "type": "string"
							}
						},
	                 "type": "object"
					   }
				   },
                "type": "object"
			        }
		         },
        "served": true,
        "storage": true,
        "subresources": {
	    "status": {}
	    }
	}
    ]
  }
}

Copy to Clipboard

Toggle word wrap

1.13.2.2. Query all MultiClusterHubs
Copia collegamento

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator

Copy to Clipboard

Toggle word wrap

1.13.2.2.1. Description
Copia collegamento

Query your multicluster hub operator for more details.

1.13.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.13.2.2.3. Responses
Copia collegamento

Expand

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

1.13.2.2.4. Consumes
Copia collegamento

operator/yaml

1.13.2.2.5. Tags
Copia collegamento

multiclusterhubs.operator.open-cluster-management.io

1.13.2.3. Query a MultiClusterHub operator
Copia collegamento

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}

Copy to Clipboard

Toggle word wrap

1.13.2.3.1. Description
Copia collegamento

Query a single multicluster hub operator for more details.

1.13.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	application_name required	Name of the application that you wan to query.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.13.2.3.3. Responses
Copia collegamento

Expand

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

1.13.2.3.4. Tags
Copia collegamento

multiclusterhubs.operator.open-cluster-management.io

1.13.2.4. Delete a MultiClusterHub operator
Copia collegamento

DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}

DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}

Copy to Clipboard

Toggle word wrap

1.13.2.4.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	application_name required	Name of the multicluster hub operator that you want to delete.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.13.2.4.2. Responses
Copia collegamento

Expand

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

1.13.2.4.3. Tags
Copia collegamento

multiclusterhubs.operator.open-cluster-management.io

1.13.3. Definitions
Copia collegamento

1.13.3.1. Multicluster hub operator
Copia collegamento

Expand

Name	Description	Schema
apiVersion required	The versioned schema of the MultiClusterHub.	string
kind required	String value that represents the REST resource.	string
metadata required	Describes rules that define the resource.	object
spec required	The resource specification.	spec

spec

Expand

availabilityConfig optional	Specifies deployment replication for improved availability. The default value is `High`.	string
customCAConfigmap optional	Provide the customized OpenShift default ingress CA certificate to Red Hat Advanced Cluster Management.	string
disableHubSelfManagement optional	Disable automatic import of the hub cluster as a managed cluster.	boolean
disableUpdateClusterImageSets optional	Disable automatic update of ClusterImageSets.	boolean
hive optional	(Deprecated) An object that overrides for the default HiveConfig specification.	hive
imagePullSecret optional	Overrides pull secret for accessing MultiClusterHub operand and endpoint images.	string
ingress optional	Configuration options for ingress management.	ingress
nodeSelector optional	Set the node selectors.	string
separateCertificateManagement optional	(Deprecated) Install `cert-manager` into its own namespace.	boolean

hive

Expand

additionalCertificateAuthorities optional	(Deprecated) A list of references to secrets in the `hive` namespace that contain an additional Certificate Authority to use when communicating with target clusters. These certificate authorities are used in addition to any self-signed CA generated by each cluster on installation.	object
backup optional	(Deprecated) Specifies the configuration for backup integration. If absent, backup integration is disabled.	backup
externalDNS optional	(Deprecated) Specifies configuration for `external-dns` if it is to be deployed by Hive. If absent, `external-dns` is not be deployed.	object
failedProvisionConfig required	(Deprecated) Used to configure settings related to handling provision failures.	failedProvisionConfig
globalPullSecret optional	(Deprecated) Used to specify a pull secret that is used globally by all of the cluster deployments. For each cluster deployment, the contents of `globalPullSecret` are merged with the specific pull secret for a cluster deployment (if specified), with precedence given to the contents of the pull secret for the cluster deployment.	object
maintenanceMode optional	(Deprecated) Can be set to true to disable the hive controllers in situations where you need to ensure nothing is running that adds or acts upon finalizers on Hive types. This should rarely be needed. Sets replicas to `0` for the `hive-controllers` deployment to accomplish this.	boolean

ingress

Expand

sslCiphers optional	List of SSL ciphers enabled for management ingress. Defaults to full list of supported ciphers.	string

backup

Expand

minBackupPeriodSeconds optional	(Deprecated) Specifies that a minimum of `MinBackupPeriodSeconds` occurs in between each backup. This is used to rate limit backups. This potentially batches together multiple changes into one backup. No backups are lost as changes happen during this interval are queued up and result in a backup happening once the interval has been completed.	integer
velero optional	(Deprecated) Velero specifies configuration for the Velero backup integration.	object

failedProvisionConfig

Expand

skipGatherLogs optional	(Deprecated) Disables functionality that attempts to gather full logs from the cluster if an installation fails for any reason. The logs are stored in a persistent volume for up to seven days.	boolean

status

Expand

components optional	The components of the status configuration.	object
conditions optional	Contains the different conditions for the multicluster hub.	conditions
desiredVersion optional	Indicates the desired version.	string
phase optional	Represents the active phase of the MultiClusterHub resource. The values that are used for this parameter are: `Pending`, `Running`, `Installing`, `Updating`, `Uninstalling`	string

conditions

Expand

lastTransitionTime optional	The last time the condition changed from one status to another.	string
lastUpdateTime optional	The last time this condition was updated.	string
message required	Message is a human-readable message indicating details about the last status change.	string
reason required	A brief reason for why the condition status changed.	string
status required	The status of the condition.	string
type required	The type of the cluster condition.	string

StatusConditions

Expand

kind required	The resource `kind` that represents this status.	string
available required	Indicates whether this component is properly running.	boolean
lastTransitionTime optional	The last time the condition changed from one status to another.	metav1.time
lastUpdateTime optional	The last time this condition was updated.	metav1.time
message required	Message is a human-readable message indicating details about the last status change.	string
reason optional	A brief reason for why the condition status changed.	string
status optional	The status of the condition.	string
type optional	The type of the cluster condition.	string

1.14. Placements API (v1alpha1)
Copia collegamento

1.14.1. Overview
Copia collegamento

This documentation is for the Placement resource for Red Hat Advanced Cluster Management for Kubernetes. Placement resource has four possible requests: create, query, delete and update.

1.14.1.1. Version information
Copia collegamento

Version : 2.4.0

1.14.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.14.1.3. License information
Copia collegamento

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

1.14.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.14.1.5. Tags
Copia collegamento

cluster.open-cluster-management.io : Create and manage Placements

1.14.1.6. External Docs
Copia collegamento

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

1.14.2. Paths
Copia collegamento

1.14.2.1. Query all Placements
Copia collegamento

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements

Copy to Clipboard

Toggle word wrap

1.14.2.1.1. Description
Copia collegamento

Query your Placements for more details.

1.14.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

1.14.2.1.3. Responses
Copia collegamento

Expand

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

1.14.2.1.4. Consumes
Copia collegamento

placement/yaml

1.14.2.1.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.14.2.2. Create a Placement
Copia collegamento

POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements

POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements

Copy to Clipboard

Toggle word wrap

1.14.2.2.1. Description
Copia collegamento

Create a Placement.

1.14.2.2.2. Parameters
Copia collegamento

Expand

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 placement to be created.	Placement

1.14.2.2.3. Responses
Copia collegamento

Expand

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

1.14.2.2.4. Consumes
Copia collegamento

placement/yaml

1.14.2.2.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.14.2.2.6. Example HTTP request
Copia collegamento

1.14.2.2.6.1. Request body
Copia collegamento

{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "Placement",
  "metadata" : {
    "name" : "placement1",
    "namespace": "ns1"
  },
  "spec": {
    "predicates": [
      {
        "requiredClusterSelector": {
          "labelSelector": {
            "matchLabels": {
              "vendor": "OpenShift"
            }
          }
        }
      }
    ]
  },
  "status" : { }
}

{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "Placement",
  "metadata" : {
    "name" : "placement1",
    "namespace": "ns1"
  },
  "spec": {
    "predicates": [
      {
        "requiredClusterSelector": {
          "labelSelector": {
            "matchLabels": {
              "vendor": "OpenShift"
            }
          }
        }
      }
    ]
  },
  "status" : { }
}

Copy to Clipboard

Toggle word wrap

1.14.2.3. Query a single Placement
Copia collegamento

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements/{placement_name}

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements/{placement_name}

Copy to Clipboard

Toggle word wrap

1.14.2.3.1. Description
Copia collegamento

Query a single Placement for more details.

1.14.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	placement_name required	Name of the Placement that you want to query.	string

1.14.2.3.3. Responses
Copia collegamento

Expand

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

1.14.2.3.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.14.2.4. Delete a Placement
Copia collegamento

DELETE /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements/{placement_name}

DELETE /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements/{placement_name}

Copy to Clipboard

Toggle word wrap

1.14.2.4.1. Description
Copia collegamento

Delete a single Placement.

1.14.2.4.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	placement_name required	Name of the Placement that you want to delete.	string

1.14.2.4.3. Responses
Copia collegamento

Expand

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

1.14.2.4.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.14.3. Definitions
Copia collegamento

1.14.3.1. Placement
Copia collegamento

Expand

Name	Description	Schema
apiVersion required	The versioned schema of the Placement.	string
kind required	String value that represents the REST resource.	string
metadata required	The meta data of the Placement.	object
spec required	The specification of the Placement.	spec

spec

Expand

Name	Description	Schema
ClusterSets optional	A subset of ManagedClusterSets from which the ManagedClusters are selected. If it is empty, ManagedClusters is selected from the ManagedClusterSets that are bound to the Placement namespace. Otherwise, ManagedClusters are selected from the intersection of this subset and the ManagedClusterSets are bound to the placement namespace.	string array
numberOfClusters optional	The desired number of ManagedClusters to be selected.	integer (int32)
predicates optional	A subset of cluster predicates to select ManagedClusters. The conditional logic is OR.	clusterPredicate array

clusterPredicate

Expand

Name	Description	Schema
requiredClusterSelector optional	A cluster selector to select ManagedClusters with a label and cluster claim.	clusterSelector

clusterSelector

Expand

Name	Description	Schema
labelSelector optional	A selector of ManagedClusters by label.	object
claimSelector optional	A selector of ManagedClusters by claim.	clusterClaimSelector

clusterClaimSelector

Expand

Name	Description	Schema
matchExpressions optional	A subset of the cluster claim selector requirements. The conditional logic is AND.	< object > array

1.15. PlacementDecisions API (v1alpha1)
Copia collegamento

1.15.1. Overview
Copia collegamento

This documentation is for the PlacementDecision resource for Red Hat Advanced Cluster Management for Kubernetes. PlacementDecision resource has four possible requests: create, query, delete and update.

1.15.1.1. Version information
Copia collegamento

Version : 2.4.0

1.15.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.15.1.3. License information
Copia collegamento

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

1.15.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.15.1.5. Tags
Copia collegamento

cluster.open-cluster-management.io : Create and manage PlacementDecisions.

1.15.1.6. External Docs
Copia collegamento

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

1.15.2. Paths
Copia collegamento

1.15.2.1. Query all PlacementDecisions
Copia collegamento

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions

Copy to Clipboard

Toggle word wrap

1.15.2.1.1. Description
Copia collegamento

Query your PlacementDecisions for more details.

1.15.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

1.15.2.1.3. Responses
Copia collegamento

Expand

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

1.15.2.1.4. Consumes
Copia collegamento

placementdecision/yaml

1.15.2.1.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.15.2.2. Create a PlacementDecision
Copia collegamento

POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions

POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions

Copy to Clipboard

Toggle word wrap

1.15.2.2.1. Description
Copia collegamento

Create a PlacementDecision.

1.15.2.2.2. Parameters
Copia collegamento

Expand

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 PlacementDecision to be created.	PlacementDecision

1.15.2.2.3. Responses
Copia collegamento

Expand

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

1.15.2.2.4. Consumes
Copia collegamento

placementdecision/yaml

1.15.2.2.5. Tags
Copia collegamento

cluster.open-cluster-management.io

1.15.2.2.6. Example HTTP request
Copia collegamento

1.15.2.2.6.1. Request body
Copia collegamento

{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "PlacementDecision",
  "metadata" : {
    "labels" : {
      "cluster.open-cluster-management.io/placement" : "placement1"
    },
    "name" : "placement1-decision1",
    "namespace": "ns1"
  },
  "status" : { }
}

{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "PlacementDecision",
  "metadata" : {
    "labels" : {
      "cluster.open-cluster-management.io/placement" : "placement1"
    },
    "name" : "placement1-decision1",
    "namespace": "ns1"
  },
  "status" : { }
}

Copy to Clipboard

Toggle word wrap

1.15.2.3. Query a single PlacementDecision
Copia collegamento

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

Copy to Clipboard

Toggle word wrap

1.15.2.3.1. Description
Copia collegamento

Query a single PlacementDecision for more details.

1.15.2.3.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	placementdecision_name required	Name of the PlacementDecision that you want to query.	string

1.15.2.3.3. Responses
Copia collegamento

Expand

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

1.15.2.3.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.15.2.4. Delete a PlacementDecision
Copia collegamento

DELETE /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

DELETE /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

Copy to Clipboard

Toggle word wrap

1.15.2.4.1. Description
Copia collegamento

Delete a single PlacementDecision.

1.15.2.4.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	placementdecision_name required	Name of the PlacementDecision that you want to delete.	string

1.15.2.4.3. Responses
Copia collegamento

Expand

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

1.15.2.4.4. Tags
Copia collegamento

cluster.open-cluster-management.io

1.15.3. Definitions
Copia collegamento

1.15.3.1. PlacementDecision
Copia collegamento

Expand

Name	Description	Schema
apiVersion required	The versioned schema of PlacementDecision.	string
kind required	String value that represents the REST resource.	string
metadata required	The meta data of PlacementDecision.	object

1.16. DiscoveryConfig API
Copia collegamento

1.16.1. Overview
Copia collegamento

This documentation is for the DiscoveryConfig resource for Red Hat Advanced Cluster Management for Kubernetes. The DiscoveryConfig resource has four possible requests: create, query, delete, and update.

1.16.1.1. Version information
Copia collegamento

Version : 2.4.0

1.16.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.16.1.3. License information
Copia collegamento

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

1.16.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.16.1.5. Tags
Copia collegamento

discoveryconfigs.discovery.open-cluster-management.io : Create and manage DiscoveryConfigs

1.16.1.6. External Docs
Copia collegamento

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

1.16.2. Paths
Copia collegamento

1.16.2.1. Create a DiscoveryConfig
Copia collegamento

POST /app.k8s.io/v1alpha1/namespaces/{namespace}/discoveryconfigs

POST /app.k8s.io/v1alpha1/namespaces/{namespace}/discoveryconfigs

Copy to Clipboard

Toggle word wrap

1.16.2.1.1. Description
Copia collegamento

Create a DiscoveryConfig.

1.16.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the DiscoveryConfig to be created.	DiscoveryConfig

1.16.2.1.3. Responses
Copia collegamento

Expand

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

1.16.2.1.4. Consumes
Copia collegamento

discoveryconfigs/yaml

1.16.2.1.5. Tags
Copia collegamento

discoveryconfigs.discovery.open-cluster-management.io

1.16.2.1.5.1. Request body
Copia collegamento

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",
    },
    "creationTimestamp": null,
    "name": "discoveryconfigs.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveryConfig",
      "listKind": "DiscoveryConfigList",
      "plural": "discoveryconfigs",
      "singular": "discoveryconfig"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1alpha1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveryConfig is the Schema for the discoveryconfigs API",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "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",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "DiscoveryConfigSpec defines the desired state of DiscoveryConfig",
                "properties": {
                  "credential": {
                    "description": "Credential is the secret containing credentials to connect to the OCM api on behalf of a user",
                    "type": "string"
                  },
                  "filters": {
                    "description": "Sets restrictions on what kind of clusters to discover",
                    "properties": {
                      "lastActive": {
                        "description": "LastActive is the last active in days of clusters to discover, determined by activity timestamp",
                        "type": "integer"
                      },
                      "openShiftVersions": {
                        "description": "OpenShiftVersions is the list of release versions of OpenShift of the form \"<Major>.<Minor>\"",
                        "items": {
                          "description": "Semver represents a partial semver string with the major and minor version in the form \"<Major>.<Minor>\". For example: \"4.5\"",
                          "pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "type": "object"
                  }
                },
                "required": [
                  "credential"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveryConfigStatus defines the observed state of DiscoveryConfig",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",
    },
    "creationTimestamp": null,
    "name": "discoveryconfigs.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveryConfig",
      "listKind": "DiscoveryConfigList",
      "plural": "discoveryconfigs",
      "singular": "discoveryconfig"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1alpha1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveryConfig is the Schema for the discoveryconfigs API",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "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",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "DiscoveryConfigSpec defines the desired state of DiscoveryConfig",
                "properties": {
                  "credential": {
                    "description": "Credential is the secret containing credentials to connect to the OCM api on behalf of a user",
                    "type": "string"
                  },
                  "filters": {
                    "description": "Sets restrictions on what kind of clusters to discover",
                    "properties": {
                      "lastActive": {
                        "description": "LastActive is the last active in days of clusters to discover, determined by activity timestamp",
                        "type": "integer"
                      },
                      "openShiftVersions": {
                        "description": "OpenShiftVersions is the list of release versions of OpenShift of the form \"<Major>.<Minor>\"",
                        "items": {
                          "description": "Semver represents a partial semver string with the major and minor version in the form \"<Major>.<Minor>\". For example: \"4.5\"",
                          "pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "type": "object"
                  }
                },
                "required": [
                  "credential"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveryConfigStatus defines the observed state of DiscoveryConfig",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

Copy to Clipboard

Toggle word wrap

1.16.2.2. Query all DiscoveryConfigs
Copia collegamento

GET /operator.open-cluster-management.io/v1alpha1/namespaces/{namespace}/operator

GET /operator.open-cluster-management.io/v1alpha1/namespaces/{namespace}/operator

Copy to Clipboard

Toggle word wrap

1.16.2.2.1. Description
Copia collegamento

Query your discovery config operator for more details.

1.16.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.16.2.2.3. Responses
Copia collegamento

Expand

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

1.16.2.2.4. Consumes
Copia collegamento

operator/yaml

1.16.2.2.5. Tags
Copia collegamento

discoveryconfigs.discovery.open-cluster-management.io

1.16.2.3. Delete a DiscoveryConfig operator
Copia collegamento

DELETE /operator.open-cluster-management.io/v1alpha1/namespaces/{namespace}/operator/{discoveryconfigs_name}

DELETE /operator.open-cluster-management.io/v1alpha1/namespaces/{namespace}/operator/{discoveryconfigs_name}

Copy to Clipboard

Toggle word wrap

1.16.2.3.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	application_name required	Name of the Discovery Config operator that you want to delete.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.16.2.3.2. Responses
Copia collegamento

Expand

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

1.16.2.3.3. Tags
Copia collegamento

discoveryconfigs.operator.open-cluster-management.io

1.16.3. Definitions
Copia collegamento

1.16.3.1. DiscoveryConfig
Copia collegamento

Expand

Name	Description	Schema
apiVersion required	The versioned schema of the discoveryconfigs.	string
kind required	String value that represents the REST resource.	string
metadata required	Describes rules that define the resource.	object
spec required	Defines the desired state of DiscoveryConfig.	See List of specs

1.16.3.2. List of specs
Copia collegamento

Expand

Name	Description	Schema
credential required	Credential is the secret containing credentials to connect to the OCM API on behalf of a user.	string
filters optional	Sets restrictions on what kind of clusters to discover.	See List of filters

1.16.3.3. List of filters
Copia collegamento

Expand

Name	Description	Schema
lastActive required	LastActive is the last active in days of clusters to discover, determined by activity timestamp.	integer
openShiftVersions optional	OpenShiftVersions is the list of release versions of OpenShift of the form "<Major>.<Minor>"	object

1.17. DiscoveredCluster API
Copia collegamento

1.17.1. Overview
Copia collegamento

This documentation is for the DiscoveredCluster resource for Red Hat Advanced Cluster Management for Kubernetes. The DiscoveredCluster resource has four possible requests: create, query, delete, and update.

1.17.1.1. Version information
Copia collegamento

Version : 2.4.0

1.17.1.2. Contact information
Copia collegamento

Contact Email : apiteam@swagger.io

1.17.1.3. License information
Copia collegamento

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

1.17.1.4. URI scheme
Copia collegamento

BasePath : /kubernetes/apis
Schemes : HTTPS

1.17.1.5. Tags
Copia collegamento

discoveredclusters.discovery.open-cluster-management.io : Create and manage DiscoveredClusters

1.17.1.6. External Docs
Copia collegamento

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

1.17.2. Paths
Copia collegamento

1.17.2.1. Create a DiscoveredCluster
Copia collegamento

POST /app.k8s.io/v1alpha1/namespaces/{namespace}/discoveredclusters

POST /app.k8s.io/v1alpha1/namespaces/{namespace}/discoveredclusters

Copy to Clipboard

Toggle word wrap

1.17.2.1.1. Description
Copia collegamento

Create a DiscoveredCluster.

1.17.2.1.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the DiscoveredCluster to be created.	DiscoveredCluster

1.17.2.1.3. Responses
Copia collegamento

Expand

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

1.17.2.1.4. Consumes
Copia collegamento

discoveredclusters/yaml

1.17.2.1.5. Tags
Copia collegamento

discoveredclusters.discovery.open-cluster-management.io

1.17.2.1.5.1. Request body
Copia collegamento

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",\
    },
    "creationTimestamp": null,
    "name": "discoveredclusters.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveredCluster",
      "listKind": "DiscoveredClusterList",
      "plural": "discoveredclusters",
      "singular": "discoveredcluster"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1alpha1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveredCluster is the Schema for the discoveredclusters API",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "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",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "DiscoveredClusterSpec defines the desired state of DiscoveredCluster",
                "properties": {
                  "activityTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "apiUrl": {
                    "type": "string"
                  },
                  "cloudProvider": {
                    "type": "string"
                  },
                  "console": {
                    "type": "string"
                  },
                  "creationTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "credential": {
                    "description": "ObjectReference contains enough information to let you inspect or modify the referred object. --- New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.  1. Ignored fields.  It includes many fields which are not generally honored.  For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage.  2. Invalid usage help.  It is impossible to add specific help for individual usage.  In most embedded usages, there are particular     restrictions like, \"must refer only to types A and B\" or \"UID not honored\" or \"name must be restricted\".     Those cannot be well described when embedded.  3. Inconsistent validation.  Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.  4. The fields are both imprecise and overly precise.  Kind is not a precise mapping to a URL. This can produce ambiguity     during interpretation and require a REST mapping.  In most cases, the dependency is on the group,resource tuple     and the version of the actual struct is irrelevant.  5. We cannot easily change it.  Because this type is embedded in many locations, updates to this type     will affect numerous schemas.  Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .",
                    "properties": {
                      "apiVersion": {
                        "description": "API version of the referent.",
                        "type": "string"
                      },
                      "fieldPath": {
                        "description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.",
                        "type": "string"
                      },
                      "kind": {
                        "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                      },
                      "namespace": {
                        "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                        "type": "string"
                      },
                      "resourceVersion": {
                        "description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
                        "type": "string"
                      },
                      "uid": {
                        "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "displayName": {
                    "type": "string"
                  },
                  "isManagedCluster": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "openshiftVersion": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                },
                "required": [
                  "apiUrl",
                  "displayName",
                  "isManagedCluster",
                  "name",
                  "type"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveredClusterStatus defines the observed state of DiscoveredCluster",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",\
    },
    "creationTimestamp": null,
    "name": "discoveredclusters.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveredCluster",
      "listKind": "DiscoveredClusterList",
      "plural": "discoveredclusters",
      "singular": "discoveredcluster"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1alpha1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveredCluster is the Schema for the discoveredclusters API",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "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",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "DiscoveredClusterSpec defines the desired state of DiscoveredCluster",
                "properties": {
                  "activityTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "apiUrl": {
                    "type": "string"
                  },
                  "cloudProvider": {
                    "type": "string"
                  },
                  "console": {
                    "type": "string"
                  },
                  "creationTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "credential": {
                    "description": "ObjectReference contains enough information to let you inspect or modify the referred object. --- New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.  1. Ignored fields.  It includes many fields which are not generally honored.  For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage.  2. Invalid usage help.  It is impossible to add specific help for individual usage.  In most embedded usages, there are particular     restrictions like, \"must refer only to types A and B\" or \"UID not honored\" or \"name must be restricted\".     Those cannot be well described when embedded.  3. Inconsistent validation.  Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.  4. The fields are both imprecise and overly precise.  Kind is not a precise mapping to a URL. This can produce ambiguity     during interpretation and require a REST mapping.  In most cases, the dependency is on the group,resource tuple     and the version of the actual struct is irrelevant.  5. We cannot easily change it.  Because this type is embedded in many locations, updates to this type     will affect numerous schemas.  Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .",
                    "properties": {
                      "apiVersion": {
                        "description": "API version of the referent.",
                        "type": "string"
                      },
                      "fieldPath": {
                        "description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.",
                        "type": "string"
                      },
                      "kind": {
                        "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                      },
                      "namespace": {
                        "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                        "type": "string"
                      },
                      "resourceVersion": {
                        "description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
                        "type": "string"
                      },
                      "uid": {
                        "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "displayName": {
                    "type": "string"
                  },
                  "isManagedCluster": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "openshiftVersion": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                },
                "required": [
                  "apiUrl",
                  "displayName",
                  "isManagedCluster",
                  "name",
                  "type"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveredClusterStatus defines the observed state of DiscoveredCluster",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

Copy to Clipboard

Toggle word wrap

1.17.2.2. Query all DiscoveredClusters
Copia collegamento

GET /operator.open-cluster-management.io/v1alpha1/namespaces/{namespace}/operator

GET /operator.open-cluster-management.io/v1alpha1/namespaces/{namespace}/operator

Copy to Clipboard

Toggle word wrap

1.17.2.2.1. Description
Copia collegamento

Query your discovered clusters operator for more details.

1.17.2.2.2. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.17.2.2.3. Responses
Copia collegamento

Expand

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

1.17.2.2.4. Consumes
Copia collegamento

operator/yaml

1.17.2.2.5. Tags
Copia collegamento

discoveredclusters.discovery.open-cluster-management.io

1.17.2.3. Delete a DiscoveredCluster operator
Copia collegamento

DELETE /operator.open-cluster-management.io/v1alpha1/namespaces/{namespace}/operator/{discoveredclusters_name}

DELETE /operator.open-cluster-management.io/v1alpha1/namespaces/{namespace}/operator/{discoveredclusters_name}

Copy to Clipboard

Toggle word wrap

1.17.2.3.1. Parameters
Copia collegamento

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	application_name required	Name of the Discovered Cluster operator that you want to delete.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.17.2.3.2. Responses
Copia collegamento

Expand

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

1.17.2.3.3. Tags
Copia collegamento

discoveredclusters.operator.open-cluster-management.io

1.17.3. Definitions
Copia collegamento

1.17.3.1. DiscoveredCluster
Copia collegamento

Expand

Name	Description	Schema
apiVersion required	The versioned schema of the discoveredclusters.	string
kind required	String value that represents the REST resource.	string
metadata required	Describes rules that define the resource.	object
spec required	DiscoveredClusterSpec defines the desired state of DiscoveredCluster.	See List of specs

1.17.3.2. List of specs
Copia collegamento

Expand

Name	Description	Schema
activityTimestamp optional	Discoveredclusters last available activity timestamp.	metav1.time
apiUrl required	Discoveredclusters API URL endpoint.	string
cloudProvider optional	Cloud provider of discoveredcluster.	string
console optional	Discoveredclusters console URL endpoint.	string
creationTimestamp optional	Discoveredclusters creation timestamp.	metav1.time
credential optional	The reference to the credential from which the cluster was discovered.	corev1.ObjectReference
displayName required	The display name of the discovered cluster.	string
isManagedCluster required	If true, cluster is managed by ACM.	boolean
name required	The name of the discoveredcluster.	string
openshiftVersion optional	The OpenShift version of the discovered cluster.	string
status optional	The status of the discovered cluster.	string
type required	The OpenShift flavor (ex. OCP, ROSA, etc.).	string

Questo contenuto non è disponibile nella lingua selezionata.

1.1. Clusters APICopia collegamentoCollegamento copiato negli appunti!

1.1.1. OverviewCopia collegamentoCollegamento copiato negli appunti!

1.1.1.1. Version informationCopia collegamentoCollegamento copiato negli appunti!

1.1.1.2. Contact informationCopia collegamentoCollegamento copiato negli appunti!

1.1.1.3. License informationCopia collegamentoCollegamento copiato negli appunti!

1.1.1.4. URI schemeCopia collegamentoCollegamento copiato negli appunti!

1.1.1.5. TagsCopia collegamentoCollegamento copiato negli appunti!

1.1.1.6. External DocsCopia collegamentoCollegamento copiato negli appunti!

1.1.2. PathsCopia collegamentoCollegamento copiato negli appunti!

1.1.2.1. Query all clustersCopia collegamentoCollegamento copiato negli appunti!

1.1.2.1.1. DescriptionCopia collegamentoCollegamento copiato negli appunti!

1.1.2.1.2. ParametersCopia collegamentoCollegamento copiato negli appunti!

1.1.2.1.3. ResponsesCopia collegamentoCollegamento copiato negli appunti!

1.1.2.1.4. ConsumesCopia collegamentoCollegamento copiato negli appunti!

1.1.2.1.5. TagsCopia collegamentoCollegamento copiato negli appunti!

1.1.2.2. Create a clusterCopia collegamentoCollegamento copiato negli appunti!

1.1.2.2.1. DescriptionCopia collegamentoCollegamento copiato negli appunti!

1.1.2.2.2. ParametersCopia collegamentoCollegamento copiato negli appunti!

1.1.2.2.3. ResponsesCopia collegamentoCollegamento copiato negli appunti!

1.1.2.2.4. ConsumesCopia collegamentoCollegamento copiato negli appunti!

1.1.2.2.5. TagsCopia collegamentoCollegamento copiato negli appunti!

1.1.2.2.6. Example HTTP requestCopia collegamentoCollegamento copiato negli appunti!

1.1.2.2.6.1. Request bodyCopia collegamentoCollegamento copiato negli appunti!

1.1.2.3. Query a single clusterCopia collegamentoCollegamento copiato negli appunti!

1.1.2.3.1. DescriptionCopia collegamentoCollegamento copiato negli appunti!

1.1.2.3.2. ParametersCopia collegamentoCollegamento copiato negli appunti!

1.1.2.3.3. ResponsesCopia collegamentoCollegamento copiato negli appunti!

1.1.2.3.4. TagsCopia collegamentoCollegamento copiato negli appunti!

1.1.2.4. Delete a clusterCopia collegamentoCollegamento copiato negli appunti!

1.1.2.4.1. DescriptionCopia collegamentoCollegamento copiato negli appunti!

1.1.2.4.2. ParametersCopia collegamentoCollegamento copiato negli appunti!

1.1.2.4.3. ResponsesCopia collegamentoCollegamento copiato negli appunti!

1.1.2.4.4. TagsCopia collegamentoCollegamento copiato negli appunti!

1.1.3. DefinitionsCopia collegamentoCollegamento copiato negli appunti!

1.1.3.1. ClusterCopia collegamentoCollegamento copiato negli appunti!

1.2. Clustersets API (v1beta1)Copia collegamentoCollegamento copiato negli appunti!

1.2.1. OverviewCopia collegamentoCollegamento copiato negli appunti!

1.2.1.1. Version informationCopia collegamentoCollegamento copiato negli appunti!

1.2.1.2. Contact informationCopia collegamentoCollegamento copiato negli appunti!

1.2.1.3. License informationCopia collegamentoCollegamento copiato negli appunti!

1.2.1.4. URI schemeCopia collegamentoCollegamento copiato negli appunti!

1.2.1.5. TagsCopia collegamentoCollegamento copiato negli appunti!

1.2.1.6. External DocsCopia collegamentoCollegamento copiato negli appunti!

1.2.2. PathsCopia collegamentoCollegamento copiato negli appunti!

1.2.2.1. Query all clustersetsCopia collegamentoCollegamento copiato negli appunti!

1.2.2.1.1. DescriptionCopia collegamentoCollegamento copiato negli appunti!

1.2.2.1.2. ParametersCopia collegamentoCollegamento copiato negli appunti!

1.2.2.1.3. ResponsesCopia collegamentoCollegamento copiato negli appunti!

1.2.2.1.4. ConsumesCopia collegamentoCollegamento copiato negli appunti!

1.2.2.1.5. TagsCopia collegamentoCollegamento copiato negli appunti!

1.2.2.2. Create a clustersetCopia collegamentoCollegamento copiato negli appunti!

1.2.2.2.1. DescriptionCopia collegamentoCollegamento copiato negli appunti!

1.2.2.2.2. ParametersCopia collegamentoCollegamento copiato negli appunti!

1.2.2.2.3. ResponsesCopia collegamentoCollegamento copiato negli appunti!

1.2.2.2.4. ConsumesCopia collegamentoCollegamento copiato negli appunti!

1.2.2.2.5. TagsCopia collegamentoCollegamento copiato negli appunti!

1.2.2.2.6. Example HTTP requestCopia collegamentoCollegamento copiato negli appunti!

1.2.2.2.6.1. Request bodyCopia collegamentoCollegamento copiato negli appunti!

1.2.2.3. Query a single clustersetCopia collegamentoCollegamento copiato negli appunti!

1.2.2.3.1. DescriptionCopia collegamentoCollegamento copiato negli appunti!

1.2.2.3.2. ParametersCopia collegamentoCollegamento copiato negli appunti!

1.2.2.3.3. ResponsesCopia collegamentoCollegamento copiato negli appunti!

1.2.2.3.4. TagsCopia collegamentoCollegamento copiato negli appunti!

1.2.2.4. Delete a clustersetCopia collegamentoCollegamento copiato negli appunti!

1.2.2.4.1. DescriptionCopia collegamentoCollegamento copiato negli appunti!

1.2.2.4.2. ParametersCopia collegamentoCollegamento copiato negli appunti!

1.2.2.4.3. ResponsesCopia collegamentoCollegamento copiato negli appunti!

1.2.2.4.4. TagsCopia collegamentoCollegamento copiato negli appunti!

1.2.3. DefinitionsCopia collegamentoCollegamento copiato negli appunti!

1.2.3.1. ClustersetCopia collegamentoCollegamento copiato negli appunti!

1.3. Clustersetbindings API (v1beta1)Copia collegamentoCollegamento copiato negli appunti!

1.3.1. OverviewCopia collegamentoCollegamento copiato negli appunti!

1.3.1.1. Version informationCopia collegamentoCollegamento copiato negli appunti!

1.3.1.2. Contact informationCopia collegamentoCollegamento copiato negli appunti!

1.3.1.3. License informationCopia collegamentoCollegamento copiato negli appunti!

1.3.1.4. URI schemeCopia collegamentoCollegamento copiato negli appunti!

1.3.1.5. TagsCopia collegamentoCollegamento copiato negli appunti!

1.3.1.6. External DocsCopia collegamentoCollegamento copiato negli appunti!

1.1. Clusters API
Copia collegamento

1.1.1. Overview
Copia collegamento

1.1.1.1. Version information
Copia collegamento

1.1.1.2. Contact information
Copia collegamento

1.1.1.3. License information
Copia collegamento

1.1.1.4. URI scheme
Copia collegamento

1.1.1.5. Tags
Copia collegamento

1.1.1.6. External Docs
Copia collegamento

1.1.2. Paths
Copia collegamento

1.1.2.1. Query all clusters
Copia collegamento

1.1.2.1.1. Description
Copia collegamento

1.1.2.1.2. Parameters
Copia collegamento

1.1.2.1.3. Responses
Copia collegamento

1.1.2.1.4. Consumes
Copia collegamento

1.1.2.1.5. Tags
Copia collegamento

1.1.2.2. Create a cluster
Copia collegamento

1.1.2.2.1. Description
Copia collegamento

1.1.2.2.2. Parameters
Copia collegamento

1.1.2.2.3. Responses
Copia collegamento

1.1.2.2.4. Consumes
Copia collegamento

1.1.2.2.5. Tags
Copia collegamento

1.1.2.2.6. Example HTTP request
Copia collegamento

1.1.2.2.6.1. Request body
Copia collegamento

1.1.2.3. Query a single cluster
Copia collegamento

1.1.2.3.1. Description
Copia collegamento

1.1.2.3.2. Parameters
Copia collegamento

1.1.2.3.3. Responses
Copia collegamento

1.1.2.3.4. Tags
Copia collegamento

1.1.2.4. Delete a cluster
Copia collegamento

1.1.2.4.1. Description
Copia collegamento

1.1.2.4.2. Parameters
Copia collegamento

1.1.2.4.3. Responses
Copia collegamento

1.1.2.4.4. Tags
Copia collegamento

1.1.3. Definitions
Copia collegamento

1.1.3.1. Cluster
Copia collegamento

1.2. Clustersets API (v1beta1)
Copia collegamento

1.2.1. Overview
Copia collegamento

1.2.1.1. Version information
Copia collegamento

1.2.1.2. Contact information
Copia collegamento

1.2.1.3. License information
Copia collegamento

1.2.1.4. URI scheme
Copia collegamento

1.2.1.5. Tags
Copia collegamento

1.2.1.6. External Docs
Copia collegamento

1.2.2. Paths
Copia collegamento

1.2.2.1. Query all clustersets
Copia collegamento

1.2.2.1.1. Description
Copia collegamento

1.2.2.1.2. Parameters
Copia collegamento

1.2.2.1.3. Responses
Copia collegamento

1.2.2.1.4. Consumes
Copia collegamento

1.2.2.1.5. Tags
Copia collegamento

1.2.2.2. Create a clusterset
Copia collegamento

1.2.2.2.1. Description
Copia collegamento

1.2.2.2.2. Parameters
Copia collegamento

1.2.2.2.3. Responses
Copia collegamento

1.2.2.2.4. Consumes
Copia collegamento

1.2.2.2.5. Tags
Copia collegamento

1.2.2.2.6. Example HTTP request
Copia collegamento

1.2.2.2.6.1. Request body
Copia collegamento

1.2.2.3. Query a single clusterset
Copia collegamento

1.2.2.3.1. Description
Copia collegamento

1.2.2.3.2. Parameters
Copia collegamento

1.2.2.3.3. Responses
Copia collegamento

1.2.2.3.4. Tags
Copia collegamento

1.2.2.4. Delete a clusterset
Copia collegamento

1.2.2.4.1. Description
Copia collegamento

1.2.2.4.2. Parameters
Copia collegamento

1.2.2.4.3. Responses
Copia collegamento

1.2.2.4.4. Tags
Copia collegamento

1.2.3. Definitions
Copia collegamento

1.2.3.1. Clusterset
Copia collegamento

1.3. Clustersetbindings API (v1beta1)
Copia collegamento

1.3.1. Overview
Copia collegamento

1.3.1.1. Version information
Copia collegamento

1.3.1.2. Contact information
Copia collegamento

1.3.1.3. License information
Copia collegamento

1.3.1.4. URI scheme
Copia collegamento

1.3.1.5. Tags
Copia collegamento

1.3.1.6. External Docs
Copia collegamento

1.3.2. Paths
Copia collegamento

1.3.2.1. Query all clustersetbindings
Copia collegamento