DaemonSet [apps/v1]

    DaemonSet represents the configuration of a daemon set.

    Type

    .spec

    Description

    DaemonSetSpec is the specification of a daemon set.

    Type

    object

    Required

    • selector

    • template

    PropertyTypeDescription

    minReadySeconds

    integer

    The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).

    revisionHistoryLimit

    integer

    The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

    selector

    LabelSelector meta/v1

    A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template’s labels. More info:

    template

    PodTemplateSpec core/v1

    An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info:

    updateStrategy

    object

    DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

    .spec.updateStrategy

    Description

    DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

    Type

    object

    PropertyTypeDescription

    rollingUpdate

    object

    Spec to control the desired behavior of daemon set rolling update.

    type

    string

    Type of daemon set update. Can be “RollingUpdate” or “OnDelete”. Default is RollingUpdate.

    .spec.updateStrategy.rollingUpdate

    Description

    Spec to control the desired behavior of daemon set rolling update.

    Type

    object

    PropertyTypeDescription

    maxSurge

    IntOrString util/none

    The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. 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 to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. This is an alpha field and requires enabling DaemonSetUpdateSurge feature gate.

    maxUnavailable

    The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding down to a minimum of one. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.

    .status

    Description

    DaemonSetStatus represents the current status of a daemon set.

    Type

    object

    Required

    • currentNumberScheduled

    • desiredNumberScheduled

    • numberReady

    PropertyTypeDescription

    collisionCount

    integer

    Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

    conditions

    array

    Represents the latest available observations of a DaemonSet’s current state.

    conditions[]

    object

    DaemonSetCondition describes the state of a DaemonSet at a certain point.

    currentNumberScheduled

    integer

    The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

    desiredNumberScheduled

    integer

    The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info:

    numberAvailable

    integer

    The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)

    numberMisscheduled

    integer

    The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

    numberReady

    integer

    The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.

    numberUnavailable

    integer

    The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)

    observedGeneration

    integer

    The most recent generation observed by the daemon set controller.

    updatedNumberScheduled

    integer

    The total number of nodes that are running updated daemon pod

    .status.conditions

    Description

    Represents the latest available observations of a DaemonSet’s current state.

    Type

    array

    .status.conditions[]

    Description

    DaemonSetCondition describes the state of a DaemonSet at a certain point.

    Type

    object

    Required

    • type

    • status

    PropertyTypeDescription

    lastTransitionTime

    Last time the condition transitioned from one status to another.

    message

    string

    A human readable message indicating details about the transition.

    reason

    string

    The reason for the condition’s last transition.

    status

    string

    Status of the condition, one of True, False, Unknown.

    type

    string

    API endpoints

    The following API endpoints are available:

    • /apis/apps/v1/daemonsets

      • GET: list or watch objects of kind DaemonSet
    • /apis/apps/v1/namespaces/{namespace}/daemonsets

      • DELETE: delete collection of DaemonSet

      • : list or watch objects of kind DaemonSet

    • /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}

      • DELETE: delete a DaemonSet

      • GET: read the specified DaemonSet

      • PATCH: partially update the specified DaemonSet

      • PUT: replace the specified DaemonSet

    • /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status

      • GET: read status of the specified DaemonSet

      • PATCH: partially update status of the specified DaemonSet

      • PUT: replace status of the specified DaemonSet

    Table 1. Global query parameters
    ParameterTypeDescription

    allowWatchBookmarks

    boolean

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    pretty

    string

    If ‘true’, then the output is pretty printed.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    watch

    boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    HTTP method

    GET

    Description

    list or watch objects of kind DaemonSet

    Table 2. HTTP responses
    HTTP codeReponse body

    200 - OK

    Table 3. Global path parameters
    ParameterTypeDescription

    namespace

    string

    object name and auth scope, such as for teams and projects

    Table 4. Global query parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete collection of DaemonSet

    Table 5. Query parameters
    ParameterTypeDescription

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    gracePeriodSeconds

    integer

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    orphanDependents

    boolean

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    propagationPolicy

    string

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    Table 6. Body parameters
    ParameterTypeDescription

    body

    DeleteOptions meta/v1

    Table 7. HTTP responses
    HTTP codeReponse body

    200 - OK

    HTTP method

    GET

    Description

    list or watch objects of kind DaemonSet

    Table 9. HTTP responses
    HTTP codeReponse body

    200 - OK

    DaemonSetList apps/v1

    HTTP method

    POST

    Description

    create a DaemonSet

    Table 10. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    Table 11. Body parameters
    ParameterTypeDescription

    body

    DaemonSet apps/v1

    Table 12. HTTP responses
    HTTP codeReponse body

    200 - OK

    Table 13. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the DaemonSet

    namespace

    string

    object name and auth scope, such as for teams and projects

    Table 14. Global query parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete a DaemonSet

    Table 15. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    gracePeriodSeconds

    integer

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    orphanDependents

    boolean

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    propagationPolicy

    string

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

    Table 16. Body parameters
    ParameterTypeDescription

    body

    DeleteOptions meta/v1

    Table 17. HTTP responses
    HTTP codeReponse body

    200 - OK

    HTTP method

    GET

    Description

    read the specified DaemonSet

    Table 18. HTTP responses
    HTTP codeReponse body

    200 - OK

    DaemonSet apps/v1

    HTTP method

    PATCH

    Description

    partially update the specified DaemonSet

    Table 19. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by . This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    force

    boolean

    Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    Table 20. Body parameters
    ParameterTypeDescription

    body

    Patch meta/v1

    HTTP method

    PUT

    Description

    replace the specified DaemonSet

    Table 22. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    Table 23. Body parameters
    ParameterTypeDescription

    body

    DaemonSet apps/v1

    Table 24. HTTP responses
    HTTP codeReponse body

    200 - OK

    Table 25. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the DaemonSet

    namespace

    string

    object name and auth scope, such as for teams and projects

    Table 26. Global query parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    GET

    Description

    read status of the specified DaemonSet

    Table 27. HTTP responses
    HTTP codeReponse body

    200 - OK

    DaemonSet apps/v1

    HTTP method

    PATCH

    Description

    partially update status of the specified DaemonSet

    Table 28. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by . This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    force

    boolean

    Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    Table 29. Body parameters
    ParameterTypeDescription

    body

    Patch meta/v1

    Table 30. HTTP responses
    HTTP codeReponse body

    200 - OK

    HTTP method

    PUT

    Description

    replace status of the specified DaemonSet

    Table 31. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    Table 32. Body parameters
    ParameterTypeDescription

    body

    Table 33. HTTP responses
    HTTP codeReponse body

    DaemonSet apps/v1