Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jrxFive/python-nomad

Client library Hashicorp Nomad
https://github.com/jrxFive/python-nomad

api client hashicorp nomad python

Last synced: 30 days ago
JSON representation

Client library Hashicorp Nomad

Host: GitHub
URL: https://github.com/jrxFive/python-nomad
Owner: jrxFive
License: mit
Created: 2016-05-06T13:34:56.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-04-23T21:03:39.000Z (8 months ago)
Last Synced: 2024-05-01T23:53:53.078Z (8 months ago)
Topics: api, client, hashicorp, nomad, python
Language: Python
Homepage: https://python-nomad.readthedocs.io/en/latest/
Size: 343 KB
Stars: 133
Watchers: 7
Forks: 71
Open Issues: 20
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # python-nomad

[![Python Nomad Test and Publish](https://github.com/jrxFive/python-nomad/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/jrxFive/python-nomad/actions/workflows/main.yml)

[![codecov](https://codecov.io/gh/jrxFive/python-nomad/branch/master/graph/badge.svg)](https://codecov.io/gh/jrxFive/python-nomad)

[![PyPI version](https://badge.fury.io/py/python-nomad.svg)](https://badge.fury.io/py/python-nomad)

[![PyPI pyversions](https://img.shields.io/pypi/pyversions/python-nomad.svg)](https://pypi.python.org/pypi/python-nomad/)

[![Downloads](https://pepy.tech/badge/python-nomad/month)](https://pepy.tech/project/python-nomad)

[![Downloads](https://static.pepy.tech/personalized-badge/python-nomad?period=total&units=international_system&left_color=black&right_color=blue&left_text=Downloads)](https://pepy.tech/project/python-nomad)

[![PyPI license](https://img.shields.io/pypi/l/python-nomad.svg)](https://pypi.python.org/pypi/python-nomad/)

## Installation

```

pip install python-nomad

```

## Documentation

https://python-nomad.readthedocs.io/en/latest/

## Examples

```python

import nomad

# For HTTP Nomad instances

n = nomad.Nomad(host="172.16.100.10", timeout=5)

# For HTTPS Nomad instances with non-self-signed SSL certificates

n = nomad.Nomad(host="172.16.100.10", secure=True, timeout=5, verify=True)

# For HTTPS Nomad instances with self-signed SSL certificates and no validate the cert

n = nomad.Nomad(host="172.16.100.10", secure=True, timeout=5, verify=False)

# For HTTPS Nomad instances with self-signed SSL certificates that must validate with cert

n = nomad.Nomad(host="172.16.100.10", secure=True, timeout=5, verify=True, cert="/path/to/certfile") # See http://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification

# For HTTPS Nomad instances with cert file and key

n = nomad.Nomad(host="https://172.16.100.10", secure=True, timeout=5, verify=True, cert=("/path/to/certfile", "/path/to/key")) # See http://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification

# For HTTPS Nomad instances with namespace and acl token

n = nomad.Nomad(host="172.16.100.10", secure=True, timeout=5, verify=False, namespace='Namespace-example',token='3f4a0fcd-7c42-773c-25db-2d31ba0c05fe')

"example" in n.jobs

j = n.jobs["example"]["ID"]

example_allocation = n.job.get_allocations(j)

n.job.deregister_job(j)

```

## Environment Variables

This library also supports environment variables: `NOMAD_ADDR`, `NOMAD_NAMESPACE`, `NOMAD_TOKEN`, `NOMAD_REGION`, `NOMAD_CLIENT_CERT`, and `NOMAD_CLIENT_KEY`

for ease of configuration and unifying with nomad cli tools and other libraries.

```bash

NOMAD_ADDR=http://127.0.0.1:4646

NOMAD_NAMESPACE=default

NOMAD_TOKEN=xxxx-xxxx-xxxx-xxxx

NOMAD_REGION=us-east-1a

NOMAD_CLIENT_CERT=/path/to/tls/client.crt

NOMAD_CLIENT_KEY=/path/to/tls/client.key

```

## Class Dunders

| Class | contains | len | getitem | iter |

|---|---|---|---|---|

|agent|N|N|N|N

|allocation|Y|N|Y|N

|allocations|N|Y|N|Y

|client|N|N|N|N

|evaluation|Y|N|Y|N

|evaluations|Y|Y|Y|Y

|event|N|N|N|N

|job|Y|N|Y|N

|jobs|Y|Y|Y|Y

|node|Y|N|Y|N

|nodes|Y|Y|Y|Y

|regions|Y|Y|Y|Y

|status.leader|Y|Y|N|N

|status.peers|Y|Y|Y|Y

|system|N|N|N|N

|validate|N|N|N|N

|deployments|Y|Y|Y|Y

|deployment|Y|N|Y|N

|namespace|Y|N|Y|N

|namespaces|Y|Y|Y|Y

|acl|Y|N|Y|N

|sentinel|Y|N|Y|N

## Development

* create virtualenv and activate

* install requirements-dev.txt

* can either use the Vagrantfile for local integration testing or create environment variables `NOMAD_IP` and `NOMAD_PORT` that are assigned to a nomad binary that is running

```

virtualenv .venv

source .venv/bin/activate

pip install -r requirements-dev.txt

```

## Testing with vagrant and virtualbox

```

vagrant up --provider virtualbox

py.test --cov=nomad --cov-report=term-missing --runxfail tests/

```

## Testing with nomad binary

```

./nomad agent -dev -node pynomad1 --acl-enabled

NOMAD_IP=127.0.0.1 NOMAD_VERSION= py.test --cov=nomad --cov-report=term-missing --runxfail tests/

```

- Examples

    - [x] Acl [:link:](docs/api/acl.md)

    - [x] Agent [:link:](docs/api/agent.md)

    - [x] Allocation [:link:](docs/api/allocation.md)

    - [x] Allocations [:link:](docs/api/allocations.md)

    - [x] Deployment [:link:](docs/api/deployment.md)

    - [x] Deployments [:link:](docs/api/deployments.md)

    - [x] Client [:link:](docs/api/client.md)

    - [x] Evaluation [:link:](docs/api/evaluation.md)

    - [x] Evaluations [:link:](docs/api/evaluations.md)

    - [x] Event [:link:](docs/api/event.md)

    - [x] Job [:link:](docs/api/job.md)

    - [x] Jobs [:link:](docs/api/jobs.md)

    - [x] Namespace [:link:](docs/api/namespace.md)

    - [x] Namespaces [:link:](docs/api/namespaces.md)

    - [x] Node [:link:](docs/api/node.md)

    - [x] Nodes [:link:](docs/api/nodes.md)

    - [x] Regions [:link:](docs/api/regions.md)

    - [x] Sentinel [:link:](docs/api/sentinel.md)

    - [x] Search [:link:](docs/api/search.md)

    - [x] Status [:link:](docs/api/status.md)

    - [x] System [:link:](docs/api/system.md)

    - [x] Validate [:link:](docs/api/validate.md)

    - [x] Variable [:link:](docs/api/variable.md)

    - [x] Variables [:link:](docs/api/variables.md)