Skip to content

javanile/ipqueue

Repository files navigation

ipqueue

StyleCI Build Status codecov Codacy Badge License: 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)

$ curl -LXPOST <service>.ipqueue.com

Retrieve information of service (call from dependants system)

$ curl -sL <service>.ipqueue.com

<services> 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 ()

$ openssl genrsa -out service-secret.pem 2048

generate public key to send it on ipqueue ()

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

send public key to ipqueue (now service is protectect)

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