Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Josh Wong <[email protected]>
  • Loading branch information
kota2and3kan and josh-wong authored Dec 25, 2023
1 parent 766995f commit ddad824
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -77,7 +78,8 @@ The `scalar-admin-k8s` CLI tool executes Kubernetes APIs in its internal process
namespace: <YOUR_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
Expand Down Expand Up @@ -105,6 +107,6 @@ The `scalar-admin-k8s` CLI tool executes Kubernetes APIs in its internal process
- <TIMEZONE>
```

## 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.

0 comments on commit ddad824

Please sign in to comment.