ব্যবহারকারীর নির্দেশিকা

আপনি প্রদত্ত ওয়েব ডেমো ব্যবহার করে বা সরাসরি REST API কল করে সিমুলেশন চালাতে পারেন।

ইনপুট ও আউটপুট

ইনপুট ও আউটপুট ফাইল Terraform সেট-আপ থেকে Cloud Storage বাকেট ব্যবহার করে।

ইনপুট ডিরেক্টরিতে metrics_config.zip এবং publisher_config.zip ফাইল থাকতে হবে। প্রয়োজন অনুযায়ী আপনি এটির পাথ নির্ধারণ করতে পারবেন।

আউটপুটের জন্য বাকেটে একটি simulations ডিরেক্টরি থাকে, যা প্রতিটি সিমুলেশনকে তার আইডি দ্বারা স্টোর করে। প্রতিটি সিমুলেশন ডিরেক্টরিতে কপি করা ইনপুট ফাইল সহ একটি inputs ফোল্ডার এবং একটি outputs ফোল্ডার থাকে। outputs ফোল্ডারে বাগরিপোর্ট, logcat ফাইল এবং জেনারেট করা সিমুলেটর ফাইল থাকে।

ওয়েব ডেমো ব্যবহার করুন

এই প্ল্যাটফর্মে ডেমো দেখানোর জন্য Flutter-ভিত্তিক ওয়েব অ্যাপ্লিকেশন অন্তর্ভুক্ত আছে যার মাধ্যমে আপনি সিমুলেশন দেখতে, তৈরি ও ম্যানেজ করতে পারবেন। আপনার প্রয়োজন অনুযায়ী নিজস্ব ইউজার ইন্টারফেস তৈরি করার জন্য আপনাকে উৎসাহিত করা হচ্ছে।

ডেমো অ্যাপটি App Engine-এ ডেপ্লয় করা হয়েছে এবং আপনাকে Google অ্যাকাউন্ট দিয়ে সাইন-ইন করতে হবে। আপনার Google Cloud প্রোজেক্টে কনফিগার করা OAuth 2.0 ক্লায়েন্ট আইডি ব্যবহার করে এটি সুরক্ষিত করা হয়। ডিপ্লয় করা Cloud Functions চালু করার জন্য সাইন-ইন করা অ্যাকাউন্টের IAM অনুমতি থাকতে হবে। ব্যবহারকারীর অ্যাকাউন্টে প্রয়োজনীয় অনুমতি দেওয়ার ব্যাপারে নির্দেশাবলী পেতে, IAM-এর মাধ্যমে অ্যাক্সেস অনুমোদন করুন দেখুন, যেমন Cloud Functions Invoker ভূমিকা (roles/cloudfunctions.invoker)।

ব্যবহারকারীর ওয়ার্কফ্লো

  1. OAuth 2.0 প্রসেস ব্যবহার করে যাচাই করা আপনার Google অ্যাকাউন্ট দিয়ে সাইন-ইন করুন।
  2. মূল পৃষ্ঠায় সিমুলেশন দেখুন, যা Firestore ডেটাবেস কোয়েরি করে সব সিমুলেশন তালিকাভুক্ত করে, যেখানে সব এক্সিকিউশন তথ্য থাকে।
  3. নিচে ডানদিকের কোণে + অ্যাকশন বোতামে ক্লিক করে নতুন সিমুলেশন শিডিউল করার জন্য ফর্মে নেভিগেট করুন। আপনি ইনপুট পাথ, বিল্ড আইডি এবং ইনস্ট্যান্স টাইপ সহ একাধিক প্যারামিটার প্রদান করেন। আরও তথ্যের জন্য, সিমুলেশন তৈরি করুন দেখুন।
  4. সিমুলেশন তালিকার আপডেটে মনিটরের স্ট্যাটাস চেক করুন, যা নতুন সিমুলেশনের স্ট্যাটাস দেখায়, যেমন, PENDING, RUNNING, COMPLETED.
  5. সিমুলেশন সম্পূর্ণ হওয়ার পরে, জেনারেট করা রিপোর্ট ও আর্টিফ্যাক্ট দেখুন। ইনপুট ফাইল, আউটপুট রিপোর্ট, লগ, Logcat এবং Bugreports, Cloud Storage-এ স্টোর করা হয়।
  6. ঐচ্ছিক: শিডিউল করা বা চালু থাকা সিমুলেশন বাতিল করা।

