guide: handson cli

CLIハンズオンガイド

作成者

波田野 裕一

公開日

2020-05-25

このガイドでは、CLIハンズオンの実施方法や効果的に行うためのポイントについて説明し ます。

CLIハンズオン手順書の特徴

本ガイドの対象となっているCLIハンズオン手順書は、別途明記がある場合を除いて全ての手順がコピー&ペーストで完結するように記述してあります。

以下についてきちんと確認しながら進めていただければ、必ず完遂が可能できます。

  1. 手順が想定している環境で実施していること

  2. 手順書の順番通り進めていること

  3. 読み飛ばしや、手順のスキップをしていないこと

注釈

なるべく完璧を期していますが、誤字、脱字、矛盾などがあれば是非ご指摘ください。

ハンズオン学習において優先すべきこと

時間が限られるハンズオン時間内において効率よく行うためには、以下を念頭に進めていただくことをお勧めします。

  1. 「完了すること」を最優先すること。 (全体把握)

ハンズオンにおいて最も大事なことは、「手順通り進めたら、想定通りの結果が得られた」ことを体感することです。 わからない点がたくさんあっても、とにかく一回最後まで進めてください。 それによって、ハンズオン全体でどんなことをやっているのか、どんなアウトプットが得られるのかを把握することができます。(全体を俯瞰することができます。)

  1. 必ず復習すること。(インプット)

1回完了させることで、手順の全体構造と具体的なアウトプットを確認できているので、あとは、ワンステップずつ復習することで、効率良く確実に知識を身につけることができます。 そのときに、「全てを把握しよう」とするのではなく、「わかりやすい」ところから順次理解していくのが、持続しやすく、実務に活用しやすいのでおすすめです。

ハンズオンによる学習で最も重要なのは、この「復習」であり、復習をやる人とやらない人の差はとてつもなく大きいです。

  1. 自分なりにカスタマイズしてオリジナル手順にしてみること。 (アウトプット)

    2で知識が身についたとしても、まだテンプレートが扱える段階で、自動車免許で言うと仮免許が取れた段階です。 実際に路上に出るように、2までで得られた知識を基にオリジナル手順を作成してみましょう。

    自力で書いた手順通りにリソース構築ができるようになったら、仮免許は卒業でしょう。 多くの人の目に触れることで、手順書の品質や作成効率はどんどんあがっていきます。色々な人に見てもらうようにしましょう。

ハンズオン手順における表記について (入力部分)

CLIハンズオンにおいては、以下の青および黄色のブロック部分をターミナルに、順次入力して進めていきます。

ブロック範囲内をコピーして、ターミナルにペーストしてエンターキーを押すと、そのまま実行されます。

環境変数の設定(例):

export AWS_DEFAULT_REGION:"ap-northeast-1"

注釈

上記の例では、環境変数AWS_DEFAULT_REGIONを設定しています。

変数の設定(例):

VARIABLE="value"

注釈

上記の例では、シェル変数VARIABLEを設定しています。

変数の確認(例):

cat << END

  # AWS_DEFAULT_REGION:"ap-northeast-1"
    AWS_DEFAULT_REGION:"${AWS_DEFAULT_REGION}"
  # VARIABLE:"value"
    VARIABLE:"${VARIABLE}"

END

注釈

上記の例では、環境変数AWS_DEFAULT_REGIONと変数VARIABLEに正しい値が入っているかどうかを確認するために、ヒアドキュメントを利用して表示しています。

  • 上段に想定している値、下段に実際に変数に入っている値が表示されます。

  • ブロック全体を選択してコピーしてしまうと、ペーストしたときにヒアドキュメントとして動作しない場合があります。失敗した場合は、"cat"から最後の"END"の部分のみコピーしてペーストをやりなおしてください。

「変数の確認」は、手順に必要な変数の入力後およびリソースについてCreate/Update/Deleteを実行する前に、想定通りに手順が進んでいるかを確認するために実施しています。

コマンド:

echo ${VARIABLE}

注釈

上記の例では、echoコマンドを実行しています。

ハンズオン手順における表記について (出力部分)

コマンドの実行結果などの出力例については、グレーで表記しています。

実行結果が想定通りかどうかを確認するために参照してください。

結果(例):

value

注釈

上記の例では、echoコマンドの出力例を表示しています。

ハンズオン学習において最も大事なこと

いろいろ書きましたが、楽しめるかどうかが最終的に習得できる範囲と深さに最も影響があるそうです。(必要に迫られているかどうかももちろん重要です、が。)

なにはともあれ、楽しんでハンズオンをやりましょう。