JFrog-Cloud-Installers/Ansible/ansible_collections/jfrog/installers/roles/xray/README.md

xray

The xray role will install Xray software onto the host. An Artifactory server and Postgress database is required.

Role Variables

• xray_version: The version of Artifactory to install. eg. "3.3.0"
• jfrog_url: This is the URL to the Artifactory base URL. eg. "http://ec2-54-237-207-135.compute-1.amazonaws.com"
• master_key: This is the Artifactory Master Key. See below to autogenerate this key.
• join_key: This is the Artifactory Join Key. See below to autogenerate this key.
• db_type: This is the database type. eg. "postgresql"
• db_driver: This is the JDBC driver class. eg. "org.postgresql.Driver"
• db_url: This is the database url. eg. "postgres://10.0.0.59:5432/xraydb?sslmode=disable"
• db_user: The database user to configure. eg. "xray"
• db_password: The database password to configure. "xray"
• xray_system_yaml: Your own system YAML file can be specified and used. If specified, this file will be used rather than constructing a file from the parameters above.
• xray_upgrade_only: Perform an software upgrade only. Default is false.

Additional variables can be found in defaults/main.yml.

Example Playbook

---
- hosts: xray
  roles:
    - xray

Upgrades

The Xray role supports software upgrades. To use a role to perform a software upgrade only, use the xray_upgrade_only variables and specify the version. See the following example.

- hosts: xray
  vars:
    xray_version: "{{ lookup('env', 'xray_version_upgrade') }}"
    xray_upgrade_only: true
  roles:
    - xray