Red Hat Advanced Cluster Management for Kubernetes 2.1 APIs · 2021. 2. 18. · Red Hat Advanced...

Red Hat Advanced Cluster Managementfor Kubernetes 2.1

APIs

APIs

Last Updated: 2021-06-23

Red Hat Advanced Cluster Management for Kubernetes 2.1 APIs

APIs

Legal Notice

Copyright © 2021 Red Hat, Inc.

The text of and illustrations in this document are licensed by Red Hat under a Creative CommonsAttribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA isavailable athttp://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you mustprovide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert,Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift,Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United Statesand other countries.

Linux ® is the registered trademark of Linus Torvalds in the United States and other countries.

Java ® is a registered trademark of Oracle and/or its affiliates.

XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United Statesand/or other countries.

MySQL ® is a registered trademark of MySQL AB in the United States, the European Union andother countries.

Node.js ® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by theofficial Joyent Node.js open source or commercial project.

The OpenStack ® Word Mark and OpenStack logo are either registered trademarks/service marksor trademarks/service marks of the OpenStack Foundation, in the United States and othercountries and are used with the OpenStack Foundation's permission. We are not affiliated with,endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Abstract

API guide for Red Hat Advanced Cluster Management for Kubernetes

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Table of Contents

CHAPTER 1. APIS1.1. CLUSTERS API

1.1.1. Overview1.1.1.1. Version information1.1.1.2. Contact information1.1.1.3. License information1.1.1.4. URI scheme1.1.1.5. Tags1.1.1.6. External Docs

1.1.2. Paths1.1.2.1. Query all clusters

1.1.2.1.1. Description1.1.2.1.2. Parameters1.1.2.1.3. Responses1.1.2.1.4. Consumes1.1.2.1.5. Tags

1.1.2.2. Create a cluster1.1.2.2.1. Description1.1.2.2.2. Parameters1.1.2.2.3. Responses1.1.2.2.4. Consumes1.1.2.2.5. Tags1.1.2.2.6. Example HTTP request

1.1.2.2.6.1. Request body1.1.2.3. Query a single cluster

1.1.2.3.1. Description1.1.2.3.2. Parameters1.1.2.3.3. Responses1.1.2.3.4. Tags

1.1.2.4. Delete a cluster1.1.2.4.1. Description1.1.2.4.2. Parameters1.1.2.4.3. Responses1.1.2.4.4. Tags

1.1.3. Definitions1.1.3.1. Cluster

1.2. CLUSTERSETS API (V1ALPHA1)1.2.1. Overview

1.2.1.1. Version information1.2.1.2. Contact information1.2.1.3. License information1.2.1.4. URI scheme1.2.1.5. Tags1.2.1.6. External Docs

1.2.2. Paths1.2.2.1. Query all clustersets


9999999

1010101010101010111111111111111111

121212121313131313131414141415151515151515151515151616

Table of Contents

1

1.2.2.2. Create a clusterset1.2.2.2.1. Description1.2.2.2.2. Parameters1.2.2.2.3. Responses1.2.2.2.4. Consumes1.2.2.2.5. Tags1.2.2.2.6. Example HTTP request

1.2.2.2.6.1. Request body1.2.2.3. Query a single clusterset


1.2.2.4. Delete a clusterset1.2.2.4.1. Description1.2.2.4.2. Parameters1.2.2.4.3. Responses1.2.2.4.4. Tags

1.2.3. Definitions1.2.3.1. Clusterset

1.3. CLUSTERSETBINDINGS API (V1ALPHA1)1.3.1. Overview


1.3.2. Paths1.3.2.1. Query all clustersetbindings


1.3.2.2. Create a clustersetbinding1.3.2.2.1. Description1.3.2.2.2. Parameters1.3.2.2.3. Responses1.3.2.2.4. Consumes1.3.2.2.5. Tags1.3.2.2.6. Example HTTP request

1.3.2.2.6.1. Request body1.3.2.3. Query a single clustersetbinding


1.3.2.4. Delete a clustersetbinding1.3.2.4.1. Description1.3.2.4.2. Parameters1.3.2.4.3. Responses1.3.2.4.4. Tags

161616161717171717171718181818181819191919191919

2020202020202020202121212121212222222222222223232323232424


2

1.3.3. Definitions1.3.3.1. Clustersetbinding

1.4. CHANNELS API1.4.1. Overview


1.4.2. Paths1.4.2.1. Create a channel

1.4.2.1.1. Description1.4.2.1.2. Parameters1.4.2.1.3. Responses1.4.2.1.4. Consumes1.4.2.1.5. Tags1.4.2.1.6. Example HTTP request

1.4.2.1.6.1. Request body1.4.2.2. Query all channels for the target namespace


1.4.2.3. Query a single channels of a namespace1.4.2.3.1. Description1.4.2.3.2. Parameters1.4.2.3.3. Responses1.4.2.3.4. Tags

