আপনি কীভাবে এড়াতে পারবেন যে সার্ভারের ডকুমেন্টেশনগুলি আসল সেটআপের সাথে সিঙ্কের বাইরে চলে যায়?


8

আমাদের পরিবেশের জন্য আমাদের পক্ষে যুক্তিসঙ্গতভাবে ভাল ডকুমেন্টেশন রয়েছে (AsciiDoc ফর্ম্যাটে) যা সম্প্রতি অন্য একজনকে 30 মিনিটেরও কম সময়ে স্ক্র্যাচ থেকে পুরো সেটআপটি পুনরায় তৈরি করতে দেয়।
তবে, আমি লক্ষ্য করেছি যে প্রাথমিক সেটআপের পরে, এটি সহজেই ঘটে যায় যে সিস্টেমে ছোট ছোট পরিবর্তন হয়েছে (বলুন: ইনড্ড অক্ষম হয়ে যায়, আমার আইএমএপি সার্ভার ম্যানেজসিভ সংযোগগুলির জন্য একটি অতিরিক্ত পোর্টে শোনেন, এক্সিম কনফিগারেশনে একটি নতুন রাউটার যুক্ত হয়েছে) ডন তাত্ক্ষণিকভাবে ডকুমেন্টেশনে শেষ হবে না (যদি তা হয়)।

এই লাগাতে হতে পারে বাস্তবায়ন এক উপায় - আমার ধারণা দ্বারা (? আংশিকভাবে) এই সমস্যা এড়ানোর কনফিগারেশন ফাইল থেকে বের ডকুমেন্টেশন এবং তাতে মন্তব্য উৎপাদিত ছিল /etcএবং /usr/local/etcকিছু সোর্স কোড ব্যবস্থাপনা সিস্টেমের মধ্যে (বলুন - Git) এবং তারপর একটি রান স্ক্রিপ্ট যা প্রতিটি প্রতিশ্রুতিতে ডকুমেন্টেশন পুনরায় জেনারেট করে। তবে, আমি নিশ্চিত নই যে এটি ওভারকিল এবং / অথবা সঠিকভাবে পাওয়া খুব কঠিন হবে (সর্বোপরি, আমি আমার ডকুমেন্টেশনে উত্স ফাইলগুলির সম্পূর্ণ অনুলিপিগুলি চাই না বরং কেবল ভিন্নতাগুলি চাই)।

অন্যান্য লোকেরা কীভাবে এড়ানো যায় যে সার্ভারের ডকুমেন্টেশনগুলি পুরানো হয়ে যায় - এগুলি স্বয়ংক্রিয়ভাবে সিঙ্কে রাখার কোনও ভাল উপায় আছে বা সিস্টেমটি একই সময়ে পরিবর্তন করার সাথে সাথে ডকুমেন্টেশন আপডেট করার জন্য আপনার কেবল শৃঙ্খলা রয়েছে?


আমি মনে করি এই প্রশ্নটি অনেক ছোট এবং মাঝারি আকারের দোকানে প্রয়োগ করা যেতে পারে। আমি জানি আমাদের একই সমস্যা আছে। আমি মনে করি শৃঙ্খলাবদ্ধতা এবং আপনার কাজের অনুমানের ডকুমেন্টেশন সহ এক বিরক্তিকর তবে সহজ সমাধান
Rqomey

উত্তর:


5

আপনি কখনও কোনও ডকুমেন্টেশন থেকে দূরে সরে যাবেন না তবে আপনি যেমন অবহিত করেছেন এমন সিস্টেম রয়েছে যা আপনার পরিবর্তন প্রক্রিয়ায় এটির অনেকগুলি coverাকতে একীভূত করা যেতে পারে।

  • একটি কনফিগার পরিচালন সরঞ্জাম ব্যবহার করুন (যেমন পুতুল বা শেফ )।
  • আপনার কনফিগারেশনটি পরিবর্তন নিয়ন্ত্রিত উপায়ে সংরক্ষণ করুন। (যেমন গিট বা এসভিএন )
  • নিশ্চিত করুন কনফিগারেশনটি মানুষের দ্বারা পঠনযোগ্য / অ্যাক্সেসযোগ্য (যেমন প্লেইন পাঠ্য, সন্ধানযোগ্য ডিবি)

এই পদ্ধতিতে নিম্ন স্তরের ডকুমেন্টেশন যা আমরা সকলেই সাধারণত মিস করি (বা বিরক্ত করি না) প্রয়োগ করা হয় সেই পদ্ধতিটি আপনার পরিবর্তনের জন্য সিস্টেমের অংশ হিসাবে কনফিগার আইটেম বা কোডে তথ্য স্থাপন করে। এটিতে ভবিষ্যতে আরও পুনরাবৃত্তিযোগ্য হওয়ার প্রক্রিয়াটির একটি অতিরিক্ত বোনাস রয়েছে।

বাহ্যিক ডকুমেন্টেশনগুলিকে এখনও আপডেট করার দরকার নেই তবে এটি দীর্ঘ কমান্ড / ফাইল তালিকার পরিবর্তে "ডিপ্লয় এক্স" বা "ডিপ্লয় ওয়াই" পয়েন্টার সহ খুব উচ্চ স্তরের হয়ে যায়। এটি ডকুমেন্টেশনগুলি কম ঘন এবং সহজ উভয়ই পরিবর্তন করে যার অর্থ এটি সম্পন্ন হওয়ার সম্ভাবনাও বেশি।

এছাড়াও পুতুলের সাথে ঝাঁকুনির আগে আপনি যা চান তা পরিচালনা করার জন্য ইতিমধ্যে কেউ ইতিমধ্যে কিছু লিখেছেন