API ব্যবহার

অটোমেশন এবং অন্যান্য সিস্টেমের সাথে ইন্টিগ্রেশনের জন্য, আপনি REST API ব্যবহার করতে পারেন।

যাচাইকরণ বিভাগ এবং এন্ডপয়েন্ট সংজ্ঞায় ব্যবহৃত CLOUD_FUNCTION_URL প্লেসহোল্ডারটি কল করা Cloud Function-এর বেস URL-কে রেফার করে। আপনি Google Cloud কনসোলের Cloud Functions পৃষ্ঠায় ফাংশন URL খুঁজে পাবেন; প্রতিটি ফাংশনের URL তার ফাংশনের বিবরণ পৃষ্ঠার ট্রিগার ট্যাবে দেখানো হয়। এছাড়াও, আপনি Terraform আউটপুটে এইসব URL খুঁজে পেতে পারেন যা আপনি apply কমান্ড চালানোর পরে প্রিন্ট করা হয়।

যাচাইকরণ

সব API অনুরোধ অবশ্যই একটি পরিচয় টোকেন দিয়ে যাচাই করতে হবে যা কলারের পরিচয় প্রমাণ করে। টার্গেট ফাংশনে পরিচয় (ব্যবহারকারী বা পরিষেবা অ্যাকাউন্ট)-এর কাছে Cloud Functions Invoker-এর অনুমতি থাকতে হবে।

  1. ব্যবহারকারীর ইনভোকেশন (লোকাল ও CLI): লোকাল মেশিন বা Google Cloud নয় এমন পরিবেশ থেকে API ইনভোক করার সময়, আপনাকে অবশ্যই ব্যবহারকারীর অ্যাকাউন্টের জন্য Google-এর ইস্যু করা আইডেন্টিটি টোকেন ব্যবহার করতে হবে।

    TOKEN=$(gcloud auth print-identity-token)
    
  2. পরিষেবা অ্যাকাউন্ট ইনভোকেশন (Google Cloud-এর মধ্যে): Google Cloud রিসোর্স (যেমন, Compute Engine VM, অন্য Cloud Function বা Kubernetes ক্লাস্টার) থেকে API ইনভোক করার সময়, রিসোর্সের সাথে অ্যাটাচ করা পরিষেবা অ্যাকাউন্টের পরিচয় ব্যবহার করুন। রিসোর্সের মেটাডেটা সার্ভার থেকে টোকেন ফেচ করতে হবে।

    TOKEN=$(curl -s "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity?audience=CLOUD_FUNCTION_URL" -H "Metadata-Flavor: Google")
    

আপনার অনুরোধের Authorization হেডারে, উদ্ধার করা টোকেনটি Bearer টোকেন হিসেবে যোগ করুন।

এন্ডপয়েন্ট

Cloud Telemetry Simulation স্ট্যাকের ব্যবহারকারী নিজে ইন্টার‌্যাক্ট করতে পারেন এমন এন্ডপয়েন্ট আপনাকে সিমুলেশন তৈরি ও মুছে দিতে অথবা ডেটাবেস থেকে সিমুলেশন সংক্রান্ত তথ্য পড়তে দেয়।

সিমুলেশন তৈরি করুন

