1.2. Channels API
1.2.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.2.1.1. Version information 复制链接链接已复制到粘贴板!
Version : 2.0.0
1.2.1.2. Contact information 复制链接链接已复制到粘贴板!
Contact Email : apiteam@swagger.io
1.2.1.3. License information 复制链接链接已复制到粘贴板!
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.2.1.4. URI scheme 复制链接链接已复制到粘贴板!
BasePath : /kubernetes/apis
Schemes : HTTPS
1.2.1.5. Tags 复制链接链接已复制到粘贴板!
- channels.apps.open-cluster-management.io : Create and manage deployables
1.2.1.6. External Docs 复制链接链接已复制到粘贴板!
Description : Find out more about Swagger.
URL : http://swagger.io
1.2.2. Paths 复制链接链接已复制到粘贴板!
1.2.2.1. Create a channel 复制链接链接已复制到粘贴板!
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.2.2.1.1. Description 复制链接链接已复制到粘贴板!
Create a channel.
1.2.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.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 复制链接链接已复制到粘贴板!
-
application/yaml
1.2.2.1.5. Tags 复制链接链接已复制到粘贴板!
- channels.apps.open-cluster-management.io
1.2.2.1.6. Example HTTP request 复制链接链接已复制到粘贴板!
1.2.2.1.6.1. Request body 复制链接链接已复制到粘贴板!
1.2.2.2. Query all channels for the target namespace 复制链接链接已复制到粘贴板!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.2.2.2.1. Description 复制链接链接已复制到粘贴板!
Query your channels for more details.
1.2.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.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 复制链接链接已复制到粘贴板!
-
application/yaml
1.2.2.2.5. Tags 复制链接链接已复制到粘贴板!
- channels.apps.open-cluster-management.io
1.2.2.3. Query a single channels of a namespace 复制链接链接已复制到粘贴板!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.2.2.3.1. Description 复制链接链接已复制到粘贴板!
Query a single channels 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 |
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.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 复制链接链接已复制到粘贴板!
- channels.apps.open-cluster-management.io
1.2.2.4. Delete a Channel 复制链接链接已复制到粘贴板!
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.2.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.2.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.2.2.4.3. Tags 复制链接链接已复制到粘贴板!
- channels.apps.open-cluster-management.io
1.2.3. Definitions 复制链接链接已复制到粘贴板!
1.2.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://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | string |
name | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#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/api-conventions.md#concurrency-control-and-consistency | string |
uid | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | string |
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/api-conventions.md#types-kinds | string |
name | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#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/api-conventions.md#concurrency-control-and-consistency | string |
uid | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | string |