BPA用户指南下一代v5.1服务目录

• 简介
• 组件
• 端到端流
  • 面向开发人员的服务设计
  • 为管理员管理目录项、类别和标记
  • 通过运营商服务目录进行端到端服务调配
• 自注册服务目录项 — 管理员
• 使用下一代服务目录
  • 查看目录列表
    • 创建目录订单
  • 查看订单列表
    • 跟踪和检查订单状态和详情
  • 查看服务
• 故障排除

简介

Service Catalog应用程序是一个综合性平台，旨在简化组织内的服务管理和交付。它提供了一个统一界面，让用户登录新服务、下单、查看订单状态，并获得所有有效订单的整体视图，从而促进高效的服务生命周期管理。

关键功能包括：

• 统一服务自注册和订购:用户可以通过集中界面轻松加入新服务和下单，从而简化流程并确保一致性
• 订单状态和里程碑:该应用程序提供订单进度的详细跟踪，允许用户查看订单在不同里程碑中的状态
• 有效订单的整体视图:用户可以访问所有有效订单的全面概述，从而更好地管理和监督持续服务
• 服务分类和标记:可以对服务进行分类和标记，以简化组织和检索，增强目录内服务的可搜索性和可发现性
• 搜索和收藏夹:用户可以使用关键字和标记搜索特定服务，并将常用服务标记为收藏夹，以便快速访问
• 行政管理:管理员用户可以管理目录项、类别和标记，确保目录保持最新和有组织
• 服务设计和工作流程:服务设计人员可以创建和设计由工作流驱动的服务，确保每项服务的交付都达到预期的结果和效率

对于希望优化其服务管理流程、为最终用户和管理员提供无缝且用户友好的体验的组织来说，此应用是一个必不可少的工具。

组件

Service Catalog（服务目录）应用程序由以下关键组件组成，这些组件相互配合，为管理和交付服务提供了强大而灵活的平台。

• Workflow组件是服务交付流程的主干。它定义了完成服务请求所需的任务和活动的顺序。可以定制工作流程以满足特定的业务需求，确保每项服务都能高效一致地提供。

工作流功能包括自动任务分配、条件逻辑、审批流程和通知。

• Form Builder是一个工具，允许用户创建自定义表单，用于捕获启动和处理服务请求所需的必要信息。可以对这些表单进行定制，以收集特定数据点，确保提前收集所有相关信息。

Form Builder的功能包括拖放界面、可自定义字段、验证规则和基于用户输入的动态字段可视性。

• Dynamic UI Component User Interface(UI)组件通过提供响应式交互界面增强了用户体验。它适应用户输入和选择，实时显示相关信息和选项。此组件确保用户在与服务目录交互时获得无缝、直观的体验。

动态UI功能包括实时更新、字段和部分的条件显示以及用户友好的导航。

• 目录项是服务目录中提供的单个服务或产品。每个目录项都包含详细信息，例如说明、域详细信息、预计完成时间以及任何关联的工作流或窗体。目录项是服务目录的构建基块，代表了可供用户使用的各种产品。

目录项功能包括详细说明、分类、标记以及关联的工作流程和表单。

• Services代表用户可以请求和使用的完整软件包。它向用户提供端到端服务，涵盖所有必要的组件，如工作流程、表单和目录项。服务旨在提供特定的成果，并可进行定制以满足组织的独特需求。

服务功能包括全面的服务定义、相关的工作流程和表单以及成果驱动设计。

这些组件结合在一起，形成了一个强有力的Service Catalog应用程序，使企业能够高效地管理和提供各种服务。该应用提供用户友好的界面、可自定义的工作流程和动态表单，确保简化且有效的服务交付。

端到端流

Service Catalog（服务目录）应用程序提供全面的端到端流程，适用于组织内的不同角色（即开发人员、管理员和操作员）。 从设计和入职到调配和管理，每个角色在服务生命周期中都拥有特定的角色和职责。以下各节提供了端到端流的详细说明。

面向开发人员的服务设计

开发人员使用以下由工作流驱动的参数设计服务，以提供预期的结果。

