Ansible Role: Flyway Command-line Tool (lrk.flyway)

This Ansible role installs the Flyway Command-line Tool.

Supported Operating Systems

This role has been tested on these operating systems:

• EL - 7
• Ubuntu - Bionic / Xenial
• Debian - Buster / Stretch / Jessie

Requirements

No special requirements for this role, but Flyway needs JAVA to run.

Role Variables

Here are the available variables with their default values (check defaults/main.yml):

---

  # Flyway version
  flyway_version: 6.0.1

  # Flyway Edition
  # Ignored if the version is before 5.2.0
  flyway_edition: community

  # Installation path for Flyway
  flyway_install_root: /opt/flyway

  # Optional repository URL for downloading Flyway
  flyway_repo_url: None

  # Repository username (if needed)
  flyway_repo_username: None

  # Repository password (if needed)
  flyway_repo_password: None

  # Should default drivers be deleted?
  flyway_remove_default_drivers: false

  # Additional Maven drivers to download (optional)
  flyway_additional_mvn_drivers: []

  # Database connection settings
  flyway_url: null
  flyway_driver: null
  flyway_user: null
  flyway_password: null
  flyway_connect_retries: 0
  flyway_init_sql: null
  flyway_schemas: []
  flyway_table: 'flyway_schema_history'
  flyway_tablespace: null
  flyway_locations: []
  flyway_resolvers: []
  flyway_skip_default_resolvers: false

  # SQL migration settings
  flyway_sql_migration_prefix: "V"
  flyway_undo_sql_migration_prefix: "U"
  flyway_repeatable_sql_migration_prefix: "R"
  flyway_sql_migration_separator: "__"
  flyway_sql_migration_suffixes: []

  # Other migration options
  flyway_stream: false
  flyway_batch: false
  flyway_encoding: "UTF-8"
  flyway_placeholder_replacement: true
  flyway_placeholder_prefix: "${"
  flyway_placeholder_suffix: "}"

  # Migration management options
  flyway_target: null
  flyway_validate_on_migrate: true
  flyway_clean_on_validation_error: false
  flyway_clean_disabled: false
  flyway_baseline_version: 1
  flyway_baseline_description: "Flyway Baseline"
  flyway_baseline_on_migrate: false
  flyway_out_of_order: false
  flyway_output_query_results: true

  # Custom callback options
  flyway_callbacks: []
  flyway_skip_default_callbacks: false

  # Migration ignoring options
  flyway_ignore_missing_migrations: false
  flyway_ignore_ignored_migrations: false
  flyway_ignore_pending_migrations: false
  flyway_ignore_future_migrations: true

  # Database user recording options
  flyway_installed_by: null

Dependencies

None

Example Playbook

    - hosts: servers
      roles:
         - lrk.flyway

License

Apache License Version 2.0

References

• Flyway

Author Information

This role was created by Lrk.