Skip to content

Commit

Permalink
Merge pull request #252 from zong-zhe/add-konfig-strategy
Browse files Browse the repository at this point in the history
feat: add 'deploymentStrategy' to konfig
  • Loading branch information
zong-zhe authored Oct 24, 2024
2 parents ccdb440 + 2f6f496 commit a65d6d6
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 1 deletion.
2 changes: 1 addition & 1 deletion konfig/kcl.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "konfig"
version = "0.10.0"
version = "0.11.0"
description = "Konfig provides users with an out-of-the-box, highly abstract configuration interface. The original starting point of the model library is to improve the efficiency and experience of YAML users. We hope to simplify the writing of user-side configuration code by abstracting and encapsulating the model with more complex code into a unified model."

[dependencies]
Expand Down
2 changes: 2 additions & 0 deletions konfig/models/kube/backend/server_backend.k
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ schema ServerBackend[inputConfig: server.Server]:
serviceAccountName = config.serviceAccount.name
}
}
if config.deploymentStrategy:
strategy = config.deploymentStrategy
}
}

Expand Down
23 changes: 23 additions & 0 deletions konfig/models/kube/frontend/deployment/deployment_strategy.k
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"""
This is the deployment_strategy module in k8s.api.apps.v1 package.
This file was generated by the KCL auto-gen tool. DO NOT EDIT.
Editing this file might prove futile when you re-run the KCL auto-gen generate command.
"""


schema DeploymentStrategy:
"""
DeploymentStrategy describes how to replace existing pods with new ones.

Attributes
----------
rollingUpdate : RollingUpdateDeployment, default is Undefined, optional
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
$type : str, default is Undefined, optional
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
"""


rollingUpdate?: RollingUpdateDeployment

$type?: str
23 changes: 23 additions & 0 deletions konfig/models/kube/frontend/deployment/rolling_update_deployment.k
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"""
This is the rolling_update_deployment module in k8s.api.apps.v1 package.
This file was generated by the KCL auto-gen tool. DO NOT EDIT.
Editing this file might prove futile when you re-run the KCL auto-gen generate command.
"""


schema RollingUpdateDeployment:
"""
Spec to control the desired behavior of rolling update.

Attributes
----------
maxSurge : int | str, default is Undefined, optional
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
maxUnavailable : int | str, default is Undefined, optional
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
"""


maxSurge?: int | str

maxUnavailable?: int | str
4 changes: 4 additions & 0 deletions konfig/models/kube/frontend/server.k
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import models.kube.frontend.volume
import models.kube.frontend.sidecar as s
import models.kube.frontend.strategy
import models.kube.frontend.storage
import models.kube.frontend.deployment

schema Server:
"""Server is abstaction of Deployment and StatefulSet.
Expand Down Expand Up @@ -143,3 +144,6 @@ schema Server:

# extra resources
extraResources?: {str: {str:}}

# Strategy for deployment
deploymentStrategy?: deployment.DeploymentStrategy

0 comments on commit a65d6d6

Please sign in to comment.