Role to download, install and configure the IntelliJ IDEA IDE https://www.jetbrains.com/idea.
While this role can install IntelliJ plugins, if you want to conditionally install particular plugins take a look at our companion role: gantsign.intellij-plugins.
-
Ansible Core >= 2.16
-
Linux Distribution
-
Debian Family
-
Ubuntu
- Jammy (22.04)
- Noble (24.04)
-
-
RedHat Family
-
Rocky Linux
- 9
-
-
Note: other versions are likely to work but have not been tested.
-
-
Java JDK
- You need to install the JDK src as well as the JDK.
- When using Java > 9 you also need to install the jmods.
e.g. the following is required if using OpenJDK 17 with Rocky Linux:
- name: Install OpenJDK 17 become: true yum: name: - java-17-openjdk-devel - java-17-openjdk-jmods - java-17-openjdk-src state: present
-
Apache Maven
The following variables will change the behavior of this role (default values are shown below):
# IntelliJ IDEA version number
intellij_version: '2024.3'
# Mirror where to dowload IntelliJ IDEA redistributable package from
# Using HTTP because of https://github.com/ansible/ansible/issues/11579
intellij_mirror: 'http://download.jetbrains.com/idea'
# Edition to install (community or ultimate)
intellij_edition: community
# Base installation directory for any IntelliJ IDEA distribution
intellij_install_dir: /opt/idea/idea-{{ intellij_edition }}-{{ intellij_version }}
# Owner of the installation files
intellij_install_user: root
# Location of the default Apache Maven installation for IntelliJ IDEA projects
# Defaults to value of ansible_local.maven.general.home (see gantsign.maven role)
intellij_default_maven_home: '{{ ((((ansible_local | default(dict())).maven | default(dict())).general | default(dict())).home | default(None)) }}'
# URL for IntelliJ IDEA plugin manager web service
intellij_plugin_manager_url: 'https://plugins.jetbrains.com/pluginManager/'
# List of users to configure IntelliJ IDEA for
users: []
# Directory to store files downloaded for IntelliJ IDEA installation
intellij_download_dir: "{{ x_ansible_download_dir | default(ansible_facts.env.HOME + '/.ansible/tmp/downloads') }}"
# Timeout for IntelliJ IDEA download response in seconds
intellij_idea_download_timeout_seconds: 600Users are configured as follows:
users:
- username: # Unix user name
intellij_group: # Unix group for the user's files/directories (optional - defaults to username)
intellij_jdks:
- name: # The name use want to use for this JDK
home: # The path to the JDK home.
# The name of the JDK you want to be the default for new projects.
# Required if you specify `intellij_jdks`.
# Must match the name given to one of the `intellij_jdks`.
intellij_default_jdk:
intellij_disabled_plugins: # see ~/.config/JetBrains/*Idea*/disabled_plugins.txt
- # Plugin ID
intellij_codestyles:
# List of codestyles (each XML location may be specified by URL or filesystem path)
- name: # Name (must match the value in the XML file /code_scheme/@name)
url: # URL to download the codestyles XML from
- name: # Name (must match the value in the XML file /code_scheme/@name)
src: # path to the codestyles XML file (may be absolute or relative, relative paths are evaluated the same way as the Ansible copy module)
remote_src: # yes/no, wether to copy from the remote filesystem (default no)
intellij_default_codestyle: # Name (must match the value in the XML file /code_scheme/@name)
intellij_inspection_profiles:
# List of inspection profiles (each XML location may be specified by URL or filesystem path)
- name: # Name (must match the value in the XML file /profile/option[@name='myName']/@value)
url: # URL to download the inspection profile XML from
- name: # Name (must match the value in the XML file /profile/option[@name='myName']/@value)
src: # path to the inspection profile XML file (may be absolute or relative, relative paths are evaluated the same way as the Ansible copy module)
remote_src: # yes/no, wether to copy from the remote filesystem (default no)
intellij_default_inspection_profile: # Name (must match the value in the XML file /profile/option[@name='myName']/@value)
intellij_plugins:
- # Plugin ID of plugin to install
# Ultimate Edition only: location of the IntelliJ license key on the Ansible master.
# Your license key can be found at ~/.config/JetBrains/*Idea*/idea.key
intellij_license_key_path: # e.g. '/vagrant/idea.key'Warning: the feature for installing additional plugins relies on internal IntelliJ IDEA APIs and should be considered experimental at this time.
The following versions of IntelliJ IDEA are supported without any additional configuration (for other versions follow the Advanced Configuration instructions):
2024.32024.2.42024.2.32024.2.22024.2.12024.22024.1.42024.1.32024.1.22024.1.12024.12023.3.62023.3.52023.3.42023.3.32023.3.22023.3.12023.32023.2.52023.2.42023.2.32023.2.22023.2.12023.22023.1.52023.1.42023.1.32023.1.22023.1.12023.12022.3.32022.3.22022.3.12022.32022.2.42022.2.32022.2.22022.2.12022.22022.1.42022.1.32022.1.22022.1.12022.12021.3.32021.3.22021.3.12021.32021.2.32021.2.22021.2.12021.22021.1.32021.1.22021.1.12021.12020.3.32020.3.22020.3.12020.32020.2.42020.2.32020.2.22020.2.12020.22020.1.22020.1.12020.12019.3.42019.3.32019.3.22019.3.12019.32019.2.42019.2.32019.2.22019.2.12019.22019.1.32019.1.22019.1.12019.12018.3.62018.3.52018.3.42018.3.32018.3.22018.3.12018.32018.2.52018.2.42018.2.32018.2.22018.2.12018.22018.1.62018.1.52018.1.42018.1.32018.1.22018.1.12018.12017.3.52017.3.42017.3.32017.3.22017.3.12017.32017.2.62017.2.52017.2.42017.2.32017.2.22017.2.12017.22017.1.52017.1.42017.1.32017.1.22017.1.12017.12016.3.52016.3.42016.3.32016.3.22016.3.12016.32016.2.52016.2.42016.2.32016.2.22016.2.12016.22016.1.32016.1.1
The following role variable is dependent on the IntelliJ IDEA version; to use a IntelliJ IDEA version not pre-configured by this role you must configure the variable below:
# SHA256 sum for the redistributable package
# i.e. ideaIC-{{ intellij_version }}.tar.gz for the Community Edition
# or ideaIU-{{ intellij_version }}.tar.gz for the Ultimate Edition
intellij_redis_sha256sum: d1cd3f9fd650c00ba85181da6d66b4b80b8e48ce5f4f15b5f4dc67453e96a179JetBrains doesn't make the IntelliJ Plugin IDs visible on their marketplace website (https://plugins.jetbrains.com/idea). But it's relatively easy to get the ID with a little JavaScript.
-
Search JetBrains Marketplace for a plugin you want to install and navigate to it's overview page (e.g. https://plugins.jetbrains.com/plugin/12195-concise-assertj-optimizing-nitpicker-cajon-).
-
Type
javascript:into your browser address bar (don't press enter yet).Note: for security reasons you can't paste
javascript:into the address bar (the browser won't let you), you have to type it. -
Paste the following after
javascript:followed by enter/return:fetch(window.location.pathname.replace(/\/plugin\/(\d+).*/, "/api/plugins/$1")) .then((response) => response.json()) .then((data) => alert(`Plugin ID: "${data.xmlId}"`));This uses a RegEx to alter the path of the URL, and the fetch API to make a request to the JetBrains plugins REST API. It then displays an alert showing the Plugin ID (
xmlIdfrom the JSON response).
Minimal playbook:
- hosts: servers
roles:
- role: gantsign.intellijPlaybook with user specific configuration (Default JDK, Maven, disabled plugins and code style):
- hosts: servers
roles:
- role: gantsign.intellij
intellij_default_maven_home: '/opt/maven/apache-maven-3.9.4'
users:
- username: vagrant
intellij_jdks:
- name: '17'
home: '/usr/lib/jvm/java-17-openjdk-amd64'
- name: '11'
home: '/usr/lib/jvm/java-11-openjdk-amd64'
- name: '1.8'
home: '/usr/lib/jvm/java-8-openjdk-amd64'
intellij_default_jdk: '17'
intellij_disabled_plugins:
- org.jetbrains.plugins.gradle
- CVS
- com.intellij.uiDesigner
- org.jetbrains.android
- TestNG-J
- hg4idea
- Subversion
- AntSupport
- DevKit
intellij_codestyles:
- name: Example1
src: Example-style1.xml
- name: Example2
src: /example/Example-style2.xml
remote_src: true
- name: GoogleStyle
url: 'https://raw.githubusercontent.com/google/styleguide/gh-pages/intellij-java-google-style.xml'
intellij_default_codestyle: GoogleStyle
intellij_inspection_profiles:
- name: Example1
src: Example1.xml
- name: Example2
src: /example/Example2.xml
remote_src: true
- name: GantSign
url: 'https://raw.githubusercontent.com/gantsign/inspection-profile-intellij/master/GantSign.xml'
intellij_default_inspection_profile: GantSign
intellij_plugins:
- CheckStyle-IDEAThis role exports the following Ansible facts for use by other roles:
-
ansible_local.intellij.general.home- e.g.
/opt/idea/idea-community-2024.3
- e.g.
-
ansible_local.intellij.general.desktop_filename- e.g.
jetbrains-idea-ce.desktop
- e.g.
-
ansible_local.intellij.general.desktop_file- e.g.
/usr/share/applications/jetbrains-idea-ce.desktop
- e.g.
-
ansible_local.intellij.general.user_config_dir- e.g.
.config/JetBrains/IntelliJIdea2023.2
- e.g.
-
ansible_local.intellij.general.user_plugins_dir- e.g.
.local/share/JetBrains/IntelliJIdea2023.2
- e.g.
You can find more roles from GantSign on Ansible Galaxy.
This project uses the following tooling:
- Molecule for orchestrating test scenarios
- Testinfra for testing the changes on the remote
- pytest the testing framework
- Tox manages Python virtual environments for linting and testing
- pip-tools for managing dependencies
A Visual Studio Code Dev Container is provided for developing and testing this role.
MIT
John Freeman
GantSign Ltd. Company No. 06109112 (registered in England)