1.4.2.4. Delete a Channel1.4.2.4.1. Parameters1.4.2.4.2. Responses1.4.2.4.3. Tags

1.4.3. Definitions1.4.3.1. Channel

1.5. SUBSCRIPTIONS API1.5.1. Overview


1.5.2. Paths1.5.2.1. Create a subscription


1.5.2.1.6.1. Request body

2424252525252525252525252526262626262627272727272728282828282828292929293333333333333334343434343434353535

Table of Contents

3

1.5.2.2. Query all subscriptions1.5.2.2.1. Description1.5.2.2.2. Parameters1.5.2.2.3. Responses1.5.2.2.4. Consumes1.5.2.2.5. Tags

1.5.2.3. Query a single subscription1.5.2.3.1. Description1.5.2.3.2. Parameters1.5.2.3.3. Responses1.5.2.3.4. Tags

1.5.2.4. Delete a subscription1.5.2.4.1. Parameters1.5.2.4.2. Responses1.5.2.4.3. Tags

1.5.3. Definitions1.5.3.1. Subscription

1.6. PLACEMENTRULES API1.6.1. Overview


1.6.2. Paths1.6.2.1. Create a placement rule


1.6.2.1.6.1. Request body1.6.2.2. Query all placementrules


1.6.2.3. Query a single placementrule1.6.2.3.1. Description1.6.2.3.2. Parameters1.6.2.3.3. Responses1.6.2.3.4. Tags

1.6.2.4. Delete a placementrule1.6.2.4.1. Parameters1.6.2.4.2. Responses1.6.2.4.3. Tags

1.6.3. Definitions1.6.3.1. Placementrule

1.7. APPLICATIONS API1.7.1. Overview

3636363636363636373737373738383838444444444444444444444445454545454546464646464647474747474747484848485151


4


1.7.2. Paths1.7.2.1. Create a application


1.7.2.1.6.1. Request body1.7.2.2. Query all applications


1.7.2.3. Query a single application1.7.2.3.1. Description1.7.2.3.2. Parameters1.7.2.3.3. Responses1.7.2.3.4. Tags

1.7.2.4. Delete a application1.7.2.4.1. Parameters1.7.2.4.2. Responses1.7.2.4.3. Tags

1.7.3. Definitions1.7.3.1. Application

1.8. HELM API1.8.1. Overview


1.8.2. Paths1.8.2.1. Create a helmrelease


1.8.2.1.6.1. Request body1.8.2.2. Query all helmreleases

1.8.2.2.1. Description1.8.2.2.2. Parameters1.8.2.2.3. Responses

5151515151515252525252525252535353535354545454545455555555565656626262626262626262626363636363636364646464

Table of Contents

5

1.8.2.2.4. Consumes1.8.2.2.5. Tags

1.8.2.3. Query a single helmrelease1.8.2.3.1. Description1.8.2.3.2. Parameters1.8.2.3.3. Responses1.8.2.3.4. Tags

1.8.2.4. Delete a helmrelease1.8.2.4.1. Parameters1.8.2.4.2. Responses1.8.2.4.3. Tags

1.8.3. Definitions1.8.3.1. HelmRelease

1.9. POLICY API1.9.1. Overview


1.9.2. Paths1.9.2.1. Create a policy


1.9.2.1.6.1. Request body1.9.2.2. Query all policies


1.9.2.3. Query a single policy1.9.2.3.1. Description1.9.2.3.2. Parameters1.9.2.3.3. Responses1.9.2.3.4. Tags

1.9.2.4. Delete a policy1.9.2.4.1. Parameters1.9.2.4.2. Responses1.9.2.4.3. Tags

1.9.3. Definitions1.9.3.1. Policy

1.10. OBSERVABILITY API1.10.1. Overview

1.10.1.1. Version information1.10.1.2. Contact information1.10.1.3. License information1.10.1.4. URI scheme

6565656565656666666666676770707070707171717171717171727272727474747474747474757575757576767676787878787878


6

1.10.1.5. Tags1.10.1.6. External Docs

1.10.2. Paths1.10.2.1. Create a multiclusterobservability resource


1.10.2.1.6.1. Request body1.10.2.2. Query all multiclusterobservabilities


1.10.2.3. Query a single multiclusterobservability1.10.2.3.1. Description1.10.2.3.2. Parameters1.10.2.3.3. Responses1.10.2.3.4. Tags

1.10.2.4. Delete a multiclusterobservability resource1.10.2.4.1. Parameters1.10.2.4.2. Responses1.10.2.4.3. Tags

1.10.3. Definitions1.10.3.1. MultiClusterObservability

787878787979797979797980808080808081818181818181

82828282

Table of Contents

7


8

CHAPTER 1. APISYou can access APIs to create and manage application resources, channels, subscriptions, and to queryinformation.

User required access: You can only perform actions that your role is assigned. Learn about accessrequirements from the Role-based access control documentation.

For more information, review the API documentation for each of the following resources:

Clusters API

ClusterSets API (v1alpha1)

