Merge pull request #174 from ak1ra24/fix-docs-about-runner-user

Fix documents about runner_user
whywaita · Sep 1, 2023 · ed213ab · ed213ab
2 parents 2e1b8d8 + 4e3e07e
commit ed213ab
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 12 deletions.
diff --git a/docs/01_01_for_admin_setup.md b/docs/01_01_for_admin_setup.md
@@ -98,6 +98,11 @@ A config variables can set from environment values.
     - Use the latest version in starting job
   - The version of `actions/runner`
   - example) `v2.302.1`, `latest`
+- `RUNNER_USER`
+  - default: `runner`
+  - set linux username that executes runner. you need to set exist user.
+    - DO NOT set root. It can't run GitHub Actions runner in root permission.
+    - Example: `ubuntu`
 
 For tuning values
 

diff --git a/docs/02_01_for_user_setup.md b/docs/02_01_for_user_setup.md
@@ -28,17 +28,14 @@ you need to register a target that repository or organization.
 - `scope`: set target scope for an auto-scaling runner.
   - Repository example: `octocat/hello-worlds`
   - Organization example: `octocat`
-- `runner_user`: set linux username that executes runner. you need to set exist user.
-  - DO NOT set `root`. It can't run GitHub Actions runner in root permission.
-  - Example: `ubuntu`
 - `resource_type`: set instance size for a runner.
   - We will describe later.
   - Please teach it from myshoes admin.
 
 Example (create a target):
 
 ```bash
-$ curl -XPOST -d '{"scope": "octocat/hello-world", "resource_type": "micro", "runner_user": "ubuntu"}' ${your_shoes_host}/target
+$ curl -XPOST -d '{"scope": "octocat/hello-world", "resource_type": "micro"}' ${your_shoes_host}/target
 ```
 
 You can check registered targets.
@@ -51,8 +48,6 @@ curl -XGET ${your_shoes_host}/target | jq .
     "scope": "octocat",
     "token_expired_at": "2006-01-02T15:04:05Z",
     "resource_type": "micro",
-    "runner_user": "ubuntu",
-    "runner_version": "",
     "provider_url": "",
     "status": "active",
     "status_description": "",
@@ -74,8 +69,8 @@ For example,
 So please configure it.
 
 ```bash
-$ curl -XPOST -d '{"scope": "octocat", "resource_type": "nano", "runner_user": "ubuntu"}' ${your_shoes_host}/target
-$ curl -XPOST -d '{"scope": "octocat/huge-repository", "resource_type": "4xlarge", "runner_user": "ubuntu"}' ${your_shoes_host}/target
+$ curl -XPOST -d '{"scope": "octocat", "resource_type": "nano"}' ${your_shoes_host}/target
+$ curl -XPOST -d '{"scope": "octocat/huge-repository", "resource_type": "4xlarge"}' ${your_shoes_host}/target
 
 $ curl -XGET ${your_shoes_host}/target | jq .
 [
@@ -84,8 +79,6 @@ $ curl -XGET ${your_shoes_host}/target | jq .
     "scope": "octocat",
     "token_expired_at": "2006-01-02T15:04:05Z",
     "resource_type": "nano",
-    "runner_user": "ubuntu",
-    "runner_version": "",
     "provider_url": "",
     "status": "active",
     "status_description": "",
@@ -97,8 +90,6 @@ $ curl -XGET ${your_shoes_host}/target | jq .
     "scope": "octocat/huge-repository",
     "token_expired_at": "2006-01-02T15:04:05Z",
     "resource_type": "4xlarge",
-    "runner_user": "ubuntu",
-    "runner_version": "",
     "provider_url": "",
     "status": "active",
     "status_description": "",