使用最新的JFrog产品?hth华体会最新官方网站
JFrog平台用户指南
JFrog x射线x文档
要获取最新版本,请访问JFrog统一平台
屏幕会显示你添加到x射线显示的人工实例列表:
ID |
您在注册实例时提供的Artifactory ID。 |
Artifactory URL |
注册Artifactory实例的URL,包括“/ Artifactory”路径(如截图所示)。 |
许可证 |
指示所选Artifactory实例中的x射线许可证是否有效。 |
索引文件数 |
方法为Artifactory实例索引了多少个文件为分析指定的存储库在Artifactory |
添加新实例
要添加新实例,请单击新实例链接并填写显示的表单。
Artifactory ID |
此Artifactory实例的逻辑标识符。 |
描述 |
此实例的描述。 |
Artifactory URL |
将访问该实例的URL。 |
代理启用 |
设置后,Xray将通过HTTP连接到这个Artifactory实例代理定义在管理模块。 |
管理用户 |
在此实例中具有管理员权限的用户。 |
管理员密码 |
admin密码。 |
测试连接 |
测试Xray和Artifactory之间的连接(在两个方向上),以确保已正确配置。 |
指定用于分析的存储库
为了避免冗长而密集的分析过程,Xray不会分析连接的Artifactory实例中的所有存储库。相反,在您创建一个新的Artifactory实例之后,Xray将显示该实例中的存储库,这样您就可以选择哪些存储库应该被索引以供分析。
一旦您在Artifactory中指定了用于分析的存储库,它们将出现在存储库选项卡下索引资源2022世界杯阿根廷预选赛赛程在Artifactory实例页面中(在管理模块下Artifactory).
您现在可以对所选存储库中的构件进行索引,以便进行分析索引的工件。
为分析指定构建
为了避免冗长而密集的分析过程,Xray不会分析连接的Artifactory实例中的所有构建。相反,在创建新的Artifactory实例之后,在构建标签索引资源2022世界杯阿根廷预选赛赛程面板中,您可以选择应该索引哪些构建以供分析。
希望扫描所有构建?
如果您确实希望x射线扫描所有构建,请在美元XRAY_HOME / config / xray_config.yaml
,设置indexAllBuilds:真
重启x射线。
管理用户
Xray支持两种方式来管理用户:
- 通过身份验证提供程序
- 内部定义用户
通过身份验证提供程序管理用户
从1.9版本开始,您可以将其中一个连接的Artifactory实例设置为身份验证提供者。在这种情况下,Artifactory将首先尝试通过为该实例设置的方法(无论是LDAP/Crowd还是SAML)对用户进行身份验证。
详情请参阅身份验证。
内部管理用户
使用身份验证提供者不是强制性的,您总是可以在Xray内部定义用户。
您可以查看在Xray下注册的用户列表管理模块下用户。
用户名 |
用户登录到Xray时使用的用户名 |
电子邮件 |
用户的邮箱地址。这是向该用户的观察者发送通知的默认电子邮件。 |
管理 |
指示该用户是否具有管理员权限 |
创建和编辑用户
如需添加新用户,请单击新用户,或者单击所显示的表中的现有用户以编辑其详细信息。
用户名 |
这个用户应该登录的用户名,或者用来运行REST API调用的用户名 |
电子邮件 |
用户邮箱 |
管理 |
设置后,该用户将拥有管理员权限,因此可以访问更广泛的功能和REST API调用 |
密码 |
用户密码。用户将需要它来登录或运行REST API调用。 |
配置邮件服务器
对于发生的不同事件,Xray会向用户发送电子邮件通知。
SaaS用户
此配置不适用于自动配置默认邮件服务器的SaaS用户。
一些例子是:
- 观察者可以发送警报电子邮件。
- 用户可能会收到有关其帐户信息更改的通知
要启用邮件通知,您需要使用下面的邮件服务器详细信息配置Xray管理员|邮件如下所述。
宿主 |
邮件服务器的主机名。 |
港口 |
邮件服务器的端口。 |
用户名 |
与邮件服务器进行身份验证的用户名。 |
密码 |
与邮件服务器进行身份验证的密码。 |
从(可选) |
在所有外发邮件中使用的“from”地址头。 |
主题的前缀 |
用于所有外发邮件主题的前缀。 |
人工URL(可选) |
在所有外发邮件中使用的Artifactory URL,以表示到Artifactory的链接。 |
使用SSL / TLS |
设置后,在连接到邮件服务器时使用传输层安全性。 |
发送测试邮件 |
单击,将测试信息发送到指定邮箱。 |
配置人
配置watch时的一个选项是让它们调用webhook, webhook是你可以定义的专有url,可以在违规发布时执行自定义操作。
webhook显示在管理模块下人则。
点击一个网络钩子来编辑它的详细信息,或者点击新Webhook去定义一个新的。
一般 |
|
Webhook名字 |
webhook的标识符。这个名称将被任何手表想要在违反的情况下调用webhook |
URL |
此webhook调用的URL。有关x射线提供给网钩的有效载荷的详细信息,请参阅Webhook载荷。 |
描述 |
免费文本描述 |
基本认证 |
|
用户名/密码 |
webhook要求的用户名和密码 |
自定义标题 |
调用webhook时可能需要添加的任何自定义头 |
索引的工件
JFrog Xray提供了关于它所索引的组件中的问题和漏洞的信息。在正常操作期间,当对标记为分析的存储库中的组件进行更改时,组件数据库会不断更新和重新索引,但是,要设置初始数据库,您需要手动调用标记为分析的存储库的索引。
在管理模块,在Artifactory,可以查看已连接的Artifactory实例列表。单击要索引其存储库的实例。该实例的详细信息页面显示了标记为索引的存储库列表。
这指数状态列将指示哪些存储库索引是最新的,哪些需要索引。你可以点击计算启动单个存储库的索引,或选中多个存储库并单击现在指数一次为多个存储库启动索引。
资源密集型
根据存储库的大小,索引是一项资源密集型操作,因此我们建议单独调用存储库上的索引,以避免系统的过度负载。
同步数据库
使用防火墙?
如果您使用的是防火墙,为了让数据库同步成功完成,您需要将以下url添加到防火墙的白名单中:
要测试同步的能力,运行以下REST API端点:
https://jxray.jfrog.io/api/v1/system/ping
对于x射线扫描您的索引工件,它必须从连接到的各种提要中摄取有关问题和漏洞的数据。主提要来自全局数据库服务器由JFrog维护(其他源包括您可能通过x射线的直接连接)集成与外部提供者)。有两种方法可以同步x射线与全局数据库服务器:
- 在线:在联机模式下,Xray每天通过互联网连接自动与全球数据库服务器同步
- 离线:在离线模式下,您手动从全局数据库服务器下载文件,然后将它们上传到Xray
要配置与全局数据库服务器的同步,请在管理模块,选择数据库同步。
网络同步
要立即开始,以便Xray可以扫描您的工件,您可以通过选择手动调用初始同步开始同步在状态面板。从那时起,Xray将定期自动同步问题和漏洞,每天一次。
离线同步
如果出于某种原因不希望维护到全局数据库服务器的实时internet连接,请选择离线在同步模式小组,以获得有关如何获得最新可用数据的详细说明。
与JFrog CLI的版本兼容性
离线数据库同步需要使用JFrog CLI。
来自x射线版本2.1.2,要执行脱机同步,您必须有JFrog CLI版本1.16.2或更高版本。
暂停和恢复同步
使用来自全局数据库服务器的最新数据更新Xray可能是一项资源密集型操作。在更新过程中,您可以单击文件中的相应链接状态面板,以便随时暂停操作以释放资源,然后稍后恢复操作。2022世界杯阿根廷预选赛赛程
使用自签名证书使用SSL
当连接到其他应用程序和服务时,Xray能够通过安全连接工作。例如,它通过HTTPS连接到Artifactory。作为HTTPS协议的一部分,Xray能够通过验证其SSL证书来验证站点的身份,然而,在可信连接的情况下,站点可能使用无法验证的自签名证书(这可能是Artifactory/Xray连接中的情况)。
从2.0版本开始,sslInsecure
参数已从xray_config.yaml
文件。该配置已移动到一般设置在Xray UI中。
配置HTTPS设置
您可以通过HTTP、HTTPS或两者(至少需要一种)配置对Xray的访问。
要配置使用HTTPS访问Xray,请粘贴您的SSL密钥和SSL认证以下目录下的文件:XRAY_HOME /数据/ ssl / serverCerts美元
然后去管理模块>HTTP的设置,点击刷新查看添加的SSL文件,并单击保存。
使用SSL |
设置后,Xray将在设置的相应端口上通过HTTPS访问。 |
HTTPS端口 |
设置HTTPS服务器的端口。默认值是8000,在xray_config文件中配置。yaml文件。 |
SSL密钥路径 |
通过HTTPS访问的密钥文件的完整路径。 (注意:这只能通过将证书插入到 XRAY_HOME /数据/ ssl / serverCerts美元 文件夹中。参见上面的说明) |
SSL证书路径 |
通过HTTPS访问的证书文件的完整路径。(支持的格式:.cer, .crt, .csr, .pem) (注意:这只能通过将证书插入到 XRAY_HOME /数据/ ssl / serverCerts美元 文件夹中。参见上面的说明) |
对于基于docker的安装,将证书复制到xray-server容器使用以下命令:
docker cp:/var/opt/jfrog/xray/data/ssl/serverCerts . docker cp
在使用自签名证书的情况下,启用“SSL不安全”管理模块,在一般设置。然后,将证书导入到Artifactory。
设置证书后,更新“x射线基础URL”切换到HTTPS并重新启动Xray。
当将默认端口更改为1024以下的端口时,例如要运行侦听端口为80的服务器,请使用以下命令:
Setcap cap_net_bind_service=ep /opt/jfrog/xray/bin/server
安装Docker时,以root用户的身份进入xray-server容器并运行以下命令:
Setcap cap_net_bind_service=ep /opt/jfrog/xray-server/server
配置代理
根据组织的策略,您可能需要配置Xray以通过代理访问外部资源,代理可以在2022世界杯阿根廷预选赛赛程管理模块下代理。
一般设置
Xray建立在一组微服务之上,这些微服务在索引工件、与Artifactory通信、管理事件和通知等领域执行其操作。
基本配置
Xray Base URL |
可以访问Xray的基本URL。基本URL的格式如下:PROTOCOL://IP_OR_HOST:8000 例如, 请注意,Xray Base URL不应该定义为“localhost”或“127.0.0.1”,也不应该包含“/web”元素。例如,下面的基本url行不通的: x射线访问URL不是它的基URL 注意不要混淆Xray的访问URL和它的基础URL。 Xray的访问URL是: 如果您在Xray Base URL字段中设置了访问URL,则连接的Artifactory实例将无法与Xray通信 |
队列的工人
队列的工人提供了几个参数,您可以配置来调整x射线的性能,通过改变工作人员的数量执行不同的任务。
指数 |
管理工件索引的工作人员的数量。 |
二进制文件管理器 |
管理与Artifactory通信的工人数量。 |
事件 |
处理Artifactory向Xray发出的事件的工人数量。 |
坚持 |
管理构建工件关系图所需的持久存储的工作人员的数量。 |
警报 |
管理警报的工作人员的数量。 |
分析 |
参与的工人人数扫描分析。 |
影响分析 |
涉及的工人数量在影响分析来确定具有报告问题的组件如何影响系统中的其他组件。 |
通知 |
管理通知的工作人员的数量。 |
系统参数
SSL不安全 |
切换启用跳过Xray的自签名证书验证 |
没有SSL的邮件 |
在连接到邮件服务器时切换使用传输层安全性 |
最大磁盘使用率 |
x射线允许的磁盘使用百分比。当达到指定值时,Xray将不会下载用于索引的软件包 |
监控采样间隔 |
CPU、磁盘使用率、重启等监控任务的执行时间间隔。 |
队列消息最大TTL |
消息队列系统中要接受的重试次数 |
工作时间间隔 |
运行节点特定作业的间隔时间 |
有关调整这些参数可能如何影响系统性能的更多详细信息,请联系JFrog支持。
更改第三方服务凭据
Xray与许多第三方服务一起工作,例如各种数据库,这些服务预先配置了Xray访问的默认凭据。以下部分将展示如何更改这些默认凭据。
MongoDB
要更改Xray访问其内部MongoDB数据库时使用的默认凭据,您需要以“Xray”用户身份登录数据库,并使用安装Xray时建立的密码。
如果最初安装的Xray版本是2.8.8或更早版本,默认密码是“password”。
如果最初安装的Xray版本是释放2.8.9默认密码是由安装过程生成的随机字符串,然后由Xray master.key加密。生成的密码存储在/根文件夹作为文本文件,称为MongoDB_Admin_pass.txt
。根据x射线的安装方式,它可能在本地用户的主目录中:~ / MongoDB_Admin_pass.txt
登录MongoDB数据库修改密码的方法如下:
$ mongo——port 27017 -u " Xray " -p ""——authenticationDatabase " Xray " #切换到x射线数据库$ use Xray #更新凭据$ db。updateUser("xray",{pwd: " "}) #使用新凭据登录验证更新是否成功$ mongo——port 27017 -u "xray" -p " "——authenticationDatabase "xray"
PostgreSQL
要修改Xray访问PostgreSQL内部数据库的默认凭证,需要以“Xray”用户登录数据库,并修改密码,如下所示:
$ psql -d xraydb -U Xray -W #安全修改用户“Xray”的密码在提示符下输入并重新键入密码。使用新凭据登录验证更新是否成功$ psql -d xraydb -U xray -W
RabbitMQ
Xray是预先安装在RabbitMQ中的,使用默认凭证:用户:客人,密码:客人
要更改默认凭据,请按照以下步骤操作:
$ rabbitmqctl change_password guest#验证更新是否成功$ rabbitmqctl authenticate_user guest
加强机密安全
Xray使用一组加密参数(秘密)来连接外部资源,例如它使用的不同数据库。2022世界杯阿根廷预选赛赛程虽然这些秘密可能存储在Xray配置文件中,但这会带来暴露的风险。
为了保护秘密不被曝光,从2.5版开始在运行中的x射线安装上Kubernetes,您可以在第一次启动Xray时从临时文件中预加载秘密。一旦Xray读取并成功使用了秘密,文件就会被删除。
下面的代码片段显示了可以包含在这个临时文件中的参数示例。这些是Xray连接到它使用的不同数据库的连接字符串。
mqBaseUrl: amqp://: @rabbitmq:5672/ mongoUrl: mongodb:// : @mongodb:27017/?authSource=xray&authMechanism= sram - sha -1 postgresqlUrl: postgres:// : @postgres:5432/xraydb?sslmode =禁用
虽然我们建议只包含敏感信息,如加密的连接字符串,但该文件可能包含任何x射线配置参数,并且指定的任何参数(包括环境变量和系统属性)将覆盖x射线配置文件中的相应参数。
一旦文件准备好,从它创建一个Kubernetes密钥。例如:
kubectl create secret generic
——from-file= / TEMP .xray_config.yml - 使用init容器,将秘密作为卷预加载到每个x射线服务的临时路径。
您还需要挂载x光数据量
来/var/opt/jfrog/xray/data
- 在init容器中,将临时文件复制到
/var/opt/jfrog/xray/data/.secrets/.temp.xray_config.yml
- 开始x光。在启动过程中,如果临时配置文件存在,Xray将从中读取所有参数,然后删除该文件。如果Xray删除文件失败,则Xray将不会启动并发出错误。
需要重新启动完整的pod
由于临时文件在Xray启动时被删除,因此如果Xray服务容器崩溃并重新启动,则需要重新启动完整的pod。
这是pod生命周期的一个已知限制。目前不支持容器崩溃时的自动pod重启。
观看视频
观看此屏幕视频,了解如何排除与以下问题相关的x射线安装故障代理连接、数据库、网络和计算资源。2022世界杯阿根廷预选赛赛程
配置PostgreSQL连接池
可以在文件中配置以下PostgreSQL参数xray_config.yml提高系统性能的文件。
maxOpenConnServer: 30
maxIdleConnServer: 15
maxOpenConnPersist: 30
maxIdleConnPersist: 15
maxOpenConnAnalysis: 30
maxIdleConnAnalysis: 15
maxOpenConnIndexer: 30
maxIdleConnIndexer: 15