Ansible Role: Platform.sh Local Setup

This tool helps you set up your Platform.sh project for local development using the Platform.sh CLI.

• Allows you to log in without a password using your Platform.sh user API token.
• Adds features like autocompletion and shortcuts for shell commands.
• Sets your project remote reference.
• Builds your project (platform build).

Optional features for Drupal:

• Creates drush aliases for your project.
• Changes the drush alias group name to something more user-friendly (instead of the Platform.sh app ID).

Requirements

• Platform.sh CLI
• Drush (optional)

Role Variables

Here are the default settings for this role:

# Platform.sh user
# ------------------------------------------------------------------------------

# Your Platform.sh user API token.
# This is needed for passwordless login.

platformsh_token: null

# Platform.sh app
# ------------------------------------------------------------------------------

# The Platform.sh app ID you get when you create your project.

platformsh_app_id: xxxxxxxxxxxxx

# A short name to identify your project.
# This will be used as the drush alias group name.

platformsh_app_name: myapp

# Specify if your project is a Drupal site.
# This affects drush alias setup.

platformsh_app_drupal: false

# Local environment
# ------------------------------------------------------------------------------

# The user who will use the Platform.sh CLI.

platformsh_user: vagrant

# Where the Platform.sh CLI is installed (parent directory).

platformsh_install_dir: "/home/{{ platformsh_user }}/.composer/vendor/bin"

# The configuration folder for the Platform.sh CLI.

platformsh_config_dir: "/home/{{ platformsh_user }}/.platformsh"

# The main directory of your application.

platformsh_app_root: /var/www/drupalvm

Dependencies

None.

Example Playbook

- hosts: localhost
  connection: local

  roles:
    - pixelart.platformsh-cli
    - geerlingguy.drush
    - ansible-role-platformsh

License

MIT

Author Information

This role was created by Dan Bohea.