Overview
This documentation is for the MultiClusterEngine resource for multicluster engine for Kubernetes. The MultiClusterEngine
resource has four possible requests: create, query, delete, and update.
Contact information
Contact Email : apiteam@swagger.io
License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
Tags
-
multiclusterengines.multicluster.openshift.io : Create and manage MultiClusterEngines
External Docs
Description : Find out more about Swagger.
URL : http://swagger.io
Paths
Create a MultiClusterEngine
POST /apis/multicluster.openshift.io/v1alpha1/multiclusterengines
Description
Create a MultiClusterEngine.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE |
Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. |
string |
Body |
body |
Parameters describing the MultiClusterEngine to be created. |
MultiClusterEngine |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
No Content |
403 |
Access forbidden |
No Content |
404 |
Resource not found |
No Content |
500 |
Internal service error |
No Content |
503 |
Service unavailable |
No Content |
Consumes
-
MultiClusterEngines/yaml
Tags
-
multiclusterengines.multicluster.openshift.io
Request body
{
"apiVersion": "apiextensions.k8s.io/v1",
"kind": "CustomResourceDefinition",
"metadata": {
"annotations": {
"controller-gen.kubebuilder.io/version": "v0.4.1"
},
"creationTimestamp": null,
"name": "multiclusterengines.multicluster.openshift.io"
},
"spec": {
"group": "multicluster.openshift.io",
"names": {
"kind": "MultiClusterEngine",
"listKind": "MultiClusterEngineList",
"plural": "multiclusterengines",
"shortNames": [
"mce"
],
"singular": "multiclusterengine"
},
"scope": "Cluster",
"versions": [
{
"additionalPrinterColumns": [
{
"description": "The overall state of the MultiClusterEngine",
"jsonPath": ".status.phase",
"name": "Status",
"type": "string"
},
{
"jsonPath": ".metadata.creationTimestamp",
"name": "Age",
"type": "date"
}
],
"name": "v1alpha1",
"schema": {
"openAPIV3Schema": {
"description": "MultiClusterEngine is the Schema for the multiclusterengines\nAPI",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation\nof an object. Servers should convert recognized schemas to the latest\ninternal 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\nobject represents. Servers may infer this from the endpoint the client\nsubmits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"description": "MultiClusterEngineSpec defines the desired state of MultiClusterEngine",
"properties": {
"imagePullSecret": {
"description": "Override pull secret for accessing MultiClusterEngine\noperand and endpoint images",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Set the nodeselectors",
"type": "object"
},
"targetNamespace": {
"description": "Location where MCE resources will be placed",
"type": "string"
},
"tolerations": {
"description": "Tolerations causes all components to tolerate any taints.",
"items": {
"description": "The pod this Toleration is attached to tolerates any\ntaint that matches the triple <key,value,effect> using the matching\noperator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty\nmeans match all taint effects. When specified, allowed values\nare NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies\nto. Empty means match all taint keys. If the key is empty,\noperator must be Exists; this combination means to match all\nvalues and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the\nvalue. Valid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod\ncan tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time\nthe toleration (which must be of effect NoExecute, otherwise\nthis field is ignored) tolerates the taint. By default, it\nis not set, which means tolerate the taint forever (do not\nevict). Zero and negative values will be treated as 0 (evict\nimmediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches\nto. If the operator is Exists, the value should be empty,\notherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"status": {
"description": "MultiClusterEngineStatus defines the observed state of MultiClusterEngine",
"properties": {
"components": {
"items": {
"description": "ComponentCondition contains condition information for\ntracked components",
"properties": {
"kind": {
"description": "The resource kind this condition represents",
"type": "string"
},
"lastTransitionTime": {
"description": "LastTransitionTime is the last time the condition\nchanged 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"
},
"name": {
"description": "The component name",
"type": "string"
},
"reason": {
"description": "Reason is a (brief) reason for the condition's\nlast status change.",
"type": "string"
},
"status": {
"description": "Status is the status of the condition. One of True,\nFalse, Unknown.",
"type": "string"
},
"type": {
"description": "Type is the type of the cluster condition.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"conditions": {
"items": {
"properties": {
"lastTransitionTime": {
"description": "LastTransitionTime is the last time the condition\nchanged 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\ndetails about the last status change.",
"type": "string"
},
"reason": {
"description": "Reason is a (brief) reason for the condition's\nlast status change.",
"type": "string"
},
"status": {
"description": "Status is the status of the condition. One of True,\nFalse, Unknown.",
"type": "string"
},
"type": {
"description": "Type is the type of the cluster condition.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"phase": {
"description": "Latest observed overall state",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"served": true,
"storage": true,
"subresources": {
"status": {}
}
}
]
},
"status": {
"acceptedNames": {
"kind": "",
"plural": ""
},
"conditions": [],
"storedVersions": []
}
}
Query all MultiClusterEngines
GET /apis/multicluster.openshift.io/v1alpha1/multiclusterengines
Description
Query your multicluster engine for more details.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE |
Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
No Content |
403 |
Access forbidden |
No Content |
404 |
Resource not found |
No Content |
500 |
Internal service error |
No Content |
503 |
Service unavailable |
No Content |
Consumes
-
operator/yaml
Tags
-
multiclusterengines.multicluster.openshift.io
Delete a MultiClusterEngine operator
DELETE /apis/multicluster.openshift.io/v1alpha1/multiclusterengines/{name}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
COOKIE |
Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. |
string |
Path |
name |
Name of the multiclusterengine that you want to delete. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
No Content |
403 |
Access forbidden |
No Content |
404 |
Resource not found |
No Content |
500 |
Internal service error |
No Content |
503 |
Service unavailable |
No Content |
Tags
-
multiclusterengines.multicluster.openshift.io
Definitions
MultiClusterEngine
Name | Description | Schema |
---|---|---|
apiVersion |
The versioned schema of the MultiClusterEngines. |
string |
kind |
String value that represents the REST resource. |
string |
metadata |
Describes rules that define the resource. |
object |
spec |
MultiClusterEngineSpec defines the desired state of MultiClusterEngine. |
See List of specs |
List of specs
Name | Description | Schema |
---|---|---|
nodeSelector |
Set the nodeselectors. |
map[string]string |
imagePullSecret |
Override pull secret for accessing MultiClusterEngine operand and endpoint images. |
string |
tolerations |
Tolerations causes all components to tolerate any taints. |
[]corev1.Toleration |
targetNamespace |
Location where MCE resources will be placed. |
string |