ข้อกำหนดการตั้งชื่อ

ชื่อทรัพยากรตัวอย่าง

ชื่อ ทรัพยากรตัวอย่างและสาธิตใช้คำนำหน้า example- ในรูปแบบ kebab-case วิธีนี้ช่วยให้เอกสาร ข้อกำหนด API ตัวอย่างโค้ด และการกำหนดค่าที่สร้างขึ้น มีความสอดคล้องกันทั่วทั้งระบบนิเวศ

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

ใช้ example- — ไม่ใช่ my-, test-, foo-, demo-, sample- หรือ ตัวแทนที่คล้ายชื่อบริษัท เช่น mycompany — สำหรับชื่อทรัพยากรตัวอย่างใดๆ ซึ่งครอบคลุม:

• ฟิลด์ name ของทรัพยากรในตัวอย่าง
• ค่า example: ในข้อกำหนด workflow และพารามิเตอร์
• ค่าตัวอย่างใน OpenAPI
• ไฟล์ตัวอย่าง Terraform (.tf)

สิ่งที่ไม่ครอบคลุม

ข้อกำหนดนี้ใช้กับ ชื่อทรัพยากร ตัวอย่างเท่านั้น สิ่งต่อไปนี้ ไม่ต้องเปลี่ยนแปลง:

• ชื่อแอตทริบิวต์และชื่อฟิลด์ (เช่น test_key)
• โค้ดทดสอบจริงและไดเรกทอรี test/
• ชื่อแพ็กเกจและ dependency
• โดเมนและอีเมลตัวอย่าง ซึ่งปฏิบัติตามข้อกำหนดอยู่แล้ว (app.example.com, user@example.com)

ตัวอย่าง

แทนที่	ใช้
my-origin-pool	example-origin-pool
test-namespace	example-namespace
demo-app	example-app
mycompany	example-company