Metadata-Version: 2.1
Name: termination-handler
Version: 0.0.2
Summary: Handle termination notices on spot/preemptible instances.
Home-page: https://github.com/dgzlopes/termination-handler
Author: Daniel González Lopes
Author-email: danielgonzalezlopes@gmail.com
License: MIT
Description: # termination-handler
        [![PyPI](https://img.shields.io/pypi/v/cloud-detect.svg)](https://pypi.org/project/termination-handler/)
        [![PyPI - License](https://img.shields.io/pypi/l/cloud-detect.svg)](https://github.com/dgzlopes/termination-handler/blob/master/LICENSE.md)
        ## About
        `termination-handler` handles termination notices on spot/preemptible instances.
        
        As an example, if deployed on a Kubernetes cluster and a termination notice is issued by the cloud provider, `termination-handler` drains the node it is running on before the node is taken away by the cloud provider.
        
        Inspired by [pusher/k8s-spot-termination-handler](https://github.com/pusher/k8s-spot-termination-handler) for AWS, `termination-handler` surges from the need to operate the same tooling in various distinct environments (providers, orchestrators...)
        
        ## Features
        - Supports multiple cloud providers (AWS, GCP).
        - Supports multiple scheduling & orchestration tools (Kubernetes, Nomad).
        - Small and extensible.
        
        ## Documentation
        TBD
        ## Usage
        ### Deploy to Kubernetes
        
        A K8s docker image is available at [`dgzlopes/termination-handler-k8s`](https://hub.docker.com/r/dgzlopes/termination-handler-k8s) and sample Kubernetes manifests are available in the [deploy/k8s](deploy/k8s) folder.
        
        To deploy in clusters using RBAC, please apply all of the manifests (Daemonset, ClusterRole, ClusterRoleBinding and ServiceAccount) in the [deploy/k8s](deploy/k8s) folder but uncomment the `serviceAccountName` in the [Daemonset](deploy/k8s/daemonset.yaml).
        
        #### Requirements
        
        For `termination-handler` to schedule correctly; you will need an identifying label on your spot/preemptible instances.
        
        We add a label `node-role.kubernetes.io/spot-worker` to our spot/preemptible instances and hence this is the default value in the node selector of the [Daemonset](deploy/k8s/daemonset.yaml).
        ```yaml
        nodeSelector:
          "node-role.kubernetes.io/spot-worker": "true"
        ```
        To achieve this, add the following flag to your Kubelet:
        ```
        --node-labels="node-role.kubernetes.io/spot-worker=true"
        ```
        
        #### Configuration
        
        To define any custom parameters to the drain command you can use `DRAIN_PARAMETERS` environment property. If not defined, default parameters are `--grace-period=120 --force --ignore-daemonsets`.
        ```yaml
        env:
          - name: DRAIN_PARAMETERS
            value: '--grace-period=120 --force --ignore-daemonsets --delete-local-data'
        ```
        
        #### Demo mode
        TBD
        
        ### Deploy to Nomad
        TBD
        
        ## How to contribute
        1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
        2. Fork [the repository](https://github.com/dgzlopes/termination-handler) on GitHub to start making your changes to the master branch (or branch off of it).
        3. Write a test which shows that the bug was fixed or that the feature works as expected.
        4. Send a [pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) and bug [me](https://github.com/dgzlopes) until it gets merged and published.
        
        Some things that would be great to have:
        - Support for Azure cloud provider.
        - Support for Execution handler (certain command or task)
        - Support for notifications (Slack, Datadog..)
        - Option to omit selected cloud provider discovery.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: System :: Networking
Description-Content-Type: text/markdown
