Remedy v1alpha1
apiVersion: remedy.karmada.io/v1alpha1
import "github.com/karmada-io/karmada/pkg/apis/remedy/v1alpha1"
Remedy
Remedy represents the cluster-level management strategies based on cluster conditions.
apiVersion: remedy.karmada.io/v1alpha1
kind: Remedy
metadata (ObjectMeta)
spec (RemedySpec), required
Spec represents the desired behavior of Remedy.
RemedySpec
RemedySpec represents the desired behavior of Remedy.
actions ([]string)
Actions specifies the actions that remedy system needs to perform. If empty, no action will be performed.
clusterAffinity (ClusterAffinity)
ClusterAffinity specifies the clusters that Remedy needs to pay attention to. For clusters that meet the DecisionConditions, Actions will be preformed. If empty, all clusters will be selected.
ClusterAffinity represents the filter to select clusters.
clusterAffinity.clusterNames ([]string)
ClusterNames is the list of clusters to be selected.
decisionMatches ([]DecisionMatch)
DecisionMatches indicates the decision matches of triggering the remedy system to perform the actions. As long as any one DecisionMatch matches, the Actions will be preformed. If empty, the Actions will be performed immediately.
DecisionMatch represents the decision match detail of activating the remedy system.
decisionMatches.clusterConditionMatch (ClusterConditionRequirement)
ClusterConditionMatch describes the cluster condition requirement.
ClusterConditionRequirement describes the Cluster condition requirement details.
decisionMatches.clusterConditionMatch.conditionStatus (string), required
ConditionStatus specifies the ClusterStatue condition status.
decisionMatches.clusterConditionMatch.conditionType (string), required
ConditionType specifies the ClusterStatus condition type.
decisionMatches.clusterConditionMatch.operator (string), required
Operator represents a conditionType's relationship to a conditionStatus. Valid operators are Equal, NotEqual.
RemedyList
RemedyList contains a list of Remedy.
apiVersion: remedy.karmada.io/v1alpha1
kind: RemedyList
metadata (ListMeta)
items ([][Remedy](../remedy-resources/remedy-v1alpha1#remedy)), required
Operations
get read the specified Remedy
HTTP Request
GET /apis/remedy.karmada.io/v1alpha1/remedies/{name}
Parameters
name (in path): string, required
name of the Remedy
pretty (in query): string
Response
200 (Remedy): OK
get read status of the specified Remedy
HTTP Request
GET /apis/remedy.karmada.io/v1alpha1/remedies/{name}/status
Parameters
name (in path): string, required
name of the Remedy
pretty (in query): string
Response
200 (Remedy): OK
list list or watch objects of kind Remedy
HTTP Request
GET /apis/remedy.karmada.io/v1alpha1/remedies
Parameters
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
watch (in query): boolean
Response
200 (RemedyList): OK
create create a Remedy
HTTP Request
POST /apis/remedy.karmada.io/v1alpha1/remedies
Parameters
- body: Remedy, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (Remedy): OK
201 (Remedy): Created
202 (Remedy): Accepted
update replace the specified Remedy
HTTP Request
PUT /apis/remedy.karmada.io/v1alpha1/remedies/{name}
Parameters
name (in path): string, required
name of the Remedy
body: Remedy, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (Remedy): OK
201 (Remedy): Created
update replace status of the specified Remedy
HTTP Request
PUT /apis/remedy.karmada.io/v1alpha1/remedies/{name}/status
Parameters
name (in path): string, required
name of the Remedy
body: Remedy, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (Remedy): OK
201 (Remedy): Created
patch partially update the specified Remedy
HTTP Request
PATCH /apis/remedy.karmada.io/v1alpha1/remedies/{name}
Parameters
name (in path): string, required
name of the Remedy
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
Response
200 (Remedy): OK
201 (Remedy): Created
patch partially update status of the specified Remedy
HTTP Request
PATCH /apis/remedy.karmada.io/v1alpha1/remedies/{name}/status
Parameters
name (in path): string, required
name of the Remedy
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
Response
200 (Remedy): OK
201 (Remedy): Created
delete delete a Remedy
HTTP Request
DELETE /apis/remedy.karmada.io/v1alpha1/remedies/{name}
Parameters
name (in path): string, required
name of the Remedy
body: DeleteOptions
dryRun (in query): string
gracePeriodSeconds (in query): integer
pretty (in query): string
propagationPolicy (in query): string
Response
200 (Status): OK
202 (Status): Accepted
deletecollection delete collection of Remedy
HTTP Request
DELETE /apis/remedy.karmada.io/v1alpha1/remedies
Parameters
- body: DeleteOptions
continue (in query): string
dryRun (in query): string
fieldSelector (in query): string
gracePeriodSeconds (in query): integer
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
propagationPolicy (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
Response
200 (Status): OK