नामकरण परंपराएँ

नमूना संसाधन नाम

नमूना और डेमो संसाधन नामों में kebab-case में example- उपसर्ग का उपयोग किया जाता है। यह पूरे इकोसिस्टम में दस्तावेज़ीकरण, API विनिर्देश, कोड नमूनों और जनरेट किए गए कॉन्फ़िगरेशन को एकसमान बनाए रखता है।

metadata:
  name: example-http-lb
  namespace: example-namespace

किसी भी नमूना संसाधन नाम के लिए example- का उपयोग करें — न कि my-, test-, foo-, demo-, sample-, या mycompany जैसे कंपनी-समान प्लेसहोल्डर का। यह निम्नलिखित पर लागू होता है:

• उदाहरणों में संसाधन name फ़ील्ड,
• वर्कफ़्लो और पैरामीटर विनिर्देशों में example: मान,
• OpenAPI उदाहरण मान,
• नमूना Terraform (.tf) फ़ाइलें।

यह किसे कवर नहीं करता

यह परंपरा केवल नमूना संसाधन नामों पर लागू होती है। निम्नलिखित को अपरिवर्तित रहने दें:

• विशेषता और फ़ील्ड नाम (उदाहरण के लिए test_key),
• वास्तविक परीक्षण कोड और test/ डायरेक्टरी,
• पैकेज और डिपेंडेंसी नाम,
• उदाहरण डोमेन और ईमेल, जो पहले से ही परंपरा का पालन करते हैं (app.example.com, user@example.com)।

उदाहरण

इसके बजाय	इसका उपयोग करें
my-origin-pool	example-origin-pool
test-namespace	example-namespace
demo-app	example-app
mycompany	example-company