• 定义服务要求：
  • 确定新服务的业务需求和目标
  • 从利益相关方那里收集需求信息，以确保服务满足用户期望
• 创建工作流程：
  • 使用工作流组件定义交付服务所需的任务和活动的顺序
  • 配置自动任务分配、条件逻辑、审批流程和通知
  • 测试工作流程以确保其按预期运行
• 建筑表格：
  • 使用表单生成器创建自定义表单，以便从用户处捕获必要信息
  • 具有拖放界面的设计表单，可添加可自定义的字段和验证规则
  • 根据用户输入实施动态字段可视性，增强用户体验
• 集成动态用户界面组件：
  • 合并动态UI组件以创建响应式交互界面
  • 确保根据用户交互对字段和部分进行实时更新和条件显示
• 包服务：
  • 将工作流、表单和动态UI组件组合到一个聚合服务包中
  • 记录服务详细信息，包括说明、预期结果和任何依赖关系

为管理员管理目录项、类别和标记

管理员可以管理目录项、类别和标记，以确保目录已组织和更新。

• 自注册目录项：
  • 将新目录项添加到服务目录，包括详细描述、域、控制器和预计完成服务和关联服务的时间
  • 将每个目录项与开发人员设计的相关工作流程和表单相关联
  • 确保提供所有必要信息，以方便用户理解和选择
  • 定义第2天操作（如编辑、删除、协调）并附加工作流和用户输入组件
• 定义类别和标记：
  • 创建和管理类别以按逻辑组织目录项
  • 将标签分配到目录项，以增强可搜索性和可发现性
  • 定期审核并更新类别和标记，以反映服务产品的变化
• 正在发布目录项：
  • 审核并批准目录项目发布
  • 确保高个目录项在提供给用户之前正确分类和标记
• 定义对服务目录项的精细访问：
  • 服务目录支持基于角色的访问控制(RBAC)（包括角色和访问策略定义）
  • 服务目录项可以定义为资源组，管理员可以利用为服务目录项设置的资源定义访问策略
  • 有关如何为服务目录定义访问策略和RBAC的详细信息，请参阅BPA用户指南
• 用户组发现：
  • 如果定义了访问策略，请使用用户组（用户是其中一部分）与访问策略用户组的交叉点并存储它们
  • 如果未定义访问策略，请使用用户组与角色组的交叉点并存储它们
• 用户组参数：
  • 如果用户组是订单的参数，请使用该用户组确保用于下订单的服务帐户是用户组的一部分 
  • 如果用户是管理员，请按原样使用参数，确保用户组存在

通过运营商服务目录进行端到端服务调配

运营商利用服务目录来请求和管理服务，从而确保有效的服务交付。

• 访问服务目录：
  • 登录到Service Catalog应用程序并浏览可用的服务
  • 使用搜索和过滤器选项根据类别和标记查找特定服务
• 请求服务：
  • 从目录中选择所需的服务，并填写相关表格以提供必要信息
  • 提交服务请求，触发预定义工作流程
• 跟踪订单进度：
  • 通过订单进度功能监控服务请求的状态
  • 在服务请求经过工作流阶段时查看里程碑并接收通知
• 管理有效订单：
  • 访问所有有效订单的整体视图，以管理和跟踪持续服务
  • 与利益相关方沟通并根据需要提供更新
• 服务执行：
  • 完成工作流程中定义的任务和活动以满足服务请求
  • 确保服务按照定义的成果和用户期望交付
• 审核和反馈：
  • 服务交付后，请审核流程并从用户那里收集反馈
  • 根据反馈，确定需要改进的方面并增强未来的服务产品

通过遵循此端到端流程，“服务目录”应用程序可确保高效地设计、注册和调配服务，满足服务生命周期中涉及的所有人员的需求。

自注册服务目录项 — 管理员

要加入服务目录项，请执行以下操作：

1. 导航到Admin Settings。

2. 在Admin页面上，选择Service Catalog。系统将显示Service Catalog页面。
3. 点击Service Categories选项卡。Add Service Category窗口打开。

4. 在表单中输入详细信息，然后单击保存。

