simpleservice

簡単なサービス

たとえば、コンテナオーケストレーションのセットアップのテストに使用できるシンプルで構成可能なサービス（ヘルスチェックエンドポイントを含む）。

以下で使用される0.4.0などのsimpleserviceのバージョンは、作成されたそれぞれのDocker画像で使用されたタグを参照することに注意してください。このGitHubリポジトリには、タグやリリースはありません。

コンテンツ：

• HTTP API
• それを実行します
• ランタイム動作の変更
• それを呼び出す

HTTP API

ここにリストされているエンドポイントに加えて、以下のランタイム動作セクションの変更も参照してください。

/env [0.5.0+]

原則的な応答：

 HTTP/1.1 200 OK
$HEADER_FIELDS
 {
     "env": "$DUMP_OF_ENVIRONMENT_VARS",
     "version": "$VERSION"
 }

応答の例：

 HTTP/1.1 200 OK                                                                                                                                                             [5/99]
Content-Length: 2471
Content-Type: application/json
Date: Mon, 24 Apr 2017 12:38:47 GMT
Etag: "5ccb76cf1545f01fd1e0df4257ff6f8da19678e9"
Server: TornadoServer/4.3

{
    "env": "{'USER': 'mhausenblas', ...}"
    "version": "0.5.0"
}    

/info [0.5.0+]

原則的な応答：

 HTTP/1.1 200 OK
$HEADER_FIELDS
 {
     "from": "$REMOTE_IP",
     "host": ""$HOST:$PORT"",
     "version": "$VERSION"
 }

応答の例：

 HTTP/1.1 200 OK
Content-Length: 67
Content-Type: application/json
Date: Mon, 24 Apr 2017 12:36:37 GMT
Etag: "9d09b0a126f68a0fddfec0f494e56fcab29eac15"
Server: TornadoServer/4.3

{
    "from": "127.0.0.1",
    "host": "localhost:9876",
    "version": "0.5.0"
}

/health [0.4.0+]

原則的な応答：

 HTTP/1.1 200 OK
$HEADER_FIELDS
 {
     "healthy": true
 }

応答の例：

 HTTP/1.1 200 OK
Content-Length: 17
Content-Type: application/json
Date: Tue, 11 Oct 2016 17:17:21 GMT
Etag: "b40026a9bea9f5096f4ef55d3d23d6730139ff5e"
Server: TornadoServer/4.3

{
    "healthy": true
}

/endpoint0 [0.3.0+]

原則的な応答：

 HTTP/1.1 200 OK
$HEADER_FIELDS
{
    "host": "$HOST:$PORT",
    "result": "all is well",
    "version": "$VERSION"
}

応答の例：

 HTTP/1.1 200 OK
Content-Length: 71
Content-Type: application/json
Date: Tue, 11 Oct 2016 16:57:33 GMT
Etag: "ce18606c019e1d8c584b796d1fe7402d9767b9b6"
Server: TornadoServer/4.3

{
    "host": "localhost:9876",
    "result": "all is well",
    "version": "0.4.0"
}

それを実行します

ローカル実行には、Python 2.7.9が必要です。その後、 simpleservice次のように実行できます。

 # with defaults:
$ python simpleservice.py

# overwriting certain runtime settings:
$ HEALTH_MAX=200 VERSION=1.0 python simpleservice.py

あなたがそれを空想するなら、あなたはあなたのローカルマシンでsimpleserviceのコンテナ化されたバージョンを実行することができます（Dockerがインストールされる必要があります）：

 $ docker run -P mhausenblas/simpleservice:0.5.0

コンテナ画像も参照してください。

ランタイム動作の変更

次の環境変数を設定することで、 simpleserviceのランタイム動作を変更できます。

• PORT0 ...ポートsimpleserviceが提供しています
• VERSION ... /endpoint0エンドポイントのJSON応答で返されるversionの値
• HEALTH_MIN and HEALTH_MAX ... the min。とマックス。 /health Endpointが応答するミリ秒での遅延

それを呼び出す

simpleserviceが開始されたら、そのように呼び出すことができます（ここに表示されているローカルサービスの実行が表示されます）：

 $ http localhost:9876/endpoint0
HTTP/1.1 200 OK
Content-Length: 71
Content-Type: application/json
Date: Tue, 11 Oct 2016 16:57:33 GMT
Etag: "ce18606c019e1d8c584b796d1fe7402d9767b9b6"
Server: TornadoServer/4.3

{
    "host": "localhost:9876",
    "result": "all is well",
    "version": "0.4.0"
}

そして、サービスログには次のようなものが表示されます。

 ~$ python simpleservice.py
This is a simple service in version v0.4.0 listening on port 9876
2016-10-11T05:57:33 INFO /endpoint0 serving from localhost:9876 has been invoked from 127.0.0.1 [at line 58]
2016-10-11T05:57:33 INFO 200 GET /endpoint0 (127.0.0.1) 1.10ms [at line 1946]

使用可能なエンドポイントは、このドキュメントの最初のセクション（別名API）で定義されているように、 simpleserviceのバージョンに依存することに注意してください。