nuxeoapbcatalog/nuxeo-arender-previewer-apb

Nuxeo ARender Previewer APB

镜像概述和主要用途

该Ansible Playbook Bundle (APB) 用于在OpenShift环境中部署ARender基础设施，专注于预览器组件的自动化部署与管理，简化ARender服务在OpenShift平台上的搭建流程。

核心功能和特性

• 自动化部署：通过Ansible playbook实现ARender预览器在OpenShift中的一键部署
• 配置灵活：支持通过配置文件自定义部署参数，默认值可在指定配置文件中查看和调整
• 资源管理：采用变量定义资源名称，避免硬编码，便于跨资源引用和维护
• 生命周期管理：提供部署（provision）和取消部署（deprovision）完整操作支持

使用场景和适用范围

适用于需要在OpenShift集群中部署ARender预览器服务的场景，特别适合企业级文档预览解决方案的搭建，可集成到文档管理系统、内容协作平台等需要文档预览功能的应用中。

前提条件

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

构建Docker镜像

执行以下命令构建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-previewer-apb/nuxeo-arender-previewer: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-previewer-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-previewer-apb/nuxeo-arender-previewer: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 Previewer service] **********************
   
   
   ...
   
   
   
   PLAY RECAP *********************************************************************
   localhost                  : ok=6    changed=5    unreachable=0    failed=0
   

取消部署ARender实例

执行以下命令取消部署ARender实例：

console
make deprovision

工作原理

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

执行入口为tasks/main.yml文件，该文件迭代处理templates目录中的模板文件，并将其传递给Kubernetes客户端。

变量默认值存储在defaults/main.yml中，资源名称通过vars/main.yml定义为变量，避免硬编码，便于跨资源引用。