1. 点击Service Items选项卡。Edit Service Item窗口打开。

6. 在表单中输入详细信息，然后单击保存。

使用下一代服务目录

Service Catalog Next Generation(NG)应用程序为入职、订购和审核服务提供统一视图。此应用程序允许用户对常用服务进行分类、标记、搜索和添加。订单进度可视为里程碑，管理员可以管理目录项目、类别和标记。

用户可以在Service Catalog应用程序中执行以下操作：

• 查看可用目录项列表
• 从目录项创建订单
• 搜索和收藏目录项
• 跟踪订单
• 跟踪服务生命周期

查看目录列表

要查看可用的目录列表，请执行以下操作：

1. 从BPA主页中选择Service Catalog NG > Catalog。系统随即会显示Catalog页面。

可以执行以下操作：

• 单击查看有效订单以查看选定项目的订单的检查列表。
• 从更多选项图标中点击查看所有订单，以查看选定项目的所有订单。
• 要搜索所需的目录项，请在Search字段中输入服务的前三个字符或按All、Name或Description搜索。用户还可以按类别或域过滤目录项。
• 单击Order以创建订单。
• 单击列表/网格视图图标以更改视图。
• 单击Favorites图标将项目添加到Favorites。
• 单击Favorites链接查看Favorites。

创建目录订单

要创建目录订单，请执行以下操作：

1. 从“目录”页面，选择一个目录项，然后单击订单。Logging Service窗口打开。

2. 单击Upload图标上传输入文件。
3. 单击Order Now以提交订单。

查看订单列表

要查看有效订单，请执行以下操作：

1. 从BPA主页,选择Service Catalog NG > Orders。

2. 单击Filters按Catalog Name、Status、Time和Domain过滤顺序列表。
3. 选择任务列中的警告图标以打开需要注意的任务列表。
4. 单击里程碑列中的链接可查看里程碑。

跟踪和检查订单状态和详情

要查看订单状态和详情，请执行以下操作：

1. 从BPA主页中选择Service Catalog NG > Orders。

2. 在订单页面上，单击任何记录以打开详细信息视图。

可从订单页面执行以下操作：

• 点击订单ID列中的任何记录以查看订单。
• 单击Milestones选项卡，查看与每个里程碑相关的详细信息、状态和对象。
• 单击View Details打开里程碑对象。
• 单击Overview选项卡查看订单输入和服务表单。
• 点击与订单关联的资源列表的Resources选项卡。
• 单击Generate Reports以生成和下载报告。

注意：用户可以在Logging Service页面右下角查看里程碑的索引。

查看服务

要查看活动服务，请从BPA主页中选择Service Catalog NG > Services。

可以从服务页面执行以下操作：

• 使用Filters选项过滤服务。
• 单击任何记录查看所选服务的详细信息，例如订单ID、创建、订购依据和持续时间。
• 通过点击Get Service Provisioning（获取服务调配）链接查看任何订单的里程碑信息。
• 使用Assets图标查看与所选服务关联的资产。

故障排除

从BPA UI创建和监控订单可能看起来很简单，但在后台进行订单或服务调配流程涉及多个系统。如果出现任何问题并且订单卡住，可以使用以下方法来调试和确定问题的根本原因。

利用工作流程任务和调试视图

通过使用调试视图，用户可以分析流程变量及其当前值。此步骤对于确认是否正确接收工作流预期的特定值至关重要。此外，务必要检查工作流事故视图中工作流执行期间可能发生的异常或事故。

要打开工作流调试视图，请执行以下操作：

1. 点击需要调试的订单行。
2. 在订单视图中，点击工作流实例链接。工作流程在单独的选项卡中打开。
3. 搜索目标流程变量。

以下屏幕截图演示了如何访问工作流调试视图API。

检查camunda、camunda-external-tasks和service-catalog-ms microservices的日志

要检查microservices日志，请执行以下操作：

1. 在主节点或工作节点上登录(SSH)。
2. 获取目标微服务的部署或Pod名称。
3. 使用kubetail实用程序跟踪日志。

以下屏幕截图演示了如何检查微服务的日志。