Skip to content

Commit

Permalink
Add cluster resource modeling api
Browse files Browse the repository at this point in the history 
Signed-off-by: halfrost <ydz627@gmail.com>
  • Loading branch information
@halfrost
halfrost committed Aug 17, 2022
1 parent 4224d90 commit 928ebbd
Show file tree
Hide file tree
Showing 7 changed files with 702 additions and 2 deletions.
71 changes: 71 additions & 0 deletions api/openapi-spec/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14054,6 +14054,22 @@
}
}
},
"com.github.karmada-io.karmada.pkg.apis.cluster.v1alpha1.AllocatableModeling": {
"description": "AllocatableModeling represents the number of nodes in which allocatable resources in a specific resource model grade. E.g. AllocatableModeling{Grade: 2, Count: 10} means 10 nodes belong to resource model in grade 2.",
"type": "object",
"properties": {
"count": {
"description": "Count is the number of nodes that own the resources delineated by this modeling.",
"type": "integer",
"format": "int32"
},
"grade": {
"description": "Grade is the index of ResourceModel.",
"type": "integer",
"format": "int32"
}
}
},
"com.github.karmada-io.karmada.pkg.apis.cluster.v1alpha1.Cluster": {
"description": "Cluster represents the desire state and status of a member cluster.",
"type": "object",
Expand Down Expand Up @@ -14171,6 +14187,14 @@
"description": "Region represents the region of the member cluster locate in.",
"type": "string"
},
"resourceModels": {
"description": "ResourceModels is the list of resource modeling in this cluster. Each modeling quota can be customized by the user. Modeling name must be one of the following: cpu, memory, storage, ephemeral-storage. If the user does not define the modeling name and modeling quota, it will be the default model. The default model index from 0 to 8. Each default model's cpu quota is [2^(index-1), 2^index), 2 \u003c= index \u003c= 8 Each default model's memory quota is also [2^(index + 2), 2^(index + 3)), 2 \u003c= index \u003c= 8, E.g. model 0 is like this: - index: 0 ranges:\n - name: \"cpu\"\n min: 0 C\n max: 1 C\n - name: \"memory\"\n min: 0 GB\n max: 4 GB\n\n- index: 1 ranges:\n - name: \"cpu\"\n min: 1 C\n max: 2 C\n - name: \"memory\"\n min: 4 GB\n max: 16 GB\n\n- index: 2 ranges:\n - name: \"cpu\"\n min: 2 C\n max: 4 C\n - name: \"memory\"\n min: 16 GB\n max: 32 GB\n\n- index: 7 range:\n - name: \"cpu\"\n min: 64 C\n max: 128 C\n - name: \"memory\"\n min: 512 GB\n max: 1024 GB\n\nmodel8 is like this: - index: 8 range:\n - name: \"cpu\"\n min: 128 C\n max: MAXINT\n - name: \"memory\"\n min: 1024 GB\n max: MAXINT",
"type": "array",
"items": {
"default": {},
"$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.cluster.v1alpha1.ResourceModel"
}
},
"secretRef": {
"description": "SecretRef represents the secret contains mandatory credentials to access the member cluster. The secret should hold credentials as follows: - secret.data.token - secret.data.caBundle",
"$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.cluster.v1alpha1.LocalSecretReference"
Expand Down Expand Up @@ -14264,6 +14288,45 @@
}
}
},
"com.github.karmada-io.karmada.pkg.apis.cluster.v1alpha1.ResourceModel": {
"description": "ResourceModel describes the modeling that you want to statistics.",
"type": "object",
"properties": {
"grade": {
"description": "Grade is the index for the resource modeling.",
"type": "integer",
"format": "int32"
},
"ranges": {
"description": "Ranges describes the resource quota ranges.",
"type": "array",
"items": {
"default": {},
"$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.cluster.v1alpha1.ResourceModelRange"
}
}
}
},
"com.github.karmada-io.karmada.pkg.apis.cluster.v1alpha1.ResourceModelRange": {
"description": "ResourceModelRange describes the detail of each modeling quota that ranges from min to max. Please pay attention, by default, the value of min can be inclusive, and the value of max cannot be inclusive. E.g. in an interval, min = 2, max =10 is set, which means the interval [2,10). This rule ensure that all intervals have the same meaning. If the last interval is +∞, it is definitely unreachable. Therefore, we define the right interval as the open interval. For a valid interval, the value on the right is greater than the value on the left, in other words, max must be greater than min.",
"type": "object",
"properties": {
"max": {
"description": "Max is the maximum amount of this resource represented by resource name. Special Instructions, for the last ResourceModelRange, which no matter what Max value you pass, the meaning is infinite. Because for the last item, any ResourceModelRange's quota larger than Min will be classified to the last one. Of course, the value of the Max field is always greater than the value of the Min field. It should be true in any case.",
"default": {},
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"min": {
"description": "Min is the minimum amount of this resource represented by resource name.",
"default": {},
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"name": {
"description": "Name is the name for the resource that you want to categorize.",
"type": "string"
}
}
},
"com.github.karmada-io.karmada.pkg.apis.cluster.v1alpha1.ResourceSummary": {
"description": "ResourceSummary represents the summary of resources in the member cluster.",
"type": "object",
Expand All @@ -14276,6 +14339,14 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
}
},
"allocatableModelings": {
"description": "AllocatableModelings represents the statistical resource modeling.",
"type": "array",
"items": {
"default": {},
"$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.cluster.v1alpha1.AllocatableModeling"
}
},
"allocated": {
"description": "Allocated represents the resources of a cluster that have been scheduled. Total amount of required resources of all Pods that have been scheduled to nodes.",
"type": "object",
Expand Down
129 changes: 129 additions & 0 deletions pkg/apis/cluster/types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,30 @@ package cluster

import (
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// ResourceName is the name identifying various resources in a ResourceList.
type ResourceName string

// Resource names must be not more than 63 characters, consisting of upper- or lower-case alphanumeric characters,
// with the -, _, and . characters allowed anywhere, except the first or last character.
// The default convention, matching that for annotations, is to use lower-case names, with dashes, rather than
// camel case, separating compound words.
// Fully-qualified resource typenames are constructed from a DNS-style subdomain, followed by a slash `/` and a name.
const (
// ResourceCPU in cores. (e,g. 500m = .5 cores)
ResourceCPU ResourceName = "cpu"
// ResourceMemory in bytes. (e,g. 500Gi = 500GiB = 500 * 1024 * 1024 * 1024)
ResourceMemory ResourceName = "memory"
// ResourceStorage is volume size, in bytes (e,g. 5Gi = 5GiB = 5 * 1024 * 1024 * 1024)
ResourceStorage ResourceName = "storage"
// ResourceEphemeralStorage is local ephemeral storage, in bytes. (e,g. 500Gi = 500GiB = 500 * 1024 * 1024 * 1024)
// The resource name for ResourceEphemeralStorage is alpha and it can change across releases.
ResourceEphemeralStorage ResourceName = "ephemeral-storage"
)

//revive:disable:exported

// +genclient
Expand Down Expand Up @@ -104,6 +125,97 @@ type ClusterSpec struct {
// any resource that does not tolerate the Taint.
// +optional
Taints []corev1.Taint

// ResourceModels is the list of resource modeling in this cluster. Each modeling quota can be customized by the user.
// Modeling name must be one of the following: cpu, memory, storage, ephemeral-storage.
// If the user does not define the modeling name and modeling quota, it will be the default model.
// The default model index from 0 to 8. Each default model's cpu quota is [2^(index-1), 2^index), 2 <= index <= 8
// Each default model's memory quota is also [2^(index + 2), 2^(index + 3)), 2 <= index <= 8, E.g. model 0 is like this:
// - index: 0
// ranges:
// - name: "cpu"
// min: 0 C
// max: 1 C
// - name: "memory"
// min: 0 GB
// max: 4 GB
//
// - index: 1
// ranges:
// - name: "cpu"
// min: 1 C
// max: 2 C
// - name: "memory"
// min: 4 GB
// max: 16 GB
//
// - index: 2
// ranges:
// - name: "cpu"
// min: 2 C
// max: 4 C
// - name: "memory"
// min: 16 GB
// max: 32 GB
//
// - index: 7
// range:
// - name: "cpu"
// min: 64 C
// max: 128 C
// - name: "memory"
// min: 512 GB
// max: 1024 GB
//
// model8 is like this:
// - index: 8
// range:
// - name: "cpu"
// min: 128 C
// max: MAXINT
// - name: "memory"
// min: 1024 GB
// max: MAXINT
//
// +optional
ResourceModels []ResourceModel
}

// ResourceModel describes the modeling that you want to statistics.
type ResourceModel struct {
// Grade is the index for the resource modeling.
// +optional
Grade int

// Ranges describes the resource quota ranges.
// +optional
Ranges []ResourceModelRange
}

// ResourceModelRange describes the detail of each modeling quota that ranges from min to max.
// Please pay attention, by default, the value of min can be inclusive, and the value of max cannot be inclusive.
// E.g. in an interval, min = 2, max =10 is set, which means the interval [2,10).
// This rule ensure that all intervals have the same meaning. If the last interval is +∞,
// it is definitely unreachable. Therefore, we define the right interval as the open interval.
// For a valid interval, the value on the right is greater than the value on the left,
// in other words, max must be greater than min.
type ResourceModelRange struct {
// Name is the name for the resource that you want to categorize.
// +optional
Name ResourceName

// Min is the minimum amount of this resource represented by resource name.
// +optional
Min resource.Quantity

// Max is the maximum amount of this resource represented by resource name.
// Special Instructions, for the last ResourceModelRange, which no matter what Max value you pass,
// the meaning is infinite. Because for the last item,
// any ResourceModelRange's quota larger than Min will be classified to the last one.
// Of course, the value of the Max field is always greater than the value of the Min field.
// It should be true in any case.
// +optional
Max resource.Quantity
}

const (
Expand Down Expand Up @@ -216,6 +328,23 @@ type ResourceSummary struct {
// Total amount of required resources of all Pods that have been scheduled to nodes.
// +optional
Allocated corev1.ResourceList

// AllocatableModelings represents the statistical resource modeling.
// +optional
AllocatableModelings []AllocatableModeling
}

// AllocatableModeling represents the number of nodes in which allocatable resources in a specific resource model grade.
// E.g. AllocatableModeling{Grade: 2, Count: 10} means 10 nodes belong to resource model in grade 2.
type AllocatableModeling struct {

// Grade is the index of ResourceModel.
// +optional
Grade int

// Count is the number of nodes that own the resources delineated by this modeling.
// +optional
Count int
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
Expand Down
Loading

0 comments on commit 928ebbd

Please sign in to comment.