ClusterSetBindings API (v1alpha1)

Channels API

Subscriptions API

PlacementRules API

Applications API

Helm API

Policy API

Observability API

1.1. CLUSTERS API

1.1.1. Overview

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

1.1.1.1. Version information

Version : 2.1.0

1.1.1.2. Contact information

Contact Email : [email protected]

1.1.1.3. License information

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

1.1.1.4. URI scheme

BasePath : /kubernetes/apis

CHAPTER 1. APIS

9

../security#role-based-access-control

mailto:[email protected]

http://www.apache.org/licenses/LICENSE-2.0.html

http://swagger.io/terms/

BasePath : /kubernetes/apisSchemes : HTTPS

1.1.1.5. Tags

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

1.1.1.6. External Docs

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

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 COOKIErequired

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

string

1.1.2.1.3. Responses

HTTPCode

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


10

http://swagger.io

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


Create a cluster





string

Body bodyrequired

Parameters describing the cluster to be created. Cluster


HTTPCode

Description Schema






1.1.2.2.4. Consumes

cluster/yaml

1.1.2.2.5. Tags


1.1.2.2.6. Example HTTP request


CHAPTER 1. APIS

11

1.1.2.3. Query a single cluster

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


Query a single cluster for more details.





string

Path cluster_namerequired

Name of the cluster that you want to query. string


HTTPCode

Description Schema




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


12



HTTPCode

Description Schema

1.1.2.3.4. Tags


1.1.2.4. Delete a cluster

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


Delete a single cluster





string

Path cluster_namerequired

Name of the cluster that you want to delete. string


HTTPCode

Description Schema






1.1.2.4.4. Tags


CHAPTER 1. APIS

13

1.1.3. Definitions

1.1.3.1. Cluster

Name Schema

apiVersionrequired

string

kindrequired

string

metadatarequired

object

specrequired

spec

spec

Name Schema

hubAcceptsClientrequired

bool

managedClusterClientConfigsoptional

< managedClusterClientConfigs > array

leaseDurationSecondsoptional

integer (int32)

managedClusterClientConfigs

Name Description Schema

URLrequired

string

CABundleoptional

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

string (byte)

1.2. CLUSTERSETS API (V1ALPHA1)

1.2.1. Overview

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


14


Version : 2.1.0





1.2.1.4. URI scheme


1.2.1.5. 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/v1alpha1/managedclustersets


Query your Clustersets for more details.





string


CHAPTER 1. APIS

15




http://swagger.io

HTTPCode

Description Schema






1.2.2.1.4. Consumes

clusterset/yaml

1.2.2.1.5. Tags


1.2.2.2. Create a clusterset

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


Create a clusterset.





string

Body bodyrequired

Parameters describing the clusterset to be created. Clusterset


HTTPCode

Description Schema




16




HTTPCode

Description Schema

1.2.2.2.4. Consumes

clusterset/yaml

1.2.2.2.5. Tags




1.2.2.3. Query a single clusterset

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


Query a single clusterset for more details.





string

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

CHAPTER 1. APIS

17

Path clusterset_namerequired

Name of the clusterset that you want to query. string



HTTPCode

Description Schema






1.2.2.3.4. Tags


1.2.2.4. Delete a clusterset

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


Delete a single clusterset.





string

Path clusterset_namerequired

Name of the clusterset that you want to delete. string



18

HTTPCode

Description Schema






1.2.2.4.4. Tags


1.2.3. Definitions

1.2.3.1. Clusterset

Name Schema

apiVersionrequired

string

kindrequired

string

metadatarequired

object

1.3. CLUSTERSETBINDINGS API (V1ALPHA1)

1.3.1. Overview

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


Version : 2.1.0



CHAPTER 1. APIS

19




1.3.1.4. URI scheme


1.3.1.5. 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/v1alpha1/namespaces/{namespace}/managedclustersetbindings


Query your clustersetbindings for more details.





string

Path namespacerequired

Namespace that you want to use, for example,default.

string


HTTPCode

Description Schema




20



http://swagger.io




HTTPCode

Description Schema

1.3.2.1.4. Consumes

clustersetbinding/yaml

1.3.2.1.5. Tags


1.3.2.2. Create a clustersetbinding

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


Create a clustersetbinding.





string



string

Body bodyrequired

Parameters describing the clustersetbinding to becreated.

Clustersetbinding


HTTPCode

Description Schema



CHAPTER 1. APIS

21




HTTPCode

Description Schema

1.3.2.2.4. Consumes

clustersetbinding/yaml

1.3.2.2.5. Tags




1.3.2.3. Query a single clustersetbinding

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


Query a single clustersetbinding for more details.


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


22




string



string

Path clustersetbinding_namerequired

Name of the clustersetbinding that you want toquery.

string


HTTPCode

Description Schema






1.3.2.3.4. Tags


1.3.2.4. Delete a clustersetbinding

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


Delete a single clustersetbinding.





string

CHAPTER 1. APIS

23



string

