jellyfishco/jf_agent

jf_agent

一个可在本地部署的代理，用于下载并发送数据至Jellyfish。

参见文档https://jf-public.s3.amazonaws.com/Jellyfish+Agent+Guide.pdf

使用自定义SSL/TLS证书的代理

部分组织会通过组织范围的证书颁发机构(CA)生成自己的证书。如果jf_agent连接的系统的证书链不包含代理已知的证书，代理将终止并显示类似以下错误：

text
[2101] Failed to connect to bitbucket_server:
HTTPSConnectionPool(host='bitbucket.example.com', port=443): Max retries exceeded with url: /rest/
(Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1129)')))

解决方法如下：

1. 从https://github.com/certifi/python-certifi下载最新的证书 bundle，例如https://github.com/certifi/python-certifi/blob/2021.10.08/certifi/cacert.pem%E3%80%82(https://pypi.org/project/certifi/%E6%98%AFhttps://pypi.org/project/requests/%E7%9A%84%E4%BE%9D%E8%B5%96%E9%A1%B9%EF%BC%8C%E5%85%B6%60cacert.pem%60 bundle可在容器内找到)

2. 获取服务器使用的完整证书链，格式为Base-64编码的X.509（PEM）。

3. 将第二步获取的证书追加到第一步获取的cacert.pem文件中。

4. 最后一步是将更新后的cacert.pem bundle挂载到代理可访问的路径，并设置REQUESTS_CA_BUNDLE环境变量指向该路径。例如，以下Bash脚本展示了如何调用docker run（注意我们将本地cacert.pem文件挂载到容器内的路径，并在容器中设置REQUESTS_CA_BUNDLE环境变量指向该路径）：

   bash
   HERE=$(pwd)
   PATH_TO_BUNDLE=/home/jf_agent/cacert.pem
   OUTPUT_FOLDER=${HERE}/jf_agent_output
   mkdir --parents ${OUTPUT_FOLDER}
   docker run -it --rm \
       --mount type=bind,source=${HERE}/my_config.yml,target=/home/jf_agent/config.yml \
       --mount type=bind,source=${OUTPUT_FOLDER},target=/home/jf_agent/output \
       --mount type=bind,source=${HERE}/cacert.pem,target=${PATH_TO_BUNDLE} \
       --env REQUESTS_CA_BUNDLE=${PATH_TO_BUNDLE} \
       --env-file ./creds.env \
       docker.xuanyuan.run/jellyfishco/jf_agent:stable \
       $@
   

开发

初始设置

bash
pdm install --dev
pdm run pre-commit install