Tastatur Shortcuts

Tastatur Kürzel

OrchidE ergänzt die Tastenkürzel der IntelliJ Plattform im Kontext von Ansible Dateien, um die Bearbeitung und Navigation eines Ansible Projektes effizienter zu machen.

Alle Tastenkombination sind weiterhin konfigurierbar, und neue Aktionen von OrchidE können eigene Tastenkürzel zugewiesen werden.

In der folgenden Tabelle sind alle Abkürzungen aufgeführt, die von OrchidE mit genutzt werden oder bereitgestellt werden:

Action Tastenkürzel Im Menü Beschreibung

Go to Declaration

  • IntelliJ Name:
  • Declaration or Usages
  • Windows / Linux:
    CtrlB
  •  
  • macOS:
    ⌘CmdB
  • Navigate ➞ Declaration or Usages
  • Editor Kontext Menü ➞ Go To ➞ Declaration or Usages

Navigiert zur ursprünglichen Definition des Wertes. Unterstützt werden

  • Jinja Variablen,
  • Verweise zu Rollen, Import- und Include-Dateien, Src-Dateien von Templates, Host/Gruppenname in Playbooks

Go to Playbook or Role

  • IntelliJ Name:
  • Go to Class
  • Windows / Linux:
    CtrlN
  •  
  • macOS:
    ⌘CmdO
  • Navigate ➞ Class
  • Editor Kontext Menü ➞ Go To ➞ Class

Suche nach einem Playbook- oder Rollen Name und öffne die Datei (bei Rollen wird tasks/main geöffnet)

Go to related Ansible File

  • IntelliJ Name:
  • Go to Related Symbol
  • Windows / Linux:
    CtrlAltHome
  •  
  • macOS:
    Ctrl⌘CmdUp
  • Navigate ➞ Related Symbol
  • Editor Kontext Menü ➞ Go To ➞ Related Symbol

Navigiert für den aktuellen Editor zu einer verknüpften Datei im Sinne von Ansible.

OrchidE zeigt alle Dateien an die mit dem aktuellen Editor über Ansible Konstrukte (z.B. roles, hosts, …) verknüpft sind und erlaubt das direkte Navigieren.

Für Rollen:

  • es werden alle Dateien der Rolle angezeigt
  • es werden alle Playbooks angezeigt welche die Rolle referenzieren
  • es werden alle Inventories (via Playbooks) angezeigt
  • es werden alle Gruppen/Host Variablen Dateien (via Inventories) angezeigt

Für Playbooks:

  • es werden referenzierten Rollen angezeigt
  • es werden alle Inventories angezeigt
  • es werden alle Gruppen/Host Variablen (via Inventories) angezeigt

Für Inventories:

  • es werden alle Gruppen/Host Variablen (via Inventories) angezeigt
  • es werden alle Playbooks angezeigt

Für Inventory Gruppen/Hosts Variablen:

  • es werden alle Inventories angezeigt
  • es werden alle Playbooks (die in hosts: das Inventory referenzieren) angezeigt
  • es werden alle Rollen (der Playbooks) angezeigt

Wichtig:

  • Für eine vollständige Funktion wird ein Inventory benötigt.
  • Der Cursor darf auf keiner Referenz stehen (z.B. Jinja Variable, Import-Datei)
  • In Inventories muss der Cursor auf einer Gruppe oder einem Host sein

Go to Inventory Variable

  • IntelliJ Name:
  • Search Everywhere (Tab: Inventory)
  • Windows / Linux:
    CtrlShiftO + I
  •  
  • macOS:
    ⌘CmdShiftO + I

Via Search Everywhere: Shift + Shift

  • Navigate ➞ Inventory
  • Navigate ➞ Search Everywhere (-> Inventory)

Suche nach einer Inventory Gruppe oder einem Host und öffnen der zugehörigen Variablen Datei.

Move Ansible Task Statement Up / Down

  • IntelliJ Name:
  • Move Statement Up / Down
  • Windows / Linux:
    CtrlShift + oder
  •  
  • macOS:
    Shift⌘Cmd + oder
  • Code ➞ Move Statement Down/Up

Verschiebt einen Ansible Task Block vor den vorherigen Task oder nach dem nachfolgenden Task.

Show Jinja Variable Definition

  • IntelliJ Name:
  • Quick Definition
  • Windows / Linux:
    CtrlShiftI
  •  
  • macOS:
    ⌥OptSpace
  • View ➞ Quick Definition