Path clustersetbinding_namerequired

Name of the clustersetbinding that you want todelete.

string



HTTPCode

Description Schema






1.3.2.4.4. Tags


1.3.3. Definitions

1.3.3.1. Clustersetbinding

Name Schema

apiVersionrequired

string

kindrequired

string

metadatarequired

object

specrequired

spec


24

spec

Name Schema

clusterSetrequired

string

1.4. CHANNELS API

1.4.1. Overview

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


Version : 2.1.0





1.4.1.4. URI scheme


1.4.1.5. Tags

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



1.4.2. Paths

1.4.2.1. Create a channel

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


CHAPTER 1. APIS

25




http://swagger.io

Create a channel.





string



string

Body bodyrequired

Parameters describing the deployable to be created. Channel


HTTPCode

Description Schema






1.4.2.1.4. Consumes

application/yaml

1.4.2.1.5. Tags

channels.apps.open-cluster-management.io



{ "apiVersion" : "apps.open-cluster-management.io/v1", "kind" : "Channel", "name" : "sample-channel", "namespace" : "default", "spec" : { "type" : "Git",


26

1.4.2.2. Query all channels for the target namespace

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


Query your channels for more details.





string



string


HTTPCode

Description Schema






1.4.2.2.4. Consumes

application/yaml

1.4.2.2.5. Tags


"pathname" : "https://github.com/IBM/charts.git", "configMapRef" : { "name" : "bookinfo-resource-filter-configmap", "kind" : "configmap" } }}

CHAPTER 1. APIS

27

1.4.2.3. Query a single channels of a namespace

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


Query a single channels for more details.





string

Path channel_namerequired

Name of the deployable that you wan to query. string



string


HTTPCode

Description Schema






1.4.2.3.4. Tags


1.4.2.4. Delete a Channel

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



28




string

Path channel_namerequired

Name of the Channel that you want to delete. string



string


HTTPCode

Description Schema






1.4.2.4.3. Tags


1.4.3. Definitions

1.4.3.1. Channel

Name Schema

apiVersionrequired

string

kindrequired

string

metadatarequired

object

CHAPTER 1. APIS

29

specrequired

spec

Name Schema

spec


configMapRefoptional

ObjectReference contains enough information to let you inspector modify the referred object.

configMapRef

gatesoptional

ChannelGate defines criteria for promote to channel gates

pathnamerequired

string

secretRefoptional

ObjectReference contains enough information to let you inspector modify the referred object.

secretRef

sourceNamespacesoptional

< enum (Namespace,HelmRepo,ObjectBucket, Git,namespace,helmrepo,objectbucket,github) > array

configMapRef


apiVersionoptional

API version of the referent. string

fieldPathoptional

If referring to a piece of an object instead of an entire object, thisstring should contain a valid JSON/Go field access statement,such as desiredState.manifest.containers[2]. For example, if theobject reference is to a container within a pod, this would take ona value like: "spec.containers{name}" (where "name" refers to thename of the container that triggered the event) or if no containername is specified "spec.containers[2]" (container with index 2 inthis pod). This syntax is chosen only to have some well-definedway of referencing a part of an object. TODO: this design is notfinal and this field is subject to change in the future.

string


30

kindoptional

Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

string

nameoptional

Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

string

namespaceoptional

Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

string

resourceVersionoptional

Specific resourceVersion to which this reference is made, if any.More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

string

uidoptional

UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

string


gates


annotationsoptional

typical annotations of k8s annotations

labelSelectoroptional

A label selector is a label query over a set of resources. The resultof matchLabels and matchExpressions are ANDed. An empty labelselector matches all objects. A null label selector matches noobjects.

labelSelector

nameoptional

string

annotations

Name Schema

keyoptional

string

valueoptional

string

CHAPTER 1. APIS

31

https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

labelSelector


matchExpressionsoptional

matchExpressions is a list of label selector requirements. Therequirements are ANDed.

< matchExpressions> array

matchLabelsoptional

matchLabels is a map of {key,value} pairs. A single {key,value} inthe matchLabels map is equivalent to an element ofmatchExpressions, whose key field is "key", the operator is "In",and the values array contains only "value". The requirements areANDed.

< string, string > map

matchExpressions


keyrequired

key is the label key that the selector applies to. string

operatorrequired

operator represents a key’s relationship to a set of values. Validoperators are In, NotIn, Exists and DoesNotExist.

string

valuesoptional

values is an array of string values. If the operator is In or NotIn, thevalues array must be non-empty. If the operator is Exists orDoesNotExist, the values array must be empty. This array isreplaced during a strategic merge patch.

< string > array

secretRef


apiVersionoptional

API version of the referent. string

fieldPathoptional

If referring to a piece of an object instead of an entire object, thisstring should contain a valid JSON/Go field access statement,such as desiredState.manifest.containers[2]. For example, if theobject reference is to a container within a pod, this would take ona value like: "spec.containers{name}" (where "name" refers to thename of the container that triggered the event) or if no containername is specified "spec.containers[2]" (container with index 2 inthis pod). This syntax is chosen only to have some well-definedway of referencing a part of an object. TODO: this design is notfinal and this field is subject to change in the future.