1
পুতুল আনার জন্য +1; আমি ভেবেছিলাম এটি একবারে সম্পূর্ণ হোস্টের পরিবর্তনগুলি একবারে প্রয়োগ করার জন্য ব্যবহৃত হয়েছিল, এটি আমার কাছে কখনও ঘটেনি যে কোনও একক সিস্টেমের জন্য এটি ব্যবহার করা কোনও ডকুমেন্টেশন দৃষ্টিকোণ থেকে কার্যকর হতে পারে।
ফ্রেরিচ রাবাবে

6

আপনি যদি কেবল এক বা দুটি ছোট সিস্টেম পরিচালনা করেন তবে পুতুল বা শেফের মতো একটি বৃহত কনফিগারেশন ম্যানেজমেন্ট সিস্টেম স্থাপন করা ওভারকিলের মতো মনে হয়। (যদিও, ভবিষ্যতে আরও সিস্টেম রাখার পরিকল্পনা থাকলে, এখনই এটি করুন!)

এর মতো একটি ছোট সেটআপের জন্য, আমি এর মতো কিছু ব্যবহার করার পরামর্শ দিচ্ছি etckeeper, এমন একটি প্রোগ্রাম যা /etcএকটি gitসংগ্রহস্থল স্থাপন করে এবং কয়েকটি কার্যকর ফাংশন সরবরাহ করে, যেমন আপনি যখনই কোনও প্যাকেজ ইনস্টল করেন, আপগ্রেড করবেন বা সরিয়ে ফেলবেন, তেমন একটি স্বয়ংক্রিয় প্রতিশ্রুতি করুন।


আকর্ষণীয়, etckeeperক্ষুদ্রতর টুইটগুলি ভুলে যাবেন না এড়াতে কার্যকর শব্দগুলি।
ফ্রেরিচ রাবাবে

5

প্রতিবার সিস্টেমটিতে পরিবর্তন করার সময় আপনাকে কেবল আপনার ডকুমেন্টেশন আপডেট করতে হবে। একে Change Management

এটিকে হাস্যকর ফ্যাশনে বেশিরভাগ সংস্থাগুলি পরিবর্তন পরিচালনার বাস্তবায়ন করে যাতে এটির চেয়ে খারাপ কিছু তৈরি করা যায় যাতে মৌলিক ধারণাটির কার্যকারিতা থেকে বিরত থাকা বা আপনাকে এটি সঠিকভাবে করা থেকে বিরত রাখা উচিত নয়।

আমার htmlসমস্ত কনফিগারেশন ট্র্যাক করতে আমি বা কোনও ধরণের উইকি ব্যবহার করতাম। এখন আমি উইন্ডোজ শপটিতে ( কাঁপুন ) শেয়ারপয়েন্ট সহ কাজ করি , সুতরাং এখন আমি আমার প্রতিটি সিস্টেম এবং আমার তৈরি প্রতিটি কনফিগারেশন ট্র্যাক করার জন্য তৈরি করা ওয়ার্ড ডকুমেন্ট "টেম্পলেট" ব্যবহার করি, যা এটি যতটা শোনাচ্ছে ততটা খারাপ নয় সিস্টেমগুলি হ'ল কেবল কুকি-কাটারের অনুলিপিগুলি যা সমস্ত একই ডকুমেন্টে একসাথে লম্প করা যেতে পারে। (এবং আমি আমার হার্ড ড্রাইভের সমস্ত স্টক ডক্সের স্থানীয় অনুলিপিগুলি রাখি, যা আসলে যে কোনও ব্যক্তির শেয়ারপয়েন্ট সাইট হ'ল অসংগঠিত স্তূপে ছুঁড়ে দেওয়ার পাশাপাশি একটি সংজ্ঞাবহ ফ্যাশনে সংগঠিত করা হয়))

সবচেয়ে বড় চ্যালেঞ্জটি হ'ল ডকুমেন্ট করার সময় তৈরি করা, যা আমি পরিবর্তনটি করার জন্য সময়ের অংশ হিসাবে ডকুমেন্টেশনের সময় যুক্ত করে করি। সুতরাং, সত্যিই এতটা কঠিন নয়, বিশেষত যদি আপনি কিছুটা গাধা হয়ে থাকেন এবং লোকজনকে সেখান থেকে সরে যেতে এবং লাইনে অপেক্ষা করতে বলেন তবে আপনি এই মুহুর্তে তাদের সমস্যার জন্য খুব ব্যস্ত রয়েছেন।


যদি শেয়ারপয়েন্টটি অসংগঠিত হয় তবে তারা খুব ভাল কাজ করছে না। আমরা এটিকে মূল ডকুমেন্টেশন পদ্ধতি হিসাবে ব্যবহার করছি এবং স্বয়ংক্রিয় সংস্করণ সহ এটি বজায় রাখা বেশ সহজ।
অ্যাডাপ্ট্রি

1
+1: 'চেঞ্জ ম্যানেজমেন্ট' শব্দটি বাদ দেওয়ার জন্য ধন্যবাদ, আমি এটি জানতাম না।
ফ্রেরিচ রাবাবে

@ অ্যাডাপ্ট্রি আমি এখনও এটি ব্যবসায়ের ক্ষুদ্রতর ব্যবসায়ের বাইরে কোনও প্রতিষ্ঠানের উপযোগিতা এবং উপযোগিতার সাথে বাস্তবায়িত দেখতে পেলাম ... সুতরাং বর্তমান কর্পোরেট ওভারলর্ডরা ভাল কাজ করছে না, এটি শেয়ারপয়েন্ট এবং এর বাইরে যে কোনও সংস্থার ক্ষেত্রে একটি দুর্দান্ত সার্বজনীন সমস্যা that's একটি নির্দিষ্ট আকার।
আশাহীন N00b 10
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.