From ddad824d269608f9d8ec3b851948636bc2ef106a Mon Sep 17 00:00:00 2001 From: kota2and3kan <47254383+kota2and3kan@users.noreply.github.com> Date: Mon, 25 Dec 2023 15:03:49 +0900 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Josh Wong --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 90359f1..67cb849 100644 --- a/README.md +++ b/README.md @@ -31,11 +31,12 @@ Scalar Admin pause tool for the Kubernetes environment zone ID is case sensitive. Etc/UTC by default. ``` -## Run the CLI tool on a Kubernetes environment +## Run the CLI tool in a Kubernetes environment The `scalar-admin-k8s` CLI tool executes Kubernetes APIs in its internal processes. To run those Kubernetes APIs, you must run the `scalar-admin-k8s` CLI tool as a pod on the Kubernetes environment and you must: -1. Create three Kubernetes resources (`Role`, `RoleBinding`, and `ServiceAccount`). +1. Create three Kubernetes resources (`Role`, `RoleBinding`, and `ServiceAccount`), replacing the contents in the angle brackets as described: + * Role ```yaml @@ -77,7 +78,8 @@ The `scalar-admin-k8s` CLI tool executes Kubernetes APIs in its internal process namespace: ``` -1. Mount the `ServiceAccount` on the `scalar-admin-k8s` pod. +1. Mount the `ServiceAccount` on the `scalar-admin-k8s` pod, replacing the contents in the angle brackets as described: + * Pod ```yaml @@ -105,6 +107,6 @@ The `scalar-admin-k8s` CLI tool executes Kubernetes APIs in its internal process - ``` -## Run the CLI tool on a Kubernetes environment by using Helm Chart +## Run the CLI tool in a Kubernetes environment by using a Helm Chart Coming soon.