string


32

kindoptional

Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

string

nameoptional

Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

string

namespaceoptional

Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

string


Specific resourceVersion to which this reference is made, if any.More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

string

uidoptional

UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

string


1.5. SUBSCRIPTIONS API

1.5.1. Overview

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


Version : 2.1.0





1.5.1.4. URI scheme


1.5.1.5. Tags

CHAPTER 1. APIS

33

https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids




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



1.5.2. Paths

1.5.2.1. Create a subscription

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


Create a subscription.





string



string

Body bodyrequired

Parameters describing the subscription to becreated.

Subscription


HTTPCode

Description Schema






1.5.2.1.4. Consumes

subscription/yaml


34

http://swagger.io

1.5.2.1.5. Tags

subscriptions.apps.open-cluster-management.io



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

CHAPTER 1. APIS

35

1.5.2.2. Query all subscriptions

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


Query your subscriptions for more details.





string



string


HTTPCode

Description Schema






1.5.2.2.4. Consumes

subscription/yaml

1.5.2.2.5. Tags


1.5.2.3. Query a single subscription

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



36

Query a single subscription for more details.





string



string

Path subscription_namerequired

Name of the subscription that you wan to query. string


HTTPCode

Description Schema






1.5.2.3.4. Tags


1.5.2.4. Delete a subscription

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





string

CHAPTER 1. APIS

37



string

Path subscription_namerequired

Name of the subscription that you want to delete. string



HTTPCode

Description Schema






1.5.2.4.3. Tags


1.5.3. Definitions

1.5.3.1. Subscription

Name Schema

apiVersionrequired

string

kindrequired

string

metadatarequired

metadata

specrequired

spec


38

statusoptional

status

Name Schema

metadata

Name Schema

annotationsoptional

object

labelsoptional

object

nameoptional

string

namespaceoptional

string

spec

Name Schema

channelrequired

string

nameoptional

string

overridesoptional

< overrides > array

packageFilteroptional

packageFilter

packageOverridesoptional

< packageOverrides > array

placementoptional

placement

timewindowoptional

timewindow

CHAPTER 1. APIS

39

overrides

Name Schema

clusterNamerequired

string

clusterOverridesrequired

< object > array

packageFilter


annotationsoptional


filterRefoptional

filterRef

labelSelectoroptional

labelSelector

versionoptional

Pattern : "()((\\.[0-9])(\\.)|(\\.[0-9])?(\\.[xX]))$" string

filterRef

Name Schema

nameoptional

string

labelSelector

Name Schema


< matchExpressions > array

matchLabelsoptional


matchExpressions


40

Name Schema

keyrequired

string

operatorrequired

string

valuesoptional

< string > array

packageOverrides

Name Schema

packageAliasoptional

string

packageNamerequired

string

packageOverridesoptional

< object > array

placement

Name Schema

clusterSelectoroptional

clusterSelector

clustersoptional

< clusters > array

localoptional

boolean

placementRefoptional

placementRef

clusterSelector

Name Schema



CHAPTER 1. APIS

41

matchLabelsoptional


Name Schema

matchExpressions

Name Schema

keyrequired

string

operatorrequired

string

valuesoptional

< string > array

clusters

Name Schema

namerequired

string

placementRef

Name Schema

apiVersionoptional

string

fieldPathoptional

string

kindoptional

string

nameoptional

string

namespaceoptional

string


string


42

uidoptional

string

Name Schema

timewindow

Name Schema

daysofweekoptional

< string > array

hoursoptional

< hours > array

locationoptional

string

windowtypeoptional

enum (active, blocked, Active, Blocked)

hours

Name Schema

endoptional

string

startoptional

string

status

Name Schema

lastUpdateTimeoptional

string (date-time)

messageoptional

string

phaseoptional

string

reasonoptional

string

CHAPTER 1. APIS

43

statusesoptional

object

Name Schema

1.6. PLACEMENTRULES API

1.6.1. Overview

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


Version : 2.1.0





1.6.1.4. URI scheme


1.6.1.5. Tags

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



1.6.2. Paths

1.6.2.1. Create a placement rule

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


Create a placement rule.


44




http://swagger.io





string



string

Body bodyrequired

Parameters describing the placement rule to becreated.

Placementrule


HTTPCode

Description Schema






1.6.2.1.4. Consumes

application/yaml

1.6.2.1.5. Tags

placementrules.apps.open-cluster-management.io



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

CHAPTER 1. APIS

45

1.6.2.2. Query all placementrules

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


Query your placement rules for more details.





string



string


HTTPCode

Description Schema






1.6.2.2.4. Consumes

application/yaml

1.6.2.2.5. Tags


"type": "ManagedClusterConditionAvailable", "status": "True" } ], "clusterSelector" : { } }}


46

