https://github.com/javanile/ipqueue

Service discovery over HTTP API
https://github.com/javanile/ipqueue

curl http-api scripting service-discovery service-discovery-patterns

Last synced: about 17 hours ago
JSON representation

Service discovery over HTTP API

• Host: GitHub
• URL: https://github.com/javanile/ipqueue
• Owner: javanile
• License: mit
• Created: 2018-11-22T13:38:44.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-04-01T16:23:22.000Z (almost 4 years ago)
• Last Synced: 2024-12-10T00:15:23.678Z (about 2 months ago)
• Topics: curl, http-api, scripting, service-discovery, service-discovery-patterns
• Language: PHP
• Homepage: https://www.ipqueue.com
• Size: 173 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ipqueue

[![StyleCI](https://github.styleci.io/repos/158704688/shield?branch=master)](https://github.styleci.io/repos/158704688)

[![Build Status](https://travis-ci.org/javanile/ipqueue.svg?branch=master)](https://travis-ci.org/javanile/ipqueue)

[![codecov](https://codecov.io/gh/javanile/ipqueue/branch/master/graph/badge.svg)](https://codecov.io/gh/javanile/ipqueue)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/00bc294fe3ae4bca8c74d6d6530f3d54)](https://app.codacy.com/app/francescobianco/ipqueue?utm_source=github.com&utm_medium=referral&utm_content=javanile/ipqueue&utm_campaign=Badge_Grade_Dashboard)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Enable your project to use a service discovery. With IpQueue you can create scripts for service registration and service information retrieval in a smart way without pain. IpQueue uses a simple HTTP API layer easily integrable on every environment, you can use a cURL syntax to interact with Docker, Kubernates, Jenkins, Travis CI, etc...

## Get started

**Register your service** *(call from service machine or container)*

```bash

$ curl -LXPOST .ipqueue.com

```

**Retrieve information of service** *(call from dependants system)*

```bash

$ curl -sL .ipqueue.com

```

`` examples: 

  - *acme-crm-mysql*, 

  - *com-mycorp-nginx*, 

  - *org-care-apache*, 

  - etc...

Update Documentation

docker-compose up docs

## HTTP Methods

| Method    | Function                             |

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

| `GET`     | Retrieve information about a service |

| `HEAD`    | _Not used_                           |

| `POST`    | Register service instance            |

| `PUT`     | Store service variables and protect  |

| `DELETE`  | Delete service of remove protection  |

| `CONNECT` | _Not used_                           |

| `OPTIONS` | _Not used_                           |

| `TRACE`   | _Not used_                           |

## HTTP Headers

| Header    | Function                 |

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

| `ENV`     | Set specific environment |

| `PKG`     | Set specific package     |

| `JWT`     | Set authorization token  |

##

generate secret private key ()

```bash

$ openssl genrsa -out service-secret.pem 2048

```

generate public key to send it on ipqueue ()

```bash

$ openssl rsa -in service-secret.pem -pubout -out service-public.pem

```

send public key to ipqueue (now service is protectect)

```bash

$ curl -LXPUT [email protected] service.ipqueue.com 

```