Γενικές Συμβάσεις

Αυτό το μέρος του Οδηγού Βέλτιστων Πρακτικών εξηγεί τις γενικές συμβάσεις.

Ονόματα των Charts

Τα ονόματα των Charts πρέπει να είναι γραμμένα με μικρά λατινικά γράμματα και αριθμούς. Οι λέξεις μπορούν να διαχωρίζονται με παύλες (-):

Παραδείγματα:

drupal
nginx-lego
aws-cluster-autoscaler

Ούτε κεφαλαία γράμματα ούτε κάτω παύλες μπορούν να χρησιμοποιούνται στα ονόματα των charts. Οι τελείες δεν θα έπρεπε να χρησιμοποιούνται στα ονόματα των charts.

Αριθμοί Εκδόσεων

Όπου είναι δυνατό, το Helm χρησιμοποιεί το SemVer 2 για να αναπαραστήσει ττους αριθμούς των εκδόσεων ( versions ). (Σημειώστε ότι τα tags ενός Docker image δεν ακολουθούν απαραίτητα το SemVer, και ως εκ τούτου θεωρούνται μια ατυχής εξαίρεση στον κανόνα.)

Όταν οι εκδόσεις τύπου SemVer αποθηκεύονται στα labels του Kubernetes, εμείς ως σύμβαση αλλάζουμε τον χαρακτήρα + με τον χαρακτήρα _ , μιας και τα labels δεν επιτρέπουν το σήμα + ως τιμή.

Μορφοποίηση του YAML

Τα αρχεία YAML δεν θα έπρεπε να στοιχίζονται χρησιμοποιώντας δύο κενά (και ποτέ tabs).

Χρήση των λέξεων Helm και Chart

Υπάρχουν μερικές συμβάσεις για την χρήση των λέξεων Helm και helm.

  • Το Helm αναφέρεται σε ολόκληρο το εγχείρημα
  • Το helm αναφέρεται στην εντολή την οποία εκτελεί ένας χρήστης
  • Ο όρος chart δεν χρειάζεται να γραφτεί με κεφαλαίο, αφού δεν αποτελεί κανονικό όνομα
  • Παρ' ολ' αυτά, το Chart.yaml χρειάζεται να γραφτεί με κεφαλαίο γιατί τα ονόματα αρχείων κάνουν διάκριση κεφαλαίων και μικρών ( case sensitive ).

Όταν δεν είστε σίγουροι/ες, χρησιμοποιήστε το Helm (με κεφαλαίο 'H').