1.6.2.3. Query a single placementrule

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


Query a single placement rule for more details.





string



string

Path placementrule_namerequired

Name of the placement rule that you want to query. string


HTTPCode

Description Schema






1.6.2.3.4. Tags


1.6.2.4. Delete a placementrule

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


CHAPTER 1. APIS

47




string



string

Path placementrule_namerequired

Name of the placementrule that you want to delete. string


HTTPCode

Description Schema






1.6.2.4.3. Tags


1.6.3. Definitions

1.6.3.1. Placementrule

Name Schema

apiVersionrequired

string

kindrequired

string

metadatarequired

object


48

specrequired

spec

Name Schema

spec

Name Schema

clusterConditionsoptional

< clusterConditions > array

clusterReplicasoptional

integer

clusterSelectoroptional

clusterSelector

clustersoptional

< clusters > array

policiesoptional

< policies > array

resourceHintoptional

resourceHint

schedulerNameoptional

string

clusterConditions

Name Schema

statusoptional

string

typeoptional

string

clusterSelector

Name Schema



CHAPTER 1. APIS

49

matchLabelsoptional


Name Schema

matchExpressions

Name Schema

keyoptional

string

operatoroptional

string

valuesoptional

< string > array

clusters

Name Schema

nameoptional

string

policies

Name Schema

apiVersionoptional

string

fieldPathoptional

string

kindoptional

string

nameoptional

string

namespaceoptional

string


string


50

uidoptional

string

Name Schema

resourceHint

Name Schema

orderoptional

string

typeoptional

string

1.7. APPLICATIONS API

1.7.1. Overview

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


Version : 2.1.0





1.7.1.4. URI scheme


1.7.1.5. Tags

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



CHAPTER 1. APIS

51




http://swagger.io

1.7.2. Paths

1.7.2.1. Create a application

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


Create a application.





string



string

Body bodyrequired

Parameters describing the application to be created. Application


HTTPCode

Description Schema






1.7.2.1.4. Consumes

application/yaml

1.7.2.1.5. Tags

applications.app.k8s.io



52


1.7.2.2. Query all applications

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


Query your applications for more details.





string



string


HTTPCode

Description Schema


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

CHAPTER 1. APIS

53





HTTPCode

Description Schema

1.7.2.2.4. Consumes

application/yaml

1.7.2.2.5. Tags


1.7.2.3. Query a single application

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


Query a single application for more details.





string

Path application_namerequired

Name of the application that you wan to query. string



string



54

HTTPCode

Description Schema






1.7.2.3.4. Tags


1.7.2.4. Delete a application

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





string

Path application_namerequired

Name of the application that you want to delete. string



string


HTTPCode

Description Schema




CHAPTER 1. APIS

55



HTTPCode

Description Schema

1.7.2.4.3. Tags


1.7.3. Definitions

1.7.3.1. Application

Name Schema

apiVersionrequired

string

kindrequired

string

metadatarequired

object

specrequired

spec

spec

Name Schema

assemblyPhaseoptional

string

componentKindsoptional

< object > array

descriptoroptional

descriptor

infooptional

< info > array

selectoroptional

object


56

descriptor

Name Schema

descriptionoptional

string

iconsoptional

< icons > array

keywordsoptional

< string > array

linksoptional

< links > array

maintainersoptional

< maintainers > array

notesoptional

string

ownersoptional

< owners > array

typeoptional

string

versionoptional

string

icons

Name Schema

sizeoptional

string

srcrequired

string

typeoptional

string

links

CHAPTER 1. APIS

57

Name Schema

descriptionoptional

string

urloptional

string

maintainers

Name Schema

emailoptional

string

nameoptional

string

urloptional

string

owners

Name Schema

emailoptional

string

nameoptional

string

urloptional

string

info

Name Schema

nameoptional

string

typeoptional

string

valueoptional

string


58

valueFromoptional

valueFrom

Name Schema

valueFrom

Name Schema

configMapKeyRefoptional

configMapKeyRef

ingressRefoptional

ingressRef

secretKeyRefoptional

secretKeyRef

serviceRefoptional

serviceRef

typeoptional

string

configMapKeyRef

Name Schema

apiVersionoptional

string

fieldPathoptional

string

keyoptional

string

kindoptional

string

nameoptional

string

namespaceoptional

string

CHAPTER 1. APIS

59


string

uidoptional

string

Name Schema

ingressRef

Name Schema

apiVersionoptional

string

fieldPathoptional

string

hostoptional

string

kindoptional

string

nameoptional

string

namespaceoptional

string

pathoptional

string


string

uidoptional

string

secretKeyRef

Name Schema

apiVersionoptional

string


60

fieldPathoptional

string

keyoptional

string

kindoptional

string

nameoptional

string

namespaceoptional

string


string

uidoptional

string

Name Schema

serviceRef

Name Schema

apiVersionoptional

string

fieldPathoptional

string

kindoptional

string

nameoptional

string

namespaceoptional

string

