Diese Erste Schritte Anleitung führt Sie durch die grundlegend nötige Konfiguration des Plugins und zeigt die Einrichtung Ihres ersten Ansible Projekts in IntelliJ.

• Plugin installieren und Lizenz akzeptieren
• Einstellungen für das Erkennen von Ansible Dateien
• Einstellungen zur Nutzung von Ansible Collections
• Einstellungen für globale Navigation und ‘Neue Dateien’ Dialog

Einen allgemeinen Überblick über die IntelliJ Plattform gibt es in der Hilfe zu IntelliJ.

Zuerst müssen Sie das Plugin OrchidE installieren und die Lizenzbedingungen akzeptieren. (➞ Voraussetzungen)

Das Plugin OrchidE lässt sich wie jedes andere IntelliJ Plugin über den IntelliJ Marketplace installieren:

1. Öffnen Sie in IntelliJ die Settings und gehen Sie zu Plugins.
2. Verifizieren Sie, daß das Plugin YAML (von JetBrains) installiert und aktiviert ist.
3. Suchen Sie nach OrchidE und installieren es. Danach ist ein Neustart der IDE nötig.
   • Bei Community Editions werden Sie aufgefordert, auch das JetBrains Marketplace Plugin zu installieren. Dieses Plugin wird für alle Paid-Plugins des Marktplatzes von JetBrains benötigt.
4. Während des Neustarts können Sie einen 30 Tage Testzeitraum starten oder eine JetBrains Benutzer-Id angeben, die über eine Lizenz verfügt.
5. Nach dem Neustart öffnen Sie erneut die Settings und gehen zu dem Abschnitt Languages & Frameworks ➞ OrchidE ➞ OrchidE License. Akzeptieren Sie die Lizenzbedingungen am Ende des Lizenztextes.
6. Bestätigen Sie die Einstellung mit Apply und fahren Sie mit den weiteren Einstellungen fort.

OrchidE verfügt über verschiedene semantische Parser für Ansible Playbooks, Roles und Variablen-Dateien. OrchidE nimmt eine Zuordnung der Parser anhand der Dateipfade vor.

Überprüfen Sie, ob die Standard Patterns für die Zuordnung für Ihre Ansible-Datei Struktur passt.

Insbesondere wenn Sie Ansible Playbooks im Root-Ordner des IntelliJ Projektes ablegen, müssen Sie die Patterns anpassen. In der Regel müssen Sie nur die Playbook Patterns anpassen.

Dateipfade (vereinfacht) für die Erkennung von Ansible Dateien:

Ansible Variablen:

