coco/neo4j-kubernetes

neo4j-kubernetes

https://circleci.com/gh/Financial-Times/neo4j-kubernetes/tree/master.png?style=shield](https://circleci.com/gh/Financial-Times/neo4j-kubernetes/tree/master)https://goreportcard.com/badge/github.com/Financial-Times/neo4j-kubernetes](https://goreportcard.com/report/github.com/Financial-Times/neo4j-kubernetes) https://coveralls.io/repos/github/Financial-Times/neo4j-kubernetes/badge.svg](https://coveralls.io/github/Financial-Times/neo4j-kubernetes)

简介

此服务是什么以及其用途是什么？它依赖哪些其他服务

Neo4j在Kubernetes上的部署服务。

安装

如何安装

下载源代码、依赖项和测试依赖项：

    go get -u github.com/kardianos/govendor
    go get -u github.com/Financial-Times/neo4j-kubernetes
    cd $GOPATH/src/github.com/Financial-Times/neo4j-kubernetes
    govendor sync
    go build .

本地运行

如何运行

1. 运行测试并安装二进制文件：

    govendor sync
    govendor test -v -race
    go install
   

2. 运行二进制文件（使用help标志查看可用的可选参数）：

    $GOPATH/bin/neo4j-kubernetes [--help]
   

选项：

    --app-system-code="neo4j-kubernetes"            应用程序的系统代码 ($APP_SYSTEM_CODE)
    --app-name="neo4j-kubernetes"                   应用程序名称 ($APP_NAME)
    --port="8080"                                   监听端口 ($APP_PORT)
    

3. 测试：

1. 使用curl：

        curl http://localhost:8080/people/143ba45c-2fb3-35bc-b227-a6ed80b5c517 | json_pp

2. 或使用https://github.com/jkbrzt/httpie：

        http GET http://localhost:8080/people/143ba45c-2fb3-35bc-b227-a6ed80b5c517

构建与部署

如何构建和部署（大部分步骤可能为通用链接）

• 合并到master分支时由Docker Hub构建：https://hub.docker.com/r/coco/neo4j-kubernetes/
• CI由CircleCI提供：https://circleci.com/gh/Financial-Times/neo4j-kubernetes

服务端点

服务提供的端点

例如

GET

使用curl：

curl http://localhost:8080/people/143ba45c-2fb3-35bc-b227-a6ed80b5c517 | json_pp

或使用https://github.com/jkbrzt/httpie%EF%BC%9A

http GET http://localhost:8080/people/143ba45c-2fb3-35bc-b227-a6ed80b5c517

预期响应将包含人员信息及其通过成员关系连接的组织信息。

基于以下https://docs.google.com/document/d/1SC4Uskl-VD78y0lg5H2Gq56VCmM4OFHofZM-OvpsOFo/edit#heading=h.qjo76xuvpj83%E3%80%82

工具端点

用于支持或测试的端点，例如写入器上的读取端点

健康检查

管理端点包括：

/__gtg

/__health

/__build-info

这些标准端点无需专门文档说明。

但本部分应解释如何确定健康和gtg状态的检查内容。

执行以下几项检查：

例如

• 检查是否可以使用服务启动时提供的neo4j url连接到Neo4j。

其他信息

任何其他需要添加的内容。

例如（注意：此示例可能需要提取，因为它可能对许多服务通用）

日志

• 应用程序使用https://github.com/Sirupsen/logrus%EF%BC%9B%E6%97%A5%E5%BF%97%E6%96%87%E4%BB%B6%E5%9C%A8main.go%E4%B8%AD%E5%88%9D%E5%A7%8B%E5%8C%96%E3%80%82
• 日志记录需要env应用参数，对于除local之外的所有环境，日志写入文件。
• 本地运行时，日志输出到控制台。如果要本地将日志写入文件，需传入不等于local的env参数。
• 注意：/__build-info和/__gtg端点不记录日志，因为它们每秒从varnish/vulcand调用，这些信息不需要在日志/Splunk中记录。