StatefulSets
The StatefulSet chart in Devtron allows you to deploy and manage stateful applications. StatefulSet is a Kubernetes resource that provides guarantees about the ordering and uniqueness of Pods during deployment and scaling.
It supports only ONDELETE
and ROLLINGUPDATE
deployment strategy.
![](https://docs.devtron.ai/~gitbook/image?url=https%3A%2F%2Fdevtron-public-asset.s3.us-east-2.amazonaws.com%2Fimages%2Fcreating-application%2Fdeployment-template%2Fsts-strategy.jpg&width=768&dpr=4&quality=100&sign=73dc267&sv=1)
You can select StatefulSet
chart when you want to use only basic use cases which contain the following:
Managing Stateful Applications: StatefulSets are ideal for managing stateful applications, such as databases or distributed systems, that require stable network identities and persistent storage for each Pod.
Ordered Pod Management: StatefulSets ensure ordered and predictable management of Pods by providing each Pod with a unique and stable hostname based on a defined naming convention and ordinal index.
Updating and Scaling Stateful Applications: StatefulSets support updating and scaling stateful applications by creating new versions of the StatefulSet and performing rolling updates or scaling operations in a controlled manner, ensuring minimal disruption to the application.
Persistent Storage: StatefulSets have built-in mechanisms for handling persistent volumes, allowing each Pod to have its own unique volume claim and storage. This ensures data persistence even when Pods are rescheduled or restarted.
Maintaining Pod Identity: StatefulSets guarantee consistent identity for each Pod throughout its lifecycle. This stability is maintained even if the Pods are rescheduled, allowing applications to rely on stable network identities.
Rollback Capability: StatefulSets provide the ability to rollback to a previous version in case the current state of the application is unstable or encounters issues, ensuring a known working state for the application.
Status Monitoring: StatefulSets offer status information that can be used to monitor the deployment, including the current version, number of replicas, and the readiness of each Pod. This helps in tracking the health and progress of the StatefulSet deployment.
Resource Cleanup: StatefulSets allow for easy cleanup of older versions by deleting StatefulSets and their associated Pods and persistent volumes that are no longer needed, ensuring efficient resource utilization.
Super-admins can lock keys in StatefulSet deployment template to prevent non-super-admins from modifying those locked keys. Refer Lock Deployment Configuration to know more.
1. Yaml File
Container Ports
This defines ports on which application services will be exposed to other services
Key | Description |
---|---|
| envoy port for the container. |
| the duration of time that a connection is idle before the connection is terminated. |
| name of the port. |
| port for the container. |
| port of the corresponding kubernetes service. |
| nodeport of the corresponding kubernetes service. |
| Used for high performance protocols like grpc where timeout needs to be disabled. |
| Envoy container can accept HTTP2 requests. |
EnvVariables
EnvVariablesFromSecretKeys
It is used to get the name of Environment Variable name, Secret name and the Key name from which we are using the value in that corresponding Environment Variable.
EnvVariablesFromConfigMapKeys
It is used to get the name of Environment Variable name, Config Map name and the Key name from which we are using the value in that corresponding Environment Variable.
To set environment variables for the containers that run in the Pod.
StatefulSetConfig
These are all the configuration settings for the StatefulSet.
Mandatoryfields in statefulSetConfig is
Here is an explanation of each field in the statefulSetConfig :
Key | Description |
---|---|
| set of key-value pairs used to identify the StatefulSet . |
| A map of key-value pairs that are attached to the stateful set as metadata. |
| The name of the Kubernetes Service that the StatefulSet should create. |
| A policy that determines how Pods are created and deleted by the StatefulSet. In this case, the policy is set to "Parallel", which means that all Pods are created at once. |
| The number of revisions that should be stored for each replica of the StatefulSet. |
| The update strategy used by the StatefulSet when rolling out changes. |
| The path where the volume should be mounted in the container. |
volumeClaimTemplates: An array of volume claim templates that are used to create persistent volumes for the StatefulSet. Each volume claim template specifies the storage class, access mode, storage size, and other details of the persistent volume.
Key | Description |
---|---|
| The API version of the PVC . |
| The type of object that the PVC is. |
| Metadata that is attached to the resource being created. |
| A set of key-value pairs used to label the object for identification and selection. |
| The specification of the object, which defines its desired state and behavior. |
| A list of access modes for the PersistentVolumeClaim, such as "ReadWriteOnce" or "ReadWriteMany". |
| A data source used to populate the PersistentVolumeClaim, such as a Snapshot or a StorageClass. |
| specifies the kind of the snapshot, in this case Snapshot. |
| specifies the API group of the snapshot API, in this case snapshot.storage.k8s.io. |
| specifies the name of the snapshot, in this case my-snapshot. |
| A reference to a data source used to create the persistent volume. In this case, it's a secret. |
| The update strategy used by the StatefulSet when rolling out changes. |
| The resource requests and limits for the PersistentVolumeClaim, which define the minimum and maximum amount of storage it can use. |
| The amount of storage requested by the PersistentVolumeClaim. |
| The maximum amount of storage that the PersistentVolumeClaim can use. |
| The name of the storage class to use for the persistent volume. |
| The selector used to match a persistent volume to a persistent volume claim. |
| a map of key-value pairs to match the labels of the corresponding PersistentVolume. |
| A set of requirements that the selected object must meet to be considered a match. |
| The key of the label or annotation to match. |
| The operator used to compare the key-value pairs (in this case, "In" specifies a set membership test). |
| A list of values that the selected object's label or annotation must match. |
| The mode of the volume, either "Filesystem" or "Block". |
| The name of the PersistentVolume that is created for the PersistentVolumeClaim. |
Liveness Probe
If this check fails, kubernetes restarts the pod. This should return error code in case of non-recoverable error.
Key | Description |
---|---|
| It define the path where the liveness needs to be checked. |
| It defines the time to wait before a given container is checked for liveliness. |
| It defines the time to check a given container for liveness. |
| It defines the number of successes required before a given container is said to fulfil the liveness probe. |
| It defines the time for checking timeout. |
| It defines the maximum number of failures that are acceptable before a given container is not considered as live. |
| Custom headers to set in the request. HTTP allows repeated headers,You can override the default headers by defining .httpHeaders for the probe. |
| Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP. |
| The kubelet will attempt to open a socket to your container on the specified port. If it can establish a connection, the container is considered healthy. |
MaxUnavailable
The maximum number of pods that can be unavailable during the update process. The value of "MaxUnavailable: " can be an absolute number or percentage of the replicas count. The default value of "MaxUnavailable: " is 25%.
MaxSurge
The maximum number of pods that can be created over the desired number of pods. For "MaxSurge: " also, the value can be an absolute number or percentage of the replicas count. The default value of "MaxSurge: " is 25%.
Min Ready Seconds
This specifies the minimum number of seconds for which a newly created Pod should be ready without any of its containers crashing, for it to be considered available. This defaults to 0 (the Pod will be considered available as soon as it is ready).
Readiness Probe
If this check fails, kubernetes stops sending traffic to the application. This should return error code in case of errors which can be recovered from if traffic is stopped.
Key | Description |
---|---|
| It define the path where the readiness needs to be checked. |
| It defines the time to wait before a given container is checked for readiness. |
| It defines the time to check a given container for readiness. |
| It defines the number of successes required before a given container is said to fulfill the readiness probe. |
| It defines the time for checking timeout. |
| It defines the maximum number of failures that are acceptable before a given container is not considered as ready. |
| Custom headers to set in the request. HTTP allows repeated headers,You can override the default headers by defining .httpHeaders for the probe. |
| Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP. |
| The kubelet will attempt to open a socket to your container on the specified port. If it can establish a connection, the container is considered healthy. |
Ambassador Mappings
You can create ambassador mappings to access your applications from outside the cluster. At its core a Mapping resource maps a resource to a service.
Key | Description |
---|---|
| Set true to enable ambassador mapping else set false. |
| used to specify id for specific ambassador mappings controller. |
| used to specify cors policy to access host for this mapping. |
| used to specify weight for canary ambassador mappings. |
| used to specify hostname for ambassador mapping. |
| used to specify path for ambassador mapping. |
| used to provide custom labels for ambassador mapping. |
| used to specify retry policy for ambassador mapping. |
| Provide cors headers on flagger resource. |
| used to specify whether to redirect the path of this mapping and where. |
| used to create or define ambassador TLSContext resource. |
| used to provide extra spec values which not present in deployment template for ambassador resource. |
Autoscaling
This is connected to HPA and controls scaling up and down in response to request load.
Key | Description |
---|---|
| Set true to enable autoscaling else set false. |
| Minimum number of replicas allowed for scaling. |
| Maximum number of replicas allowed for scaling. |
| The target CPU utilization that is expected for a container. |
| The target memory utilization that is expected for a container. |
| Used to give external metrics for autoscaling. |
Fullname Override
fullnameOverride
replaces the release fullname created by default by devtron, which is used to construct Kubernetes object names. By default, devtron uses {app-name}-{environment-name} as release fullname.
Image
Image is used to access images in kubernetes, pullpolicy is used to define the instances calling the image, here the image is pulled when the image is not present,it can also be set as "Always".
imagePullSecrets
imagePullSecrets
contains the docker credentials that are used for accessing a registry.
regcred is the secret that contains the docker credentials that are used for accessing a registry. Devtron will not create this secret automatically, you'll have to create this secret using dt-secrets helm chart in the App store or create one using kubectl. You can follow this documentation Pull an Image from a Private Registry https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ .
Ingress
This allows public access to the url, please ensure you are using right nginx annotation for nginx class, its default value is nginx
Legacy deployment-template ingress format
Key | Description |
---|---|
| Enable or disable ingress |
| To configure some options depending on the Ingress controller |
| Path name |
| Host name |
| It contains security details |
Ingress Internal
This allows private access to the url, please ensure you are using right nginx annotation for nginx class, its default value is nginx
Key | Description |
---|---|
| Enable or disable ingress |
| To configure some options depending on the Ingress controller |
| Path name |
| Host name |
| It contains security details |
Init Containers
Specialized containers that run before app containers in a Pod. Init containers can contain utilities or setup scripts not present in an app image. One can use base image inside initContainer by setting the reuseContainerImage flag to true
.
Istio
Istio is a service mesh which simplifies observability, traffic management, security and much more with it's virtual services and gateways.
Key | Description |
---|---|
| Istio enablement. When |
| Allowing external traffic to enter the service mesh through the specified configurations. |
| The external domain through which traffic will be routed into the service mesh. |
| Traffic to and from the gateway should be encrypted using TLS. |
| Specifies the name of the Kubernetes secret that contains the TLS certificate and private key. The TLS certificate is used for securing the communication between clients and the Istio gateway. |
| Enables the definition of rules for how traffic should be routed to different services within the service mesh. |
| Specifies the gateways to which the rules defined in the VirtualService apply. |
| List of hosts (domains) to which this VirtualService is applied. |
| Configuration for HTTP routes within the VirtualService. It define routing rules based on HTTP attributes such as URI prefixes, headers, timeouts, and retry policies. |
| Cross-Origin Resource Sharing (CORS) policy configuration. |
| Additional headers to be added to the HTTP request. |
| Conditions that need to be satisfied for this route to be used. |
| This specifies a match condition based on the URI of the incoming request. |
| It specifies that the URI should have the specified prefix. |
| Retry configuration for failed requests. |
| It specifies the number of retry attempts for failed requests. |
| sets the timeout for each individual retry attempt. |
| Rewrites the URI of the incoming request. |
| List of destination rules for routing traffic. |
Pause For Seconds Before Switch Active
To wait for given period of time before switch active the container.
Resources
These define minimum and maximum RAM and CPU available to the application.
Resources are required to set CPU and memory usage.
Limits
Limits make sure a container never goes above a certain value. The container is only allowed to go up to the limit, and then it is restricted.
Requests
Requests are what the container is guaranteed to get.
Service
This defines annotations and the type of service, optionally can define name also.
Volumes
It is required when some values need to be read from or written to an external disk.
Volume Mounts
It is used to provide mounts to the volume.
Affinity and anti-affinity
Spec is used to define the desire state of the given container.
Node Affinity allows you to constrain which nodes your pod is eligible to schedule on, based on labels of the node.
Inter-pod affinity allow you to constrain which nodes your pod is eligible to be scheduled based on labels on pods.
Key
Key part of the label for node selection, this should be same as that on node. Please confirm with devops team.
Values
Value part of the label for node selection, this should be same as that on node. Please confirm with devops team.
Tolerations
Taints are the opposite, they allow a node to repel a set of pods.
A given pod can access the given node and avoid the given taint only if the given pod satisfies a given taint.
Taints and tolerations are a mechanism which work together that allows you to ensure that pods are not placed on inappropriate nodes. Taints are added to nodes, while tolerations are defined in the pod specification. When you taint a node, it will repel all the pods except those that have a toleration for that taint. A node can have one or many taints associated with it.
Arguments
This is used to give arguments to command.
Command
It contains the commands for the server.
Key | Description |
---|---|
| To enable or disable the command. |
| It contains the commands. |
Containers
Containers section can be used to run side-car containers along with your main container within same pod. Containers running within same pod can share volumes and IP Address and can address each other @localhost. We can use base image inside container by setting the reuseContainerImage flag to true
.
Prometheus
It is a kubernetes monitoring tool and the name of the file to be monitored as monitoring in the given case.It describes the state of the prometheus.
rawYaml
Accepts an array of Kubernetes objects. You can specify any kubernetes yaml here and it will be applied when your app gets deployed.
Grace Period
Kubernetes waits for the specified time called the termination grace period before terminating the pods. By default, this is 30 seconds. If your pod usually takes longer than 30 seconds to shut down gracefully, make sure you increase the GracePeriod
.
A Graceful termination in practice means that your application needs to handle the SIGTERM message and begin shutting down when it receives it. This means saving all data that needs to be saved, closing down network connections, finishing any work that is left, and other similar tasks.
There are many reasons why Kubernetes might terminate a perfectly healthy container. If you update your deployment with a rolling update, Kubernetes slowly terminates old pods while spinning up new ones. If you drain a node, Kubernetes terminates all pods on that node. If a node runs out of resources, Kubernetes terminates pods to free those resources. It’s important that your application handle termination gracefully so that there is minimal impact on the end user and the time-to-recovery is as fast as possible.
Server
It is used for providing server configurations.
Deployment
It gives the details for deployment.
Key | Description |
---|---|
| It is the image tag |
| It is the URL of the image |
Service Monitor
It gives the set of targets to be monitored.
Db Migration Config
It is used to configure database migration.
KEDA Autoscaling
KEDA is a Kubernetes-based Event Driven Autoscaler. With KEDA, you can drive the scaling of any container in Kubernetes based on the number of events needing to be processed. KEDA can be installed into any Kubernetes cluster and can work alongside standard Kubernetes components like the Horizontal Pod Autoscaler(HPA).
Example for autosccaling with KEDA using Prometheus metrics is given below:
Example for autosccaling with KEDA based on kafka is given below :
Winter-Soldier
Winter Soldier can be used to
cleans up (delete) Kubernetes resources
reduce workload pods to 0
NOTE: After deploying this we can create the Hibernator object and provide the custom configuration by which workloads going to delete, sleep and many more. for more information check the main repo
Given below is template values you can give in winter-soldier:
Here,
Key | values | Description |
---|---|---|
|
| decide the enabling factor |
|
| specific api version |
|
| This specify the action need to perform. |
| eg:- | It use to specify the timeZone used. (It uses standard format. please refer this) |
| array of [ | It use to define time period/range on which the user need to perform the specified action. you can have multiple timeRanges.
These settings will take |
|
| These is mandatory field when the |
|
| These value will take a list of methods to select the resources on which we perform specified |
here is an example,
Above settings will take action on Sat
and Sun
from 00:00 to 23:59:59, and on Mon
-Fri
from 00:00 to 08:00 and 20:00 to 23:59:59. If action:sleep
then runs hibernate at timeFrom and unhibernate at timeTo
. If action: delete
then it will delete workloads at timeFrom
and timeTo
. Here the action:scale
thus it scale the number of resource replicas to targetReplicas: [1,1,1]
. Here each element of targetReplicas
array is mapped with the corresponding elements of array timeRangesWithZone/timeRanges
. Thus make sure the length of both array is equal, otherwise the cnages cannot be observed.
The above example will select the application objects which have been created 10 hours ago across all namespaces excluding application's namespace. Winter soldier exposes following functions to handle time, cpu and memory.
ParseTime - This function can be used to parse time. For eg to parse creationTimestamp use ParseTime({{metadata.creationTimestamp}}, '2006-01-02T15:04:05Z')
AddTime - This can be used to add time. For eg AddTime(ParseTime({{metadata.creationTimestamp}}, '2006-01-02T15:04:05Z'), '-10h') ll add 10h to the time. Use d for day, h for hour, m for minutes and s for seconds. Use negative number to get earlier time.
Now - This can be used to get current time.
CpuToNumber - This can be used to compare CPU. For eg any({{spec.containers.#.resources.requests}}, { MemoryToNumber(.memory) < MemoryToNumber('60Mi')}) will check if any resource.requests is less than 60Mi.
Security Context
A security context defines privilege and access control settings for a Pod or Container.
To add a security context for main container:
To add a security context on pod level:
Topology Spread Constraints
You can use topology spread constraints to control how Pods are spread across your cluster among failure-domains such as regions, zones, nodes, and other user-defined topology domains. This can help to achieve high availability as well as efficient resource utilization.
Deployment Metrics
It gives the realtime metrics of the deployed applications
Key | Description |
---|---|
| It shows how often this app is deployed to production |
| It shows how often the respective pipeline fails. |
| It shows the average time taken to deliver a change to production. |
| It shows the average time taken to fix a failed pipeline. |
2. Show application metrics
If you want to see application metrics like different HTTP status codes metrics, application throughput, latency, response time. Enable the Application metrics from below the deployment template Save button. After enabling it, you should be able to see all metrics on App detail page. By default it remains disabled.
Once all the Deployment template configurations are done, click on Save
to save your deployment configuration. Now you are ready to create Workflow to do CI/CD.
Helm Chart Json Schema
Helm Chart json schema is used to validate the deployment template values.
Other Validations in Json Schema
The values of CPU and Memory in limits must be greater than or equal to in requests respectively. Similarly, In case of envoyproxy, the values of limits are greater than or equal to requests as mentioned below.
Last updated