Zeigt für eine Jinja Variable die Definition/die Werte in einem Popup an.

Quick Ansible Documentation

  • IntelliJ Name:
  • Quick Documentation
  • Windows / Linux:
    CtrlQ
  •  
  • macOS:
    F1
  • View ➞ Quick Documentation

OrchidE zeigt die Ansible Dokumentation für das Code-Element unter dem Cursor an. (für Module und Keywords)

Für Variablen in Inventories wird die Dokumentation aus der Rolle (argument_spec) angezeigt, sofern die Variablen annotiert wurden.

Alternativ zum Tastaturkürzel, wird die Dokumentation auch angezeigt, wenn der Mauszeiger über Code-Elemente bewegt wird.

Ansible File

  • Windows / Linux:
    • via CtrlAltIns im Projektbaum und Editor
    • via AltIns im Projektbaum
  •  
  • macOS:
    • via Ctrl⌥OptN im Projektbaum und Editor
    • ⌘CmdN im Projektbaum
  • File ➞ New ➞ Ansible File
  • Project Tree Menu ➞ New ➞ Ansible File

Die Action ermöglicht es, aus einem beliebigen Kontext heraus, ein Ansible Element (Rolle, Playbook, …) zu erzeugen. Mit der Action können einfach schnell Dateien für Ansible Rollen, Playbooks oder Inventory Variablen angelegt werden.

Die Datei wird dabei ungeachtet der aktuellen Auswahl im Projektbaum an der konfigurierten Stelle (OrchidE’s Ansible Folder Mapping) im Verzeichnisbaum erstellt.

Bei Rollen können tasks/main.y(a)ml und meta/main.y(a)ml, bei Playbooks direkt die Datei oder ein Ordner mit main.y(a)ml erstellt werden.

Bei Inventory Variablen wird ein Ordner unterhalb group_vars/host_vars und mit dem konfigurierten Dateinamen erstellt.

Encrypt Ansible Vault

Editor Kontext Menü ➞ OrchidE ➞ Encrypt Ansible Vault

Erstellt aus einer Ansible Variablen-Datei ein Ansible Vault, optional mit Vault Id.

Die Datei kann später mit der Decrypt Action geöffnet und verändert werden.

Decrypt Ansible Vault

Editor Kontext Menü ➞ OrchidE ➞ Decrypt Ansible Vault

Öffnet (entschlüsselt) eine Ansible Vault Datei so das die Datei editieren werden kann.

Ist ein Ansible Vault im Editor entschlüsselt, kann OrchidE die Keys für Code Completion verwenden.

Die Datei wird nur im Hauptspeicher entschlüsselt, zu keiner Zeit werden die entschlüsselten Daten in einer Datei gespeichert.

Beim Speichern des Textes im Editor wird der Inhalt verschlüsselt in der Ansible Vault Datei gespeichert. Das funktioniert mit manuellem Speichern und dem Auto-Speichern von IntelliJ.

Change Vault Password

Editor Kontext Menü ➞ OrchidE ➞ Change Vault Password

Ändert das Passwort für eine Ansible Vault Datei.

Das Ändern kann mit ent- und verschlüsselten Ansible Vault Dateien erfolgen.

Set Vault Id

Editor Kontext Menü ➞ OrchidE ➞ Set Vault Id

Ändert die Vault Id für eine Ansible Vault Datei.

Make Vault Writeable

Editor Kontext Menü ➞ OrchidE ➞ Make Vault Writeable

OrchidE öffnet Ansible Vault Dateien, für die kein Passwort gespeichert wurde, im Read-only Modus. Um trotzdem die Raw-Daten eines Ansible Vaults zu verändern, kann hiermit der Editor in Read-Write Modus gesetzt werden.

Ein falsches Editieren für zu einem zerstörten Ansible Vault.

Encrypt Value

Editor Kontext Menü ➞ OrchidE ➞ Encrypt Value

Verschlüsselt einen einzelnen Variablenwert in einer Ansible Datei.

Details zu encrypting individual variables findet sich in der Ansible Dokumentation.

Decrypt Value

Editor Kontext Menü ➞ OrchidE ➞ Decrypt Value

Entschlüsselt einen einzelnen Variablenwert in einer Ansible Datei.