Spesifikasi format lensa - AWS Well-Architected Tool

Anda dapat menggunakan AWS Well-Architected Tool Connector for Jira untuk menautkan akun Jira Anda AWS Well-Architected Tool, dan menyinkronkan item peningkatan antara beban kerja Anda dan proyek Jira.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Spesifikasi format lensa

Lensa didefinisikan menggunakan format JSON tertentu. Saat Anda mulai membuat lensa khusus, Anda memiliki opsi untuk mengunduh file JSON template. Anda dapat menggunakan file ini sebagai dasar untuk lensa kustom Anda karena mendefinisikan struktur dasar untuk pilar, pertanyaan, praktik terbaik, dan rencana perbaikan.

Bagian lensa

Bagian ini mendefinisikan atribut untuk lensa kustom itu sendiri. Ini adalah nama dan deskripsinya.

  • schemaVersion: Versi skema lensa kustom untuk digunakan. Ditetapkan oleh template, jangan berubah.

  • name: Nama lensa. Namanya bisa sampai 128 karakter.

  • description: Deskripsi teks lensa. Teks ini ditampilkan saat memilih lensa untuk ditambahkan selama pembuatan beban kerja, atau saat memilih lensa untuk diterapkan pada beban kerja yang ada nanti. Deskripsi dapat mencapai 2048 karakter.

"schemaVersion": "2021-11-01", "name": "Company Policy ABC", "description": "This lens provides a set of specific questions to assess compliance with company policy ABC-2021 as revised on 2021/09/01.",

Bagian pilar

Bagian ini mendefinisikan pilar yang terkait dengan lensa kustom. Anda dapat memetakan pertanyaan Anda ke pilar Kerangka AWS Well-Architected, menentukan pilar Anda sendiri, atau keduanya.

Anda dapat menentukan hingga 10 pilar dalam lensa khusus.

  • id: ID untuk pilar. ID dapat antara 3 dan 128 karakter dan hanya berisi karakter alfanumerik dan garis bawah (“_”). ID yang digunakan dalam pilar harus unik.

    Saat memetakan pertanyaan Anda ke pilar Framework, gunakan ID berikut:

    • operationalExcellence

    • security

    • reliability

    • performance

    • costOptimization

    • sustainability

  • name: Nama pilar. Namanya bisa sampai 128 karakter.

"pillars": [ { "id": "company_Privacy", "name": "Privacy Excellence", . . . }, { "id": "company_Security", "name": "Security", . . . } ]

Bagian pertanyaan

Bagian ini mendefinisikan pertanyaan yang terkait dengan pilar.

Anda dapat menentukan hingga 20 pertanyaan dalam pilar di lensa khusus.

  • id: ID untuk pertanyaan. ID dapat dari 3 hingga 128 karakter dan hanya berisi karakter alfanumerik dan garis bawah (“_”). ID yang digunakan dalam pertanyaan harus unik.

  • title: Judul pertanyaan. Judulnya bisa sampai 128 karakter.

  • description: Menjelaskan pertanyaan secara lebih rinci. Deskripsi dapat mencapai 2048 karakter.

  • helpfulResource displayText: Opsional. Teks yang memberikan informasi bermanfaat tentang pertanyaan tersebut. Teks dapat mencapai 2048 karakter. Harus ditentukan jika helpfulResource url ditentukan.

  • helpfulResource url: Opsional. Sumber daya URL yang menjelaskan pertanyaan secara lebih rinci. URL harus dimulai dengan http:// atauhttps://.

catatan

Saat menyinkronkan beban kerja lensa khusus ke Jira, pertanyaan menampilkan “id” dan “judul” pertanyaan.

Format yang digunakan dalam tiket Jira adalah[ QuestionID ] QuestionTitle.

"questions": [ { "id": "privacy01", "title": "How do you ensure HR conversations are private?", "description": "Career and benefits discussions should occur on secure channels only and be audited regularly for compliance.", "helpfulResource": { "displayText": "This is helpful text for the first question", "url": "https://example.com/poptquest01_help.html" }, . . . }, { "id": "privacy02", "title": "Is your team following the company privacy policy?", "description": "Our company requires customers to opt-in to data use and does not disclose customer data to third parties either individually or in aggregate.", "helpfulResource": { "displayText": "This is helpful text for the second question", "url": "https://example.com/poptquest02_help.html" }, . . . } ]

Bagian pilihan

Bagian ini mendefinisikan pilihan yang terkait dengan pertanyaan.

