TOP オフショア開発 本番環境(プロダクション環境)へのデプロイをスムーズにする方法  パート1

本番環境(プロダクション環境)へのデプロイをスムーズにする方法  パート1

by Van Nguyen
0 コメント

皆様ソフトウエア開発において、本番環境のデプロイで苦労した経験はありますか?私は本番環境にソフトウエアをデプロイする時、何度もトイレで涙を流したことがあります。またデプロイで徹夜をしたことも何度もあります。また、顧客に完成品を引き渡す直前にシステムが正しく稼働せず、パニックになった事もあります。今回はそう言った私の本番環境のデプロイで経験してきたことを紹介したいと思います。紹介したい経験がたくさんあるので、3つのパートに分けて、紹介して行きます。今回はそのパート1です!

  • パート1:準備
  • パート2:配備
  • パート3:監視

早速、パート1に入りましょう

パート 1  準備

1. クリーンコードを実行する

2.  防御的プログラムを練習する

3. ユニットテストを使用する

4. ログを記録することを習慣づける

5. 出来る限りCIを使用する

6. 配備チェックリストを準備する

7. 本番環境へのデプロイ前に、開発やテストやステージング環境を準備する

8. デプロイ用のワークフローとパイプラインを作成する

パート1

修正することより防ぐことの方が簡単です。

システムがスムーズに稼働する為に、本番環境にデプロイする前の準備は、システムを円滑に実行するための最も重要なステップです。 

 Mike Tyson選手の言葉に「Everyone has a plan until they get punched in the mouth」という 言葉があります。

日本語に訳すと「誰もが口に俺のパンチを喰らうまで作戦を持っている」

要は準備周到でも一度パンチを喰らえば、作戦が崩れパニックになるという意味です。

私はタイソンのその名言が大好きですが、ソフトウエア開発に置いて完璧に準備することが無駄になることはありません。苦境にある時にこそ準備してきたことが役に立つことはよくあります。

ということで、今回のパート1では「準備」をテーマにお話しをします。

1. クリーンコードを実行する

どんな状況でもクリーンコードが必要になります。

本番環境にスムーズにデプロイする為に、コードがクリーンで理解しやすいものである必要があります。

コードがクリーンであると、他のメンバーがソースコードを理解しやすいだけでなく、本番環境で問題が発生しても修正しやすくなります。

本番環境へデプロイする時は「時は金なり」と考えましょう。1分の遅延さえ深刻な被害をもたらす可能性があります。

私は同僚のコードをデプロイする際に、本番環境でコードエラーが発生することが多々あります。エラーが発生した時はソースコードの担当者に連絡しますが、担当者でも分からないことが多いので、結局私があーでもない、こーでもないと焦って修正することになります。

これはコードが整理されておらず理解しにくいことが原因です。

こう言ったことを未然に防ぐ為に、コードは日頃からクリーンに書くことを意識しなければいけません。

2. Defensive Programmingを練習する

これは私が個人的にも好きなプログラミング技術です。この技術はDave Thomasという作家の「The Pragmatic Programmer」という本で紹介された方法です。

この本は開発者が読むべき10の本の1つでもあります。

私もこの本を読んで多くのことを学びました。

一般的に、コードと実行する環境で起こり得るすべてのイベントを予測することは非常に難しいです。

しかしDefensive Programming技術を使用することで、エラーが起きにくいコードとなり、より安心できるようになります。

インド人のコードは長く、複雑なことが多いです。私もプログラマーとして彼らのコードを解析するのはあまり好きではありません。

しかし毎回驚かさせられることは、彼らのソフトウェアはちゃんと稼働し、エラーがほとんど発生しないのです。

また、コードに対するエラーハンドリングも非常に優れています。

3. 出来る時にユニットテストを使用する

エラーが発生するまで誰もあなたのコードを見ることも知ることもありません。

その為、コードを書き留めた瞬間からエラーを処理する機能をセルフマスタリングすることは必須です。 

そうすることで、エラーを直す際に、システムの全てをチェックする必要がなくなります。

ユニットテストを使用することを慣れておくことで、コードを書く時にエラーが発生する可能性があるかどうかの判断力もついてきます。

様々なケースを想定し判断する事で、本番環境へのデプロイが安心できるようになります。

4. ログを記録することを習慣づける

ログを記載することはコードを書く時だけでなく、本番環境へのデプロイの時にも役立ちます。本番環境でデバックモードを有効にするということは、決して起きてはいけない事です。

早めにエラーをトレースする為に例外のログとシステム稼働時の情報ログを記載しておきましょう。

ログがある事でエラー事もログを見直し解決につなげる事ができます。

5. 出来る時にCIを使用する

CIの使用は自動コードレビュー、自動テストなど、多くのステップを自動化することができるのでとても便利です。CIの使用で開発スピードを大きく向上する事ができるのでコードを書く時間に多く費やすことができるようになります。

6. 配備チェックリストを準備する

配備チェックリストを準備することはとても大切です。

配備チェックリストの中にシステム導入前、導入中、導入後に実行する手順を含めましょう。

それは重要なステップを忘れないようにするだけでなくて、どのステップまで実行しているか、各ステップを完了するのにどれくらい時間がかかるか分かるようになります。

通常、顧客はシステムのデプロイ過程事にデプロイチェックリストを使用して監査するので、発注先にデプロイチェックリストの作成を依頼します。

しかし、顧客がこれを依頼しなくても、こっちから顧客にデプロイチェックリストを提供できるようにしておくことがプロの開発者の仕事だと思います。

7. 本番環境へのデプロイの前に、開発やテストやステージングの環境を準備する

プロジェクトの要件とそのプロジェクトの人材により、準備する内容が変わってきます。

重要なプロジェクトでDevOpsの各ステップを実装するのに十分な人数がいる場合はバージョンを分けて、異なる環境で実行するべきです。

本番環境へのデプロイ前にステージングサーバーでコードがクリーンで、スムーズに実行される事を確保してください。

8.デプロイ用のワークフローとパイプラインを作成する

基本的に、ワークフローやパイプラインはチェックリストを使用する事と同じです。ただしそれらより、より技術的です。

そしてパイプラインではどのステップでも、ステップを実行する前に、ノードが全部完了していることを必ず確認する事が大切です。

例えば、自動化テストのステップで失敗する場合はテスト環境の配備も実施できません。

パイプライン、ステップバイステップ、チェックリストが対応する必要のタスクリストに過ぎず、任意の順序に実行できます。

以上がパート1です。

お役立ていただければ幸いです。

パート2、3も私の色々な経験や知識を共有して行くので楽しみにしていて下さい。

関連記事