এই এন্ডপয়েন্ট নতুন সিমুলেশন অনুরোধ তৈরি করে এবং তা কার্যকর করার জন্য শিডিউল করে।

  • এন্ডপয়েন্ট: POST https://CLOUD_FUNCTION_URL/simulation-orchestrator-receive-requests
  • অনুরোধের মূল অংশ:

    {
      "build_id": "latest",
      "file_path": "inputs/my-test-case/",
      "instance_type": "n1-standard-8",
      "owner": "user@example.com",
      "max_simulation_time": 300,
      "max_report_count": 5
    }
    
    • build_id (স্ট্রিং): ব্যবহার করার জন্য এজেন্ট Docker ইমেজের ট্যাগ, যেমন,latest।

    • file_path (স্ট্রিং): GCS বাকেটের মধ্যে metrics_config.zip ও publisher_config.zip থাকা ফোল্ডারের পাথ।

    • instance_type (স্ট্রিং): Compute Engine মেশিনের ধরন। এই ধরনের নেস্টেড ভার্চুয়ালাইজেশন অবশ্যই কাজ করতে হবে, যেমন n1, n2 বা t2d সিরিজ। আরও তথ্যের জন্য, নেস্টেড ভার্চুয়ালাইজেশন ওভারভিউ দেখুন।

    • owner (স্ট্রিং): সিমুলেশন শুরু করা ব্যবহারকারীর ইমেল।

    • max_simulation_time (পূর্ণসংখ্যা): সিমুলেশন যত সেকেন্ড ধরে চলে তার সর্বাধিক সময়।

    • max_report_count (পূর্ণসংখ্যা): টেলিমেট্রি রিপোর্টের সংখ্যা যার পরে সিমুলেশন শেষ হয়।

  • সফল রেসপন্স (২০০ ঠিক আছে):

    { "id": "sim-a1b2c3d4e5f6" }
    

সিমুলেশন মুছে দিন

এই এন্ডপয়েন্ট কোনও পেন্ডিং বা চালু থাকা সিমুলেশন বাতিল করে এবং এর সাথে যুক্ত রিসোর্স মুছে দেয়।

  • এন্ডপয়েন্ট: POST https://CLOUD_FUNCTION_URL/simulation-orchestrator-delete-simulation
  • হেডার:
    • Content-Type: application/json
  • অনুরোধের বডি:

    { "id": "sim-a1b2c3d4e5f6" }
    
  • সফল রেসপন্স (200 OK): একটি প্লেন-টেক্সট মেসেজ (Request accepted and is being processed).

সিমুলেশন ডেটা পড়ুন

সিমুলেশন ডেটা পড়তে, আপনি simulation-reader ফাংশনের সাথে ইন্টার‍্যাক্ট করতে পারেন। এইসব এন্ডপয়েন্ট ইতিহাস, স্ট্যাটাস ও সিস্টেম কনফিগারেশন ফিরিয়ে আনতে GET পদ্ধতি ব্যবহার করে।

সিমুলেশনের তালিকা তৈরি করা হচ্ছে

