이 콘텐츠는 선택한 언어로 제공되지 않습니다.
APIs
APIs
Abstract
Chapter 1. APIs
You can access APIs to create and manage application resources, channels, subscriptions, and to query information.
User required access: You can only perform actions that your role is assigned. Learn about access requirements from the Role-based access control documentation.
For more information, review the API documentation for each of the following resources:
- Clusters API
- ClusterSets API (v1beta2)
- ClusterSetBindings API (v1beta2)
- Channels API
- Subscriptions API
- PlacementRules API (deprecated)
- Applications API
- Helm API
- Policy API
- Observability API
- Search query API
- MultiClusterHub API
- Placements API (v1beta1)
- PlacementDecisions API (v1beta1)
- DiscoveryConfig API
- DiscoveredCluster API
- AddOnDeploymentConfig API (v1alpha1)
- ClusterManagementAddOn API (v1alpha1)
- ManagedClusterAddOn API (v1alpha1)
- ManagedClusterSet API
1.1. Clusters API
1.1.1. Overview
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. ManagedCluster
represents the desired state and current status of a managed cluster. ManagedCluster
is a cluster-scoped resource.
1.1.1.1. Version information
Version : 2.8.0
1.1.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.1.1.3. Tags
- cluster.open-cluster-management.io : Create and manage clusters
1.1.2. Paths
1.1.2.1. Query all clusters
GET /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.1.1. Description
Query your clusters for more details.
1.1.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
1.1.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.1.2.1.4. Consumes
-
cluster/yaml
1.1.2.1.5. Tags
- cluster.open-cluster-management.io
1.1.2.2. Create a cluster
POST /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.2.1. Description
Create a cluster
1.1.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Body |
body | Parameters describing the cluster to be created. |
1.1.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.1.2.2.4. Consumes
-
cluster/yaml
1.1.2.2.5. Tags
- cluster.open-cluster-management.io
1.1.2.2.6. Example HTTP request
1.1.2.2.6.1. Request body
{ "apiVersion" : "cluster.open-cluster-management.io/v1", "kind" : "ManagedCluster", "metadata" : { "labels" : { "vendor" : "OpenShift" }, "name" : "cluster1" }, "spec": { "hubAcceptsClient": true, "managedClusterClientConfigs": [ { "caBundle": "test", "url": "https://test.com" } ] }, "status" : { } }
1.1.2.3. Query a single cluster
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
1.1.2.3.1. Description
Query a single cluster for more details.
1.1.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
cluster_name | Name of the cluster that you want to query. | string |
1.1.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.1.2.3.4. Tags
- cluster.open-cluster-management.io
1.1.2.4. Delete a cluster
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}
1.1.2.4.1. Description
Delete a single cluster
1.1.2.4.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
cluster_name | Name of the cluster that you want to delete. | string |
1.1.2.4.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.1.2.4.4. Tags
- cluster.open-cluster-management.io
1.1.3. Definitions
1.1.3.1. Cluster
Name | Description | Schema |
---|---|---|
apiVersion |
The versioned schema of the | string |
kind | String value that represents the REST resource. | string |
metadata |
The metadata of the | object |
spec |
The specification of the |
spec
Name | Description | Schema |
---|---|---|
hubAcceptsClient |
Specifies whether the hub can establish a connection with the klusterlet agent on the managed cluster. The default value is | bool |
managedClusterClientConfigs | Lists the apiserver addresses of the managed cluster. | |
leaseDurationSeconds | Specifies the lease update time interval of the klusterlet agents on the managed cluster. By default, the klusterlet agent updates its lease every 60 seconds. | integer (int32) |
taints | Prevents a managed cluster from being assigned to one or more managed cluster sets during scheduling. | taint array |
managedClusterClientConfigs
Name | Description | Schema |
---|---|---|
URL | string | |
CABundle | Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" | string (byte) |
taint
Name | Description | Schema |
---|---|---|
key | The taint key that is applied to a cluster. | string |
value | The taint value that corresponds to the taint key. | string |
effect |
Effect of the taint on placements that do not tolerate the taint. Valid values are | string |
1.2. Clustersets API (v1beta2)
1.2.1. Overview
This documentation is for the ClusterSet resource for Red Hat Advanced Cluster Management for Kubernetes. The ClusterSet resource has four possible requests: create, query, delete, and update. The ManagedClusterSet defines a group of ManagedClusters. You can assign a ManagedCluster to a specific ManagedClusterSet by adding a label with the name cluster.open-cluster-management.io/clusterset
on the ManagedCluster that refers to the ManagedClusterSet. You can only add or remove this label on a ManagedCluster when you have an RBAC rule that allows the create
permissions on a virtual subresource of managedclustersets/join
. You must have this permission on both the source and the target ManagedClusterSets to update this label.
1.2.1.1. Version information
Version : 2.8.0
1.2.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.2.1.3. Tags
- cluster.open-cluster-management.io : Create and manage Clustersets
1.2.2. Paths
1.2.2.1. Query all clustersets
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets
1.2.2.1.1. Description
Query your Clustersets for more details.
1.2.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
1.2.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.2.2.1.4. Consumes
-
clusterset/yaml
1.2.2.1.5. Tags
- cluster.open-cluster-management.io
1.2.2.2. Create a clusterset
POST /cluster.open-cluster-management.io/v1beta2/managedclustersets
1.2.2.2.1. Description
Create a Clusterset.
1.2.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Body |
body | Parameters describing the clusterset to be created. |
1.2.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.2.2.2.4. Consumes
-
clusterset/yaml
1.2.2.2.5. Tags
- cluster.open-cluster-management.io
1.2.2.2.6. Example HTTP request
1.2.2.2.6.1. Request body
{ "apiVersion": "cluster.open-cluster-management.io/v1beta2", "kind": "ManagedClusterSet", "metadata": { "name": "clusterset1" }, "spec": { "clusterSelector": { "selectorType": "ExclusiveClusterSetLabel" } }, "status": {} }
1.2.2.3. Query a single clusterset
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}
1.2.2.3.1. Description
Query a single clusterset for more details.
1.2.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
clusterset_name | Name of the clusterset that you want to query. | string |
1.2.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.2.2.3.4. Tags
- cluster.open-cluster-management.io
1.2.2.4. Delete a clusterset
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}
1.2.2.4.1. Description
Delete a single clusterset.
1.2.2.4.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
clusterset_name | Name of the clusterset that you want to delete. | string |
1.2.2.4.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.2.2.4.4. Tags
- cluster.open-cluster-management.io
1.2.3. Definitions
1.2.3.1. Clusterset
Name | Schema |
---|---|
apiVersion | string |
kind | string |
metadata | object |
1.3. Clustersetbindings API (v1beta2)
1.3.1. Overview
This documentation is for the ClusterSetBinding resource for Red Hat Advanced Cluster Management for Kubernetes. The ClusterSetBinding resource has four possible requests: create, query, delete, and update. ManagedClusterSetBinding projects a ManagedClusterSet into a certain namespace. You can create a ManagedClusterSetBinding in a namespace and bind it to a ManagedClusterSet if you have an RBAC rule that allows you to create
on the virtual subresource of managedclustersets/bind
.
1.3.1.1. Version information
Version : 2.8.0
1.3.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.3.1.3. Tags
- cluster.open-cluster-management.io : Create and manage clustersetbindings
1.3.2. Paths
1.3.2.1. Query all clustersetbindings
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings
1.3.2.1.1. Description
Query your clustersetbindings for more details.
1.3.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.3.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.3.2.1.4. Consumes
-
clustersetbinding/yaml
1.3.2.1.5. Tags
- cluster.open-cluster-management.io
1.3.2.2. Create a clustersetbinding
POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings
1.3.2.2.1. Description
Create a clustersetbinding.
1.3.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace |
Namespace that you want to use, for example, | string |
Body |
body | Parameters describing the clustersetbinding to be created. |
1.3.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.3.2.2.4. Consumes
-
clustersetbinding/yaml
1.3.2.2.5. Tags
- cluster.open-cluster-management.io
1.3.2.2.6. Example HTTP request
1.3.2.2.6.1. Request body
{ "apiVersion" : "cluster.open-cluster-management.io/v1beta2", "kind" : "ManagedClusterSetBinding", "metadata" : { "name" : "clusterset1", "namespace" : "ns1" }, "spec": { "clusterSet": "clusterset1" }, "status" : { } }
1.3.2.3. Query a single clustersetbinding
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}
1.3.2.3.1. Description
Query a single clustersetbinding for more details.
1.3.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace |
Namespace that you want to use, for example, | string |
Path |
clustersetbinding_name | Name of the clustersetbinding that you want to query. | string |
1.3.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.3.2.3.4. Tags
- cluster.open-cluster-management.io
1.3.2.4. Delete a clustersetbinding
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersetbindings/{clustersetbinding_name}
1.3.2.4.1. Description
Delete a single clustersetbinding.
1.3.2.4.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace |
Namespace that you want to use, for example, | string |
Path |
clustersetbinding_name | Name of the clustersetbinding that you want to delete. | string |
1.3.2.4.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.3.2.4.4. Tags
- cluster.open-cluster-management.io
1.3.3. Definitions
1.3.3.1. Clustersetbinding
Name | Description | Schema |
---|---|---|
apiVersion |
Versioned schema of the | string |
kind | String value that represents the REST resource. | string |
metadata |
Metadata of the | object |
spec |
Specification of the |
spec
Name | Description | Schema |
---|---|---|
clusterSet |
Name of the | string |
1.4. Clusterview API (v1alpha1)
1.4.1. Overview
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
Version : 2.8.0
1.4.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.4.1.3. Tags
- clusterview.open-cluster-management.io : View a list of managed clusters that your ID can access.
1.4.2. Paths
1.4.2.1. Get managed clusters
GET /managedclusters.clusterview.open-cluster-management.io
1.4.2.1.1. Description
View a list of the managed clusters that you can access.
1.4.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
1.4.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.4.2.1.4. Consumes
-
managedcluster/yaml
1.4.2.1.5. Tags
- clusterview.open-cluster-management.io
1.4.2.2. List managed clusters
LIST /managedclusters.clusterview.open-cluster-management.io
1.4.2.2.1. Description
View a list of the managed clusters that you can access.
1.4.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Body |
body | Name of the user ID for which you want to list the managed clusters. | string |
1.4.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.4.2.2.4. Consumes
-
managedcluster/yaml
1.4.2.2.5. Tags
- clusterview.open-cluster-management.io
1.4.2.2.6. Example HTTP request
1.4.2.2.6.1. Request body
{ "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1", "kind" : "ClusterView", "metadata" : { "name" : "<user_ID>" }, "spec": { }, "status" : { } }
1.4.2.3. Watch the managed cluster sets
WATCH /managedclusters.clusterview.open-cluster-management.io
1.4.2.3.1. Description
Watch the managed clusters that you can access.
1.4.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
clusterview_name | Name of the user ID that you want to watch. | string |
1.4.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.4.2.4. List the managed cluster sets.
GET /managedclustersets.clusterview.open-cluster-management.io
1.4.2.4.1. Description
List the managed clusters that you can access.
1.4.2.4.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
clusterview_name | Name of the user ID that you want to watch. | string |
1.4.2.4.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.4.2.5. List the managed cluster sets.
LIST /managedclustersets.clusterview.open-cluster-management.io
1.4.2.5.1. Description
List the managed clusters that you can access.
1.4.2.5.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
clusterview_name | Name of the user ID that you want to watch. | string |
1.4.2.5.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.4.2.6. Watch the managed cluster sets.
WATCH /managedclustersets.clusterview.open-cluster-management.io
1.4.2.6.1. Description
Watch the managed clusters that you can access.
1.4.2.6.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
clusterview_name | Name of the user ID that you want to watch. | string |
1.4.2.6.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.5. Channels API
1.5.1. Overview
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
Version : 2.8.0
1.5.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.5.1.3. Tags
- channels.apps.open-cluster-management.io : Create and manage deployables
1.5.2. Paths
1.5.2.1. Create a channel
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.5.2.1.1. Description
Create a channel.
1.5.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Body |
body | Parameters describing the deployable to be created. |
1.5.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.5.2.1.4. Consumes
-
application/yaml
1.5.2.1.5. Tags
- channels.apps.open-cluster-management.io
1.5.2.1.6. Example HTTP request
1.5.2.1.6.1. Request body
{ "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" } }
1.5.2.2. Query all channels for the target namespace
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.5.2.2.1. Description
Query your channels for more details.
1.5.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.5.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.5.2.2.4. Consumes
-
application/yaml
1.5.2.2.5. Tags
- channels.apps.open-cluster-management.io
1.5.2.3. Query a single channels of a namespace
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.5.2.3.1. Description
Query a single channels for more details.
1.5.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
channel_name | Name of the deployable that you wan to query. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.5.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.5.2.3.4. Tags
- channels.apps.open-cluster-management.io
1.5.2.4. Delete a Channel
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.5.2.4.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
channel_name | Name of the Channel that you want to delete. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.5.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.5.2.4.3. Tags
- channels.apps.open-cluster-management.io
1.5.3. Definitions
1.5.3.1. Channel
Name | Schema |
---|---|
apiVersion | string |
kind | string |
metadata | object |
spec |
spec
Name | Description | Schema |
---|---|---|
configMapRef | ObjectReference contains enough information to let you inspect or modify the referred object. | |
gates | ChannelGate defines criteria for promote to channel | |
pathname | string | |
secretRef | ObjectReference contains enough information to let you inspect or modify the referred object. | |
sourceNamespaces | enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) array |
configMapRef
Name | Description | Schema |
---|---|---|
apiVersion | API version of the referent. | string |
fieldPath | 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 | Kind of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/ |
name |
Name of the referent. More info: Names | string |
namespace |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
resourceVersion |
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 | string |
uid |
gates
Name | Description | Schema |
---|---|---|
annotations | typical annotations of k8s | |
labelSelector | 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. | |
name | string |
annotations
Name | Schema |
---|---|
key | string |
value | string |
labelSelector
Name | Description | Schema |
---|---|---|
matchExpressions | matchExpressions is a list of label selector requirements. The requirements are ANDed. | matchExpressions array |
matchLabels | 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
Name | Description | Schema |
---|---|---|
key | key is the label key that the selector applies to. | string |
operator | operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. | string |
values | 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
Name | Description | Schema |
---|---|---|
apiVersion | API version of the referent. | string |
fieldPath | 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 | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | string |
name | Name of the referent. More info: Names | string |
namespace | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
resourceVersion | 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 | string |
uid | UID of the referent. More info: UIIDs | string |
1.6. Subscriptions API
1.6.1. Overview
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
Version : 2.8.0
1.6.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.6.1.3. Tags
- subscriptions.apps.open-cluster-management.io : Create and manage subscriptions
1.6.2. Paths
1.6.2.1. Create a subscription
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.1.1. Description
Create a subscription.
1.6.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Body |
body | Parameters describing the subscription to be created. |
1.6.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.6.2.1.4. Consumes
-
subscription/yaml
1.6.2.1.5. Tags
- subscriptions.apps.open-cluster-management.io
1.6.2.1.6. Example HTTP request
1.6.2.1.6.1. Request body
{ "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" } } } }
1.6.2.2. Query all subscriptions
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.2.1. Description
Query your subscriptions for more details.
1.6.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.6.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.6.2.2.4. Consumes
-
subscription/yaml
1.6.2.2.5. Tags
- subscriptions.apps.open-cluster-management.io
1.6.2.3. Query a single subscription
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.3.1. Description
Query a single subscription for more details.
1.6.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Path |
subscription_name | Name of the subscription that you wan to query. | string |
1.6.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.6.2.3.4. Tags
- subscriptions.apps.open-cluster-management.io
1.6.2.4. Delete a subscription
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.4.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Path |
subscription_name | Name of the subscription that you want to delete. | string |
1.6.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.6.2.4.3. Tags
- subscriptions.apps.open-cluster-management.io
1.6.3. Definitions
1.6.3.1. Subscription
Name | Schema |
---|---|
apiVersion | string |
kind | string |
metadata | |
spec | |
status |
metadata
Name | Schema |
---|---|
annotations | object |
labels | object |
name | string |
namespace | string |
spec
Name | Schema |
---|---|
channel | string |
name | string |
overrides | overrides array |
packageFilter | |
packageOverrides | packageOverrides array |
placement | |
timewindow |
overrides
Name | Schema |
---|---|
clusterName | string |
clusterOverrides | object array |
packageFilter
Name | Description | Schema |
---|---|---|
annotations | string, string map | |
filterRef | ||
labelSelector | ||
version |
Pattern : | string |
filterRef
Name | Schema |
---|---|
name | string |
labelSelector
Name | Schema |
---|---|
matchExpressions | matchExpressions array |
matchLabels | string, string map |
matchExpressions
Name | Schema |
---|---|
key | string |
operator | string |
values | string array |
packageOverrides
Name | Schema |
---|---|
packageAlias | string |
packageName | string |
packageOverrides | object array |
placement
Name | Schema |
---|---|
clusterSelector | |
clusters | clusters array |
local | boolean |
placementRef |
clusterSelector
Name | Schema |
---|---|
matchExpressions | matchExpressions array |
matchLabels | string, string map |
matchExpressions
Name | Schema |
---|---|
key | string |
operator | string |
values | string array |
clusters
Name | Schema |
---|---|
name | string |
placementRef
Name | Schema |
---|---|
apiVersion | string |
fieldPath | string |
kind | string |
name | string |
namespace | string |
resourceVersion | string |
uid | string |
timewindow
Name | Schema |
---|---|
daysofweek | string array |
hours | hours array |
location | string |
windowtype | enum (active, blocked, Active, Blocked) |
hours
Name | Schema |
---|---|
end | string |
start | string |
status
Name | Schema |
---|---|
lastUpdateTime | string (date-time) |
message | string |
phase | string |
reason | string |
statuses | object |
1.7. PlacementRules API (deprecated)
1.7.1. Overview
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
Version : 2.8.0
1.7.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.7.1.3. Tags
- placementrules.apps.open-cluster-management.io : Create and manage placement rules
1.7.2. Paths
1.7.2.1. Create a placement rule
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.7.2.1.1. Description
Create a placement rule.
1.7.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Body |
body | Parameters describing the placement rule to be created. |
1.7.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.7.2.1.4. Consumes
-
application/yaml
1.7.2.1.5. Tags
- placementrules.apps.open-cluster-management.io
1.7.2.1.6. Example HTTP request
1.7.2.1.6.1. Request body
{ "apiVersion" : "apps.open-cluster-management.io/v1", "kind" : "PlacementRule", "metadata" : { "name" : "towhichcluster", "namespace" : "ns-sub-1" }, "spec" : { "clusterConditions" : [ { "type": "ManagedClusterConditionAvailable", "status": "True" } ], "clusterSelector" : { } } }
1.7.2.2. Query all placement rules
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.7.2.2.1. Description
Query your placement rules for more details.
1.7.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.7.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.7.2.2.4. Consumes
-
application/yaml
1.7.2.2.5. Tags
- placementrules.apps.open-cluster-management.io
1.7.2.3. Query a single placementrule
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.7.2.3.1. Description
Query a single placement rule for more details.
1.7.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Path |
placementrule_name | Name of the placementrule that you want to query. | string |
1.7.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.7.2.3.4. Tags
- placementrules.apps.open-cluster-management.io
1.7.2.4. Delete a placementrule
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.7.2.4.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Path |
placementrule_name | Name of the placementrule that you want to delete. | string |
1.7.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.7.2.4.3. Tags
- placementrules.apps.open-cluster-management.io
1.7.3. Definitions
1.7.3.1. Placementrule
Name | Schema |
---|---|
apiVersion | string |
kind | string |
metadata | object |
spec |
spec
Name | Schema |
---|---|
clusterConditions | clusterConditions array |
clusterReplicas | integer |
clusterSelector | |
clusters | clusters array |
policies | policies array |
resourceHint | |
schedulerName | string |
clusterConditions
Name | Schema |
---|---|
status | string |
type | string |
clusterSelector
Name | Schema |
---|---|
matchExpressions | matchExpressions array |
matchLabels | string, string map |
matchExpressions
Name | Schema |
---|---|
key | string |
operator | string |
values | string array |
clusters
Name | Schema |
---|---|
name | string |
policies
Name | Schema |
---|---|
apiVersion | string |
fieldPath | string |
kind | string |
name | string |
namespace | string |
resourceVersion | string |
uid | string |
resourceHint
Name | Schema |
---|---|
order | string |
type | string |
1.8. Applications API
1.8.1. Overview
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
Version : 2.8.0
1.8.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.8.1.3. Tags
- applications.app.k8s.io : Create and manage applications
1.8.2. Paths
1.8.2.1. Create a application
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.8.2.1.1. Description
Create a application.
1.8.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Body |
body | Parameters describing the application to be created. |
1.8.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.8.2.1.4. Consumes
-
application/yaml
1.8.2.1.5. Tags
- applications.app.k8s.io
1.8.2.1.6. Example HTTP request
1.8.2.1.6.1. Request body
{ "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" : { } }
1.8.2.2. Query all applications
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.8.2.2.1. Description
Query your applications for more details.
1.8.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.8.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.8.2.2.4. Consumes
-
application/yaml
1.8.2.2.5. Tags
- applications.app.k8s.io
1.8.2.3. Query a single application
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.8.2.3.1. Description
Query a single application for more details.
1.8.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
application_name | Name of the application that you wan to query. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.8.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.8.2.3.4. Tags
- applications.app.k8s.io
1.8.2.4. Delete a application
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.8.2.4.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
application_name | Name of the application that you want to delete. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.8.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.8.2.4.3. Tags
- applications.app.k8s.io
1.8.3. Definitions
1.8.3.1. Application
Name | Schema |
---|---|
apiVersion | string |
kind | string |
metadata | object |
spec |
spec
Name | Schema |
---|---|
assemblyPhase | string |
componentKinds | object array |
descriptor | |
info | info array |
selector | object |
descriptor
Name | Schema |
---|---|
description | string |
icons | icons array |
keywords | string array |
links | links array |
maintainers | maintainers array |
notes | string |
owners | owners array |
type | string |
version | string |
icons
Name | Schema |
---|---|
size | string |
src | string |
type | string |
links
Name | Schema |
---|---|
description | string |
url | string |
maintainers
Name | Schema |
---|---|
email | string |
name | string |
url | string |
owners
Name | Schema |
---|---|
email | string |
name | string |
url | string |
info
Name | Schema |
---|---|
name | string |
type | string |
value | string |
valueFrom |
valueFrom
Name | Schema |
---|---|
configMapKeyRef | |
ingressRef | |
secretKeyRef | |
serviceRef | |
type | string |
configMapKeyRef
Name | Schema |
---|---|
apiVersion | string |
fieldPath | string |
key | string |
kind | string |
name | string |
namespace | string |
resourceVersion | string |
uid | string |
ingressRef
Name | Schema |
---|---|
apiVersion | string |
fieldPath | string |
host | string |
kind | string |
name | string |
namespace | string |
path | string |
resourceVersion | string |
uid | string |
secretKeyRef
Name | Schema |
---|---|
apiVersion | string |
fieldPath | string |
key | string |
kind | string |
name | string |
namespace | string |
resourceVersion | string |
uid | string |
serviceRef
Name | Schema |
---|---|
apiVersion | string |
fieldPath | string |
kind | string |
name | string |
namespace | string |
path | string |
port | integer (int32) |
resourceVersion | string |
uid | string |
1.9. Helm API
1.9.1. Overview
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
Version : 2.8.0
1.9.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.9.1.3. Tags
- helmreleases.apps.open-cluster-management.io : Create and manage helmreleases
1.9.2. Paths
1.9.2.1. Create a helmrelease
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.9.2.1.1. Description
Create a helmrelease.
1.9.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Body |
body | Parameters describing the helmrelease to be created. |
1.9.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.9.2.1.4. Consumes
-
application/yaml
1.9.2.1.5. Tags
- helmreleases.apps.open-cluster-management.io
1.9.2.1.6. Example HTTP request
1.9.2.1.6.1. Request body
{ "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 } } }
1.9.2.2. Query all helmreleases
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.9.2.2.1. Description
Query your helmreleases for more details.
1.9.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.9.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.9.2.2.4. Consumes
-
application/yaml
1.9.2.2.5. Tags
- helmreleases.apps.open-cluster-management.io
1.9.2.3. Query a single helmrelease
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.9.2.3.1. Description
Query a single helmrelease for more details.
1.9.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
helmrelease_name | Name of the helmrelease that you wan to query. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.9.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.9.2.3.4. Tags
- helmreleases.apps.open-cluster-management.io
1.9.2.4. Delete a helmrelease
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.9.2.4.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
helmrelease_name | Name of the helmrelease that you want to delete. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.9.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.9.2.4.3. Tags
- helmreleases.apps.open-cluster-management.io
1.9.3. Definitions
1.9.3.1. HelmRelease
Name | Schema |
---|---|
apiVersion | string |
kind | string |
metadata | object |
repo | |
spec | object |
status |
repo
Name | Schema |
---|---|
chartName | string |
configMapRef | |
secretRef | |
source | |
version | string |
configMapRef
Name | Schema |
---|---|
apiVersion | string |
fieldPath | string |
kind | string |
name | string |
namespace | string |
resourceVersion | string |
uid | string |
secretRef
Name | Schema |
---|---|
apiVersion | string |
fieldPath | string |
kind | string |
name | string |
namespace | string |
resourceVersion | string |
uid | string |
source
Name | Schema |
---|---|
github | |
helmRepo | |
type | string |
github
Name | Schema |
---|---|
branch | string |
chartPath | string |
urls | string array |
helmRepo
Name | Schema |
---|---|
urls | string array |
status
Name | Schema |
---|---|
conditions | conditions array |
deployedRelease |
conditions
Name | Schema |
---|---|
lastTransitionTime | string (date-time) |
message | string |
reason | string |
status | string |
type | string |
deployedRelease
Name | Schema |
---|---|
manifest | string |
name | string |
1.10. Policy API
1.10.1. Overview
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
Version : 2.8.0
1.10.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.10.1.3. Tags
- policy.open-cluster-management.io/v1 : Create and manage policies
1.10.2. Paths
1.10.2.1. Create a policy
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.10.2.1.1. Description
Create a policy.
1.10.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Body |
body | Parameters describing the policy to be created. |
1.10.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.10.2.1.4. Consumes
-
application/json
1.10.2.1.5. Tags
- policy.open-cluster-management.io
1.10.2.1.6. Example HTTP request
1.10.2.1.6.1. Request body
{ "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", "metadataComplianceType": "musthave", "metadata": { "namespace": null, "name": "test-role" }, "selector": { "matchLabels": { "cloud": "IBM" } }, "spec" : { "object-templates": { "complianceType": "musthave", "metadataComplianceType": "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" ], }, ], }, }, }, },
1.10.2.2. Query all policies
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.10.2.2.1. Description
Query your policies for more details.
1.10.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to apply the policy to, for example, default. | string |
1.10.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.10.2.2.4. Consumes
-
application/json
1.10.2.2.5. Tags
- policy.open-cluster-management.io
1.10.2.3. Query a single policy
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.10.2.3.1. Description
Query a single policy for more details.
1.10.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
policy_name | Name of the policy that you want to query. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.10.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.10.2.3.4. Tags
- policy.open-cluster-management.io
1.10.2.4. Delete a policy
DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.10.2.4.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
policy_name | Name of the policy that you want to delete. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.10.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.10.2.4.3. Tags
- policy.open-cluster-management.io
1.10.3. Definitions
1.10.3.1. Policy
Name | Description | Schema |
---|---|---|
apiVersion | The versioned schema of Policy. | string |
kind | String value that represents the REST resource. | string |
metadata | Describes rules that define the policy. | object |
spec
Name | Description | Schema |
---|---|---|
remediationAction | Value that represents how violations are handled as defined in the resource. | string |
namespaceSelector | Value that represents which namespaces the policy is applied. | string |
policy-templates
Name | Description | Schema |
---|---|---|
apiVersion | The versioned schema of Policy. | string |
kind | String value that represents the REST resource. | string |
metadata | 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 |
metadataComplianceType |
Provides a way for users to process labels and annotations of an object differently than the other fields. The parameter value defaults to the same value of the | string |
clusterConditions | Section to define labels. | string |
rules | string |
clusterConditions
Name | Description | Schema |
---|---|---|
matchLabels | The label that is required for the policy to be applied to a namespace. | object |
cloud | The label that is required for the policy to be applied to a cloud provider. | string |
rules
Name | Description | Schema |
---|---|---|
apiGroups | List of APIs that the rule applies to. | string |
resources | A list of resource types. | object |
verbs | A list of verbs. | string |
1.11. Observability API
1.11.1. Overview
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
Version : 2.8.0
1.11.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.11.1.3. Tags
- observability.open-cluster-management.io : Create and manage multiclusterobservabilities
1.11.2. Paths
1.11.2.1. Create a multiclusterobservability resource
POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
1.11.2.1.1. Description
Create a MultiClusterObservability resource.
1.11.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Body |
body | Parameters describing the MultiClusterObservability resource to be created. |
1.11.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.11.2.1.4. Consumes
-
application/yaml
1.11.2.1.5. Tags
- observability.apps.open-cluster-management.io
1.11.2.1.6. Example HTTP request
1.11.2.1.6.1. Request body
{ "apiVersion": "observability.open-cluster-management.io/v1beta2", "kind": "MultiClusterObservability", "metadata": { "name": "example" }, "spec": { "observabilityAddonSpec": {} "storageConfig": { "metricObjectStorage": { "name": "thanos-object-storage", "key": "thanos.yaml" "writeStorage": { - "key": " ", "name" : " " - "key": " ", "name" : " " } } } }
1.11.2.2. Query all multiclusterobservabilities
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
1.11.2.2.1. Description
Query your MultiClusterObservability resources for more details.
1.11.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
1.11.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.11.2.2.4. Consumes
-
application/yaml
1.11.2.2.5. Tags
- observability.apps.open-cluster-management.io
1.11.2.3. Query a single multiclusterobservability
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
1.11.2.3.1. Description
Query a single MultiClusterObservability resource for more details.
1.11.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
multiclusterobservability_name | Name of the multiclusterobservability that you want to query. | string |
1.11.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.11.2.3.4. Tags
- observability.apps.open-cluster-management.io
1.11.2.4. Delete a multiclusterobservability resource
DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
1.11.2.4.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
multiclusterobservability_name | Name of the multiclusterobservability that you want to delete. | string |
1.11.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.11.2.4.3. Tags
- observability.apps.open-cluster-management.io
1.11.3. Definitions
1.11.3.1. MultiClusterObservability
Name | Description | Schema |
---|---|---|
apiVersion | The versioned schema of the MultiClusterObservability. | string |
kind | String value that represents the REST resource, MultiClusterObservability. | string |
metadata | Describes rules that define the policy. | object |
spec
Name | Description | Schema |
---|---|---|
enableDownsampling |
Enable or disable the downsample. Default value is | boolean |
imagePullPolicy |
Pull policy for the MultiClusterObservability images. The default value is | corev1.PullPolicy |
imagePullSecret |
Pull secret for the MultiClusterObservability images. The default value is | string |
nodeSelector | Specification of the node selector. | map[string]string |
observabilityAddonSpec | The global settings for all managed clusters, which have the observability add-on installed. | |
storageConfig | Specifies the storage configuration to be used by observability. | StorageConfig |
tolerations | Provided the ability for all components to tolerate any taints. | []corev1.Toleration |
advanced | The advanced configuration settings for observability. | |
resources | Compute resources required by MultiClusterObservability. | corev1.ResourceRequirements |
replicas | Replicas for MultiClusterObservability. | integer |
storageConfig
Name | Description | Schema |
---|---|---|
alertmanagerStorageSize |
The amount of storage applied to the alertmanager stateful sets. Default value is | string |
compactStorageSize |
The amount of storage applied to the thanos compact stateful sets. Default value is | string |
metricObjectStorage | Object store to configure secrets for metrics. | |
receiveStorageSize |
The amount of storage applied to thanos receive stateful sets. Default value is | string |
ruleStorageSize |
The amount of storage applied to thanos rule stateful sets. Default value is | string |
storageClass |
Specify the | string |
storeStorageSize |
The amount of storage applied to thanos store stateful sets. Default value is | string |
writeStorage | A list of endpoint access information. | [ ]WriteStorage |
writeStorage
Name | Description | Schema |
---|---|---|
name | The name of the secret with endpoint access information. | string |
key | The key of the secret to select from. | string |
metricObjectStorage
Name | Description | Schema |
---|---|---|
key | The key of the secret to select from. Must be a valid secret key. See Thanos documentation. | string |
name |
Name of the | string |
observabilityAddonSpec
Name | Description | Schema |
---|---|---|
enableMetrics |
Indicates if the observability add-on sends metrics to the hub cluster. Default value is | boolean |
interval |
Interval for when the observability add-on sends metrics to the hub cluster. Default value is 300 seconds ( | integer |
resources |
Resource for the metrics collector resource requirement. The default CPU request is | corev1.ResourceRequirements |
advanced
Name | Description | Schema |
---|---|---|
retentionConfig | Specifies the data retention configuration to be used by observability. |
|
rbacQueryProxy | Specifies the replicas and resources for the rbac-query-proxy deployment. | CommonSpec |
grafana | Specifies the replicas and resources for the grafana deployment | CommonSpec |
alertmanager | Specifies the replicas and resources for alertmanager statefulset. | CommonSpec |
observatoriumAPI |
Specifies the replicas and resources for the | CommonSpec |
queryFrontend | Specifies the replicas and resources for the query-frontend deployment. | CommonSpec |
query | Specifies the replicas and resources for the query deployment. | CommonSpec |
receive | Specifies the replicas and resources for the receive statefulset. | CommonSpec |
rule | Specifies the replicas and resources for rule statefulset. | CommonSpec |
store | Specifies the replicas and resources for the store statefulset. | CommonSpec |
CompactSpec | Specifies the resources for compact statefulset. | |
storeMemcached | Specifies the replicas, resources, etc. for store-memcached. | |
queryFrontendMemcached | Specifies the replicas, resources, etc for query-frontend-memcached. | CacheConfig |
retentionConfig
Name | Description | Schema |
---|---|---|
blockDuration |
The amount of time to block the duration for Time Series Database (TSDB) block. Default value is | string |
cleanupInterval |
The frequency of how often partially uploaded blocks are cleaned, and how often blocks with the deletion mark that have | string |
deleteDelay |
The amount of time until a block marked for deletion is deleted from a bucket. Default value is | string |
retentionInLocal |
The amount of time to retain raw samples from the local storage. Default value is | string |
retentionResolutionRaw |
The amount of time to retain raw samples of resolution in a bucket. Default value is 30 days ( | string |
retentionResolution5m |
The amount of time to retain samples of resolution 1 (5 minutes) in a bucket. Default value is 180 days ( | string |
retentionResolution1h |
The amount of time to retain samples of resolution 2 (1 hour) in a bucket. Default value is 0 days ( | string |
CompactSpec
Name | Description | Schema |
---|---|---|
resources | Compute resources required by thanos compact. | corev1.ResourceRequirements |
serviceAccountAnnotations | Annotations is an unstructured key value map stored with the compact service account. | map[string]string |
storeMemcached
Name | Description | Schema |
---|---|---|
resources | Compute resources required by MultiCLusterObservability. | corev1.ResourceRequirements |
replicas | Replicas for MultiClusterObservability. | integer |
memoryLimitMb | Memory limit of Memcached in megabytes. | integer |
maxItemSize |
Max item size of Memcached. The default value is | string |
connectionLimit | Max simultaneous connections of Memcached. The default value is | integer |
status
Name | Description | Schema |
---|---|---|
status | Status contains the different condition statuses for MultiClusterObservability. | metav1.Condition |
CommonSpec
Name | Description | Schema |
---|---|---|
resources | Compute resources required by the component. | corev1.ResourceRequirements |
replicas | Replicas for the component. | integer |
QuerySpec
Name | Description | Schema |
CommonSpec | Specifies the replicas and resources for the query deployment. | CommonSpec |
serviceAccountAnnotations | Annotations is an unstructured key value map stored with the query service account. | map[string]string |
ReceiveSpec
Name | Description | Schema |
CommonSpec | Specifies the replicas and resources for the query deployment. | CommonSpec |
serviceAccountAnnotations | Annotations is an unstructured key value map stored with the query service account. | map[string]string |
StoreSpec
Name | Description | Schema |
CommonSpec | Specifies the replicas and resources for the query deployment. | CommonSpec |
serviceAccountAnnotations | Annotations is an unstructured key value map stored with the query service account. | map[string]string |
RuleSpec
Name | Description | Schema |
CommonSpec | Specifies the replicas and resources for the query deployment. | CommonSpec |
evalInterval | Specifies the evaluation interval for the rules. | string |
serviceAccountAnnotations | Annotations is an unstructured key value map stored with the query service account. | map[string]string |
1.12. Search query API
The search query API is not a Kubernetes API, therefore is not displayed through the Red Hat OpenShift Container Platform API Explorer. Continue reading to understand the search query API capabilities.
1.12.1. Overview
You can expose the search query API with a route and use the API to resolve search queries. The API is a GraphQL endpoint. You can use any client such as curl or Postman.
1.12.1.1. Version information
Version : 2.8.0
1.12.1.2. URI scheme
BasePath : /searchapi/graphql
Schemes : HTTPS
1.12.1.3. Configure API access
Create a route to access the Search API external from your cluster with the following command:
oc create route passthrough search-api --service=search-search-api -n open-cluster-management
Important: You must configure your route to secure your environment. See Route configuration in the OpenShift Container Platform documentation for more details.
1.12.2. Schema design
input SearchFilter { property: String! values: [String]! } input SearchInput { keywords: [String] filters: [SearchFilter] limit: Int relatedKinds: [String] } type SearchResult { count: Int items: [Map] related: [SearchRelatedResult] } type SearchRelatedResult { kind: String! count: Int items: [Map] }
Parameters with !
indicates that the field is required.
1.12.2.1. Description table of query inputs
Type | Description | Property |
---|---|---|
SearchFilter | Defines a key and value to filter results. When you provide many values for a property, the API interpret the values as an "OR" operation. When you provide many filters, results match all filters and the API interprets as an "AND" operation. | string |
SearchInput | Enter key words to receive a list of resources. When you provide many keywords, the API interprets it as an "AND" operation. | String |
limit |
Determine the maximum number of results returned after you enter the query. The default value is | Integer |
1.12.2.2. Schema example
{ "query": "type SearchResult {count: Intitems: [Map]related: [SearchRelatedResult]} type SearchRelatedResult {kind: String!count: Intitems: [Map]}", "variables": { "input": [ { "keywords": [], "filters": [ { "property": "kind", "values": [ "Deployment" ] } ], "limit": 10 } ] } }
1.12.3. Generic schema
type Query { search(input: [SearchInput]): [SearchResult] searchComplete(property: String!, query: SearchInput, limit: Int): [String] searchSchema: Map messages: [Message] }
1.12.4. Supported queries
Continue reading to see the query types that are supported in JSON format.
1.12.4.1. Search for deployments
Query:
query mySearch($input: [SearchInput]) { search(input: $input) { items } }
Variables:
{"input":[ { "keywords":[], "filters":[ {"property":"kind","values":["Deployment"]}], "limit":10 } ]}
1.12.4.2. Search for pods
Query:
query mySearch($input: [SearchInput]) { search(input: $input) { items } }
Variables:
{"input":[ { "keywords":[], "filters":[ {"property":"kind","values":["Pod"]}], "limit":10 } ]}
1.13. MultiClusterHub API
1.13.1. Overview
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
Version : 2.8.0
1.13.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.13.1.3. Tags
- multiclusterhubs.operator.open-cluster-management.io : Create and manage multicluster hub operators
1.13.2. Paths
1.13.2.1. Create a MultiClusterHub resource
POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch
1.13.2.1.1. Description
Create a MultiClusterHub resource to define the configuration for an instance of the multicluster hub.
1.13.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
Body |
body | Parameters describing the multicluster hub to be created. |
1.13.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.13.2.1.4. Consumes
-
multiclusterhubs/yaml
1.13.2.1.5. Tags
- multiclusterhubs.operator.open-cluster-management.io
1.13.2.1.6. Example HTTP request
1.13.2.1.6.1. Request body
{ "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": {} } } ] } }
1.13.2.2. Query all MultiClusterHubs
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator
1.13.2.2.1. Description
Query your multicluster hub operator for more details.
1.13.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.13.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.13.2.2.4. Consumes
-
operator/yaml
1.13.2.2.5. Tags
- multiclusterhubs.operator.open-cluster-management.io
1.13.2.3. Query a MultiClusterHub operator
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
1.13.2.3.1. Description
Query a single multicluster hub operator for more details.
1.13.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
application_name | Name of the application that you wan to query. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.13.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.13.2.3.4. Tags
- multiclusterhubs.operator.open-cluster-management.io
1.13.2.4. Delete a MultiClusterHub operator
DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
1.13.2.4.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
application_name | Name of the multicluster hub operator that you want to delete. | string |
Path |
namespace | Namespace that you want to use, for example, default. | string |
1.13.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.13.2.4.3. Tags
- multiclusterhubs.operator.open-cluster-management.io
1.13.3. Definitions
1.13.3.1. Multicluster hub operator
Name | Description | Schema |
---|---|---|
apiVersion | The versioned schema of the MultiClusterHub. | string |
kind | String value that represents the REST resource. | string |
metadata | Describes rules that define the resource. | object |
spec | The resource specification. |
spec
availabilityConfig optional | Specifies deployment replication for improved availability. The default value is High . | string |
---|---|---|
customCAConfigmap | Provide the customized OpenShift default ingress CA certificate to Red Hat Advanced Cluster Management. | string |
disableHubSelfManagement | Disable automatic import of the hub cluster as a managed cluster. | boolean |
disableUpdateClusterImageSets | Disable automatic update of ClusterImageSets. | boolean |
hive | (Deprecated) An object that overrides for the default HiveConfig specification. | |
imagePullSecret | Overrides pull secret for accessing MultiClusterHub operand and endpoint images. | string |
ingress | Configuration options for ingress management. | |
nodeSelector | Set the node selectors. | string |
separateCertificateManagement |
(Deprecated) Install | boolean |
hive
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 | (Deprecated) Specifies the configuration for backup integration. If absent, backup integration is disabled. | |
externalDNS |
(Deprecated) Specifies configuration for | object |
failedProvisionConfig | (Deprecated) Used to configure settings related to handling provision failures. | |
globalPullSecret |
(Deprecated) Used to specify a pull secret that is used globally by all of the cluster deployments. For each cluster deployment, the contents of | object |
maintenanceMode |
(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 | boolean |
ingress
sslCiphers optional | List of SSL ciphers enabled for management ingress. Defaults to full list of supported ciphers. | string |
---|
backup
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 | (Deprecated) Velero specifies configuration for the Velero backup integration. | object |
failedProvisionConfig
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
components optional | The components of the status configuration. | object |
---|---|---|
conditions | Contains the different conditions for the multicluster hub. | |
desiredVersion | Indicates the desired version. | string |
phase |
Represents the active phase of the MultiClusterHub resource. The values that are used for this parameter are: | string |
conditions
lastTransitionTime optional | The last time the condition changed from one status to another. | string |
---|---|---|
lastUpdateTime | The last time this condition was updated. | string |
message | Message is a human-readable message indicating details about the last status change. | string |
reason | A brief reason for why the condition status changed. | string |
status | The status of the condition. | string |
type | The type of the cluster condition. | string |
StatusConditions
kind required | The resource kind that represents this status. | string |
---|---|---|
available | Indicates whether this component is properly running. | boolean |
lastTransitionTime | The last time the condition changed from one status to another. | metav1.time |
lastUpdateTime | The last time this condition was updated. | metav1.time |
message | Message is a human-readable message indicating details about the last status change. | string |
reason | A brief reason for why the condition status changed. | string |
status | The status of the condition. | string |
type | The type of the cluster condition. | string |
1.14. Placement API (v1beta1)
1.14.1. Overview
This documentation is for the Placement resource for Red Hat Advanced Cluster Management for Kubernetes. The Placement resource has four possible requests: create, query, delete, and update. Placement defines a rule to select a set of ManagedClusters from the ManagedClusterSets that are bound to the placement namespace. A slice of PlacementDecisions with the label cluster.open-cluster-management.io/placement={placement name}
is created to represent the ManagedClusters that are selected by this placement.
1.14.1.1. Version information
Version : 2.8.0
1.14.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.14.1.3. Tags
- cluster.open-cluster-management.io : Create and manage Placements
1.14.2. Paths
1.14.2.1. Query all Placements
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement
1.14.2.1.1. Description
Query your Placements for more details.
1.14.2.1.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
1.14.2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.14.2.1.4. Consumes
-
placement/yaml
1.14.2.1.5. Tags
- cluster.open-cluster-management.io
1.14.2.2. Create a Placement
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
1.14.2.2.1. Description
Create a Placement.
1.14.2.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Body |
body | Parameters describing the placement binding to be created. |
1.14.2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.14.2.2.4. Consumes
-
placement/yaml
1.14.2.2.5. Tags
- cluster.open-cluster-management.io
1.14.2.2.6. Example HTTP request
1.14.2.2.6.1. Request body
{ "apiVersion" : "cluster.open-cluster-management.io/v1beta1", "kind" : "Placement", "metadata" : { "name" : "placement1", "namespace": "ns1" }, "spec": { "predicates": [ { "requiredClusterSelector": { "labelSelector": { "matchLabels": { "vendor": "OpenShift" } } } } ] }, "status" : { } }
1.14.2.3. Query a single Placement
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
1.14.2.3.1. Description
Query a single Placement for more details.
1.14.2.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
placement_name | Name of the Placement that you want to query. | string |
1.14.2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Success | No Content |
403 | Access forbidden | No Content |
404 | Resource not found | No Content |
500 | Internal service error | No Content |
503 | Service unavailable | No Content |
1.14.2.3.4. Tags
- cluster.open-cluster-management.io
1.14.2.4. Delete a Placement
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
1.14.2.4.1. Description
Delete a single Placement.
1.14.2.4.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string |
Path |
placement_name | Name of the Placement that you want to delete. |