From 0eb329fe9f746286d3ab7a7d4e3fcb7d0a79ef97 Mon Sep 17 00:00:00 2001 From: S-mishina <45090872+S-mishina@users.noreply.github.com> Date: Tue, 10 Dec 2024 01:38:02 +0900 Subject: [PATCH] fix (#79) Signed-off-by: S-mishina <45090872+S-mishina@users.noreply.github.com> --- docs/k8s-resource/README.md | 164 +----------------------------- docs/k8s-resource/k8s-resource.md | 161 +++++++++++++++++++++++++++++ 2 files changed, 165 insertions(+), 160 deletions(-) create mode 100644 docs/k8s-resource/k8s-resource.md diff --git a/docs/k8s-resource/README.md b/docs/k8s-resource/README.md index f1c68829..b9498948 100644 --- a/docs/k8s-resource/README.md +++ b/docs/k8s-resource/README.md @@ -1,161 +1,5 @@ -# Kubernetes resource(request/memory) Docs +# Kubernetes Docs -## Kubernetesにおけるresource設計 - -### CPU - -CPUリソースは、コンテナの処理速度やパフォーマンスに影響します。 - -- **requests**: 最小限必要なCPU量。 -- **limits**: 最大許容CPU量。 - -適切なCPUリソース設計により、Podのパフォーマンス劣化を防ぎます。 - -#### 参考資料 - -[assign-cpu-resource/](https://kubernetes.io/ja/docs/tasks/configure-pod-container/assign-cpu-resource/) - -[meaning-of-cpu](https://kubernetes.io/ja/docs/concepts/configuration/manage-resources-containers/?utm_source=chatgpt.com#meaning-of-cpu) - -### Memory - -メモリは、アプリケーションの安定動作に欠かせないリソースです。 - -- **requests**: 最小限必要なメモリ量。 -- **limits**: 最大許容メモリ量。 - -メモリ不足はPodの再起動を引き起こすため、余裕を持った設計が重要です。 - -#### 参考資料 - -[meaning-of-memory](https://kubernetes.io/ja/docs/concepts/configuration/manage-resources-containers/?utm_source=chatgpt.com#meaning-of-memory) - -### Storage - -エフェメラルストレージは、コンテナ内で一時的なデータ保存に使用します。 - -- **requests**: 最小限必要なストレージ量。 -- **limits**: 最大許容ストレージ量。 - -ストレージ不足はPodの再起動を引き起こすため、適切な設定が必要です。 - -#### 参考資料 - -[local-ephemeral-storage](https://kubernetes.io/ja/docs/concepts/configuration/manage-resources-containers/?utm_source=chatgpt.com#local-ephemeral-storage) - -## ハンズオン - -### podで設定しているCPU(resource.limit)を超えたらどうなるのか？ - -``` -> kubectl apply -k sample_manifest/kubernetes/locust/sample2/ -``` - -上記のコマンドを実行して一定タイミングを超えた段階でCPUに高負荷を与える処理を走らせてみました。 - -``` -root@flexiblemockserver-857d88469c-vtbzx:/# curl http://localhost:8080/120/1/max-cpu -{"message":"1Core is used for 120.0 seconds MAX"} -``` - -その結果、以下のような結果になりました。 - -![image](./image/1.png) - -上記の画像をさらに深ぼってみると、 - -![image](./image/2.png) - -レイテンシーが悪化しているポイントがあるのが分かります。 - -ここから、実際podのCPUはどのような変化をしていたのかを深掘りしていきます。 - -![image](./image/3.png) - -上記の画像を深掘りしていくと、 - -![image](./image/4.png) - -CPU Usageが該当時間割り当てpodのmaxを超えていて、かつスロットリングが発生していることがわかります。 - -よって、ここから分かることはCPUがmaxに到達してもpodは死なないがスロットリングが発生してパフォーマンスが劣化することが分かりました。 - -> [!NOTE] -> ここまで検証してCPUスロットリングを理解した上で知っておきたいこと。 -> * cpuが100%を超えてもpodは死なない。 -> * これは**CPUスロットリング**が発生するから -> * k8sの運用において、podのCPUが高負荷の状態でレイテンシーが悪化した時にCPU以外に変化がない場合はスロットリングを疑う必要がある。 -> * 基本的に恒常的にスロットリングが起きる状態は正常な状態とは言えないので、**resource調整が必要** -> * 通常のpod監視においてスロットリングの監視をしておくことは有用 -> * 今回示したように通常のCPUが増加傾向を示しただけでは原因がわからない。スロットリングのメトリクスと組み合わせて監視を行うことで初めて分かる。 - - -### podで設定しているMemory(resource.limit)を超えたらどうなるのか？ - -podで設定しているCPU(resource.limit)がlimitを超えた時にはスロットリングが走ってアプリケーションに直接的な影響を与えることはなかったがmemoryがlimitを超えた時にどうなるかも記載する。 - -今回も負荷をかけながら一定のタイミングでmemoryがlimitを超える処理をかけてみる。 - -``` -> kubectl apply -k sample_manifest/kubernetes/locust/sample2/ -``` - -上記のコマンドを実行して一定タイミングを超えた段階でCPUに高負荷を与える処理を走らせてみました。 - -``` -root@flexiblemockserver-857d88469c-vtbzx:/# curl http://localhost:8080/1000/max-memory -``` - -実際にメトリクスをみると、 - -![image](./image/5.png) - -負荷試験用のメトリクスでエラーが発生していることが分かる。 - -![image](./image/6.png) - -リクエスト量も減っている。 - -![image](./image/7.png) - -podの再起動も走っている。 - -ここから分かるのは、CPUはlimitを超えてもpod自体に直接的な影響は出ないがメモリーはlimitを超えると再起動が走る。 -※今回memoryのメトリクスを表示していない理由は、Prometheusが巡回するタイミングでmax値が取れなかったため出していない。(逆に言うと、自前でk8sのメトリクスを取得する場合Prometheusの巡回タイミングも重要になる。) - -> [!NOTE] -> ここまで検証してmemoryのlimitが超えた時の挙動を理解した上で知っておきたいこと。 -> * cpuが100%を超えてもpodは死なないが、memoryは100%を超えるとpodは再起動する。 -> * したがって、memoryは余力を持った構成が必要 - -### podで設定しているstorage(resource.limit)を超えたらどうなるのか？ - -ここまで、CPU、Memoryとlimitが超えた時にどうなるのかについて挙動を追ってきましたが、ここからはstorageを追っていきたいと思います。 - -今回もある程度の負荷をかけながらその挙動を追っていきます。 - -``` -> kubectl apply -k sample_manifest/kubernetes/locust/sample2/ -``` - -上記のコマンドを実行して一定タイミングを超えた段階でstorageに高負荷を与える処理を走らせてみました。 - -``` -root@flexiblemockserver-857d88469c-vtbzx:/# curl http://localhost:8080/1000/max-storage -``` - -![image](./image/8.png) -![image](./image/9.png) -![image](./image/10.png) - -今回もPrometheusの関係上storageレベルでは変化を体感することはできませんでしたが、podが再起動しました。 - -storageもlimitを超えるとpodが再起動することがわかりました。 - -> [!NOTE] -> * storageもmemoryと同様にlimitを超えるとpodは再起動します。 -> * storageにもlimitを設定する場合には、memory同様の設計をすることが重要です。 -> * storageのlimitもしっかりと設定しましょう。 -> * storageのlimitを設定しないと、nodeのstorageを食い潰してしまうので、しっかりと設定しましょう。 - -**※ 私の環境では、storageの使用率をpodやcontainer、namespace単位で見ることができなかったのでNode単位で見ています。** +| item | link | +|------|------| +| Kubernetes resource(cpu/memory/storage) Docs | [Usage README](./k8s-resource.md) | diff --git a/docs/k8s-resource/k8s-resource.md b/docs/k8s-resource/k8s-resource.md new file mode 100644 index 00000000..fb74e20b --- /dev/null +++ b/docs/k8s-resource/k8s-resource.md @@ -0,0 +1,161 @@ +# Kubernetes resource(cpu/memory/storage) Docs + +## Kubernetesにおけるresource設計 + +### CPU + +CPUリソースは、コンテナの処理速度やパフォーマンスに影響します。 + +- **requests**: 最小限必要なCPU量。 +- **limits**: 最大許容CPU量。 + +適切なCPUリソース設計により、Podのパフォーマンス劣化を防ぎます。 + +#### 参考資料 + +[assign-cpu-resource/](https://kubernetes.io/ja/docs/tasks/configure-pod-container/assign-cpu-resource/) + +[meaning-of-cpu](https://kubernetes.io/ja/docs/concepts/configuration/manage-resources-containers/?utm_source=chatgpt.com#meaning-of-cpu) + +### Memory + +メモリは、アプリケーションの安定動作に欠かせないリソースです。 + +- **requests**: 最小限必要なメモリ量。 +- **limits**: 最大許容メモリ量。 + +メモリ不足はPodの再起動を引き起こすため、余裕を持った設計が重要です。 + +#### 参考資料 + +[meaning-of-memory](https://kubernetes.io/ja/docs/concepts/configuration/manage-resources-containers/?utm_source=chatgpt.com#meaning-of-memory) + +### Storage + +エフェメラルストレージは、コンテナ内で一時的なデータ保存に使用します。 + +- **requests**: 最小限必要なストレージ量。 +- **limits**: 最大許容ストレージ量。 + +ストレージ不足はPodの再起動を引き起こすため、適切な設定が必要です。 + +#### 参考資料 + +[local-ephemeral-storage](https://kubernetes.io/ja/docs/concepts/configuration/manage-resources-containers/?utm_source=chatgpt.com#local-ephemeral-storage) + +## ハンズオン + +### podで設定しているCPU(resource.limit)を超えたらどうなるのか？ + +``` +> kubectl apply -k sample_manifest/kubernetes/locust/sample2/ +``` + +上記のコマンドを実行して一定タイミングを超えた段階でCPUに高負荷を与える処理を走らせてみました。 + +``` +root@flexiblemockserver-857d88469c-vtbzx:/# curl http://localhost:8080/120/1/max-cpu +{"message":"1Core is used for 120.0 seconds MAX"} +``` + +その結果、以下のような結果になりました。 + +![image](./image/1.png) + +上記の画像をさらに深ぼってみると、 + +![image](./image/2.png) + +レイテンシーが悪化しているポイントがあるのが分かります。 + +ここから、実際podのCPUはどのような変化をしていたのかを深掘りしていきます。 + +![image](./image/3.png) + +上記の画像を深掘りしていくと、 + +![image](./image/4.png) + +CPU Usageが該当時間割り当てpodのmaxを超えていて、かつスロットリングが発生していることがわかります。 + +よって、ここから分かることはCPUがmaxに到達してもpodは死なないがスロットリングが発生してパフォーマンスが劣化することが分かりました。 + +> [!NOTE] +> ここまで検証してCPUスロットリングを理解した上で知っておきたいこと。 +> * cpuが100%を超えてもpodは死なない。 +> * これは**CPUスロットリング**が発生するから +> * k8sの運用において、podのCPUが高負荷の状態でレイテンシーが悪化した時にCPU以外に変化がない場合はスロットリングを疑う必要がある。 +> * 基本的に恒常的にスロットリングが起きる状態は正常な状態とは言えないので、**resource調整が必要** +> * 通常のpod監視においてスロットリングの監視をしておくことは有用 +> * 今回示したように通常のCPUが増加傾向を示しただけでは原因がわからない。スロットリングのメトリクスと組み合わせて監視を行うことで初めて分かる。 + + +### podで設定しているMemory(resource.limit)を超えたらどうなるのか？ + +podで設定しているCPU(resource.limit)がlimitを超えた時にはスロットリングが走ってアプリケーションに直接的な影響を与えることはなかったがmemoryがlimitを超えた時にどうなるかも記載する。 + +今回も負荷をかけながら一定のタイミングでmemoryがlimitを超える処理をかけてみる。 + +``` +> kubectl apply -k sample_manifest/kubernetes/locust/sample2/ +``` + +上記のコマンドを実行して一定タイミングを超えた段階でCPUに高負荷を与える処理を走らせてみました。 + +``` +root@flexiblemockserver-857d88469c-vtbzx:/# curl http://localhost:8080/1000/max-memory +``` + +実際にメトリクスをみると、 + +![image](./image/5.png) + +負荷試験用のメトリクスでエラーが発生していることが分かる。 + +![image](./image/6.png) + +リクエスト量も減っている。 + +![image](./image/7.png) + +podの再起動も走っている。 + +ここから分かるのは、CPUはlimitを超えてもpod自体に直接的な影響は出ないがメモリーはlimitを超えると再起動が走る。 +※今回memoryのメトリクスを表示していない理由は、Prometheusが巡回するタイミングでmax値が取れなかったため出していない。(逆に言うと、自前でk8sのメトリクスを取得する場合Prometheusの巡回タイミングも重要になる。) + +> [!NOTE] +> ここまで検証してmemoryのlimitが超えた時の挙動を理解した上で知っておきたいこと。 +> * cpuが100%を超えてもpodは死なないが、memoryは100%を超えるとpodは再起動する。 +> * したがって、memoryは余力を持った構成が必要 + +### podで設定しているstorage(resource.limit)を超えたらどうなるのか？ + +ここまで、CPU、Memoryとlimitが超えた時にどうなるのかについて挙動を追ってきましたが、ここからはstorageを追っていきたいと思います。 + +今回もある程度の負荷をかけながらその挙動を追っていきます。 + +``` +> kubectl apply -k sample_manifest/kubernetes/locust/sample2/ +``` + +上記のコマンドを実行して一定タイミングを超えた段階でstorageに高負荷を与える処理を走らせてみました。 + +``` +root@flexiblemockserver-857d88469c-vtbzx:/# curl http://localhost:8080/1000/max-storage +``` + +![image](./image/8.png) +![image](./image/9.png) +![image](./image/10.png) + +今回もPrometheusの関係上storageレベルでは変化を体感することはできませんでしたが、podが再起動しました。 + +storageもlimitを超えるとpodが再起動することがわかりました。 + +> [!NOTE] +> * storageもmemoryと同様にlimitを超えるとpodは再起動します。 +> * storageにもlimitを設定する場合には、memory同様の設計をすることが重要です。 +> * storageのlimitもしっかりと設定しましょう。 +> * storageのlimitを設定しないと、nodeのstorageを食い潰してしまうので、しっかりと設定しましょう。 + +**※ 私の環境では、storageの使用率をpodやcontainer、namespace単位で見ることができなかったのでNode単位で見ています。**