ফিল্টার ও সর্ট করার সুবিধা সহ সিমুলেশনের একটি পৃষ্ঠাভিত্তিক তালিকা উদ্ধার করে।

  • এন্ডপয়েন্ট: GET https://CLOUD_FUNCTION_URL/simulation-reader/simulations
  • কোয়েরি প্যারামিটার (সব ঐচ্ছিক):

    • status (স্ট্রিং): সিমুলেশন স্ট্যাটাস (running, Simulation request received, cancelled, completed, অথবা failed) অনুযায়ী ফিল্টার করুন।
    • owner (স্ট্রিং): মালিকের ইমেল আইডি অনুযায়ী ফিল্টার করুন।
    • sort_by (স্ট্রিং): যে ফিল্ড অনুযায়ী সাজাতে হবে (received_at, status_updated_at, started_at)। ডিফল্ট হিসেবে received_at সেট করা থাকে।
    • sort_order (স্ট্রিং): বাছাই করার উপায়, asc বা desc। ডিফল্ট হিসেবে desc সেট করা থাকে।
    • page_size (পূর্ণসংখ্যা): পৃষ্ঠা প্রতি ফলাফলের সংখ্যা। ডিফল্ট হিসেবে ২০ সেট করা থাকে।
    • page_token (স্ট্রিং): ফলাফলের পরবর্তী পৃষ্ঠা ফেচ করার টোকেন।
  • অনুরোধের উদাহরণ:

    curl -H "Authorization: Bearer $TOKEN"
    "https://CLOUD_FUNCTION_URL/simulation-reader/simulations?status=completed&owner=user@example.com&sort_by=status_updated_at"
    
  • সফল রেসপন্স (২০০ ঠিক আছে):

    • সিমুলেশনের অ্যারে এবং ঐচ্ছিক next_page_token সহ JSON অবজেক্ট রিটার্ন করে।
    {
      "simulations": [
        {
          "id": "1234-abcd",
          "owner": "some@email.com",
          "status": "completed",
          "status_updated_at": "2025-12-05T14:50:00.952Z",
          "received_at": "2025-12-05T14:46:43.106Z",
          "started_at": "2025-12-05T14:47:05.848Z",
          "ended_at": "0001-01-01T00:00:00Z",
          "instance_id": "sim-1234-abcd",
          "ip": "10.156.15.230",
          "build_id": "europe-west3-docker.pkg.dev/your-project/simulation/simulation-agent:latest",
          "instance_type": "n1-standard-8",
          "file_path": "gs://your-project-simulation_files/path/",
          "max_simulation_time": 60,
          "max_report_count": 1
        },
        {
          "id": "5678-efgh",
          "owner": "some@email.com",
          "status": "completed",
          "status_updated_at": "2025-11-07T14:49:54.25Z",
          "received_at": "2025-11-07T14:46:54.959Z",
          "started_at": "2025-11-07T14:47:13.714Z",
          "ended_at": "0001-01-01T00:00:00Z",
          "instance_id": "sim-5678-efgh",
          "ip": "10.156.15.221",
          "build_id": "europe-west3-docker.pkg.dev/your-project/simulation/simulation-agent:latest",
          "instance_type": "n1-standard-8",
          "file_path": "gs://your-project-simulation_files/path/",
          "max_simulation_time": 60,
          "max_report_count": 1
        }
      ],
      "next_page_token": "M7bydGsAptLncj8SOCb1"
    }
    
নির্দিষ্ট সিমুলেশন পান

আইডি ব্যবহার করে নির্দিষ্ট সিমুলেশনের সম্পূর্ণ বিবরণ ফিরিয়ে আনে।

  • এন্ডপয়েন্ট:

    GET https://CLOUD_FUNCTION_URL/simulation-reader/simulations/[SIMULATION_ID]
    
  • সফল রেসপন্স (২০০ ঠিক আছে): অনুরোধ করা সিমুলেশনের বিবরণ সহ একটি JSON অবজেক্ট ফেরত দেয়।

    {
      "id": "1234-abcd",
      "owner": "some@email.com",
      "status": "completed",
      "status_updated_at": "2025-12-05T14:50:00.952Z",
      "received_at": "2025-12-05T14:46:43.106Z",
      "started_at": "2025-12-05T14:47:05.848Z",
      "ended_at": "0001-01-01T00:00:00Z",
      "instance_id": "sim-1234-abcd",
      "ip": "10.156.15.230",
      "build_id": "europe-west3-docker.pkg.dev/your-project/simulation/simulation-agent:latest",
      "instance_type": "n1-standard-8",
      "file_path": "gs://your-project-simulation_files/path/",
      "max_simulation_time": 60,
      "max_report_count": 1
    }
    
সিস্টেম মেট্রিক ও কনফিগারেশন পান

এইসব এন্ডপয়েন্ট সিমুলেশন ইনফ্রাস্ট্রাকচারের বর্তমান লোড ও কনফিগারেশন সম্পর্কে ইনসাইট প্রদান করে।

  • চলমান সিমুলেশনের সংখ্যা পান: চলমান সিমুলেশনের সংখ্যা দেখায়।

    • এন্ডপয়েন্ট:

      GET https://CLOUD_FUNCTION_URL/simulation-reader/simulations/running/count
      
    • সফল রেসপন্স (২০০ ঠিক আছে):

      {
        "count": 0
      }
      
  • একসাথে চলা সর্বাধিক VM-এর সংখ্যা পান: একসাথে চলা VM-এর কনফিগার করা সর্বাধিক সংখ্যা ফেরত দেয়।

    • এন্ডপয়েন্ট:

      GET https://CLOUD_FUNCTION_URL/simulation-reader/config/max-running-vms
      
    • সফল রেসপন্স (২০০ ঠিক আছে):

      {
        "max_running_vms": 5
      }