*/group_vars/*
*/host_vars/*
*/roles*/*/vars/*
*/roles*/*/defaults/*
*/playbooks/*/defaults/*
*/playbook/*/defaults/*
*/playbook/*/vars/*
*/playbooks/*/vars/*

Ansible Roles:

*/roles*/*/vars/*
*/roles*/*/defaults/*
*/roles*/*/tasks/*
*/roles*/*/handlers/*
*/roles*/*/meta/*

Ansible Playbooks:

*/ansible/*
*/playbook/*
*/playbooks/*

Einstellungs-Dialog:

Nehmen Sie Anpassungen wie folgt vor:

1. Öffnen Sie in IntelliJ die Settings und gehen Sie zum Abschnitt Languages & Frameworks ➞ OrchidE ➞ File Type Pattern
2. Fügen Sie neue Patterns hinzu oder ändern Sie bestehende Patterns.
   • Sind Ihre Playbooks im IntelliJ Root-Ordner, ändern Sie die Playbook Patterns indem Sie den Pfadnamen playbook/ansible entfernen.
   • Nutzen Sie Ansible Task-Dateien die Sie in Playbooks importieren (ohne Rollen), erstellen Sie ein neues Pattern vom ‘AnsibleType’ RoleTask das auf die Dateipfade Ihrer Tasks passt.

Tip: Verifizieren Sie immer ob OrchidE Ihre Dateien später richtig erkennt (nach vollständiger Konfiguration, Neustart der IDE nötig) anhand der Datei-Symbole:
Playbook Datei
Tasks Datei
Variablen Datei

OrchidE kommt in der Grundinstallation mit einer kleinen Auswahl an Ansible Galaxy Collections um Code Assistant Funktionen bereitzustellen. Um den vollen Umfang an Modulen eines Ansible Releases für Syntax Highlighting, Code Completion, Navigation, Quick Documentation und diversen Inspections zu bekommen, muss ein erweitertes Paket mit Ansible Collections und Meta-Daten installiert werden.

Eine aktuelle Sammlung der relevantesten Ansible Galaxy Collections können Sie direkt aus der IDE installieren, Pakete für bestimmte Ansible Versionen müssen manuell installiert werden.

Installation des Paketes mit aktuellen Ansible Collections

1. Öffnen Sie in IntelliJ die Settings und gehen Sie zum Abschnitt Languages & Frameworks ➞ OrchidE ➞ Extension
2. Konfigurieren Sie für den Speicherort ein leeres Verzeichnis
3. Prüfen Sie ob neue Updates vorhanden sind mit dem Link ‘Check for updates’
4. Starten Sie das Update mit ‘Update definition file’
5. Übernehmen Sie die Einstellungen mit dem ‘Apply’-Button
6. Wechseln Sie zum Abschnitt Languages & Frameworks ➞ OrchidE ➞ Collections
7. Deselektieren Sie alle Collections die Sie nicht benötigen
   

Optional - Code Completion Einstellungen

.

Stellen Sie Ihre bevorzugte Variante für Ansible Modul Namen ein (Collection auswählen ➞ Auswahlbox) die bei der Code Completion angezeigt werden soll:

• immer “full qualified collection name”
• immer nur den Modul Namen
• immer beide Varianten
• basierend auf den aufgeführten Collections in der Meta Datei (für aufgeführte Collections wird die FQCN Variante nicht angezeigt)

Übernehmen Sie die Einstellung und schließen die Settings Dialog mit dem ‘Ok’-Button.

Um globale IDE-Aktionen durchzuführen, benötigt OrchidE die Pfade zum Root-Ordner für Playbooks, Roles und Inventories. Damit lassen sich z.B. an jeder beliebigen (selektieren) Stelle mit der Action “New ➞ Ansible File” eine neue Rolle mit der Tasks Datei erstellen.

Öffnen Sie ein bestehendes Projekt mit Ansible Dateien oder erstellen Sie ein neues Projekt.

Für neue Projekte:

1. Erstellen Sie jeweils Ordner für Ihre Playbooks, Roles und Inventories

    <project>
    |-- inventory
    |-- playbooks
    |-- roles
   

   Anstatt playbooks können Sie auch den Root-Ordner des Projekts nehmen. In diesem Fall muss es aber ein passendes Pattern zu Erkennung von Playbooks geben.

Konfigurieren Sie die Ansible Root Ordner:

1. Öffnen Sie den Project Structure Dialog
2. Wechseln Sie in den Abschnitt Facets
3. Fügen Sie die Facet OrchidE Ansible einem Modul hinzu.
4. Fügen Sie den Abschnitten Inventories, Playbook Root Folders und Roles Root Folders jeweils Ihre Root-Ordner hinzu. Achten Sie darauf Ihre Auswahl mit Enter zu bestätigen.
5. Übernehmen Sie die Änderungen und Schließen den Dialog mit dem Ok-Button

Beenden Sie die IDE und starten neu, bevor Sie Ihre erste Ansible Dateien editieren.

1. Öffnen Sie Ihr Projekt
2. Selektieren Sie Ihr IntelliJ Module im Projekt Tab (Projekt Baum) und erzeugen ein neues Ansible File (Kontextmenü: New ➞ Ansible File) (Die genutzte Datei-Erweiterung können Sie unter Settings ➞ Editor ➞ OrchidE einstellen.)
3. Erstellen Sie ein Playbook
4. Schreiben Sie erstes Playbook mit OrchidE und lernen Sie weitere Features
   • Code Completion von Ansible Keywords und Tasks
   • Navigation zwischen Ansible Dateien
   • SearchEverywhere von Rollen, Playbooks, Inventory Variablen
   • Navigation zu referenzieren Rollen, deklarierten Variablen und inkludierten Dateien