pathoptional

string

portoptional

integer (int32)

CHAPTER 1. APIS

61


string

uidoptional

string

Name Schema

1.8. HELM API

1.8.1. Overview

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


Version : 2.1.0





1.8.1.4. URI scheme


1.8.1.5. Tags

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



1.8.2. Paths

1.8.2.1. Create a helmrelease

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


62




http://swagger.io


Create a helmrelease.





string



string

Body bodyrequired

Parameters describing the helmrelease to becreated.

HelmRelease


HTTPCode

Description Schema






1.8.2.1.4. Consumes

application/yaml

1.8.2.1.5. Tags

helmreleases.apps.open-cluster-management.io



{ "apiVersion" : "apps.open-cluster-management.io/v1", "kind" : "HelmRelease", "metadata" : { "name" : "nginx-ingress",

CHAPTER 1. APIS

63

1.8.2.2. Query all helmreleases

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


Query your helmreleases for more details.





string



string


HTTPCode

Description Schema





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


64


HTTPCode

Description Schema

1.8.2.2.4. Consumes

application/yaml

1.8.2.2.5. Tags


1.8.2.3. Query a single helmrelease

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


Query a single helmrelease for more details.





string

Path helmrelease_namerequired

Name of the helmrelease that you wan to query. string



string


HTTPCode

Description Schema




CHAPTER 1. APIS

65



HTTPCode

Description Schema

1.8.2.3.4. Tags


1.8.2.4. Delete a helmrelease

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





string

Path helmrelease_namerequired

Name of the helmrelease that you want to delete. string



string


HTTPCode

Description Schema






1.8.2.4.3. Tags


66


1.8.3. Definitions

1.8.3.1. HelmRelease

Name Schema

apiVersionrequired

string

kindrequired

string

metadatarequired

object

reporequired

repo

specrequired

object

statusrequired

status

repo

Name Schema

chartNameoptional

string

configMapRefoptional

configMapRef

secretRefoptional

secretRef

sourceoptional

source

versionoptional

string

configMapRef

CHAPTER 1. APIS

67

Name Schema

apiVersionoptional

string

fieldPathoptional

string

kindoptional

string

nameoptional

string

namespaceoptional

string


string

uidoptional

string

secretRef

Name Schema

apiVersionoptional

string

fieldPathoptional

string

kindoptional

string

nameoptional

string

namespaceoptional

string


string

uidoptional

string


68

source

Name Schema

githuboptional

github

helmRepooptional

helmRepo

typeoptional

string

github

Name Schema

branchoptional

string

chartPathoptional

string

urlsoptional

< string > array

helmRepo

Name Schema

urlsoptional

< string > array

status

Name Schema

conditionsrequired

< conditions > array

deployedReleaseoptional

deployedRelease

conditions

CHAPTER 1. APIS

69

Name Schema

lastTransitionTimeoptional

string (date-time)

messageoptional

string

reasonoptional

string

statusrequired

string

typerequired

string

deployedRelease

Name Schema

manifestoptional

string

nameoptional

string

1.9. POLICY API

1.9.1. Overview

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


Version : 2.1.0






70




1.9.1.4. URI scheme


1.9.1.5. Tags

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



1.9.2. Paths

1.9.2.1. Create a policy

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


Create a policy.





string



string

Body bodyrequired

Parameters describing the policy to be created. Application


HTTPCode

Description Schema




CHAPTER 1. APIS

71

http://swagger.io



HTTPCode

Description Schema

1.9.2.1.4. Consumes

application/json

1.9.2.1.5. Tags

policy.open-cluster-management.io



{ "apiVersion": "policy.open-cluster-management.io/v1/v1alpha1", "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/v1alpha1", "complianceType": "musthave", "metadata": { "namespace": null, "name": "test-role" }, "selector": { "matchLabels": { "cloud": "IBM" } }, "spec" : { "object-templates": { "complianceType": "mustHave", "objectDefinition": {


72

"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ß" ], }, ], }, }, }, },

CHAPTER 1. APIS

73

1.9.2.2. Query all policies

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


Query your policies for more details.





string


Namespace that you want to apply the policy to, forexample, default.

string


HTTPCode

Description Schema






1.9.2.2.4. Consumes

application/json

1.9.2.2.5. Tags


1.9.2.3. Query a single policy

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



74

Query a single policy for more details.





string

Path policy_namerequired

Name of the policy that you want to query. string



string


HTTPCode

Description Schema






1.9.2.3.4. Tags


1.9.2.4. Delete a policy

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





string

CHAPTER 1. APIS

75

Path policy_namerequired

Name of the policy that you want to delete. string



string



HTTPCode

Description Schema






1.9.2.4.3. Tags


1.9.3. Definitions

1.9.3.1. Policy


apiVersionrequired

The versioned schema of Policy. string

kindrequired

String value that represents theREST resource.

string

metadatarequired

Describes rules that define thepolicy.

object

spec


76


remediationActionoptional