Anda dapat menentukan hingga 15 pilihan untuk pertanyaan dalam lensa khusus.

  • id: ID untuk pilihan. ID dapat antara 3 dan 128 karakter dan hanya berisi karakter alfanumerik dan garis bawah (“_”). ID unik harus ditentukan untuk setiap pilihan dalam pertanyaan. Menambahkan pilihan dengan akhiran _no akan bertindak sebagai None of these pilihan untuk pertanyaan.

  • title: Judul pilihan. Judulnya bisa sampai 128 karakter.

  • helpfulResource displayText: Opsional. Teks yang memberikan informasi bermanfaat tentang pilihan. Teks dapat mencapai 2048 karakter. Harus disertakan jika helpfulResource url ditentukan.

  • helpfulResource url: Opsional. Sumber daya URL yang menjelaskan pilihan secara lebih rinci. URL harus dimulai dengan http:// atauhttps://.

  • improvementPlan displayText: Teks yang menjelaskan bagaimana pilihan dapat ditingkatkan. Teks dapat mencapai 2048 karakter. An improvementPlan diperlukan untuk setiap pilihan, kecuali untuk None of these pilihan.

  • improvementPlan url: Opsional. Sumber daya URL yang dapat membantu peningkatan. URL harus dimulai dengan http:// atauhttps://.

  • additionalResources type: Opsional. Jenis sumber daya tambahan. Nilai dapat berupa HELPFUL_RESOURCE atauIMPROVEMENT_PLAN.

  • additionalResources content: Opsional. Menentukan displayText dan url nilai-nilai untuk sumber daya tambahan. Hingga lima sumber daya tambahan yang bermanfaat dan hingga lima item rencana peningkatan tambahan dapat ditentukan untuk suatu pilihan.

    • displayText: Opsional. Teks yang menjelaskan sumber daya yang bermanfaat atau rencana perbaikan. Teks dapat mencapai 2048 karakter. Harus disertakan jika url ditentukan.

    • url: Opsional. Sumber daya URL untuk sumber daya yang bermanfaat atau rencana peningkatan. URL harus dimulai dengan http:// atauhttps://.

catatan

Saat menyinkronkan beban kerja lensa khusus ke Jira, pilihan menampilkan “id” pertanyaan dan pilihan, serta “judul” pilihan.

Format yang digunakan adalah [ QuestionID | ChoiceID ] ChoiceTitle

"choices": [ { "id": "choice_1", "title": "Option 1", "helpfulResource": { "displayText": "This is helpful text for the first choice", "url": "https://example.com/popt01_help.html" }, "improvementPlan": { "displayText": "This is text that will be shown for improvement of this choice.", "url": "https://example.com/popt01_iplan.html" } }, { "id": "choice_2", "title": "Option 2", "helpfulResource": { "displayText": "This is helpful text for the second choice", "url": "https://example.com/hr_manual_CORP_1.pdf" }, "improvementPlan": { "displayText": "This is text that will be shown for improvement of this choice.", "url": "https://example.com/popt02_iplan_01.html" }, "additionalResources":[ { "type": "HELPFUL_RESOURCE", "content": [ { "displayText": "This is the second set of helpful text for this choice.", "url": "https://example.com/hr_manual_country.html" }, { "displayText": "This is the third set of helpful text for this choice.", "url": "https://example.com/hr_manual_city.html" } ] }, { "type": "IMPROVEMENT_PLAN", "content": [ { "displayText": "This is additional text that will be shown for improvement of this choice.", "url": "https://example.com/popt02_iplan_02.html" }, { "displayText": "This is the third piece of improvement plan text.", "url": "https://example.com/popt02_iplan_03.html" } { "displayText": "This is the fourth piece of improvement plan text.", "url": "https://example.com/popt02_iplan_04.html" } ] } ] }, { "id": "option_no", "title": "None of these", "helpfulResource": { "displayText": "Choose this if your workload does not follow these best practices.", "url": "https://example.com/popt02_iplan_none.html" } }

Bagian Aturan Risiko

Bagian ini mendefinisikan bagaimana pilihan yang dipilih menentukan tingkat risiko.

Anda dapat menentukan maksimal tiga aturan risiko per pertanyaan, satu untuk setiap tingkat risiko.

  • conditionEkspresi Boolean dari pilihan yang memetakan ke tingkat risiko untuk pertanyaan, ataudefault.

    Harus ada aturan default risiko untuk setiap pertanyaan.

  • risk: Menunjukkan risiko yang terkait dengan kondisi tersebut. Nilai yang valid adalah HIGH_RISK, MEDIUM_RISK, dan NO_RISK.

Urutan aturan risiko Anda signifikan. Yang pertama condition yang mengevaluasi untuk true menetapkan risiko untuk pertanyaan. Pola umum untuk menerapkan aturan risiko adalah memulai dengan aturan Anda yang paling tidak berisiko (dan biasanya paling terperinci) dan lanjutkan ke aturan Anda yang paling berisiko (dan paling tidak spesifik).

Misalnya:

"riskRules": [ { "condition": "choice_1 && choice_2 && choice_3", "risk": "NO_RISK" }, { "condition": "((choice_1 || choice_2) && choice_3) || (!choice_1 && choice_3)", "risk": "MEDIUM_RISK" }, { "condition": "default", "risk": "HIGH_RISK" } ]

Jika pertanyaan memiliki tiga pilihan (choice_1,choice_2, danchoice_3), aturan risiko ini menghasilkan perilaku berikut:

  • Jika ketiga pilihan dipilih, tidak ada risiko.

  • Jika salah satu choice_1 atau choice_2 choice_3 dipilih dan dipilih, ada risiko sedang.

  • Jika choice_1 tidak dipilih tetapi choice_3 dipilih, ada juga risiko sedang.

  • Jika tidak satu pun dari kondisi sebelumnya yang benar, ada risiko tinggi.