nuxeoapbcatalog/nuxeo-arender-rendition-apb

Nuxeo ARender Rendition APB

镜像概述和主要用途

Nuxeo ARender Rendition APB是一个Ansible剧本包（Ansible Playbook Bundle），旨在简化ARender基础设施在OpenShift环境中的部署流程。通过Ansible playbook自动化管理部署、配置和撤销操作，帮助用户快速搭建ARender服务环境。

核心功能和特性

• 自动化部署：通过Ansible playbook实现ARender基础设施在OpenShift中的自动化部署
• 配置自定义：支持通过config.json、apb.yaml和defaults/main.yml文件自定义部署参数
• 完整生命周期管理：提供部署（provision）和撤销（deprovision）两种核心操作
• 资源灵活管理：使用模板文件和变量定义资源名称，避免硬编码，便于维护和扩展
• 监控集成：支持配置监控栈和Datadog代理配置

使用场景和适用范围

适用于需要在OpenShift集群中部署ARender文档渲染服务的场景，特别适合企业级文档处理平台搭建，支持文档转换、渲染、文本处理等功能的基础设施部署。

使用方法和配置说明

前提条件

部署前需安装https://github.com/ansibleplaybookbundle/ansible-playbook-bundle/blob/master/docs/apb_cli.md#installing-the-apb-tool%E3%80%82

构建Docker镜像

使用以下命令构建镜像：

console
# make build
apb prepare
Running APB image: docker.io/ansibleplaybookbundle/apb-tools:canary
Finished writing dockerfile.
docker build -t docker.io/nuxeo-arender-rendition-apb/nuxeo-arender-rendition:latest .
Sending build context to Docker daemon   89.6kB
Step 1/7 : FROM ansibleplaybookbundle/apb-base
 ---> 1f7ea01fe3a0
Step 2/7 : LABEL "com.redhat.apb.spec"="LS0tCnZlcnNpb246IDEuMApuYW1lOiBudXhlby1hcmVuZGVyLXJlbmRpdGlvbi1hcGIKZGVzY3JpcHRpb246IEFSZW5kZXIgUmVuZGl0aW9uIGRlcGxveW1lbnQgaW4gT3BlbnNoaWZ0IGZvciBOdXhlbwpiaW5kYWJsZTogVHJ1ZQphc3luYzogb3B0aW9uYWwKdGFnczoKICAtIG51eGVv
...
CiAgLSBudXhlby1hcmVuZGVyLXJlbmRpdGlvbgptZXRhZGF0YToKICBkaXNwbGF5TmFtZTogQVJlbmJXWCkKICAgICAgZGlzcGxheV9ncm91cDogQ29udGFpbmVyIFNwZWNzCgogICAgLSBuYW1lOiBhcmVuZGVyX2RlYnVnX3BvZAogICAgICBkZWZhdWx0OiBmYWxzZQogICAgICB0eXBlOiBib29sZWFuCiAgICAgIGRpc3BsYXlfdHlwZTogY2hlY2tib3gKICAgICAgdGl0bGU6IERlcGxveSBhIGRlYnVnIHBvZAogICAgICBkaXNwbGF5X2dyb3VwOiBPdGhlcnMKCg=="
 ---> Using cache
 ---> 8008090e4108
Step 3/7 : ADD playbooks /opt/apb/actions
 ---> Using cache
 ---> 9a56432a5881
Step 4/7 : ADD . /opt/ansible/roles/nuxeo-arender-apb/
 ---> c75b0dd320fe
Step 5/7 : ADD . /opt/ansible/roles/nuxeo-arender-rendition-apb/
 ---> eaea3b7000a4
Step 6/7 : RUN chmod -R g=u /opt/{ansible,apb}
 ---> Running in aab9559a7e51
Removing intermediate container aab9559a7e51
 ---> abc3866aa64a
Step 7/7 : USER apb
 ---> Running in a2a1f8062f40
Removing intermediate container a2a1f8062f40
 ---> ebf9108618ef
Successfully built ebf9108618ef
Successfully tagged nuxeo-arender-rendition-apb/nuxeo-arender-rendition:latest

部署ARender实例

1. 配置参数：检查并调整config.json文件中的配置参数，参数定义可参考apb.yaml或defaults/main.yml中的默认值。

2. 切换OpenShift项目：

console
# oc project int-arender-dev
Now using project "int-arender-dev" on server "https://myserver:443".

3. 执行部署：

console
# make provision
DEPRECATED: APB playbooks should be stored at /opt/apb/project
 [WARNING]: Found variable using reserved name: name


PLAY [Playbook to provision an ARender Rendition service] **********************

TASK [ansible.kubernetes-modules : Install latest openshift client] ************
skipping: [localhost]

TASK [ansibleplaybookbundle.asb-modules : debug] *******************************
skipping: [localhost]

TASK [nuxeo-arender-rendition-apb : Update last operation] *********************
skipping: [localhost]

TASK [nuxeo-arender-rendition-apb : Deploy ARender rendition pool] *************
included: /opt/ansible/roles/nuxeo-arender-rendition-apb/tasks/default.yml for localhost

...（省略部分任务输出）...

PLAY RECAP *********************************************************************
localhost                  : ok=8    changed=1    unreachable=0    failed=0

撤销ARender实例

使用以下命令撤销已部署的ARender实例：

console
make deprovision

工作原理

该APB通过在OpenShift项目上下文中执行Ansible playbook实现功能，支持provision（部署）和deprovision（撤销）两种操作。

核心执行流程：

1. 入口为tasks/main.yml文件，迭代渲染templates目录中的文件
2. 将渲染后的文件通过Kubernetes客户端应用到OpenShift集群
3. 变量默认值存储在defaults/main.yml中
4. 资源名称等可配置项定义在vars/main.yml中，便于跨资源引用，避免硬编码