Value that represents howviolations are handled as definedin the resource.

string

namespaceSelectorrequired

Value that represents whichnamespaces the policy is applied.

string

policy-templates


apiVersionrequired

The versioned schema of Policy. string

kindoptional

String value that represents theREST resource.

string

metadatarequired


object

clusterConditionsoptional

Section to define labels. string

rulesoptional

string

clusterConditions


matchLabelsoptional

The label that is required for thepolicy to be applied to anamespace.

object

cloudoptional

The label that is required for thepolicy to be applied to a cloudprovider.

string

rules

CHAPTER 1. APIS

77


apiGroupsrequired

List of APIs that the rule appliesto.

string

resourcesrequired

A list of resource types. object

verbsrequired

A list of verbs. string

1.10. OBSERVABILITY API

1.10.1. Overview

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


Version : 2.1.0





1.10.1.4. URI scheme


1.10.1.5. Tags

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



1.10.2. Paths

1.10.2.1. Create a multiclusterobservability resource


78




http://swagger.io

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


Create a MultiClusterObservability resource.





string

Body bodyrequired

Parameters describing the MultiClusterObservabilityresource to be created.

MultiClusterObservability


HTTPCode

Description Schema






1.10.2.1.4. Consumes

application/yaml

1.10.2.1.5. Tags

observability.apps.open-cluster-management.io



{ "apiVersion": "observability.open-cluster-management.io/v1beta1", "kind": "MultiClusterObservability", "metadata": { "name": "example"

CHAPTER 1. APIS

79

1.10.2.2. Query all multiclusterobservabilities

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


Query your MultiClusterObservability resources for more details.





string


HTTPCode

Description Schema






1.10.2.2.4. Consumes

application/yaml

1.10.2.2.5. Tags


}, "spec": { "storageConfigObject": { "metricObjectStorage": { "name": "thanos-object-storage", "key": "thanos.yaml" } } }}


80

1.10.2.3. Query a single multiclusterobservability

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


Query a single MultiClusterObservability resource for more details.





string

Path multiclusterobservability_namerequired

Name of the multiclusterobservability that you wantto query.

string


HTTPCode

Description Schema






1.10.2.3.4. Tags


1.10.2.4. Delete a multiclusterobservability resource

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


CHAPTER 1. APIS

81




string

Path multiclusterobservability_namerequired

Name of the multiclusterobservability that you wantto delete.

string


HTTPCode

Description Schema






1.10.2.4.3. Tags


1.10.3. Definitions

1.10.3.1. MultiClusterObservability


apiVersionrequired

The versioned schema of theMultiClusterObservability.

string

kindrequired

String value that represents theREST resource,MultiClusterObservability.

string

metadatarequired


object

spec


82


availabilityConfigoptional

The parameter used to select high-availabilitysupport. This provides support in the case of afailover, and consumes more resources.Options: Basic and High

string

enableDownSamplingoptional

Enable or disable the downsample. Default value is false. If there is no downsample data, the query isunavailable.

boolean

imagePullPolicyoptional

Pull policy for the Observability images. string

imagePullSecretoptional

Pull secret for the Observability images. string

nodeSelectoroptional

Supports node selection constraints object

observabilityAddonSpecoptional

The global settings for all managed clusters, whichhave the add-on enabled.

observabilityAddonSpec

retentionResolution1hoptional

The amount of time to retain samples of resolution 2(1 hour) in a bucket. Default value is 30 days (30d).

string

retentionResolution5moptional

The amount of time to retain samples of resolution 1(5 minutes) in a bucket. Default value is 14 days(14d).

string

retentionResolutionRawoptional

The amount of time to retain raw samples ofresolution in a bucket.

string

storageConfigObjectrequired

Specifies the storage to be used by Observability. storageConfigObject

observabilityAddonSpec


enableMetricsoptional

Indicates if the observability add-on sends metrics to the hubcluster. Default value is true.

boolean

CHAPTER 1. APIS

83

intervaloptional

Interval for when the observabilityadd-on sends metrics to the hubcluster. Default value is 60seconds (60s).

integer


storageConfigObject


metricObjectStoragerequired

Object store to configure secretsfor metrics.

metricObjectStorage

statefulSetSizeoptional

The amount of storage that isapplied to the Observabilitystateful sets, i.e. Thanos store,rule, compact, and receiver.Default value is 10Gi.

string

statefulSetStorageClassoptional

Specify the storageClassstateful sets. This storage is usedfor the object storage if MetricObjectStorage isconfigured for your operatingsystem to create storage. Defaultvalue is gp2.

string

metricObjectStorage


keyrequired

The key of the secret to selectfrom. Must be a valid secret key.

string

namerequired

Name of the metricObjectStorage.

string


84

Date post:	25-Feb-2021
Category:	Documents
Upload:	others
View:	6 times
Download:	0 times

Red Hat Advanced Cluster Management for Kubernetes 2.1 APIs · 2021. 2. 18. · Red Hat Advanced...

Documents